Perl::Critic::OptionsProcessor.3pm

Langue: en

Autres versions - même langue

Version: 2010-09-08 (fedora - 01/12/10)

Section: 3 (Bibliothèques de fonctions)

Sommaire

NAME

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

DESCRIPTION

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

INTERFACE SUPPORT

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

CONSTRUCTOR

new( %DEFAULT_PARAMS )
Returns a reference to a new "Perl::Critic::OptionsProcessor" object. You can override the coded defaults by passing in name-value pairs that correspond to the methods listed below.

This is usually only invoked by Perl::Critic::UserProfile, which passes in the global values from a .perlcriticrc file. This object contains no information for individual Policies.

METHODS

exclude()
Returns a reference to a list of the default exclusion patterns. If onto by Perl::Critic::PolicyParameter. there are no default exclusion patterns, then the list will be empty.
force()
Returns the default value of the "force" flag (Either 1 or 0).
include()
Returns a reference to a list of the default inclusion patterns. If there are no default exclusion patterns, then the list will be empty.
only()
Returns the default value of the "only" flag (Either 1 or 0).
profile_strictness()
Returns the default value of "profile_strictness" as an unvalidated string.
single_policy()
Returns the default "single-policy" pattern. (As a string.)
severity()
Returns the default "severity" setting. (1..5).
theme()
Returns the default "theme" setting. (As a string).
top()
Returns the default "top" setting. (Either 0 or a positive integer).
verbose()
Returns the default "verbose" setting. (Either a number or format string).
color()
Returns the default "color" setting. (Either 1 or 0).
pager()
Returns the default "pager" setting. (Either empty string or the pager command string).
criticism_fatal()
Returns the default "criticism-fatal" setting (Either 1 or 0).
color_severity_highest()
Returns the color to be used for coloring highest severity violations.
color_severity_high()
Returns the color to be used for coloring high severity violations.
color_severity_medium()
Returns the color to be used for coloring medium severity violations.
color_severity_low()
Returns the color to be used for coloring low severity violations.
color_severity_lowest()
Returns the color to be used for coloring lowest severity violations.

SEE ALSO

Perl::Critic::Config, Perl::Critic::UserProfile

AUTHOR

Jeffrey Ryan Thalhammer <thaljef@cpan.org> Copyright (c) 2005-2009 Jeffrey Ryan Thalhammer. All rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The full text of this license can be found in the LICENSE file included with this module.