.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
.\"
.\" 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 turned on, 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 "MakeMethods::Template::ClassVar 3pm"
.TH MakeMethods::Template::ClassVar 3pm "2016-06-10" "perl v5.22.2" "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::MakeMethods::Template::ClassVar \- Static methods with subclass variation
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 4
\&  package MyObject;
\&  use Class::MakeMethods::Template::ClassVar (
\&    scalar          => [ \*(Aqfoo\*(Aq ]
\&  );
\&  
\&  package main;
\&
\&  MyObject\->foo(\*(Aqbar\*(Aq)
\&  print MyObject\->foo();
\&
\&  $MyObject::foo = \*(Aqbazillion\*(Aq;
\&  print MyObject\->foo();
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
These meta-methods provide access to package (class global) variables,
with the package determined at run-time.
.PP
This is basically the same as the PackageVar meta-methods, except
that PackageVar methods find the named variable in the package that
defines the method, while ClassVar methods use the package the object
is blessed into. As a result, subclasses will each store a distinct
value for a ClassVar method, but will share the same value for a
PackageVar or Static method.
.PP
\&\fBCommon Parameters\fR: The following parameters are defined for ClassVar meta-methods.
.IP "variable" 4
.IX Item "variable"
The name of the variable to store the value in. Defaults to the same name as the method.
.SS "Standard Methods"
.IX Subsection "Standard Methods"
The following methods from Generic should all be supported:
.PP
.Vb 10
\&  scalar
\&  string
\&  string_index (?)
\&  number 
\&  boolean
\&  bits (?)
\&  array (*)
\&  hash (*)
\&  tiedhash (?)
\&  hash_of_arrays (?)
\&  object (?)
\&  instance (?)
\&  array_of_objects (?)
\&  code (?)
\&  code_or_scalar (?)
.Ve
.PP
See Class::MakeMethods::Template::Generic for the interfaces and behaviors of these method types.
.PP
The items marked with a * above are specifically defined in this package, whereas the others are formed automatically by the interaction of this package's generic settings with the code templates provided by the Generic superclass.
.PP
The items marked with a ? above have not been tested sufficiently; please inform the author if they do not function as you would expect.
.SS "vars"
.IX Subsection "vars"
This rewrite rule converts package variable names into ClassVar methods of the equivalent data type.
.PP
Here's an example declaration:
.PP
.Vb 1
\&  package MyClass;
\&  
\&  use Class::MakeMethods::Template::ClassVar (
\&    vars => \*(Aq$VERSION @ISA\*(Aq
\&  );
.Ve
.PP
MyClass now has methods that get and set the contents of its \f(CW$MyClass::VERSION\fR and \f(CW@MyClass::ISA\fR package variables:
.PP
.Vb 2
\&  MyClass\->VERSION( 2.4 );
\&  MyClass\->push_ISA( \*(AqExporter\*(Aq );
.Ve
.PP
Subclasses can use these methods to adjust their own variables:
.PP
.Vb 3
\&  package MySubclass;
\&  MySubclass\->MyClass::push_ISA( \*(AqMyClass\*(Aq );
\&  MySubclass\->VERSION( 1.0 );
.Ve