1Publican::ConfigData(3)User Contributed Perl DocumentatioPnublican::ConfigData(3)
2
3
4

NAME

6       Publican::ConfigData - Configuration for Publican
7

SYNOPSIS

9         use Publican::ConfigData;
10         $value = Publican::ConfigData->config('foo');
11         $value = Publican::ConfigData->feature('bar');
12
13         @names = Publican::ConfigData->config_names;
14         @names = Publican::ConfigData->feature_names;
15
16         Publican::ConfigData->set_config(foo => $new_value);
17         Publican::ConfigData->set_feature(bar => $new_value);
18         Publican::ConfigData->write;  # Save changes
19

DESCRIPTION

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

METHODS

28       config($name)
29           Given a string argument, returns the value of the configuration
30           item by that name, or "undef" if no such item exists.
31
32       feature($name)
33           Given a string argument, returns the value of the feature by that
34           name, or "undef" if no such feature exists.
35
36       set_config($name, $value)
37           Sets the configuration item with the given name to the given value.
38           The value may be any Perl scalar that will serialize correctly
39           using "Data::Dumper".  This includes references, objects (usually),
40           and complex data structures.  It probably does not include
41           transient things like filehandles or sockets.
42
43       set_feature($name, $value)
44           Sets the feature with the given name to the given boolean value.
45           The value will be converted to 0 or 1 automatically.
46
47       config_names()
48           Returns a list of all the names of config items currently defined
49           in "Publican::ConfigData", or in scalar context the number of
50           items.
51
52       feature_names()
53           Returns a list of all the names of features currently defined in
54           "Publican::ConfigData", or in scalar context the number of
55           features.
56
57       auto_feature_names()
58           Returns a list of all the names of features whose availability is
59           dynamically determined, or in scalar context the number of such
60           features.  Does not include such features that have later been set
61           to a fixed value.
62
63       write()
64           Commits any changes from "set_config()" and "set_feature()" to
65           disk.  Requires write access to the "Publican::ConfigData" module.
66

AUTHOR

68       "Publican::ConfigData" was automatically created using "Module::Build".
69       "Module::Build" was written by Ken Williams, but he holds no authorship
70       claim or copyright claim to the contents of "Publican::ConfigData".
71
72
73
74perl v5.28.0                      2018-07-15           Publican::ConfigData(3)
Impressum