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

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

NAME

       Class::MakeMethods::Template::ClassName - Access object's class

SYNOPSIS

	 package MyObject;
	 use Class::MakeMethods::Template::ClassName (
	   subclass_name => [ 'type' ]
	 );
	 ...
	 package main;
	 my $object = MyObject->new;

	 $object->type('Foo')
	 # reblesses object to MyObject::Foo subclass

	 print $object->type();
	 # prints "Foo".

DESCRIPTION

       These method types access or change information about the class an object is associated with.

   class_name
       Called without arguments, returns the class name.

       If called with an argument, reblesses object into that class.  If the class doesn't already exist, it will be created.

   subclass_name
       Called without arguments, returns the subclass name.

       If called with an argument, reblesses object into that subclass.  If the subclass doesn't already exist, it will be created.

       The subclass name is written as follows:

       o   if it's the original, defining class: empty

       o   if its a a package within the namespace of the original: the distingushing name within that namespace, without leading "::"

       o   if it's a package elsewhere: the full name with leading "::"

   static_hash_classname
       Provides a shared hash mapping keys to class names.

	 class_registry => [ qw/ foo / ]

       Takes a single string or a reference to an array of strings as its argument.  For each string, creates a new anonymous hash and associated
       accessor methods that will map scalar values to classes in the calling package's subclass hiearchy.

       The accessor methods provide an interface to the hash as illustrated below.  Note that several of these functions operate quite differently
       depending on the number of arguments passed, or the context in which they are called.

       @indexes = $class_or_ref->x;
	   Returns the scalar values that are indexes associated with this class, or the class of this object.

       $class = $class_or_ref->x( $index );
	   Returns the class name associated with the provided index value.

       @classes = $class_or_ref->x( @indexes );
	   Returns the associated classes for each index in order.

       @all_indexes = $class_or_ref->x_keys;
	   Returns a list of the indexes defined for this registry.

       @all_classes = $class_or_ref->x_values;
	   Returns a list of the classes associated with this registry.

       @all_classes = $class_or_ref->unique_x_values;
	   Returns a list of the classes associated with this registry, with no more than one occurance of any value.

       %mapping = $class_or_ref->x_hash;
	   Return the key-value pairs used to store this attribute

       $mapping_ref = $class_or_ref->x_hash;
	   Returns a reference to the hash used for the mapping.

       $class_or_ref->add_x( @indexes );
	   Adds an entry in the hash for each of the provided indexes, mapping it to this class, or the class of this object.

       $class_or_ref->clear_x;
	   Removes those entries from the hash whose values are this class, or the class of this object.

       $class_or_ref->clear_xs( @indexes );
	   Remove all entries from the hash.

SEE ALSO

       See Class::MakeMethods for general information about this distribution.

       See Class::MakeMethods::Template for information about this family of subclasses.

perl v5.10.1							    2004-09-06				     MakeMethods::Template::ClassName(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)
Man Page