1Perl::Critic::UserProfiUlsee(r3)Contributed Perl DocumenPteartli:o:nCritic::UserProfile(3)
2
3
4

NAME

6       Perl::Critic::UserProfile - Interface to the user's profile
7

DESCRIPTION

9       This is a helper class that encapsulates the contents of the user's
10       profile, which is usually stored in a .perlcriticrc file. There are no
11       user-serviceable parts here.
12

CONSTRUCTOR

14       " new( -profile =" $p ) >
15               -profile is the path to the user's profile.  If -profile is not
16               defined, then it looks for the profile at ./.perlcriticrc and
17               then $HOME/.perlcriticrc.  If neither of those files exists,
18               then the UserProfile is created with default values.
19

METHODS

21       " defaults() "
22               Returns the Perl::Critic::Defaults object for this UserProfile.
23
24       " policy_is_disabled( $policy ) "
25               Given a reference to a Perl::Critic::Policy object or the name
26               of one, returns true if the user has disabled that policy in
27               their profile.
28
29       " policy_is_enabled( $policy ) "
30               Given a reference to a Perl::Critic::Policy object or the name
31               of one, returns true if the user has explicitly enabled that
32               policy in their user profile.
33
34       " policy_params() "
35               Given a reference to a Perl::Critic::Policy object or the name
36               of one, returns a reference to a hash of the user's configura‐
37               tion parameters for that policy.
38
39       " listed_policies() "
40               Returns a list of the names of all the Policies that are men‐
41               tioned in the profile.  The Policy names will be fully quali‐
42               fied (e.g. Perl::Critic::Foo).
43

AUTHOR

45       Jeffrey Ryan Thalhammer <thaljef@cpan.org>
46

48       Copyright (c) 2005-2007 Jeffrey Ryan Thalhammer.  All rights reserved.
49
50       This program is free software; you can redistribute it and/or modify it
51       under the same terms as Perl itself.  The full text of this license can
52       be found in the LICENSE file included with this module.
53
54
55
56perl v5.8.8                       2007-03-20      Perl::Critic::UserProfile(3)
Impressum