Matthew Simon Cavalletto > Class-MakeMethods-1.009 > Class::MakeMethods::Composite::Array

Download:
Class-MakeMethods-1.009.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  2
View/Report Bugs
Module Version: 1   Source   Latest Release: Class-MakeMethods-1.01

NAME ^

Class::MakeMethods::Composite::Array - Basic array methods

SYNOPSIS ^

  package MyObject;
  use Class::MakeMethods::Composite::Array (
    new => 'new',
    scalar => [ 'foo', 'bar' ],
    array => 'my_list',
    hash => 'my_index',
  );
  ...
  
  my $obj = MyObject->new( foo => 'Foozle' );
  print $obj->foo();
  
  $obj->bar('Barbados');
  print $obj->bar();
  
  $obj->my_list(0 => 'Foozle', 1 => 'Bang!');
  print $obj->my_list(1);
  
  $obj->my_index('broccoli' => 'Blah!', 'foo' => 'Fiddle');
  print $obj->my_index('foo');

DESCRIPTION ^

The Composite::Array suclass of MakeMethods provides a basic constructor and accessors for blessed-array object instances.

Class::MakeMethods Calling Conventions

When you use 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 -TargetClass => package as your first arguments to use or make.

See Class::MakeMethods for more details.

Class::MakeMethods::Basic Declaration Syntax

The following types of Basic declarations are supported:

See the "METHOD GENERATOR TYPES" section below for a list of the supported values of generator_type.

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.

Class::MakeMethods::Composite Declaration Syntax

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

Basic declarations, as described above, are treated as having an empty parameter hash.

Positional Accessors and %FIELDS

Each accessor method is assigned the next available array index at which to store its value.

The mapping between method names and array positions is stored in a hash named %FIELDS in the declaring package. When a package declares its first positional accessor, its %FIELDS are initialized by searching its inheritance tree.

Warning: Subclassing packages that use positional accessors is somewhat fragile, since you may end up with two distinct methods assigned to the same position. Specific cases to avoid are:

METHOD GENERATOR TYPES ^

new - Constructor

For each method name passed, returns a subroutine with the following characteristics:

Sample declaration and usage:

  package MyObject;
  use Class::MakeMethods::Composite::Array (
    new => 'new',
  );
  ...
  
  # Bare constructor
  my $empty = MyObject->new();
  
  # Constructor with initial sequence of method calls
  my $obj = MyObject->new( foo => 'Foozle', bar => 'Barbados' );
  
  # Copy with overriding sequence of method calls
  my $copy = $obj->new( bar => 'Bob' );

new_with_values - Constructor

For each method name passed, returns a subroutine with the following characteristics:

Sample declaration and usage:

  package MyObject;
  use Class::MakeMethods::Composite::Array (
    new => 'new',
  );
  ...
  
  # Bare constructor
  my $empty = MyObject->new();
  
  # Constructor with initial sequence of method calls
  my $obj = MyObject->new( foo => 'Foozle', bar => 'Barbados' );
  
  # Copy with overriding sequence of method calls
  my $copy = $obj->new( bar => 'Bob' );

scalar - Instance Accessor

For each method name passed, uses a closure to generate a subroutine with the following characteristics:

Sample declaration and usage:

  package MyObject;
  use Class::MakeMethods::Composite::Array (
    scalar => 'foo',
  );
  ...
  
  # Store value
  $obj->foo('Foozle');
  
  # Retrieve value
  print $obj->foo;

array - Instance Ref Accessor

For each method name passed, uses a closure to generate a subroutine with the following characteristics:

Sample declaration and usage:

  package MyObject;
  use Class::MakeMethods::Composite::Array (
    array => 'bar',
  );
  ...
  
  # Clear and set contents of list
  print $obj->bar([ 'Spume', 'Frost' ] );  
  
  # Set values by position
  $obj->bar(0 => 'Foozle', 1 => 'Bang!');
  
  # Positions may be overwritten, and in any order
  $obj->bar(2 => 'And Mash', 1 => 'Blah!');
  
  # Retrieve value by position
  print $obj->bar(1);
  
  # Direct access to referenced array
  print scalar @{ $obj->bar() };

There are also calling conventions for slice and splice operations:

  # Retrieve slice of values by position
  print join(', ', $obj->bar( undef, [0, 2] ) );
  
  # Insert an item at position in the array
  $obj->bar([3], 'Potatoes' );  
  
  # Remove 1 item from position 3 in the array
  $obj->bar([3, 1], undef );  
  
  # Set a new value at position 2, and return the old value 
  print $obj->bar([2, 1], 'Froth' );

hash - Instance Ref Accessor

For each method name passed, uses a closure to generate a subroutine with the following characteristics:

Sample declaration and usage:

  package MyObject;
  use Class::MakeMethods::Composite::Array (
    hash => 'baz',
  );
  ...
  
  # Set values by key
  $obj->baz('foo' => 'Foozle', 'bar' => 'Bang!');
  
  # Values may be overwritten, and in any order
  $obj->baz('broccoli' => 'Blah!', 'foo' => 'Fiddle');
  
  # Retrieve value by key
  print $obj->baz('foo');
  
  # Retrive slice of values by position
  print join(', ', $obj->baz( ['foo', 'bar'] ) );
  
  # Direct access to referenced hash
  print keys %{ $obj->baz() };
  
  # Reset the hash contents to empty
  @{ $obj->baz() } = ();

object - Instance Ref Accessor

For each method name passed, uses a closure to generate a subroutine with the following characteristics:

Sample declaration and usage:

  package MyObject;
  use Class::MakeMethods::Composite::Hash (
    object => 'foo',
  );
  ...
  
  # Store value
  $obj->foo( Foozle->new() );
  
  # Retrieve value
  print $obj->foo;

SEE ALSO ^

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

See Class::MakeMethods::Composite for more about this family of subclasses.

syntax highlighting: