1Perl::Critic::OptionsPrUosceerssCoorn(t3r)ibuted Perl DoPceurmle:n:tCartiitoinc::OptionsProcessor(3)
2
3
4

NAME

6       Perl::Critic::OptionsProcessor - The global configuration default
7       values, combined with command-line values.
8

DESCRIPTION

10       This is a helper class that encapsulates the default parameters for
11       constructing a Perl::Critic::Config object.  There are no user-
12       serviceable parts here.
13

INTERFACE SUPPORT

15       This is considered to be a non-public class.  Its interface is subject
16       to change without notice.
17

CONSTRUCTOR

19       " new( %DEFAULT_PARAMS ) "
20           Returns a reference to a new "Perl::Critic::OptionsProcessor"
21           object.  You can override the coded defaults by passing in name-
22           value pairs that correspond to the methods listed below.
23
24           This is usually only invoked by Perl::Critic::UserProfile, which
25           passes in the global values from a .perlcriticrc file.  This object
26           contains no information for individual Policies.
27

METHODS

29       " exclude() "
30           Returns a reference to a list of the default exclusion patterns.
31           If onto by Perl::Critic::PolicyParameter.  there are no default
32           exclusion patterns, then the list will be empty.
33
34       " force() "
35           Returns the default value of the "force" flag (Either 1 or 0).
36
37       " include() "
38           Returns a reference to a list of the default inclusion patterns.
39           If there are no default exclusion patterns, then the list will be
40           empty.
41
42       " only() "
43           Returns the default value of the "only" flag (Either 1 or 0).
44
45       " profile_strictness() "
46           Returns the default value of "profile_strictness" as an unvalidated
47           string.
48
49       " single_policy() "
50           Returns the default "single-policy" pattern.  (As a string.)
51
52       " severity() "
53           Returns the default "severity" setting. (1..5).
54
55       " theme() "
56           Returns the default "theme" setting. (As a string).
57
58       " top() "
59           Returns the default "top" setting. (Either 0 or a positive
60           integer).
61
62       " verbose() "
63           Returns the default "verbose" setting. (Either a number or format
64           string).
65
66       " color() "
67           Returns the default "color" setting. (Either 1 or 0).
68
69       " pager() "
70           Returns the default "pager" setting. (Either empty string or the
71           pager command string).
72
73       " criticism_fatal() "
74           Returns the default "criticism-fatal" setting (Either 1 or 0).
75
76       " color_severity_highest() "
77           Returns the color to be used for coloring highest severity
78           violations.
79
80       " color_severity_high() "
81           Returns the color to be used for coloring high severity violations.
82
83       " color_severity_medium() "
84           Returns the color to be used for coloring medium severity
85           violations.
86
87       " color_severity_low() "
88           Returns the color to be used for coloring low severity violations.
89
90       " color_severity_lowest() "
91           Returns the color to be used for coloring lowest severity
92           violations.
93

SEE ALSO

95       Perl::Critic::Config, Perl::Critic::UserProfile
96

AUTHOR

98       Jeffrey Ryan Thalhammer <thaljef@cpan.org>
99

101       Copyright (c) 2005-2009 Jeffrey Ryan Thalhammer.  All rights reserved.
102
103       This program is free software; you can redistribute it and/or modify it
104       under the same terms as Perl itself.  The full text of this license can
105       be found in the LICENSE file included with this module.
106
107
108
109perl v5.10.1                      2010-11-12 Perl::Critic::OptionsProcessor(3)
Impressum