DBIx::StORM::Class

StORM StORM Class FilteredRecordSet Inflater LexBindings OrderedRecordSet ParseCV Record RecordArray RecordSet RecordSetWithView SQLDriver SQLDriver:: mysql SQLDriver:: Pg Table TiedCallback TiedColumn TiedRecord TiedTable Index Everything Classes Functions Variables | # DBIx:: StORM:: Class
DBIx::StORM::Record
DBIx::StORM::Class
Summary
DBIx:: StORM:: Class |
DBIx:: StORM:: Class | A base class that can be used to turn a DBIx::StORM::Table into a class in another package.
Functions |
config (protected static) | Configure this class to specify connection and table information
__dbix_storm_get_config_glob (private static/ instance) | Fetch the glob which contains the configuration hash
__dbix_storm_get_config (private static/ instance) | Fetch the configuration hash
__dbix_storm_make_connect (private static/ instance) | Return an active DBIx::StORM object for this class.
all (public static) | Fetch a RecordSet of all the records in the table this class back on to.
connection |
grep (public static) | Fetch a RecordSet of all the records in the table this meet the criteria of the filter $sub.
_init (protected instance) | Initialise a newly created object of this class.
serialise (public instance) | Serialise an object to a string description which can be used to fetch it back from the database later.
unserialise (public static) | Recreate an object using the string obtained from serialise() and the database.
new (public static) | Create a new record object blessed into this class which will be stored in the underlying table.
_stash (protected static) | As objects in this class are DBIx::StORM::Records too, you cannot directly change the hash entries as this would change the database.
## DBIx:: StORM:: Class
DBIx::StORM::Record
DBIx::StORM::Class
A base class that can be used to turn a DBIx::StORM::Table into a class in another package. This class inherits from DBIx::StORM::Record and adds methods to access the records in a given table. Any records accessed will be automatically blessed into this class. =end NaturalDocs Summary
Functions |
config (protected static) | Configure this class to specify connection and table information
__dbix_storm_get_config_glob (private static/ instance) | Fetch the glob which contains the configuration hash
__dbix_storm_get_config (private static/ instance) | Fetch the configuration hash
__dbix_storm_make_connect (private static/ instance) | Return an active DBIx::StORM object for this class.
all (public static) | Fetch a RecordSet of all the records in the table this class back on to.
connection |
grep (public static) | Fetch a RecordSet of all the records in the table this meet the criteria of the filter $sub.
_init (protected instance) | Initialise a newly created object of this class.
serialise (public instance) | Serialise an object to a string description which can be used to fetch it back from the database later.
unserialise (public static) | Recreate an object using the string obtained from serialise() and the database.
new (public static) | Create a new record object blessed into this class which will be stored in the underlying table.
_stash (protected static) | As objects in this class are DBIx::StORM::Records too, you cannot directly change the hash entries as this would change the database.
### Functions ### config (protected static) Configure this class to specify connection and table information #### Parameters
Hash | Configuration information for this class
#### Returns Nothing =end NaturalDocs ### __dbix_storm_get_config_glob (private static/ instance) Fetch the glob which contains the configuration hash #### Parameters None #### Returns
GlobRef | the glob containing the configuration hash
=end NaturalDocs ### __dbix_storm_get_config (private static/ instance) Fetch the configuration hash #### Parameters None #### Returns
HashRef | configuration information as passed to config()
=end NaturalDocs ### __dbix_storm_make_connect (private static/ instance) Return an active DBIx::StORM object for this class. This may have been cached from an earlier call. #### Parameters None #### Returns
Object | DBIx::StORM connection
=end NaturalDocs ### all (public static) Fetch a RecordSet of all the records in the table this class back on to. #### Parameters None #### Returns
Object | DBIx::StORM::RecordSet of the records in the table
> =end NaturalDocs ### connection
> sub connection
### grep (public static) Fetch a RecordSet of all the records in the table this meet the criteria of the filter $sub. #### Parameters
CodeRef $sub | A filter subroutine that returns true for rows to be included
#### Returns
Object | DBIx::StORM::RecordSet of the records in the table that match
=end NaturalDocs ### _init (protected instance) Initialise a newly created object of this class. This differs to new in that new is called only for newly-created records that start life outside the database, while _init is called for all records including those fetched from the database. Currently is does nothing, but is here so that it can be subclassed. #### Parameters None #### Returns Nothing =end NaturalDocs ### serialise (public instance) Serialise an object to a string description which can be used to fetch it back from the database later. By default, it serialises to the value of the primary key columns, joined with a comma. Any commas or backslashes in these values are backslash-escaped #### Parameters None #### Returns
String | a serialised representation of this object
=end NaturalDocs ### unserialise (public static) Recreate an object using the string obtained from serialise() and the database. Currently not implemented. #### Parameters
String $string | the serialised representation of the object
#### Returns
Object | a record blessed into this package
=end NaturalDocs ### new (public static) Create a new record object blessed into this class which will be stored in the underlying table. #### Parameters None #### Returns
Object | a record blessed into this package
=end NaturalDocs ### _stash (protected static) As objects in this class are DBIx::StORM::Records too, you cannot directly change the hash entries as this would change the database. This method returns a hash scratchpad which can be edited to store data. It will not be saved between sessions. #### Parameters None #### Returns
HashRef | an in-memory scratchpad for this object
=end NaturalDocs

> sub connection