1App::GitHooks::Config(3U)ser Contributed Perl DocumentatiAopnp::GitHooks::Config(3)
2
3
4

NAME

6       App::GitHooks::Config - Configuration manager for App::GitHooks.
7

VERSION

9       Version 1.9.0
10

SYNOPSIS

12               my $config = App::GitHooks::Config->new();
13
14               my $config = App::GitHooks::Config->new(
15                       file => '...',
16               );
17
18               my $value = $config->get( $section, $name );
19

METHODS

21   new()
22       Return a new "App::GitHooks::Config" object.
23
24               my $config = App::GitHooks::Config->new(
25                       file => $file,
26               );
27
28       Arguments:
29
30       ·   file (optional)
31
32           A path to a config file to load into the object.
33
34       ·   source (optional)
35
36           How the path of the config file to use was determined.
37
38   get()
39       Retrieve the value for a given section and key name.
40
41               my $value = $config->get( $section, $name );
42
43       Note that the "App::GitHooks" configuration files are organized by
44       sections, with the main (default) section being '_'.
45
46   get_regex()
47       Retrieve the specified regex for a given section and key name.
48
49               my $regex = $config->get_regex( $section, $name );
50
51       Note that this is very much like "get()", except that it will treat the
52       value as a regex and strip out outer '/' symbols so that the result is
53       suitable for inclusion in a regex. For example:
54
55               my $regex = $config->get_regex( $section, $name );
56               if ( $variable =~ /$regex/ )
57               {
58                       ...
59               }
60

BUGS

62       Please report any bugs or feature requests through the web interface at
63       <https://github.com/guillaumeaubert/App-GitHooks/issues/new>.  I will
64       be notified, and then you'll automatically be notified of progress on
65       your bug as I make changes.
66

SUPPORT

68       You can find documentation for this module with the perldoc command.
69
70               perldoc App::GitHooks::Config
71
72       You can also look for information at:
73
74       ·   GitHub's request tracker
75
76           <https://github.com/guillaumeaubert/App-GitHooks/issues>
77
78       ·   AnnoCPAN: Annotated CPAN documentation
79
80           <http://annocpan.org/dist/app-githooks>
81
82       ·   CPAN Ratings
83
84           <http://cpanratings.perl.org/d/app-githooks>
85
86       ·   MetaCPAN
87
88           <https://metacpan.org/release/App-GitHooks>
89

AUTHOR

91       Guillaume Aubert <https://metacpan.org/author/AUBERTG>, "<aubertg at
92       cpan.org>".
93

95       Copyright 2013-2017 Guillaume Aubert.
96
97       This code is free software; you can redistribute it and/or modify it
98       under the same terms as Perl 5 itself.
99
100       This program is distributed in the hope that it will be useful, but
101       WITHOUT ANY WARRANTY; without even the implied warranty of
102       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the LICENSE
103       file for more details.
104
105
106
107perl v5.32.0                      2020-07-28          App::GitHooks::Config(3)
Impressum