Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

class::makemethods::utility::inheritable(3pm) [debian man page]

MakeMethods::Utility::Inheritable(3pm)			User Contributed Perl Documentation		    MakeMethods::Utility::Inheritable(3pm)

NAME

       Class::MakeMethods::Utility::Inheritable - "Inheritable" data

SYNOPSIS

	 package MyClass;
	 sub new { ... }

	 package MySubclass;
	 @ISA = 'MyClass';
	 ...
	 my $obj = MyClass->new(...);
	 my $subobj = MySubclass->new(...);

	 use Class::MakeMethods::Utility::Inheritable qw(get_vvalue set_vvalue );

	 my $dataset = {};
	 set_vvalue($dataset, 'MyClass', 'Foobar');    # Set value for class
	 get_vvalue($dataset, 'MyClass');	       # Gets value "Foobar"

	 get_vvalue($dataset, $obj);		       # Objects "inherit"
	 set_vvalue($dataset, $obj, 'Foible');	       # Until you override
	 get_vvalue($dataset, $obj);		       # Now finds "Foible"

	 get_vvalue($dataset, 'MySubclass');	       # Subclass "inherits"
	 get_vvalue($dataset, $subobj); 	       # As do its objects
	 set_vvalue($dataset, 'MySubclass', 'Foozle'); # Until we override it
	 get_vvalue($dataset, 'MySubclass');	       # Now finds "Foozle"

	 get_vvalue($dataset, $subobj); 	       # Change cascades down
	 set_vvalue($dataset, $subobj, 'Foolish');     # Until we override again

	 get_vvalue($dataset, 'MyClass');	       # Superclass is unchanged

DESCRIPTION

       This module provides several functions which allow you to store values in a hash corresponding to both objects and classes, and to retrieve
       those values by searching a object's inheritance tree until it finds a matching entry.

       This functionality is used by Class::MakeMethods::Standard::Inheritable and Class::MakeMethods::Composite::Inheritable to construct methods
       that can both store class data and be overriden on a per-object level.

REFERENCE

   find_vself
	 $vself = find_vself( $dataset, $instance );

       Searches $instance's inheritance tree until it finds a matching entry in the dataset, and returns either the instance, the class that
       matched, or undef.

   get_vvalue
	 $value = get_vvalue( $dataset, $instance );

       Searches $instance's inheritance tree until it finds a matching entry in the dataset, and returns that value

   set_vvalue
	 $value = set_vvalue( $dataset, $instance, $value );

       Searches $instance's inheritance tree until it finds a matching entry in the dataset, and returns that value

perl v5.10.1							    2004-09-06				    MakeMethods::Utility::Inheritable(3pm)

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