main/Criteria/Criteria.class.php Source File home about examples API documentation download forum contacts

Criteria.class.php Go to the documentation of this file. <?php /**************************************************************************** * Copyright (C) 2006-2008 by Konstantin V. Arkhipov, Anton E. Lebedevich * * * * This program is free software; you can redistribute it and/or modify * * it under the terms of the GNU Lesser General Public License as * * published by the Free Software Foundation; either version 3 of the * * License, or (at your option) any later version. * * * ****************************************************************************/ /* $Id: Criteria.class.php 5209 2008-06-17 12:39:25Z voxus $ */ final class Criteria implements Stringable, DialectString { private $dao = null; private $daoClass = null; private $logic = null; private $order = null; private $strategy = null; private $projection = null; private $distinct = false; private $limit = null; private $offset = null; private $collections = array(); // dao-like behaviour: will throw ObjectNotFoundException when 'false' private $silent = true; public static function create(/* ProtoDAO */ $dao = null) { return new self($dao); } public function __construct(/* ProtoDAO */ $dao = null) { if ($dao) Assert::isTrue($dao instanceof ProtoDAO); $this->dao = $dao; $this->logic = Expression::andBlock(); $this->order = new OrderChain(); $this->strategy = FetchStrategy::join(); } public function __clone() { $this->logic = clone $this->logic; $this->order = clone $this->order; $this->strategy = clone $this->strategy; } public function __sleep() { $this->daoClass = get_class($this->dao); $vars = get_object_vars($this); unset($vars['dao']); return array_keys($vars); } public function __wakeup() { $this->dao = Singleton::getInstance($this->daoClass); } public function getDao() { return $this->dao; } public function setDao(ProtoDAO $dao) { $this->dao = $dao; return $this; } public function getLogic() { return $this->logic; } public function add(LogicalObject $logic) { $this->logic->expAnd($logic); return $this; } public function getOrder() { return $this->order; } public function addOrder(/* MapableObject */ $order) { if (!$order instanceof MappableObject) $order = new OrderBy($order); $this->order->add($order); return $this; } public function prependOrder(/* MapableObject */ $order) { if (!$order instanceof MappableObject) $order = new OrderBy($order); $this->order->prepend($order); return $this; } public function dropOrder() { $this->order = new OrderChain(); return $this; } public function getLimit() { return $this->limit; } public function setLimit($limit) { $this->limit = $limit; return $this; } public function getOffset() { return $this->offset; } public function setOffset($offset) { $this->offset = $offset; return $this; } public function getFetchStrategy() { return $this->strategy; } public function setFetchStrategy(FetchStrategy $strategy) { $this->strategy = $strategy; return $this; } public function setProjection(ObjectProjection $chain) { $this->projection = $chain; return $this; } public function getProjection() { return $this->projection; } public function dropProjection() { $this->projection = null; return $this; } public function setDistinct($orly = true) { $this->distinct = ($orly === true); return $this; } public function isDistinct() { return $this->distinct; } public function isSilent() { return $this->silent; } public function setSilent($silent) { Assert::isBoolean($silent); $this->silent = $silent; return $this; } public function fetchCollection( $path, // to collection $lazy = false, // fetching mode /* Criteria */ $criteria = null ) { Assert::isBoolean($lazy); Assert::isTrue( ($criteria === null) || ($criteria instanceof Criteria) ); $this->collections[$path]['lazy'] = $lazy; $this->collections[$path]['criteria'] = $criteria; $this->collections[$path]['propertyPath'] = new PropertyPath($this->dao->getObjectName(), $path); return $this; } public function get() { try { $list = array($this->dao->getByQuery($this->toSelectQuery())); } catch (ObjectNotFoundException $e) { if (!$this->isSilent()) throw $e; return null; } if (!$this->collections) return reset($list); $list = $this->dao->fetchCollections($this->collections, $list); return reset($list); } public function getList() { try { $list = $this->dao->getListByQuery($this->toSelectQuery()); } catch (ObjectNotFoundException $e) { if (!$this->isSilent()) throw $e; return array(); } if (!$this->collections) return $list; return $this->dao->fetchCollections($this->collections, $list); } public function getResult() { $result = $this->dao->getQueryResult($this->toSelectQuery()); if (!$this->collections) return $result; return $result->setList( $this->dao->fetchCollections( $this->collections, $result->getList() ) ); } public function getCustom($index = null) { try { $result = $this->dao->getCustom($this->toSelectQuery()); if ($index) { if (isset($result[$index])) return $result[$index]; throw new MissingElementException(); } return $result; } catch (ObjectNotFoundException $e) { if (!$this->isSilent()) throw $e; return null; } } public function getCustomList() { try { return $this->dao->getCustomList($this->toSelectQuery()); } catch (ObjectNotFoundException $e) { if (!$this->isSilent()) throw $e; return array(); } } public function getPropertyList() { try { return $this->dao->getCustomRowList($this->toSelectQuery()); } catch (ObjectNotFoundException $e) { if (!$this->isSilent()) throw $e; return array(); } } public function toString() { return $this->toDialectString( $this->dao ? DBPool::getByDao($this->dao)->getDialect() : ImaginaryDialect::me() ); } public function toDialectString(Dialect $dialect) { return $this->toSelectQuery()->toDialectString($dialect); } public function toSelectQuery() { Assert::isNotNull($this->dao, 'DAO not set'); if ($this->projection) { $query = $this->getProjection()->process( $this, $this->dao->makeSelectHead()-> dropFields() ); } else $query = $this->dao->makeSelectHead(); return $this->fillSelectQuery($query); } public function fillSelectQuery(SelectQuery $query) { $query-> limit($this->limit, $this->offset); if ($this->distinct) $query->distinct(); if ($this->logic->getSize()) { $query-> andWhere( $this->logic->toMapped($this->dao, $query) ); } if ($this->order) { $query->setOrderChain($this->order->toMapped($this->dao, $query)); } if ( !$this->projection && ( $this->strategy->getId() <> FetchStrategy::CASCADE ) ) { $this->joinProperties($query, $this->dao, $this->dao->getTable(), true); } return $query; } private function joinProperties( SelectQuery $query, ProtoDAO $parentDao, $parentTable, $parentRequired, $prefix = null ) { $proto = call_user_func(array($parentDao->getObjectName(), 'proto')); foreach ($proto->getPropertyList() as $property) { if ( ($property instanceof LightMetaProperty) && $property->getRelationId() == MetaRelation::ONE_TO_ONE && !$property->isGenericType() && $property->getFetchStrategyId() <> FetchStrategy::CASCADE ) { if ( is_subclass_of( $property->getClassName(), 'Enumeration' ) ) { // field already added by makeSelectHead continue; } elseif ($property->isInner()) { $proto = call_user_func( array($property->getClassName(), 'proto') ); foreach ($proto->getPropertyList() as $innerProperty) $query->get( new DBField( $innerProperty->getColumnName(), $parentTable ) ); continue; } $propertyDao = call_user_func( array($property->getClassName(), 'dao') ); // add's custom dao's injection possibility if (!$propertyDao instanceof ProtoDAO) continue; $tableAlias = $propertyDao->getJoinName( $property->getColumnName(), $prefix ); $fields = $propertyDao->getFields(); if (!$query->hasJoinedTable($tableAlias)) { $logic = Expression::eq( DBField::create( $property->getColumnName(), $parentTable ), DBField::create( $propertyDao->getIdName(), $tableAlias ) ); if ($property->isRequired() && $parentRequired) $query->join($propertyDao->getTable(), $logic, $tableAlias); else $query->leftJoin($propertyDao->getTable(), $logic, $tableAlias); } foreach ($fields as $field) { $query->get( new DBField($field, $tableAlias), $propertyDao->getJoinPrefix($property->getColumnName(), $prefix) .$field ); } $this->joinProperties( $query, $propertyDao, $tableAlias, $property->isRequired() && $parentRequired, $propertyDao->getJoinPrefix($property->getColumnName(), $prefix) ); } } } private function getProto() { return call_user_func( array($this->dao->getObjectName(), 'proto') ); } } ?>

generated by doxygen-1.5.5 for onPHP at Tue Jun 17 16:42:54 2008