Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

class::makemethods::template::packagevar(3pm) [debian man page]

MakeMethods::Template::PackageVar(3pm)			User Contributed Perl Documentation		    MakeMethods::Template::PackageVar(3pm)

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' );

perl v5.10.1							    2004-09-06				    MakeMethods::Template::PackageVar(3pm)

Check Out this Related Man Page

MakeMethods::Template::Global(3pm)			User Contributed Perl Documentation			MakeMethods::Template::Global(3pm)

NAME

       Class::MakeMethods::Template::Global - Method that are not instance-dependent

SYNOPSIS

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

	 package main;

	 MyObject->foo('bar')
	 print MyObject->foo();
	 ...
	 print $my_instance->foo(); # same thing

DESCRIPTION

       These meta-methods access values that are shared across all instances of your object in your process. For example, a hash_scalar meta-
       method will be able to store a different value for each hash instance you call it on, but a static_scalar meta-method will return the same
       value for any instance it's called on, and setting it from any instance will change the value that all other instances see.

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

       data
	   The shared value.

   Standard Methods
       The following methods from Generic should be supported:

	 scalar
	 string
	 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 have not been tested sufficiently; please inform the author if they do not function as you would expect.

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::Global(3pm)
Man Page