Config::Model::Describe.3pm

Langue: en

Autres versions - même langue

Version: 2010-06-11 (ubuntu - 24/10/10)

Section: 3 (Bibliothèques de fonctions)

NAME

Config::Model::Describe - Provide a description of a node element

VERSION

version 1.205

SYNOPSIS

  use Config::Model ;
 
  # create your config model
  my $model = Config::Model -> new ;
  $model->create_config_class( ... ) ;
 
  # create instance
  my $inst = $model->instance (root_class_name => 'FooBar', 
                               instance_name => 'test1');
 
  # create root of config
  my $root = $inst -> config_root ;
 
  print $root->describe ;
 
  # or
 
  print $root->describe(element => 'foo' ) ;
 
 

DESCRIPTION

This module is used directly by Config::Model::Node to describe a node element. This module returns a human readable string that shows the content of a configuration node.

For instance (as showns by "fstab" example:

  name         value        type         comment
  fs_spec      [undef]      string       mandatory
  fs_vfstype   [undef]      enum         choice: auto davfs ext2 ext3 swap proc iso9660 vfat ignore, mandatory
  fs_file      [undef]      string       mandatory
  fs_freq      0            boolean
  fs_passno    0            integer
 
 

This module is also used by the "ll" command of Config::Model::TermUI.

CONSTRUCTOR

new ( )

No parameter. The constructor should be used only by Config::Model::Node.

Methods

describe(...)

Return a description string.

Parameters are:

node
Reference to a Config::Model::Node object. Mandatory
element
Describe only this element from the node. Optional. All elements are described if omitted.

AUTHOR

Dominique Dumont, (ddumont at cpan dot org)

SEE ALSO

Config::Model,Config::Model::Node,Config::Model::ObjTreeScanner