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::insideout(3pm) [debian man page]

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

NAME

       Class::MakeMethods::Template::InsideOut - External data

SYNOPSIS

	 package MyObject;
	 use Class::MakeMethods::Template::InsideOut (
	   scalar	   => [ 'foo', 'bar' ]
	 );
	 sub new { ... }

	 package main;

	 my $obj = MyObject->new( foo => "Foozle", bar => "Bozzle" );
	 print $obj->foo();	       # Prints Foozle
	 $obj->bar("Bamboozle");       # Sets $obj's bar value

DESCRIPTION

       Supports the Generic object constructor and accessors meta-method types, but accepts any object as the underlying implementation type, with
       member data stored in external indices.

       Each method stores the values associated with various objects in an hash keyed by the object's stringified identity. Since that hash is
       accessible only from the generated closures, it is impossible for foreign code to manipulate those values except through the method
       interface.

       A DESTROY method is installed to remove data for expired objects from the various hashes. (If the DESTROY method is not called, your
       program will not release this data and memory will be wasted.)

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

       data
	   An auto-vivified reference to a hash to be used to store the values for each object.

       Note that using InsideOut meta-methods causes the installation of a DESTROY method in the calling class, which deallocates data for each
       instance when it is discarded.

       NOTE: This needs some more work to properly handle inheritance.

   Standard Methods
       The following methods from Generic are all 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.

   boolean_index
	 boolean_index => [ qw / foo bar baz / ]

       Like InsideOut:boolean, boolean_index creates x, set_x, and clear_x methods. However, it also defines a class method find_x which returns a
       list of the objects which presently have the x-flag set to true.

       Note that to free items from memory, you must clear these bits!

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

Check Out this Related 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)
Man Page