.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Perl::Critic::UserProfile 3pm"
.TH Perl::Critic::UserProfile 3pm 2023-07-26 "perl v5.38.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Perl::Critic::UserProfile \- The contents of the user's profile, often .perlcriticrc.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This is a helper class that encapsulates the contents of the user's
profile, which is usually stored in a \fI.perlcriticrc\fR file. There are
no user-serviceable parts here.
.SH "INTERFACE SUPPORT"
.IX Header "INTERFACE SUPPORT"
This is considered to be a non-public class.  Its interface is subject
to change without notice.
.SH CONSTRUCTOR
.IX Header "CONSTRUCTOR"
.ie n .IP """ new( \-profile ="" $p ) >" 4
.el .IP "\f(CW new( \-profile =\fR \f(CW$p\fR ) >" 4
.IX Item " new( -profile = $p ) >"
\&\fB\-profile\fR is the path to the user's profile.  If \-profile is not
defined, then it looks for the profile at \fI./.perlcriticrc\fR and then
\&\fR\f(CI$HOME\fR\fI/.perlcriticrc\fR.  If neither of those files exists, then the
UserProfile is created with default values.
.Sp
This object does not take into account any command-line overrides;
Perl::Critic::Config does that.
.SH METHODS
.IX Header "METHODS"
.ie n .IP " options_processor() " 4
.el .IP "\f(CW options_processor() \fR" 4
.IX Item " options_processor() "
Returns the
Perl::Critic::OptionsProcessor
object for this UserProfile.
.ie n .IP " policy_is_disabled( $policy ) " 4
.el .IP "\f(CW policy_is_disabled( $policy ) \fR" 4
.IX Item " policy_is_disabled( $policy ) "
Given a reference to a Perl::Critic::Policy
object or the name of one, returns true if the user has disabled that
policy in their profile.
.ie n .IP " policy_is_enabled( $policy ) " 4
.el .IP "\f(CW policy_is_enabled( $policy ) \fR" 4
.IX Item " policy_is_enabled( $policy ) "
Given a reference to a Perl::Critic::Policy
object or the name of one, returns true if the user has explicitly
enabled that policy in their user profile.
.ie n .IP " policy_params( $policy ) " 4
.el .IP "\f(CW policy_params( $policy ) \fR" 4
.IX Item " policy_params( $policy ) "
Given a reference to a Perl::Critic::Policy
object or the name of one, returns a
Perl::Critic::PolicyConfig for the
user's configuration parameters for that policy.
.ie n .IP " raw_policy_params( $policy ) " 4
.el .IP "\f(CW raw_policy_params( $policy ) \fR" 4
.IX Item " raw_policy_params( $policy ) "
Given a reference to a Perl::Critic::Policy
object or the name of one, returns a reference to a hash of the user's
configuration parameters for that policy.
.ie n .IP " listed_policies() " 4
.el .IP "\f(CW listed_policies() \fR" 4
.IX Item " listed_policies() "
Returns a list of the names of all the Policies that are mentioned in
the profile.  The Policy names will be fully qualified (e.g.
Perl::Critic::Foo).
.ie n .IP " source() " 4
.el .IP "\f(CW source() \fR" 4
.IX Item " source() "
The place where the profile information came from, if available.
Usually the path to a \fI.perlcriticrc\fR.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Perl::Critic::Config,
Perl::Critic::OptionsProcessor
.SH AUTHOR
.IX Header "AUTHOR"
Jeffrey Ryan Thalhammer <jeff@imaginative\-software.com>
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (c) 2005\-2011 Imaginative Software Systems.  All rights reserved.
.PP
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.