.\" 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::Utility::Inheritable 3pm" .TH MakeMethods::Utility::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::Utility::Inheritable \- "Inheritable" data .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 2 \& package MyClass; \& sub new { ... } \& \& package MySubclass; \& @ISA = \*(AqMyClass\*(Aq; \& ... \& my $obj = MyClass\->new(...); \& my $subobj = MySubclass\->new(...); \& \& use Class::MakeMethods::Utility::Inheritable qw(get_vvalue set_vvalue ); \& \& my $dataset = {}; \& set_vvalue($dataset, \*(AqMyClass\*(Aq, \*(AqFoobar\*(Aq); # Set value for class \& get_vvalue($dataset, \*(AqMyClass\*(Aq); # Gets value "Foobar" \& \& get_vvalue($dataset, $obj); # Objects "inherit" \& set_vvalue($dataset, $obj, \*(AqFoible\*(Aq); # Until you override \& get_vvalue($dataset, $obj); # Now finds "Foible" \& \& get_vvalue($dataset, \*(AqMySubclass\*(Aq); # Subclass "inherits" \& get_vvalue($dataset, $subobj); # As do its objects \& set_vvalue($dataset, \*(AqMySubclass\*(Aq, \*(AqFoozle\*(Aq); # Until we override it \& get_vvalue($dataset, \*(AqMySubclass\*(Aq); # Now finds "Foozle" \& \& get_vvalue($dataset, $subobj); # Change cascades down \& set_vvalue($dataset, $subobj, \*(AqFoolish\*(Aq); # Until we override again \& \& get_vvalue($dataset, \*(AqMyClass\*(Aq); # Superclass is unchanged .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module provides several functions which allow you to store values in a hash corresponding to both objects and classes, and to retrieve those values by searching a object's inheritance tree until it finds a matching entry. .PP This functionality is used by Class::MakeMethods::Standard::Inheritable and Class::MakeMethods::Composite::Inheritable to construct methods that can both store class data and be overridden on a per-object level. .SH "REFERENCE" .IX Header "REFERENCE" .SS "find_vself" .IX Subsection "find_vself" .Vb 1 \& $vself = find_vself( $dataset, $instance ); .Ve .PP Searches \f(CW$instance\fR's inheritance tree until it finds a matching entry in the dataset, and returns either the instance, the class that matched, or undef. .SS "get_vvalue" .IX Subsection "get_vvalue" .Vb 1 \& $value = get_vvalue( $dataset, $instance ); .Ve .PP Searches \f(CW$instance\fR's inheritance tree until it finds a matching entry in the dataset, and returns that value .SS "set_vvalue" .IX Subsection "set_vvalue" .Vb 1 \& $value = set_vvalue( $dataset, $instance, $value ); .Ve .PP Searches \f(CW$instance\fR's inheritance tree until it finds a matching entry in the dataset, and returns that value