NAME¶

Perl::Critic::PolicyConfig - Configuration data for a Policy.

DESCRIPTION¶

A container for the configuration of a Policy.

INTERFACE SUPPORT¶

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

METHODS¶

"get_policy_short_name()"

The name of the policy this configuration is for. Primarily here for the sake of debugging.

" get_set_themes() "

The value of "set_themes" in the user's .perlcriticrc.

" get_add_themes() "

The value of "add_themes" in the user's .perlcriticrc.

" get_severity() "

The value of "severity" in the user's .perlcriticrc.

" is_maximum_violations_per_document_unlimited() "

Answer whether the value of "maximum_violations_per_document" should be considered to be unlimited.

" get_maximum_violations_per_document() "

The value of "maximum_violations_per_document" in the user's .perlcriticrc.

" get($parameter) "

Retrieve the value of the specified parameter in the user's .perlcriticrc.

" remove($parameter) "

Delete the value of the specified parameter.

" is_empty() "

Answer whether there is any non-standard configuration information left.

" get_parameter_names() "

Retrieve the names of the parameters in this object.

" set_profile_strictness($profile_strictness) "

Sets the profile strictness associated with the configuration.

" handle_extra_parameters($policy,$errors) "

Deals with any extra parameters according to the profile_strictness setting. To be called by Perl::Critic::Policy->new() once all valid policies have been processed and removed from the configuration.

If profile_strictness is $PROFILE_STRICTNESS_QUIET, extra policy parameters are ignored.

If profile_strictness is $PROFILE_STRICTNESS_WARN, extra policy parameters generate a warning.

If profile_strictness is $PROFILE_STRICTNESS_FATAL, extra policy parameters generate a fatal error.

If no profile_strictness was set, the behavior is that specified by $PROFILE_STRICTNESS_DEFAULT.

SEE ALSO¶

"MAKING YOUR POLICY CONFIGURABLE" in Perl::Critic::DEVELOPER

AUTHOR¶

Elliot Shank <perl@galumph.com>

COPYRIGHT¶

Copyright (c) 2008-2009 Elliot Shank. 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.