.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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 "Class::Accessor::Class 3pm"
.TH Class::Accessor::Class 3pm "2021-09-12" "perl v5.32.1" "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"
Class::Accessor::Class \- simple class variable accessors
.SH "VERSION"
.IX Header "VERSION"
version 0.504
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
Set up a module with class accessors:
.PP
.Vb 1
\& package Text::Fortune;
\&
\& use base qw(Class::Accessor::Class Exporter);
\& Robot\->mk_class_accessors(qw(language offensive collection));
\&
\& sub fortune { 
\&   if (_\|_PACKAGE_\|_\->offensive) {
\&         ..
.Ve
.PP
Then, when using the module:
.PP
.Vb 1
\& use Text::Fortune;
\&
\& Text::Fortune\->offensive(1);
\&
\& print fortune; # prints an offensive fortune
\&
\& Text::Fortune\->language(\*(AqEO\*(Aq);
\&
\& print fortune; # prints an offensive fortune in Esperanto
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Class::Accessor::Class provides a simple way to create accessor and mutator
methods for class variables, just as Class::Accessor provides for objects.  It
can use either an enclosed lexical variable, or a package variable.
.PP
This module was once implemented in terms of Class::Accessor, but changes to
that module broke this relationship.  Class::Accessor::Class is still a
subclass of Class::Accessor, strictly for historical reasons.  As a side
benefit, a class that isa Class::Accessor::Class is also a Class::Accessor
and can use its methods.
.SH "PERL VERSION SUPPORT"
.IX Header "PERL VERSION SUPPORT"
This code is effectively abandonware.  Although releases will sometimes be made
to update contact info or to fix packaging flaws, bug reports will mostly be
ignored.  Feature requests are even more likely to be ignored.  (If someone
takes up maintenance of this code, they will presumably remove this notice.)
.SH "METHODS"
.IX Header "METHODS"
.SS "mk_class_accessors"
.IX Subsection "mk_class_accessors"
.Vb 3
\& package Foo;
\& use base qw(Class::Accessor::Class);
\& Foo\->mk_class_accessors(qw(foo bar baz));
\&
\& Foo\->foo(10);
\& my $obj = new Foo;
\& print $obj\->foo;   # 10
.Ve
.PP
This method adds accessors for the named class variables.  The accessor will
get or set a lexical variable to which the accessor is the only access.
.SS "mk_package_accessors"
.IX Subsection "mk_package_accessors"
.Vb 3
\& package Foo;
\& use base qw(Class::Accessor::Class);
\& Foo\->mk_package_accessors(qw(foo bar baz));
\&
\& Foo\->foo(10);
\& my $obj = new Foo;
\& print $obj\->foo;   # 10
\& print $Foo::foo;    # 10
.Ve
.PP
This method adds accessors for the named class variables.  The accessor will
get or set the named variable in the package's symbol table.
.SH "DETAILS"
.IX Header "DETAILS"
.SS "make_class_accessor"
.IX Subsection "make_class_accessor"
.Vb 1
\& $accessor = Class\->make_class_accessor($field);
.Ve
.PP
This method generates a subroutine reference which acts as an accessor for the
named field.
.SS "make_package_accessor"
.IX Subsection "make_package_accessor"
.Vb 1
\& $accessor = Class\->make_package_accessor($field);
.Ve
.PP
This method generates a subroutine reference which acts as an accessor for the
named field, which is stored in the scalar named \f(CW\*(C`field\*(C'\fR in \f(CW\*(C`Class\*(C'\fR's symbol
table.
.PP
This can be useful for dealing with legacy code, but using package variables is
almost never a good idea for new code.  Use this with care.
.SH "AUTHOR"
.IX Header "AUTHOR"
Ricardo \s-1SIGNES\s0 <rjbs@semiotic.systems>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2004 by Ricardo \s-1SIGNES.\s0
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.