Oryx::Attribute - Attribute meta-type for Oryx persistent classes
my $attrib = Oryx::Attribute->new( \%meta, $owner ); $attrib->name; # name used for accessor generation $attrib->size; # size constraint for the value $attrib->type; # value type $attrib->required; # NOT NULL
Abstract (see implementing subclasses)
Inflate the attribute value and tie it to the implementing Value class, eg: Oryx::Value::String, Oryx::Value::Complex etc. (see perltie)
tie
returns the name meta-attribute for this attribute. This is the same as the accessor and the field in the table in which the value for this attribute is stored.
name
returns the type meta-attribute for this attribute. Defaults to 'String'.
type
returns the size meta-attribute for this attribute. This is the allowed length for the 'String' or size of 'Number' etc. and is used for input checking by the Value type. No default.
size
returns the value of the required meta-attribute. This has the effect of raising an error if an instance of the owning class is constructed without a value for this field defined in the prototype hash reference which is passed to Oryx::Class->create( \%proto ). Equivalent to a NOT NULL constraint.
required
Oryx::Class->create( \%proto )
returns a list the first argument of which is one of: 'Integer', 'String', 'Boolean', 'Float', 'Text', 'Binary' or 'DateTime' which are mapped to SQL column types by the Oryx::DBI::Util classes. The second argument is an optional size constraint.
returns the canonical package name of the implementing Oryx::Value meta-type for this attribute.
Richard Hundt <richard NO SPAM AT protea-systems.com>
Andrew Sterling Hanenkamp
This module is free software and may be used under the same terms as Perl itself.
To install Oryx, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Oryx
CPAN shell
perl -MCPAN -e shell install Oryx
For more information on module installation, please visit the detailed CPAN module installation guide.