DBIx::StORM::Class |
DBIx:: | |
DBIx:: | 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/ | Fetch the glob which contains the configuration hash |
__dbix_storm_get_config (private static/ | Fetch the configuration hash |
__dbix_storm_make_connect (private static/ | 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 |
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
Functions | |
config (protected static) | Configure this class to specify connection and table information |
__dbix_storm_get_config_glob (private static/ | Fetch the glob which contains the configuration hash |
__dbix_storm_get_config (private static/ | Fetch the configuration hash |
__dbix_storm_make_connect (private static/ | 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. |
sub _init
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.
None
Nothing
=end NaturalDocs
sub serialise
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
None
String | a serialised representation of this object |
=end NaturalDocs
sub _stash
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.
None
HashRef | an in-memory scratchpad for this object |
=end NaturalDocs
Configure this class to specify connection and table information
sub config
Fetch the glob which contains the configuration hash
sub __dbix_storm_get_config_glob
Fetch the configuration hash
sub __dbix_storm_get_config
Return an active DBIx::StORM object for this class.
sub __dbix_storm_make_connect
Fetch a RecordSet of all the records in the table this class back on to.
sub all
sub connection
Fetch a RecordSet of all the records in the table this meet the criteria of the filter $sub.
sub grep
Initialise a newly created object of this class.
sub _init
Serialise an object to a string description which can be used to fetch it back from the database later.
sub serialise
Recreate an object using the string obtained from serialise() and the database.
sub unserialise
Create a new record object blessed into this class which will be stored in the underlying table.
sub new
As objects in this class are DBIx::StORM::Records too, you cannot directly change the hash entries as this would change the database.
sub _stash