CommonDaoWorker Class Reference
[Root classes for building DAO hierarchies]

Tunable (aka manual) caching DAO worker. More...

Inheritance diagram for CommonDaoWorker:

[legend]

List of all members.

Public Member Functions
	getById ($id, $expires=Cache::EXPIRES_MEDIUM)
	single object getters
	getByLogic (LogicalObject $logic, $expires=Cache::DO_NOT_CACHE)
	getByQuery (SelectQuery $query, $expires=Cache::DO_NOT_CACHE)
	getCustom (SelectQuery $query, $expires=Cache::DO_NOT_CACHE)
	getListByIds (array $ids, $expires=Cache::EXPIRES_MEDIUM)
	object's list getters
	getListByQuery (SelectQuery $query, $expires=Cache::DO_NOT_CACHE)
	getListByLogic (LogicalObject $logic, $expires=Cache::DO_NOT_CACHE)
	getPlainList ($expires=Cache::EXPIRES_MEDIUM)
	getTotalCount ($expires=Cache::DO_NOT_CACHE)
	getCustomList (SelectQuery $query, $expires=Cache::DO_NOT_CACHE)
	custom list getters
	getCustomRowList (SelectQuery $query, $expires=Cache::DO_NOT_CACHE)
	getQueryResult (SelectQuery $query, $expires=Cache::DO_NOT_CACHE)
	query result getters
	dropById ($id)
	erasers
	uncacheById ($id)
	uncachers
	uncacheByIds ($ids)
	uncacheLists ()
Protected Member Functions
	cacheById (Identifiable $object, $expires=Cache::EXPIRES_MEDIUM)
	cachers
	cacheByQuery (SelectQuery $query, $object, $expires=Cache::DO_NOT_CACHE)
	cacheListByQuery (SelectQuery $query, $array)

---

Detailed Description

Tunable (aka manual) caching DAO worker.

See also:

SmartDaoWorker for auto-caching one.

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

---

Member Function Documentation

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

single object getters

Definition at line 24 of file CommonDaoWorker.class.php.

References BaseDaoWorker::cachedFetchObject(), DBField::create(), Cache::DO_NOT_CACHE, Expression::eq(), BaseDaoWorker::fetchObject(), BaseDaoWorker::getCachedById(), DBPool::me(), and Cache::NOT_FOUND.

Here is the call graph for this function:

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

Definition at line 74 of file CommonDaoWorker.class.php.

References getByQuery().

Here is the call graph for this function:

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

Definition at line 84 of file CommonDaoWorker.class.php.

References BaseDaoWorker::cachedFetchObject(), Cache::DO_NOT_CACHE, BaseDaoWorker::fetchObject(), BaseDaoWorker::getCachedByQuery(), DBPool::me(), and Cache::NOT_FOUND.

Referenced by getByLogic().

Here is the call graph for this function:

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

Definition at line 121 of file CommonDaoWorker.class.php.

References cacheByQuery(), Cache::DO_NOT_CACHE, DBPool::getByDao(), BaseDaoWorker::getCachedByQuery(), DBPool::me(), and Cache::NOT_FOUND.

Referenced by getTotalCount().

Here is the call graph for this function:

CommonDaoWorker::getListByIds	(	array $	ids,
		$	expires = Cache::EXPIRES_MEDIUM
	)

object's list getters

Definition at line 166 of file CommonDaoWorker.class.php.

References Cache::DO_NOT_CACHE, getListByLogic(), Expression::in(), Cache::me(), and Cache::NOT_FOUND.

Here is the call graph for this function:

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

Definition at line 243 of file CommonDaoWorker.class.php.

References cacheByQuery(), Cache::DO_NOT_CACHE, BaseDaoWorker::fetchList(), BaseDaoWorker::getCachedByQuery(), DBPool::me(), and Cache::NOT_FOUND.

Referenced by getListByLogic(), and getPlainList().

Here is the call graph for this function:

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

Definition at line 278 of file CommonDaoWorker.class.php.

References getListByQuery().

Referenced by getListByIds().

Here is the call graph for this function:

CommonDaoWorker::getPlainList

(

$

expires = Cache::EXPIRES_MEDIUM

)

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

References getListByQuery().

Here is the call graph for this function:

CommonDaoWorker::getTotalCount

(

$

expires = Cache::DO_NOT_CACHE

)

Definition at line 295 of file CommonDaoWorker.class.php.

References DBValue::create(), SQLFunction::create(), getCustom(), and OSQL::select().

Here is the call graph for this function:

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

custom list getters

Definition at line 311 of file CommonDaoWorker.class.php.

References cacheByQuery(), Cache::DO_NOT_CACHE, DBPool::getByDao(), BaseDaoWorker::getCachedByQuery(), DBPool::me(), and Cache::NOT_FOUND.

Here is the call graph for this function:

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

Definition at line 346 of file CommonDaoWorker.class.php.

References cacheByQuery(), Cache::DO_NOT_CACHE, DBPool::getByDao(), BaseDaoWorker::getCachedByQuery(), DBPool::me(), and Cache::NOT_FOUND.

Here is the call graph for this function:

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

query result getters

Definition at line 389 of file CommonDaoWorker.class.php.

References cacheByQuery(), QueryResult::create(), SQLFunction::create(), Cache::DO_NOT_CACHE, BaseDaoWorker::fetchList(), DBPool::getByDao(), and BaseDaoWorker::getCachedByQuery().

Here is the call graph for this function:

CommonDaoWorker::cacheById	(	Identifiable $	object,
		$	expires = Cache::EXPIRES_MEDIUM
	)			[protected]

cachers

Reimplemented in NullDaoWorker, and TransparentDaoWorker.

Definition at line 430 of file CommonDaoWorker.class.php.

References Cache::DO_NOT_CACHE, Identifiable::getId(), and Cache::me().

Here is the call graph for this function:

CommonDaoWorker::cacheByQuery	(	SelectQuery $	query,
		$	object,
		$	expires = Cache::DO_NOT_CACHE
	)			[protected]

Reimplemented in CacheDaoWorker, NullDaoWorker, SmartDaoWorker, and VoodooDaoWorker.

Definition at line 447 of file CommonDaoWorker.class.php.

References Cache::DO_NOT_CACHE, and Cache::me().

Referenced by TransparentDaoWorker::getByQuery(), TransparentDaoWorker::getCustom(), getCustom(), TransparentDaoWorker::getCustomList(), getCustomList(), TransparentDaoWorker::getCustomRowList(), getCustomRowList(), getListByQuery(), and getQueryResult().

Here is the call graph for this function:

CommonDaoWorker::cacheListByQuery	(	SelectQuery $	query,
		$	array
	)			[protected]

Reimplemented in CacheDaoWorker, SmartDaoWorker, and VoodooDaoWorker.

Definition at line 466 of file CommonDaoWorker.class.php.

Referenced by TransparentDaoWorker::getListByQuery().

CommonDaoWorker::dropById

(

$

id

)

erasers

Reimplemented from BaseDaoWorker.

Definition at line 477 of file CommonDaoWorker.class.php.

CommonDaoWorker::uncacheById

(

$

id

)

uncachers

Reimplemented from BaseDaoWorker.

Reimplemented in NullDaoWorker.

Definition at line 489 of file CommonDaoWorker.class.php.

CommonDaoWorker::uncacheByIds

(

$

ids

)

Implements BaseDAO.

Reimplemented in NullDaoWorker.

Definition at line 496 of file CommonDaoWorker.class.php.

CommonDaoWorker::uncacheLists

(

)

Implements BaseDAO.

Reimplemented in CacheDaoWorker, NullDaoWorker, SmartDaoWorker, and VoodooDaoWorker.

Definition at line 505 of file CommonDaoWorker.class.php.

References BaseDaoWorker::uncacheByQuery().

Here is the call graph for this function:

---

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

• main/DAOs/Workers/CommonDaoWorker.class.php