DBIx::StORM::TiedTable

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:: TiedTable Summary
DBIx:: StORM:: TiedTable |
DBIx:: StORM:: TiedTable | An inner class used to represent a mapping of table names to DBIx::StORM::Table objects for a given connection.
Functions |
TIEHASH (private static) | Create a new tied object.
FETCH (private instance) | Fetch a table object for a particular table in the hash
EXISTS (private instance) | Check for the existence of a table on a particular connection.
FIRSTKEY (private instance) | Reset the iterator and return the first hash object.
NEXTKEY (private instance) | Return the next table from the iterator.
SCALAR (private instance) | Return the number of tables available on the connection.
## DBIx:: StORM:: TiedTable An inner class used to represent a mapping of table names to DBIx::StORM::Table objects for a given connection. =end NaturalDocs Summary
Functions |
TIEHASH (private static) | Create a new tied object.
FETCH (private instance) | Fetch a table object for a particular table in the hash
EXISTS (private instance) | Check for the existence of a table on a particular connection.
FIRSTKEY (private instance) | Reset the iterator and return the first hash object.
NEXTKEY (private instance) | Return the next table from the iterator.
SCALAR (private instance) | Return the number of tables available on the connection.
### Functions ### TIEHASH (private static) Create a new tied object. #### Parameters
Object $storm | The DBIx::StORM connection object
#### Returns
Object | A new DBIx::StORM::TiedTable object
=end NaturalDocs ### FETCH (private instance) Fetch a table object for a particular table in the hash #### Parameters
String $index | The name of the table to fetch a table object for
#### Returns
Object | Table object of type DBIx::StORM::Table
=end NaturalDocs ### EXISTS (private instance) Check for the existence of a table on a particular connection. #### Parameters
String $index | The name of the table to check
#### Returns
Boolean | Whether the table exists
=end NaturalDocs ### FIRSTKEY (private instance) Reset the iterator and return the first hash object. The tables are returned in a random order. #### Parameters None #### Returns
String | the table name
Object | Table as a DBIx::StORM::Table (list context only)
=end NaturalDocs ### NEXTKEY (private instance) Return the next table from the iterator. The tables are returned in a random order. #### Parameters None #### Returns
String | the table name
Object | Table as a DBIx::StORM::Table (list context only)
=end NaturalDocs ### SCALAR (private instance) Return the number of tables available on the connection. #### Parameters None #### Returns
Integer | the number of tables available
=end NaturalDocs