


MakeMethods::CoUseriContributedMakeMethods::Composite::Global(3p)


NAME
       Class::MakeMethods::Composite::Global - Global data

SYNOPSIS
         package MyClass;
         use Class::MakeMethods::Composite::Global (
           scalar => [ 'foo' ],
           array  => [ 'my_list' ],
           hash   => [ 'my_index' ],
         );
         ...

         MyClass->foo( 'Foozle' );
         print MyClass->foo();

         print MyClass->new(...)->foo(); # same value for any instance
         print MySubclass->foo();        # ... and for any subclass

         MyClass->my_list(0 => 'Foozle', 1 => 'Bang!');
         print MyClass->my_list(1);

         MyClass->my_index('broccoli' => 'Blah!', 'foo' => 'Fiddle');
         print MyClass->my_index('foo');

DESCRIPTION
       The Composite::Global suclass of MakeMethods provides basic accessors
       for shared data.

   Class::MakeMethods Calling Interface
       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:

       o   generator_type => "method_name"

       o   generator_type => "name_1 name_2..."

       o   generator_type => [ "name_1", "name_2", ...]



perl v5.12.2                2004-09-06                          1





MakeMethods::CoUseriContributedMakeMethods::Composite::Global(3p)


       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.

       o   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'.)

       o   generator_type => [ [ "name_1", "name_2", ... ] => {
           param=>value... } ]

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

       o   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.

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

METHOD GENERATOR TYPES
   scalar - Global Accessor
       For each method name passed, uses a closure to generate a subroutine
       with the following characteristics:

       o   May be called as a class method, or on any instance or subclass,
           and behaves identically regardless of what it was called on.

       o   If called without any arguments returns the current value.

       o   If called with an argument, stores that as the value, and returns
           it,

       o   If called with multiple arguments, stores a reference to a new
           array with those arguments as contents, and returns that array
           reference.

       Sample declaration and usage:



perl v5.12.2                2004-09-06                          2





MakeMethods::CoUseriContributedMakeMethods::Composite::Global(3p)


         package MyClass;
         use Class::MakeMethods::Composite::Global (
           scalar => 'foo',
         );
         ...

         # Store value
         MyClass->foo('Foozle');

         # Retrieve value
         print MyClass->foo;

   array - Global Ref Accessor
       For each method name passed, uses a closure to generate a subroutine
       with the following characteristics:

       o   May be called as a class method, or on any instance or subclass,
           and behaves identically regardless of what it was called on.

       o   The global value will be a reference to an array (or undef).

       o   If called without any arguments, returns the current array-ref
           value (or undef).

       o   If called with a single non-ref argument, uses that argument as an
           index to retrieve from the referenced array, and returns that value
           (or undef).

       o   If called with a single array ref argument, uses that list to
           return a slice of the referenced array.

       o   If called with a list of argument pairs, each with a non-ref index
           and an associated value, stores the value at the given index in the
           referenced array. If the global value was previously undefined, a
           new array is autovivified. The current value in each position will
           be overwritten, and later arguments with the same index will
           override earlier ones. Returns the current array-ref value.

       o   If called with a list of argument pairs, each with the first item
           being a reference to an array of up to two numbers, loops over each
           pair and uses those numbers to splice the value array.

           The first controlling number is the position at which the splice
           will begin. Zero will start before the first item in the list.
           Negative numbers count backwards from the end of the array.

           The second number is the number of items to be removed from the
           list. If it is omitted, or undefined, or zero, no items are
           removed. If it is a positive integer, that many items will be
           returned.

           If both numbers are omitted, or are both undefined, they default to
           containing the entire value array.




perl v5.12.2                2004-09-06                          3





MakeMethods::CoUseriContributedMakeMethods::Composite::Global(3p)


           If the second argument is undef, no values will be inserted; if it
           is a non-reference value, that one value will be inserted; if it is
           an array-ref, its values will be copied.

           The method returns the items that removed from the array, if any.

       Sample declaration and usage:

         package MyClass;
         use Class::MakeMethods::Composite::Global (
           array => 'bar',
         );
         ...

         # Clear and set contents of list
         print MyClass->bar([ 'Spume', 'Frost' ] );

         # Set values by position
         MyClass->bar(0 => 'Foozle', 1 => 'Bang!');

         # Positions may be overwritten, and in any order
         MyClass->bar(2 => 'And Mash', 1 => 'Blah!');

         # Retrieve value by position
         print MyClass->bar(1);

         # Direct access to referenced array
         print scalar @{ MyClass->bar() };

       There are also calling conventions for slice and splice operations:

         # Retrieve slice of values by position
         print join(', ', MyClass->bar( undef, [0, 2] ) );

         # Insert an item at position in the array
         MyClass->bar([3], 'Potatoes' );

         # Remove 1 item from position 3 in the array
         MyClass->bar([3, 1], undef );

         # Set a new value at position 2, and return the old value
         print MyClass->bar([2, 1], 'Froth' );

   hash - Global Ref Accessor
       For each method name passed, uses a closure to generate a subroutine
       with the following characteristics:

       o   May be called as a class method, or on any instance or subclass,
           and behaves identically regardless of what it was called on.

       o   The global value will be a reference to a hash (or undef).

       o   If called without any arguments, returns the contents of the hash
           in list context, or a hash reference in scalar context (or undef).



perl v5.12.2                2004-09-06                          4





MakeMethods::CoUseriContributedMakeMethods::Composite::Global(3p)


       o   If called with one non-ref argument, uses that argument as an index
           to retrieve from the referenced hash, and returns that value (or
           undef).

       o   If called with one array-ref argument, uses the contents of that
           array to retrieve a slice of the referenced hash.

       o   If called with one hash-ref argument, sets the contents of the
           referenced hash to match that provided.

       o   If called with a list of key-value pairs, stores the value under
           the given key in the referenced hash. If the global value was
           previously undefined, a new hash is autovivified. The current value
           under each key will be overwritten, and later arguments with the
           same key will override earlier ones. Returns the contents of the
           hash in list context, or a hash reference in scalar context.

       Sample declaration and usage:

         package MyClass;
         use Class::MakeMethods::Composite::Global (
           hash => 'baz',
         );
         ...

         # Set values by key
         MyClass->baz('foo' => 'Foozle', 'bar' => 'Bang!');

         # Values may be overwritten, and in any order
         MyClass->baz('broccoli' => 'Blah!', 'foo' => 'Fiddle');

         # Retrieve value by key
         print MyClass->baz('foo');

         # Retrive slice of values by position
         print join(', ', MyClass->baz( ['foo', 'bar'] ) );

         # Direct access to referenced hash
         print keys %{ MyClass->baz() };

         # Reset the hash contents to empty
         @{ MyClass->baz() } = ();

   object - Global Ref Accessor
       For each method name passed, uses a closure to generate a subroutine
       with the following characteristics:

       o   May be called as a class method, or on any instance or subclass,
           and behaves identically regardless of what it was called on.

       o   The global value will be a reference to an object (or undef).

       o   If called without any arguments returns the current value.




perl v5.12.2                2004-09-06                          5





MakeMethods::CoUseriContributedMakeMethods::Composite::Global(3p)


       o   If called with an argument, stores that as the value, and returns
           it,

       Sample declaration and usage:

         package MyClass;
         use Class::MakeMethods::Composite::Global (
           object => 'foo',
         );
         ...

         # Store value
         MyClass->foo( Foozle->new() );

         # Retrieve value
         print MyClass->foo;

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

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



































perl v5.12.2                2004-09-06                          6


