.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "MakeMethods::Composite::Inheritable 3pm"
.TH MakeMethods::Composite::Inheritable 3pm "2016-06-10" "perl v5.22.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Class::MakeMethods::Composite::Inheritable \- Overridable data
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  package MyClass;
\&
\&  use Class::MakeMethods( \*(AqComposite::Inheritable:scalar\*(Aq => \*(Aqfoo\*(Aq );
\&  # We now have an accessor method for an "inheritable" scalar value
\&  
\&  MyClass\->foo( \*(AqFoozle\*(Aq );   # Set a class\-wide value
\&  print MyClass\->foo();       # Retrieve class\-wide value
\&  
\&  my $obj = MyClass\->new(...);
\&  print $obj\->foo();          # All instances "inherit" that value...
\&  
\&  $obj\->foo( \*(AqFoible\*(Aq );      # until you set a value for an instance.
\&  print $obj\->foo();          # This now finds object\-specific value.
\&  ...
\&  
\&  package MySubClass;
\&  @ISA = \*(AqMyClass\*(Aq;
\&  
\&  print MySubClass\->foo();    # Intially same as superclass,
\&  MySubClass\->foo(\*(AqFoobar\*(Aq);  # but overridable per subclass,
\&  print $subclass_obj\->foo(); # and shared by its instances
\&  $subclass_obj\->foo(\*(AqFosil\*(Aq);# until you override them... 
\&  ...
\&  
\&  # Similar behaviour for hashes and arrays is currently incomplete
\&  package MyClass;
\&  use Class::MakeMethods::Composite::Inheritable (
\&    array => \*(Aqmy_list\*(Aq,
\&    hash => \*(Aqmy_index\*(Aq,
\&  );
\&  
\&  MyClass\->my_list(0 => \*(AqFoozle\*(Aq, 1 => \*(AqBang!\*(Aq);
\&  print MyClass\->my_list(1);
\&  
\&  MyClass\->my_index(\*(Aqbroccoli\*(Aq => \*(AqBlah!\*(Aq, \*(Aqfoo\*(Aq => \*(AqFiddle\*(Aq);
\&  print MyClass\->my_index(\*(Aqfoo\*(Aq);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The MakeMethods subclass provides accessor methods that search an inheritance tree to find a value. This allows you to set a shared or default value for a given class, optionally override it in a subclass, and then optionally override it on a per-instance basis.
.PP
Note that all MakeMethods methods are inheritable, in the sense that they work as expected for subclasses. These methods are different in that the \fIdata\fR accessed by each method can be inherited or overridden in each subclass or instance. See Class::MakeMethods::Utility::Inheritable for more about this type of \*(L"inheritable\*(R" or overridable" data.
.SS "Class::MakeMethods Calling Interface"
.IX Subsection "Class::MakeMethods Calling Interface"
When you \f(CW\*(C`use\*(C'\fR this package, the method declarations you provide
as arguments cause subroutines to be generated and installed in
your module.
.PP
See \*(L"Calling Conventions\*(R" in Class::MakeMethods::Standard for more information.
.SS "Class::MakeMethods::Standard Declaration Syntax"
.IX Subsection "Class::MakeMethods::Standard Declaration Syntax"
To declare methods, pass in pairs of a method-type name followed
by one or more method names.
.PP
See the \*(L"\s-1METHOD GENERATOR TYPES\*(R"\s0 section below for a list of the supported values of \fIgenerator_type\fR.
.PP
See \*(L"Declaration Syntax\*(R" in Class::MakeMethods::Standard and \*(L"Parameter Syntax\*(R" in Class::MakeMethods::Standard for more information.
.SH "METHOD GENERATOR TYPES"
.IX Header "METHOD GENERATOR TYPES"
.SS "scalar \- Overrideable Accessor"
.IX Subsection "scalar - Overrideable Accessor"
For each method name passed, uses a closure to generate a subroutine with the following characteristics:
.IP "\(bu" 4
May be called as a class or instance method, on the declaring class or any subclass.
.IP "\(bu" 4
If called without any arguments returns the current value for the callee. If the callee has not had a value defined for this method, searches up from instance to class, and from class to superclass, until a callee with a value is located.
.IP "\(bu" 4
If called with an argument, stores that as the value associated with the callee, whether instance or class, and returns it,
.IP "\(bu" 4
If called with multiple arguments, stores a reference to a new array with those arguments as contents, and returns that array reference.
.PP
Sample declaration and usage:
.PP
.Vb 5
\&  package MyClass;
\&  use Class::MakeMethods::Composite::Inheritable (
\&    scalar => \*(Aqfoo\*(Aq,
\&  );
\&  ...
\&  
\&  # Store value
\&  MyClass\->foo(\*(AqFoozle\*(Aq);
\&  
\&  # Retrieve value
\&  print MyClass\->foo;
.Ve
.SS "array \- Overrideable Ref Accessor"
.IX Subsection "array - Overrideable Ref Accessor"
For each method name passed, uses a closure to generate a subroutine with the following characteristics:
.IP "\(bu" 4
May be called as a class method, or on any instance or subclass, Must be called on a hash-based instance.
.IP "\(bu" 4
The class value will be a reference to an array (or undef).
.IP "\(bu" 4
If called without any arguments, returns the current array-ref value (or undef).
.IP "\(bu" 4
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).
.IP "\(bu" 4
If called with a single array ref argument, uses that list to return a slice of the referenced array.
.IP "\(bu" 4
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 class 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.
.IP "\(bu" 4
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.
.Sp
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.
.Sp
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.
.Sp
If both numbers are omitted, or are both undefined, they default to containing the entire value array.
.Sp
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.
.Sp
The method returns the items that removed from the array, if any.
.PP
Sample declaration and usage:
.PP
.Vb 5
\&  package MyClass;
\&  use Class::MakeMethods::Composite::Inheritable (
\&    array => \*(Aqbar\*(Aq,
\&  );
\&  ...
\&  
\&  # Clear and set contents of list
\&  print MyClass\->bar([ \*(AqSpume\*(Aq, \*(AqFrost\*(Aq ] );  
\&  
\&  # Set values by position
\&  MyClass\->bar(0 => \*(AqFoozle\*(Aq, 1 => \*(AqBang!\*(Aq);
\&  
\&  # Positions may be overwritten, and in any order
\&  MyClass\->bar(2 => \*(AqAnd Mash\*(Aq, 1 => \*(AqBlah!\*(Aq);
\&  
\&  # Retrieve value by position
\&  print MyClass\->bar(1);
\&  
\&  # Direct access to referenced array
\&  print scalar @{ MyClass\->bar() };
.Ve
.PP
There are also calling conventions for slice and splice operations:
.PP
.Vb 2
\&  # Retrieve slice of values by position
\&  print join(\*(Aq, \*(Aq, MyClass\->bar( undef, [0, 2] ) );
\&  
\&  # Insert an item at position in the array
\&  MyClass\->bar([3], \*(AqPotatoes\*(Aq );  
\&  
\&  # 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], \*(AqFroth\*(Aq );
.Ve
.PP
\&\fB\s-1NOTE: THIS METHOD GENERATOR HAS NOT BEEN WRITTEN YET.\s0\fR
.SS "hash \- Overrideable Ref Accessor"
.IX Subsection "hash - Overrideable Ref Accessor"
For each method name passed, uses a closure to generate a subroutine with the following characteristics:
.IP "\(bu" 4
May be called as a class method, or on any instance or subclass, Must be called on a hash-based instance.
.IP "\(bu" 4
The class value will be a reference to a hash (or undef).
.IP "\(bu" 4
If called without any arguments returns the contents of the hash in list context, or a hash reference in scalar context for the callee. If the callee has not had a value defined for this method, searches up from instance to class, and from class to superclass, until a callee with a value is located.
.IP "\(bu" 4
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). If the callee has not had a value defined for this method, searches up from instance to class, and from class to superclass, until a callee with a value is located.
.IP "\(bu" 4
If called with one array-ref argument, uses the contents of that array to retrieve a slice of the referenced hash. If the callee has not had a value defined for this method, searches up from instance to class, and from class to superclass, until a callee with a value is located.
.IP "\(bu" 4
If called with one hash-ref argument, sets the contents of the referenced hash to match that provided.
.IP "\(bu" 4
If called with a list of key-value pairs, stores the value under the given key in the hash associated with the callee, whether instance or class. If the callee did not previously have a hash-ref value associated with it, searches up instance to class, and from class to superclass, until a callee with a value is located, and copies that hash before making the assignments. 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.
.PP
Sample declaration and usage:
.PP
.Vb 5
\&  package MyClass;
\&  use Class::MakeMethods::Composite::Inheritable (
\&    hash => \*(Aqbaz\*(Aq,
\&  );
\&  ...
\&  
\&  # Set values by key
\&  MyClass\->baz(\*(Aqfoo\*(Aq => \*(AqFoozle\*(Aq, \*(Aqbar\*(Aq => \*(AqBang!\*(Aq);
\&  
\&  # Values may be overwritten, and in any order
\&  MyClass\->baz(\*(Aqbroccoli\*(Aq => \*(AqBlah!\*(Aq, \*(Aqfoo\*(Aq => \*(AqFiddle\*(Aq);
\&  
\&  # Retrieve value by key
\&  print MyClass\->baz(\*(Aqfoo\*(Aq);
\&  
\&  # Retrieve slice of values by position
\&  print join(\*(Aq, \*(Aq, MyClass\->baz( [\*(Aqfoo\*(Aq, \*(Aqbar\*(Aq] ) );
\&  
\&  # Direct access to referenced hash
\&  print keys %{ MyClass\->baz() };
\&  
\&  # Reset the hash contents to empty
\&  @{ MyClass\->baz() } = ();
.Ve
.PP
\&\fB\s-1NOTE: THIS METHOD GENERATOR IS INCOMPLETE.\s0\fR
.SS "hook \- Overrideable array of subroutines"
.IX Subsection "hook - Overrideable array of subroutines"
A hook method is called from the outside as a normal method. However, internally, it contains an array of subroutine references, each of which are called in turn to produce the method's results.
.PP
Subroutines may be added to the hook's array by calling it with a blessed subroutine reference, as shown below. Subroutines may be added on a class-wide basis or on an individual object.
.PP
You might want to use this type of method to provide an easy way for callbacks to be registered.
.PP
.Vb 2
\&  package MyClass;
\&  use Class::MakeMethods::Composite::Inheritable ( \*(Aqhook\*(Aq => \*(Aqinit\*(Aq );
\&  
\&  MyClass\->init( Class::MakeMethods::Composite::Inheritable\->Hook( sub { 
\&      my $callee = shift;
\&      warn "Init...";
\&  } );
\&  
\&  my $obj = MyClass\->new;
\&  $obj\->init();
.Ve
.SS "object \- Overrideable Ref Accessor"
.IX Subsection "object - Overrideable Ref Accessor"
For each method name passed, uses a closure to generate a subroutine with the following characteristics:
.IP "\(bu" 4
May be called as a class method, or on any instance or subclass, Must be called on a hash-based instance.
.IP "\(bu" 4
The class value will be a reference to an object (or undef).
.IP "\(bu" 4
If called without any arguments returns the current value for the callee. If the callee has not had a value defined for this method, searches up from instance to class, and from class to superclass, until a callee with a value is located.
.IP "\(bu" 4
If called with an argument, stores that as the value associated with the callee, whether instance or class, and returns it,
.PP
Sample declaration and usage:
.PP
.Vb 5
\&  package MyClass;
\&  use Class::MakeMethods::Composite::Inheritable (
\&    object => \*(Aqfoo\*(Aq,
\&  );
\&  ...
\&  
\&  # Store value
\&  MyClass\->foo( Foozle\->new() );
\&  
\&  # Retrieve value
\&  print MyClass\->foo;
.Ve
.PP
\&\fB\s-1NOTE: THIS METHOD GENERATOR HAS NOT BEEN WRITTEN YET.\s0\fR
.SH "SEE ALSO"
.IX Header "SEE ALSO"
See Class::MakeMethods for general information about this distribution.
.PP
See Class::MakeMethods::Composite for more about this family of subclasses.