The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Class-MakeMethods-1.0.14
River stage one • 1 direct dependent • 1 total dependent
++
/ Class::MakeMethods::Standard

NAME

Class::MakeMethods::Standard - Guide to subclasses

SYNOPSIS

  package MyObject;
  use Class::MakeMethods::Standard::Hash (
    new => 'new',
    scalar => [ 'foo', 'bar' ],
    array => 'my_list',
    hash => 'my_index',
  );

DESCRIPTION

This document describes the various subclasses of Class::MakeMethods included under the Standard::* namespace, and the method types each one provides.

The Standard subclasses provide a parameterized set of method-generation implementations.

Subroutines are generated as closures bound to a hash containing the method name and (optionally) additional parameters.

Calling Conventions

When you use a subclass of this package, the method declarations you provide as arguments cause subroutines to be generated and installed in your module. You can also omit the arguments to use and instead make methods at runtime by passing the declarations to a subsequent call to make().

You may include any number of declarations in each call to use or make(). If methods with the same name already exist, earlier calls to use or make() win over later ones, but within each call, later declarations superceed earlier ones.

You can install methods in a different package by passing -target_class => package as your first arguments to use or make.

See "USAGE" in Class::MakeMethods for more details.

Declaration Syntax

The following types of Simple declarations are supported:

  • generator_type => 'method_name'

  • generator_type => 'name_1 name_2...'

  • generator_type => [ 'name_1', 'name_2', ...]

For a list of the supported values of generator_type, see "SUBCLASS CATALOG" below, or the documentation for each subclass.

For each method name you provide, a subroutine of the indicated type will be generated and installed under that name in your module.

Method names should start with a letter, followed by zero or more letters, numbers, or underscores.

Parameter Syntax

The Standard syntax also provides several ways to optionally associate a hash of additional parameters with a given method name.

  • generator_type => [ 'name_1' => { param=>value... }, ... ]

    A hash of parameters to use just for this method name.

    (Note: to prevent confusion with self-contained definition hashes, described below, parameter hashes following a method name must not contain the key 'name'.)

  • generator_type => [ [ 'name_1', 'name_2', ... ] => { param=>value... } ]

    Each of these method names gets a copy of the same set of parameters.

  • generator_type => [ { 'name'=>'name_1', param=>value... }, ... ]

    By including the reserved parameter 'name', you create a self-contained declaration with that name and any associated hash values.

Simple declarations, as described above, are given an empty parameter hash.

SUBCLASS CATALOG

Standard::Hash (Instances)

Methods for objects based on blessed hashes.

  • new: create and copy instances

  • scalar: get and set scalar values in each instance

  • array: get and set values stored in an array refered to in each instance

  • hash: get and set values in a hash refered to in each instance

  • object: access an object refered to by each instance

Standard::Array (Instances)

Methods for manipulating positional values in arrays.

  • new: create and copy instances

  • scalar: get and set scalar values in each instance

  • array: get and set values stored in an array refered to in each instance

  • hash: get and set values in a hash refered to in each instance

  • object: access an object refered to by each instance

Standard::Global (Global)

Methods for manipulating global data.

  • scalar: get and set global scalar

  • array: get and set values stored in a global array

  • hash: get and set values in a global hash

  • object: global access to an object ref

Standard::Inheritable (Any)

Methods for manipulating data which may be overridden per class or instance. Uses external data storage, so it works with objects of any underlying data type.

  • scalar: get and set scalar values for each instance or class

Supporting functions for array methods

There are also constants symbols for some for some common combinations of splicing arguments:

  # Reset the array contents to empty
  $obj->bar( array_clear );
  
  # Set the array contents to provided values
  $obj->bar( array_set, [ 'Foozle', 'Bazzle' ] );
  
  # Unshift an item onto the front of the list
  $obj->bar( array_unshift, 'Bubbles' );
  
  # Shift it back off again
  print $obj->bar( array_shift );
  
  # Push an item onto the end of the list
  $obj->bar( array_push, 'Bubbles' );
  
  # Pop it back off again
  print $obj->bar( array_pop );

SEE ALSO

See Class::MakeMethods for an overview of the method-generation framework this is based on.

See Class::MakeMethods::Guide for a getting-started guide, annotated examples of usage, and a listing of the method generation classes included in this distribution.

See Class::MakeMethods::ReadMe for distribution, installation, version and support information.