onPHP

GenericDAO Class Reference

home about examples API documentation download forum contacts
 

GenericDAO Class Reference
[Root classes for building DAO hierarchies]

Basis of all DAO's. More...

Inheritance diagram for GenericDAO:

Inheritance graph
[legend]

List of all members.

Public Member Functions

 getTable ()
 getObjectName ()
 createObject ()
 getLinkName ()
 Returns link name which is used to get actual DB-link from DBPool, returning null by default for single-source projects.
 getIdName ()
 getSequence ()
 makeSelectHead ()
 getMapping ()
 getFields ()
 dropIdentityMap ()
 get (ObjectQuery $oq, $expires=Cache::DO_NOT_CACHE)
 boring delegates
 getById ($id, $expires=Cache::EXPIRES_MEDIUM)
 getByLogic (LogicalObject $logic, $expires=Cache::DO_NOT_CACHE)
 getByQuery (SelectQuery $query, $expires=Cache::DO_NOT_CACHE)
 getCustom (SelectQuery $query, $expires=Cache::DO_NOT_CACHE)
 getList (ObjectQuery $oq, $expires=Cache::DO_NOT_CACHE)
 getListByIds ($ids, $expires=Cache::EXPIRES_MEDIUM)
 getListByQuery (SelectQuery $query, $expires=Cache::DO_NOT_CACHE)
 getListByLogic (LogicalObject $logic, $expires=Cache::DO_NOT_CACHE)
 getPlainList ($expires=Cache::DO_NOT_CACHE)
 getCustomList (SelectQuery $query, $expires=Cache::DO_NOT_CACHE)
 getCustomRowList (SelectQuery $query, $expires=Cache::DO_NOT_CACHE)
 getCountedList (ObjectQuery $oq, $expires=Cache::DO_NOT_CACHE)
 getQueryResult (SelectQuery $query, $expires=Cache::DO_NOT_CACHE)
 cacheById (Identifiable $object, $expires=Cache::EXPIRES_MEDIUM)
 cacheByQuery (SelectQuery $query, $object, $expires=Cache::DO_NOT_CACHE)
 cacheListByQuery (SelectQuery $query, $array)
 getCachedById ($id)
 cache getters
 getCachedByQuery (SelectQuery $query)
 drop (Identifiable $object)
 erasers
 dropById ($id)
 dropByIds ($ids)
 uncacheById ($id)
 uncachers
 uncacheByIds ($ids)
 uncacheByQuery (SelectQuery $query)
 uncacheLists ()

Protected Member Functions

 makeObject (&$array, $prefix=null)
 checkObjectType (Identifiable $object)

Protected Attributes

 $mapping = array()
 $identityMap = array()
 $selectHead = null

Private Member Functions

 addObjectToMap (Identifiable $object)
 addObjectListToMap ($list)

Detailed Description

Basis of all DAO's.

Definition at line 18 of file GenericDAO.class.php.

Member Function Documentation

GenericDAO::getTable (  )  [abstract]

Referenced by ProtoDAO::fetchCollections(), ComplexBuilderDAO::getJoinName(), getSequence(), ProtoDAO::guessAtom(), StorableDAO::inject(), makeSelectHead(), and ProtoDAO::processPath().

GenericDAO::getObjectName (  )  [abstract]

Referenced by BaseDaoWorker::__construct(), checkObjectType(), createObject(), ProtoDAO::fetchCollections(), getFields(), ComplexBuilderDAO::getFields(), ComplexBuilderDAO::getMapping(), ProtoDAO::guessAtom(), and ProtoDAO::processPath().

GenericDAO::makeObject ( &$  array,
$  prefix = null 
) [abstract, protected]

Reimplemented in ComplexBuilderDAO.

GenericDAO::createObject (  ) 

Definition at line 32 of file GenericDAO.class.php.

References getObjectName().

Here is the call graph for this function:

GenericDAO::getLinkName (  ) 

Returns link name which is used to get actual DB-link from DBPool, returning null by default for single-source projects.

See also:
DBPool

Definition at line 45 of file GenericDAO.class.php.

GenericDAO::getIdName (  ) 

Definition at line 50 of file GenericDAO.class.php.

Referenced by ProtoDAO::fetchCollections(), StorableDAO::inject(), ProtoDAO::processPath(), StorableDAO::save(), and ComplexBuilderDAO::selfSpawn().

GenericDAO::getSequence (  ) 

Definition at line 55 of file GenericDAO.class.php.

References getTable().

Referenced by StorableDAO::add().

Here is the call graph for this function:

GenericDAO::makeSelectHead (  ) 

Returns:
SelectQuery

Definition at line 63 of file GenericDAO.class.php.

References getFields(), getTable(), and OSQL::select().

Referenced by ObjectQuery::toSelectQuery().

Here is the call graph for this function:

GenericDAO::getMapping (  ) 

Deprecated:
by ComplexBuilderDAO::getMapping()

Reimplemented in ComplexBuilderDAO.

Definition at line 80 of file GenericDAO.class.php.

Referenced by getFields(), and ProtoDAO::guessAtom().

GenericDAO::getFields (  ) 

Deprecated:
by ComplexBuilderDAO::getFields()

Reimplemented in ComplexBuilderDAO.

Definition at line 89 of file GenericDAO.class.php.

References getMapping(), and getObjectName().

Referenced by ProtoDAO::fetchCollections(), and makeSelectHead().

Here is the call graph for this function:

GenericDAO::get ( ObjectQuery $  oq,
$  expires = Cache::DO_NOT_CACHE 
)

boring delegates

Definition at line 105 of file GenericDAO.class.php.

References Cache::worker().

Here is the call graph for this function:

GenericDAO::getById ( $  id,
$  expires = Cache::EXPIRES_MEDIUM 
)

Definition at line 110 of file GenericDAO.class.php.

References addObjectToMap(), and Cache::worker().

Here is the call graph for this function:

GenericDAO::getByLogic ( LogicalObject $  logic,
$  expires = Cache::DO_NOT_CACHE 
)

Definition at line 120 of file GenericDAO.class.php.

References addObjectToMap(), and Cache::worker().

Here is the call graph for this function:

GenericDAO::getByQuery ( SelectQuery $  query,
$  expires = Cache::DO_NOT_CACHE 
)

Definition at line 129 of file GenericDAO.class.php.

References addObjectToMap(), and Cache::worker().

Here is the call graph for this function:

GenericDAO::getCustom ( SelectQuery $  query,
$  expires = Cache::DO_NOT_CACHE 
)

Definition at line 138 of file GenericDAO.class.php.

References Cache::worker().

Here is the call graph for this function:

GenericDAO::getList ( ObjectQuery $  oq,
$  expires = Cache::DO_NOT_CACHE 
)

Definition at line 145 of file GenericDAO.class.php.

References Cache::worker().

Here is the call graph for this function:

GenericDAO::getListByIds ( $  ids,
$  expires = Cache::EXPIRES_MEDIUM 
)

Definition at line 150 of file GenericDAO.class.php.

References addObjectListToMap(), and Cache::worker().

Here is the call graph for this function:

GenericDAO::getListByQuery ( SelectQuery $  query,
$  expires = Cache::DO_NOT_CACHE 
)

Definition at line 175 of file GenericDAO.class.php.

References addObjectListToMap(), and Cache::worker().

Here is the call graph for this function:

GenericDAO::getListByLogic ( LogicalObject $  logic,
$  expires = Cache::DO_NOT_CACHE 
)

Definition at line 184 of file GenericDAO.class.php.

References addObjectListToMap(), and Cache::worker().

Here is the call graph for this function:

GenericDAO::getPlainList ( $  expires = Cache::DO_NOT_CACHE  ) 

Definition at line 193 of file GenericDAO.class.php.

References addObjectListToMap(), BaseDAO::getPlainList(), and Cache::worker().

Here is the call graph for this function:

GenericDAO::getCustomList ( SelectQuery $  query,
$  expires = Cache::DO_NOT_CACHE 
)

Definition at line 200 of file GenericDAO.class.php.

References Cache::worker().

Here is the call graph for this function:

GenericDAO::getCustomRowList ( SelectQuery $  query,
$  expires = Cache::DO_NOT_CACHE 
)

Definition at line 207 of file GenericDAO.class.php.

References Cache::worker().

Here is the call graph for this function:

GenericDAO::getCountedList ( ObjectQuery $  oq,
$  expires = Cache::DO_NOT_CACHE 
)

Definition at line 214 of file GenericDAO.class.php.

References Cache::worker().

Here is the call graph for this function:

GenericDAO::getQueryResult ( SelectQuery $  query,
$  expires = Cache::DO_NOT_CACHE 
)

Definition at line 221 of file GenericDAO.class.php.

References Cache::worker().

Here is the call graph for this function:

GenericDAO::cacheById ( Identifiable $  object,
$  expires = Cache::EXPIRES_MEDIUM 
)

Definition at line 228 of file GenericDAO.class.php.

References Cache::worker().

Here is the call graph for this function:

GenericDAO::cacheByQuery ( SelectQuery $  query,
$  object,
$  expires = Cache::DO_NOT_CACHE 
)

Definition at line 235 of file GenericDAO.class.php.

References Cache::worker().

Here is the call graph for this function:

GenericDAO::cacheListByQuery ( SelectQuery $  query,
$  array 
)

Implements BaseDAO.

Definition at line 244 of file GenericDAO.class.php.

References Cache::worker().

Here is the call graph for this function:

GenericDAO::getCachedById ( $  id  ) 

cache getters

Implements BaseDAO.

Definition at line 249 of file GenericDAO.class.php.

References Cache::worker().

Here is the call graph for this function:

GenericDAO::getCachedByQuery ( SelectQuery $  query  ) 

Implements BaseDAO.

Definition at line 254 of file GenericDAO.class.php.

References Cache::worker().

Here is the call graph for this function:

GenericDAO::drop ( Identifiable $  object  ) 

erasers

Implements BaseDAO.

Definition at line 259 of file GenericDAO.class.php.

References checkObjectType(), and dropById().

Here is the call graph for this function:

GenericDAO::dropById ( $  id  ) 

Implements BaseDAO.

Definition at line 266 of file GenericDAO.class.php.

References Cache::worker().

Referenced by drop().

Here is the call graph for this function:

GenericDAO::dropByIds ( $  ids  ) 

Implements BaseDAO.

Definition at line 273 of file GenericDAO.class.php.

References Cache::worker().

Here is the call graph for this function:

GenericDAO::uncacheById ( $  id  ) 

uncachers

Implements BaseDAO.

Definition at line 281 of file GenericDAO.class.php.

References Cache::worker().

Referenced by StorableDAO::inject().

Here is the call graph for this function:

GenericDAO::uncacheByIds ( $  ids  ) 

Implements BaseDAO.

Definition at line 288 of file GenericDAO.class.php.

References Cache::worker().

Here is the call graph for this function:

GenericDAO::uncacheByQuery ( SelectQuery $  query  ) 

Implements BaseDAO.

Definition at line 296 of file GenericDAO.class.php.

References Cache::worker().

Here is the call graph for this function:

GenericDAO::uncacheLists (  ) 

Implements BaseDAO.

Definition at line 301 of file GenericDAO.class.php.

References Cache::worker().

Here is the call graph for this function:

GenericDAO::dropIdentityMap (  ) 

Returns:
GenericDAO

Definition at line 312 of file GenericDAO.class.php.

GenericDAO::checkObjectType ( Identifiable $  object  )  [protected]

Definition at line 319 of file GenericDAO.class.php.

References getObjectName(), and Assert::isTrue().

Referenced by drop(), and StorableDAO::inject().

Here is the call graph for this function:

GenericDAO::addObjectToMap ( Identifiable $  object  )  [private]

Definition at line 327 of file GenericDAO.class.php.

References Identifiable::getId().

Referenced by getById(), getByLogic(), and getByQuery().

Here is the call graph for this function:

GenericDAO::addObjectListToMap ( $  list  )  [private]

Definition at line 332 of file GenericDAO.class.php.

Referenced by getListByIds(), getListByLogic(), getListByQuery(), and getPlainList().

Member Data Documentation

GenericDAO::$mapping = array() [protected]

Definition at line 21 of file GenericDAO.class.php.

Referenced by ProtoDAO::guessAtom().

GenericDAO::$identityMap = array() [protected]

Definition at line 23 of file GenericDAO.class.php.

GenericDAO::$selectHead = null [protected]

Definition at line 25 of file GenericDAO.class.php.

The documentation for this class was generated from the following file:

generated by doxygen-1.5.5
for onPHP at Tue Jun 17 16:43:56 2008