# TransparentDaoWorker Class Reference
[Root classes for building DAO hierarchies]

Basis for transparent DAO workers. More...

Inheritance diagram for TransparentDaoWorker:
[legend]

List of all members.

## Public Member Functions

| getById ($id)
| single object getters
| getByLogic (LogicalObject $logic)
| getByQuery (SelectQuery $query)
| getCustom (SelectQuery $query)
| getListByIds (array $ids)
| object's list getters
| getListByQuery (SelectQuery $query)
| getListByLogic (LogicalObject $logic)
| getPlainList ()
| getCustomList (SelectQuery $query)
| custom list getters
| getCustomRowList (SelectQuery $query)
| getQueryResult (SelectQuery $query)
| query result getters

## Protected Member Functions

| gentlyGetByKey ($key)
| cacheById (Identifiable $object, $expires=Cache::EXPIRES_FOREVER)
| cachers
| getCachedByQuery (SelectQuery $query)
| internal helpers
| getCachedList (SelectQuery $query)
| cacheNullById ($id)
| keyToInt ($key)

## Detailed Description

Basis for transparent DAO workers.

See also:
  VoodooDaoWorker for obscure and greedy worker.
  SmartDaoWorker for less obscure locking-based worker.

Definition at line 20 of file TransparentDaoWorker.class.php.

## Member Function Documentation

TransparentDaoWorker::cacheById | ( | Identifiable $ | object,
|  | $ | expires = `Cache::EXPIRES_FOREVER` |
| ) |  |  | `[protected]`

cachers

Reimplemented from CommonDaoWorker.

Definition at line 187 of file TransparentDaoWorker.class.php.

References Identifiable::getId(), BaseDaoWorker::makeIdKey(), and Cache::me().

Referenced by SmartDaoWorker::cacheListByQuery().

Here is the call graph for this function:

TransparentDaoWorker::cacheNullById | ( | $ | id | ) | `[protected]`

Definition at line 220 of file TransparentDaoWorker.class.php.

References Cache::EXPIRES_FOREVER, BaseDaoWorker::makeIdKey(), Cache::me(), and Cache::NOT_FOUND.

Referenced by getById().

Here is the call graph for this function:

TransparentDaoWorker::gentlyGetByKey | ( | $ | key | ) | `[abstract, protected]`

Reimplemented in CacheDaoWorker, SmartDaoWorker, and VoodooDaoWorker.

Referenced by getCachedByQuery(), and getCachedList().

TransparentDaoWorker::getById | ( | $ | id | ) |

single object getters

Implements BaseDAO.

Definition at line 26 of file TransparentDaoWorker.class.php.

References cacheNullById(), and Cache::EXPIRES_FOREVER.

Referenced by getListByIds().

Here is the call graph for this function:

TransparentDaoWorker::getByLogic | ( | LogicalObject $ | logic | ) |

Implements BaseDAO.

Definition at line 38 of file TransparentDaoWorker.class.php.

References Cache::EXPIRES_FOREVER.

TransparentDaoWorker::getByQuery | ( | SelectQuery $ | query | ) |

Implements BaseDAO.

Definition at line 43 of file TransparentDaoWorker.class.php.

References CommonDaoWorker::cacheByQuery(), Cache::EXPIRES_FOREVER, and Cache::NOT_FOUND.

Here is the call graph for this function:

TransparentDaoWorker::getCachedByQuery | ( | SelectQuery $ | query | ) | `[protected]`

internal helpers

Reimplemented from BaseDaoWorker.

Definition at line 204 of file TransparentDaoWorker.class.php.

References gentlyGetByKey(), and BaseDaoWorker::makeQueryKey().

Here is the call graph for this function:

TransparentDaoWorker::getCachedList | ( | SelectQuery $ | query | ) | `[protected]`

Definition at line 212 of file TransparentDaoWorker.class.php.

References gentlyGetByKey(), and BaseDaoWorker::makeQueryKey().

Referenced by getListByQuery().

Here is the call graph for this function:

TransparentDaoWorker::getCustom | ( | SelectQuery $ | query | ) |

Implements BaseDAO.

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

References CommonDaoWorker::cacheByQuery(), Cache::EXPIRES_FOREVER, and Cache::NOT_FOUND.

Here is the call graph for this function:

TransparentDaoWorker::getCustomList | ( | SelectQuery $ | query | ) |

custom list getters

Implements BaseDAO.

Definition at line 152 of file TransparentDaoWorker.class.php.

References CommonDaoWorker::cacheByQuery(), Cache::EXPIRES_FOREVER, and Cache::NOT_FOUND.

Here is the call graph for this function:

TransparentDaoWorker::getCustomRowList | ( | SelectQuery $ | query | ) |

Implements BaseDAO.

Definition at line 164 of file TransparentDaoWorker.class.php.

References CommonDaoWorker::cacheByQuery(), Cache::EXPIRES_FOREVER, and Cache::NOT_FOUND.

Here is the call graph for this function:

TransparentDaoWorker::getListByIds | ( | array $ | ids | ) |

object's list getters

Implements BaseDAO.

Definition at line 70 of file TransparentDaoWorker.class.php.

References getById(), BaseDaoWorker::makeIdKey(), Cache::me(), and Cache::NOT_FOUND.

Here is the call graph for this function:

TransparentDaoWorker::getListByLogic | ( | LogicalObject $ | logic | ) |

Implements BaseDAO.

Definition at line 139 of file TransparentDaoWorker.class.php.

References Cache::EXPIRES_FOREVER.

TransparentDaoWorker::getListByQuery | ( | SelectQuery $ | query | ) |

Implements BaseDAO.

Definition at line 118 of file TransparentDaoWorker.class.php.

References CommonDaoWorker::cacheListByQuery(), BaseDaoWorker::fetchList(), getCachedList(), Assert::isUnreachable(), and Cache::NOT_FOUND.

Here is the call graph for this function:

TransparentDaoWorker::getPlainList | ( |  | ) |

Implements BaseDAO.

Definition at line 144 of file TransparentDaoWorker.class.php.

References Cache::EXPIRES_FOREVER.

TransparentDaoWorker::getQueryResult | ( | SelectQuery $ | query | ) |

query result getters

Implements BaseDAO.

Definition at line 179 of file TransparentDaoWorker.class.php.

References Cache::EXPIRES_FOREVER.

TransparentDaoWorker::keyToInt | ( | $ | key | ) | `[protected]`

Definition at line 231 of file TransparentDaoWorker.class.php.

Referenced by VoodooDaoWorker::__construct(), SmartDaoWorker::cacheByQuery(), SmartDaoWorker::cacheListByQuery(), SmartDaoWorker::checkMap(), and SmartDaoWorker::uncacheLists().

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

- main/DAOs/Workers/TransparentDaoWorker.class.php