123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448 |
- <?php
- /*
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
- * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- *
- * This software consists of voluntary contributions made by many individuals
- * and is licensed under the MIT license. For more information, see
- * <http://www.doctrine-project.org>.
- */
- namespace Doctrine\ORM\Query;
- use Doctrine\ORM\EntityManager;
- use Doctrine\ORM\Mapping\ClassMetadataInfo;
- /**
- * A ResultSetMappingBuilder uses the EntityManager to automatically populate entity fields.
- *
- * @author Michael Ridgway <mcridgway@gmail.com>
- * @since 2.1
- */
- class ResultSetMappingBuilder extends ResultSetMapping
- {
- /**
- * Picking this rename mode will register entity columns as is,
- * as they are in the database. This can cause clashes when multiple
- * entities are fetched that have columns with the same name.
- *
- * @var int
- */
- const COLUMN_RENAMING_NONE = 1;
- /**
- * Picking custom renaming allows the user to define the renaming
- * of specific columns with a rename array that contains column names as
- * keys and result alias as values.
- *
- * @var int
- */
- const COLUMN_RENAMING_CUSTOM = 2;
- /**
- * Incremental renaming uses a result set mapping internal counter to add a
- * number to each column result, leading to uniqueness. This only works if
- * you use {@see generateSelectClause()} to generate the SELECT clause for
- * you.
- *
- * @var int
- */
- const COLUMN_RENAMING_INCREMENT = 3;
- /**
- * @var int
- */
- private $sqlCounter = 0;
- /**
- * @var EntityManager
- */
- private $em;
- /**
- * Default column renaming mode.
- *
- * @var int
- */
- private $defaultRenameMode;
- /**
- * @param EntityManager $em
- * @param integer $defaultRenameMode
- */
- public function __construct(EntityManager $em, $defaultRenameMode = self::COLUMN_RENAMING_NONE)
- {
- $this->em = $em;
- $this->defaultRenameMode = $defaultRenameMode;
- }
- /**
- * Adds a root entity and all of its fields to the result set.
- *
- * @param string $class The class name of the root entity.
- * @param string $alias The unique alias to use for the root entity.
- * @param array $renamedColumns Columns that have been renamed (tableColumnName => queryColumnName).
- * @param int|null $renameMode One of the COLUMN_RENAMING_* constants or array for BC reasons (CUSTOM).
- *
- * @return void
- */
- public function addRootEntityFromClassMetadata($class, $alias, $renamedColumns = array(), $renameMode = null)
- {
- $renameMode = $renameMode ?: $this->defaultRenameMode;
- $columnAliasMap = $this->getColumnAliasMap($class, $renameMode, $renamedColumns);
- $this->addEntityResult($class, $alias);
- $this->addAllClassFields($class, $alias, $columnAliasMap);
- }
- /**
- * Adds a joined entity and all of its fields to the result set.
- *
- * @param string $class The class name of the joined entity.
- * @param string $alias The unique alias to use for the joined entity.
- * @param string $parentAlias The alias of the entity result that is the parent of this joined result.
- * @param object $relation The association field that connects the parent entity result
- * with the joined entity result.
- * @param array $renamedColumns Columns that have been renamed (tableColumnName => queryColumnName).
- * @param int|null $renameMode One of the COLUMN_RENAMING_* constants or array for BC reasons (CUSTOM).
- *
- * @return void
- */
- public function addJoinedEntityFromClassMetadata($class, $alias, $parentAlias, $relation, $renamedColumns = array(), $renameMode = null)
- {
- $renameMode = $renameMode ?: $this->defaultRenameMode;
- $columnAliasMap = $this->getColumnAliasMap($class, $renameMode, $renamedColumns);
- $this->addJoinedEntityResult($class, $alias, $parentAlias, $relation);
- $this->addAllClassFields($class, $alias, $columnAliasMap);
- }
- /**
- * Adds all fields of the given class to the result set mapping (columns and meta fields).
- *
- * @param string $class
- * @param string $alias
- * @param array $columnAliasMap
- *
- * @return void
- *
- * @throws \InvalidArgumentException
- */
- protected function addAllClassFields($class, $alias, $columnAliasMap = array())
- {
- $classMetadata = $this->em->getClassMetadata($class);
- $platform = $this->em->getConnection()->getDatabasePlatform();
- if ($classMetadata->isInheritanceTypeSingleTable() || $classMetadata->isInheritanceTypeJoined()) {
- throw new \InvalidArgumentException('ResultSetMapping builder does not currently support inheritance.');
- }
- foreach ($classMetadata->getColumnNames() as $columnName) {
- $propertyName = $classMetadata->getFieldName($columnName);
- $columnAlias = $platform->getSQLResultCasing($columnAliasMap[$columnName]);
- if (isset($this->fieldMappings[$columnAlias])) {
- throw new \InvalidArgumentException("The column '$columnName' conflicts with another column in the mapper.");
- }
- $this->addFieldResult($alias, $columnAlias, $propertyName);
- }
- foreach ($classMetadata->associationMappings as $associationMapping) {
- if ($associationMapping['isOwningSide'] && $associationMapping['type'] & ClassMetadataInfo::TO_ONE) {
- foreach ($associationMapping['joinColumns'] as $joinColumn) {
- $columnName = $joinColumn['name'];
- $columnAlias = $platform->getSQLResultCasing($columnAliasMap[$columnName]);
- if (isset($this->metaMappings[$columnAlias])) {
- throw new \InvalidArgumentException("The column '$columnAlias' conflicts with another column in the mapper.");
- }
- $this->addMetaResult(
- $alias,
- $columnAlias,
- $columnName,
- (isset($associationMapping['id']) && $associationMapping['id'] === true)
- );
- }
- }
- }
- }
- /**
- * Gets column alias for a given column.
- *
- * @param string $columnName
- * @param int $mode
- * @param array $customRenameColumns
- *
- * @return string
- */
- private function getColumnAlias($columnName, $mode, array $customRenameColumns)
- {
- switch ($mode) {
- case self::COLUMN_RENAMING_INCREMENT:
- return $columnName . $this->sqlCounter++;
- case self::COLUMN_RENAMING_CUSTOM:
- return isset($customRenameColumns[$columnName])
- ? $customRenameColumns[$columnName] : $columnName;
- case self::COLUMN_RENAMING_NONE:
- return $columnName;
- }
- }
- /**
- * Retrieves a class columns and join columns aliases that are used in the SELECT clause.
- *
- * This depends on the renaming mode selected by the user.
- *
- * @param string $className
- * @param int $mode
- * @param array $customRenameColumns
- *
- * @return array
- */
- private function getColumnAliasMap($className, $mode, array $customRenameColumns)
- {
- if ($customRenameColumns) { // for BC with 2.2-2.3 API
- $mode = self::COLUMN_RENAMING_CUSTOM;
- }
- $columnAlias = array();
- $class = $this->em->getClassMetadata($className);
- foreach ($class->getColumnNames() as $columnName) {
- $columnAlias[$columnName] = $this->getColumnAlias($columnName, $mode, $customRenameColumns);
- }
- foreach ($class->associationMappings as $associationMapping) {
- if ($associationMapping['isOwningSide'] && $associationMapping['type'] & ClassMetadataInfo::TO_ONE) {
- foreach ($associationMapping['joinColumns'] as $joinColumn) {
- $columnName = $joinColumn['name'];
- $columnAlias[$columnName] = $this->getColumnAlias($columnName, $mode, $customRenameColumns);
- }
- }
- }
- return $columnAlias;
- }
- /**
- * Adds the mappings of the results of native SQL queries to the result set.
- *
- * @param ClassMetadataInfo $class
- * @param array $queryMapping
- *
- * @return ResultSetMappingBuilder
- */
- public function addNamedNativeQueryMapping(ClassMetadataInfo $class, array $queryMapping)
- {
- if (isset($queryMapping['resultClass'])) {
- return $this->addNamedNativeQueryResultClassMapping($class, $queryMapping['resultClass']);
- }
- return $this->addNamedNativeQueryResultSetMapping($class, $queryMapping['resultSetMapping']);
- }
- /**
- * Adds the class mapping of the results of native SQL queries to the result set.
- *
- * @param ClassMetadataInfo $class
- * @param string $resultClassName
- *
- * @return ResultSetMappingBuilder
- */
- public function addNamedNativeQueryResultClassMapping(ClassMetadataInfo $class, $resultClassName)
- {
- $classMetadata = $this->em->getClassMetadata($resultClassName);
- $shortName = $classMetadata->reflClass->getShortName();
- $alias = strtolower($shortName[0]).'0';
- $this->addEntityResult($class->name, $alias);
- if ($classMetadata->discriminatorColumn) {
- $discriminatorColumn = $classMetadata->discriminatorColumn;
- $this->setDiscriminatorColumn($alias, $discriminatorColumn['name']);
- $this->addMetaResult($alias, $discriminatorColumn['name'], $discriminatorColumn['fieldName']);
- }
- foreach ($classMetadata->getColumnNames() as $key => $columnName) {
- $propertyName = $classMetadata->getFieldName($columnName);
- $this->addFieldResult($alias, $columnName, $propertyName);
- }
- foreach ($classMetadata->associationMappings as $associationMapping) {
- if ($associationMapping['isOwningSide'] && $associationMapping['type'] & ClassMetadataInfo::TO_ONE) {
- foreach ($associationMapping['joinColumns'] as $joinColumn) {
- $columnName = $joinColumn['name'];
- $this->addMetaResult($alias, $columnName, $columnName, $classMetadata->isIdentifier($columnName));
- }
- }
- }
- return $this;
- }
- /**
- * Adds the result set mapping of the results of native SQL queries to the result set.
- *
- * @param ClassMetadataInfo $class
- * @param string $resultSetMappingName
- *
- * @return ResultSetMappingBuilder
- */
- public function addNamedNativeQueryResultSetMapping(ClassMetadataInfo $class, $resultSetMappingName)
- {
- $counter = 0;
- $resultMapping = $class->getSqlResultSetMapping($resultSetMappingName);
- $rooShortName = $class->reflClass->getShortName();
- $rootAlias = strtolower($rooShortName[0]) . $counter;
- if (isset($resultMapping['entities'])) {
- foreach ($resultMapping['entities'] as $key => $entityMapping) {
- $classMetadata = $this->em->getClassMetadata($entityMapping['entityClass']);
- if ($class->reflClass->name == $classMetadata->reflClass->name) {
- $this->addEntityResult($classMetadata->name, $rootAlias);
- $this->addNamedNativeQueryEntityResultMapping($classMetadata, $entityMapping, $rootAlias);
- } else {
- $shortName = $classMetadata->reflClass->getShortName();
- $joinAlias = strtolower($shortName[0]) . ++ $counter;
- $associations = $class->getAssociationsByTargetClass($classMetadata->name);
- foreach ($associations as $relation => $mapping) {
- $this->addJoinedEntityResult($mapping['targetEntity'], $joinAlias, $rootAlias, $relation);
- $this->addNamedNativeQueryEntityResultMapping($classMetadata, $entityMapping, $joinAlias);
- }
- }
- }
- }
- if (isset($resultMapping['columns'])) {
- foreach ($resultMapping['columns'] as $entityMapping) {
- $this->addScalarResult($entityMapping['name'], $entityMapping['name']);
- }
- }
- return $this;
- }
- /**
- * Adds the entity result mapping of the results of native SQL queries to the result set.
- *
- * @param ClassMetadataInfo $classMetadata
- * @param array $entityMapping
- * @param string $alias
- *
- * @return ResultSetMappingBuilder
- *
- * @throws \InvalidArgumentException
- */
- public function addNamedNativeQueryEntityResultMapping(ClassMetadataInfo $classMetadata, array $entityMapping, $alias)
- {
- if (isset($entityMapping['discriminatorColumn']) && $entityMapping['discriminatorColumn']) {
- $discriminatorColumn = $entityMapping['discriminatorColumn'];
- $this->setDiscriminatorColumn($alias, $discriminatorColumn);
- $this->addMetaResult($alias, $discriminatorColumn, $discriminatorColumn);
- }
- if (isset($entityMapping['fields']) && !empty($entityMapping['fields'])) {
- foreach ($entityMapping['fields'] as $field) {
- $fieldName = $field['name'];
- $relation = null;
- if(strpos($fieldName, '.')){
- list($relation, $fieldName) = explode('.', $fieldName);
- }
- if (isset($classMetadata->associationMappings[$relation])) {
- if($relation) {
- $associationMapping = $classMetadata->associationMappings[$relation];
- $joinAlias = $alias.$relation;
- $parentAlias = $alias;
- $this->addJoinedEntityResult($associationMapping['targetEntity'], $joinAlias, $parentAlias, $relation);
- $this->addFieldResult($joinAlias, $field['column'], $fieldName);
- }else {
- $this->addFieldResult($alias, $field['column'], $fieldName, $classMetadata->name);
- }
- } else {
- if(!isset($classMetadata->fieldMappings[$fieldName])) {
- throw new \InvalidArgumentException("Entity '".$classMetadata->name."' has no field '".$fieldName."'. ");
- }
- $this->addFieldResult($alias, $field['column'], $fieldName, $classMetadata->name);
- }
- }
- } else {
- foreach ($classMetadata->getColumnNames() as $columnName) {
- $propertyName = $classMetadata->getFieldName($columnName);
- $this->addFieldResult($alias, $columnName, $propertyName);
- }
- }
- return $this;
- }
- /**
- * Generates the Select clause from this ResultSetMappingBuilder.
- *
- * Works only for all the entity results. The select parts for scalar
- * expressions have to be written manually.
- *
- * @param array $tableAliases
- *
- * @return string
- */
- public function generateSelectClause($tableAliases = array())
- {
- $sql = "";
- foreach ($this->columnOwnerMap as $columnName => $dqlAlias) {
- $tableAlias = isset($tableAliases[$dqlAlias])
- ? $tableAliases[$dqlAlias] : $dqlAlias;
- if ($sql) {
- $sql .= ", ";
- }
- $sql .= $tableAlias . ".";
- if (isset($this->fieldMappings[$columnName])) {
- $class = $this->em->getClassMetadata($this->declaringClasses[$columnName]);
- $sql .= $class->fieldMappings[$this->fieldMappings[$columnName]]['columnName'];
- } else if (isset($this->metaMappings[$columnName])) {
- $sql .= $this->metaMappings[$columnName];
- } else if (isset($this->discriminatorColumn[$columnName])) {
- $sql .= $this->discriminatorColumn[$columnName];
- }
- $sql .= " AS " . $columnName;
- }
- return $sql;
- }
- /**
- * @return string
- */
- public function __toString()
- {
- return $this->generateSelectClause(array());
- }
- }
|