Simon Elliott > DBIx-Class-0.06002 > DBIx::Class::AccessorGroup

Download:
DBIx-Class-0.06002.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  18
Open  32
Stalled  13
View/Report Bugs
Source   Latest Release: DBIx-Class-0.082840

NAME ^

DBIx::Class::AccessorGroup - Lets you build groups of accessors

SYNOPSIS ^

DESCRIPTION ^

This class lets you build groups of accessors that will call different getters and setters.

METHODS ^

mk_group_accessors

Arguments: $group, @fieldspec

Returns: none

Creates a set of accessors in a given group.

$group is the name of the accessor group for the generated accessors; they will call get_$group($field) on get and set_$group($field, $value) on set.

@fieldspec is a list of field/accessor names; if a fieldspec is a scalar this is used as both field and accessor name, if a listref it is expected to be of the form [ $accessor, $field ].

mk_group_ro_accessors

Arguments: $group, @fieldspec

Returns: none

Creates a set of read only accessors in a given group. Identical to <L:/mk_group_accessors> but accessors will throw an error if passed a value rather than setting the value.

mk_group_wo_accessors

Arguments: $group, @fieldspec

Returns: none

Creates a set of write only accessors in a given group. Identical to <L:/mk_group_accessors> but accessors will throw an error if not passed a value rather than getting the value.

make_group_accessor

Arguments: $group, $field

Returns: $sub (\CODE)

Returns a single accessor in a given group; called by mk_group_accessors for each entry in @fieldspec.

make_group_ro_accessor

Arguments: $group, $field

Returns: $sub (\CODE)

Returns a single read-only accessor in a given group; called by mk_group_ro_accessors for each entry in @fieldspec.

make_group_wo_accessor

Arguments: $group, $field

Returns: $sub (\CODE)

Returns a single write-only accessor in a given group; called by mk_group_wo_accessors for each entry in @fieldspec.

get_simple

Arguments: $field

Returns: $value

Simple getter for hash-based objects which returns the value for the field name passed as an argument.

set_simple

Arguments: $field, $new_value

Returns: $new_value

Simple setter for hash-based objects which sets and then returns the value for the field name passed as an argument.

get_component_class

Arguments: $name

Returns: $component_class

Returns the class name for a component; returns an object key if called on an object, or attempts to return classdata referenced by _$name if called on a class.

set_component_class

Arguments: $name, $new_component_class

Returns: $new_component_class

Sets a component class name; attempts to require the class before setting but does not error if unable to do so. Sets an object key of the given name if called or an object or classdata called _$name if called on a class.

AUTHORS ^

Matt S. Trout <mst@shadowcatsystems.co.uk>

LICENSE ^

You may distribute this code under the same terms as Perl itself.

syntax highlighting: