Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

perl::critic::policyconfig(3pm) [debian man page]

Perl::Critic::PolicyConfig(3pm) 			User Contributed Perl Documentation			   Perl::Critic::PolicyConfig(3pm)

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-2011 Elliot Shank.

       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.

perl v5.14.2							    2012-06-07					   Perl::Critic::PolicyConfig(3pm)

Check Out this Related Man Page

Perl::Critic::Exception::AggregateConfiguration(3pm)	User Contributed Perl Documentation   Perl::Critic::Exception::AggregateConfiguration(3pm)

NAME

       Perl::Critic::Exception::AggregateConfiguration - A collection of a set of problems found in the configuration and/or command-line options.

DESCRIPTION

       A set of configuration settings can have multiple problems.  This is an object for collecting all the problems found so that the user can
       see them in one run.

INTERFACE SUPPORT

       This is considered to be a public class.  Any changes to its interface will go through a deprecation cycle.

METHODS

       "add_exception( $exception )"
	   Accumulate the parameter with rest of the exceptions.

       "add_exceptions_from( $aggregate )"
	   Accumulate the exceptions from another instance of this class.

       "exceptions()"
	   Returns a reference to an array of the collected exceptions.

       "add_exception_or_rethrow( $eval_error )"
	   If the parameter is an instance of Perl::Critic::Exception::Configuration or Perl::Critic::Exception::AggregateConfiguration, add it.
	   Otherwise, "die" with the parameter, if it is a reference, or "confess" with it.  If the parameter is false, simply returns.

       "has_exceptions()"
	   Answer whether any configuration problems have been found.

       "full_message()"
	   Concatenate the exception messages.	See "full_message" in Exception::Class.

AUTHOR

       Elliot Shank <perl@galumph.com>

COPYRIGHT

       Copyright (c) 2007-2011 Elliot Shank.

       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.

perl v5.14.2							    2012-06-07		      Perl::Critic::Exception::AggregateConfiguration(3pm)
Man Page