Unix/Linux Go Back    


CentOS 7.0 - man page for publican::configdata (centos section 3)

Linux & Unix Commands - Search Man Pages
Man Page or Keyword Search:   man
Select Man Page Set:       apropos Keyword Search (sections above)


Publican::ConfigData(3)        User Contributed Perl Documentation	  Publican::ConfigData(3)

NAME
       Publican::ConfigData - Configuration for Publican

SYNOPSIS
	 use Publican::ConfigData;
	 $value = Publican::ConfigData->config('foo');
	 $value = Publican::ConfigData->feature('bar');

	 @names = Publican::ConfigData->config_names;
	 @names = Publican::ConfigData->feature_names;

	 Publican::ConfigData->set_config(foo => $new_value);
	 Publican::ConfigData->set_feature(bar => $new_value);
	 Publican::ConfigData->write;  # Save changes

DESCRIPTION
       This module holds the configuration data for the "Publican" module.  It also provides a
       programmatic interface for getting or setting that configuration data.  Note that in order
       to actually make changes, you'll have to have write access to the "Publican::ConfigData"
       module, and you should attempt to understand the repercussions of your actions.

METHODS
       config($name)
	   Given a string argument, returns the value of the configuration item by that name, or
	   "undef" if no such item exists.

       feature($name)
	   Given a string argument, returns the value of the feature by that name, or "undef" if
	   no such feature exists.

       set_config($name, $value)
	   Sets the configuration item with the given name to the given value.	The value may be
	   any Perl scalar that will serialize correctly using "Data::Dumper".	This includes
	   references, objects (usually), and complex data structures.	It probably does not
	   include transient things like filehandles or sockets.

       set_feature($name, $value)
	   Sets the feature with the given name to the given boolean value.  The value will be
	   converted to 0 or 1 automatically.

       config_names()
	   Returns a list of all the names of config items currently defined in
	   "Publican::ConfigData", or in scalar context the number of items.

       feature_names()
	   Returns a list of all the names of features currently defined in
	   "Publican::ConfigData", or in scalar context the number of features.

       auto_feature_names()
	   Returns a list of all the names of features whose availability is dynamically
	   determined, or in scalar context the number of such features.  Does not include such
	   features that have later been set to a fixed value.

       write()
	   Commits any changes from "set_config()" and "set_feature()" to disk.  Requires write
	   access to the "Publican::ConfigData" module.

AUTHOR
       "Publican::ConfigData" was automatically created using "Module::Build".	"Module::Build"
       was written by Ken Williams, but he holds no authorship claim or copyright claim to the
       contents of "Publican::ConfigData".

perl v5.16.3				    2014-06-10			  Publican::ConfigData(3)
Unix & Linux Commands & Man Pages : ©2000 - 2018 Unix and Linux Forums


All times are GMT -4. The time now is 02:39 AM.