oracular (3) Class::MakeMethods::Template::PackageVar.3pm.gz

NAME

       Class::MakeMethods::Template::PackageVar - Static methods with global variables

SYNOPSIS

         package MyObject;
         use Class::MakeMethods::Template::PackageVar (
           scalar          => [ 'foo' ]
         );

         package main;

         MyObject->foo('bar')
         print MyObject->foo();

         $MyObject::foo = 'bazillion';
         print MyObject->foo();

DESCRIPTION

       These meta-methods provide access to package (class global) variables.  These are essentially the same as
       the Static meta-methods, except that they use a global variable in the declaring package to store their
       values.

       Common Parameters: The following parameters are defined for PackageVar meta-methods.

       variable
           The name of the variable to store the value in. Defaults to the same name as the method.

   Standard Methods
       The following methods from Generic should all be supported:

         scalar
         string
         string_index (?)
         number
         boolean
         bits (?)
         array (*)
         hash (*)
         tiedhash (?)
         hash_of_arrays (?)
         object (?)
         instance (?)
         array_of_objects (?)
         code (?)
         code_or_scalar (?)

       See Class::MakeMethods::Template::Generic for the interfaces and behaviors of these method types.

       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.

       The items marked with a ? above have not been tested sufficiently; please inform the author if they do
       not function as you would expect.

   PackageVar:vars
       This rewrite rule converts package variable names into PackageVar methods of the equivalent data type.

       Here's an example declaration:

         package MyClass;

         use Class::MakeMethods::Template::PackageVar (
           vars => '$DEBUG %Index'
         );

       MyClass now has methods that get and set the contents of its $MyClass::DEBUG and %MyClass::Index package
       variables:

         MyClass->DEBUG( 1 );
         MyClass->Index( 'foo' => 'bar' );