class::makemethods::template::classvar(3pm) [debian man page]
MakeMethods::Template::ClassVar(3pm) User Contributed Perl Documentation MakeMethods::Template::ClassVar(3pm)NAME
Class::MakeMethods::Template::ClassVar - Static methods with subclass variation
SYNOPSIS
package MyObject;
use Class::MakeMethods::Template::ClassVar (
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, with the package determined at run-time.
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.
Common Parameters: The following parameters are defined for ClassVar 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.
vars
This rewrite rule converts package variable names into ClassVar methods of the equivalent data type.
Here's an example declaration:
package MyClass;
use Class::MakeMethods::Template::ClassVar (
vars => '$VERSION @ISA'
);
MyClass now has methods that get and set the contents of its $MyClass::VERSION and @MyClass::ISA package variables:
MyClass->VERSION( 2.4 );
MyClass->push_ISA( 'Exporter' );
Subclasses can use these methods to adjust their own variables:
package MySubclass;
MySubclass->MyClass::push_ISA( 'MyClass' );
MySubclass->VERSION( 1.0 );
perl v5.10.1 2004-09-06 MakeMethods::Template::ClassVar(3pm)
Check Out this Related Man Page
MakeMethods::Template::Hash(3pm) User Contributed Perl Documentation MakeMethods::Template::Hash(3pm)NAME
Class::MakeMethods::Template::Hash - Method interfaces for hash-based objects
SYNOPSIS
package MyObject;
use Class::MakeMethods::Template::Hash (
new => [ 'new' ],
scalar => [ 'foo', 'bar' ]
);
package main;
my $obj = MyObject->new( foo => "Foozle", bar => "Bozzle" );
print $obj->foo();
$obj->bar("Bamboozle");
DESCRIPTION
These meta-methods create and access values within blessed hash objects.
Common Parameters: The following parameters are defined for Hash meta-methods.
hash_key
The hash key to use when retrieving values from each hash instance. Defaults to '*', the name of the meta-method.
Changing this allows you to change an accessor method name to something other than the name of the hash key used to retrieve its value.
Note that this parameter is not portable to the other implementations, such as Global or InsideOut.
You can take advantage of parameter expansion to define methods whose hash key is composed of the defining package's name and the
individual method name, such as "$self->{MyObject-foo}":
'hash_key' => '*{target_class}-*{name}'
Common Behaviors
Behavior: delete
Deletes the named key and associated value from the current hash instance.
Standard Methods
The following methods from Generic are all supported:
new
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.
struct
struct => [ qw / foo bar baz / ];
Creates methods for setting, checking and clearing values which are stored by position in an array. All the slots created with this meta-
method are stored in a single array.
The argument to struct should be a string or a reference to an array of strings. For each string meta-method x, it defines two methods: x
and clear_x. x returns the value of the x-slot. If called with an argument, it first sets the x-slot to the argument. clear_x sets the
slot to undef.
Additionally, struct defines three class method: struct, which returns a list of all of the struct values, struct_fields, which returns a
list of all the slots by name, and struct_dump, which returns a hash of the slot-name/slot-value pairs.
SEE ALSO
See Class::MakeMethods for general information about this distribution.
See Class::MakeMethods::Template for more about this family of subclasses.
See Class::MakeMethods::Template::Generic for information about the various accessor interfaces subclassed herein.
perl v5.10.1 2004-09-06 MakeMethods::Template::Hash(3pm)