eb762dea23
Doctrine is affected by PHP bug #62577. simplexml_load_file is not able to load files if libxml_disable_entity_loader(true) has been called. simplexml_load_file fails with the message: I/O warning : failed to load external entity "/my/mappings/my_entity.dcm.xml" in /path-to/lib/Doctrine/ORM/Mapping/Driver/XmlDriver.php on line 711 This error occurs even if there are no external entities in the XML file. Waiting for the PHP bug to be resolved is infeasible, because it is unresolved since years. Therefore Doctrine needs to circumvent the bug by replacing simplexml_load_file with simplexml_load_string while getting the file contents itself. simplexml_load_string is not affected by the PHP bug.
875 lines
35 KiB
PHP
875 lines
35 KiB
PHP
<?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\Mapping\Driver;
|
|
|
|
use SimpleXMLElement;
|
|
use Doctrine\Common\Persistence\Mapping\Driver\FileDriver;
|
|
use Doctrine\ORM\Mapping\Builder\EntityListenerBuilder;
|
|
use Doctrine\Common\Persistence\Mapping\ClassMetadata;
|
|
use Doctrine\ORM\Mapping\MappingException;
|
|
use Doctrine\ORM\Mapping\ClassMetadata as Metadata;
|
|
|
|
/**
|
|
* XmlDriver is a metadata driver that enables mapping through XML files.
|
|
*
|
|
* @license http://www.opensource.org/licenses/mit-license.php MIT
|
|
* @link www.doctrine-project.org
|
|
* @since 2.0
|
|
* @author Benjamin Eberlei <kontakt@beberlei.de>
|
|
* @author Guilherme Blanco <guilhermeblanco@hotmail.com>
|
|
* @author Jonathan H. Wage <jonwage@gmail.com>
|
|
* @author Roman Borschel <roman@code-factory.org>
|
|
*/
|
|
class XmlDriver extends FileDriver
|
|
{
|
|
const DEFAULT_FILE_EXTENSION = '.dcm.xml';
|
|
|
|
/**
|
|
* {@inheritDoc}
|
|
*/
|
|
public function __construct($locator, $fileExtension = self::DEFAULT_FILE_EXTENSION)
|
|
{
|
|
parent::__construct($locator, $fileExtension);
|
|
}
|
|
|
|
/**
|
|
* {@inheritDoc}
|
|
*/
|
|
public function loadMetadataForClass($className, ClassMetadata $metadata)
|
|
{
|
|
/* @var $metadata \Doctrine\ORM\Mapping\ClassMetadataInfo */
|
|
/* @var $xmlRoot SimpleXMLElement */
|
|
$xmlRoot = $this->getElement($className);
|
|
|
|
if ($xmlRoot->getName() == 'entity') {
|
|
if (isset($xmlRoot['repository-class'])) {
|
|
$metadata->setCustomRepositoryClass((string) $xmlRoot['repository-class']);
|
|
}
|
|
if (isset($xmlRoot['read-only']) && $this->evaluateBoolean($xmlRoot['read-only'])) {
|
|
$metadata->markReadOnly();
|
|
}
|
|
} else if ($xmlRoot->getName() == 'mapped-superclass') {
|
|
$metadata->setCustomRepositoryClass(
|
|
isset($xmlRoot['repository-class']) ? (string) $xmlRoot['repository-class'] : null
|
|
);
|
|
$metadata->isMappedSuperclass = true;
|
|
} else if ($xmlRoot->getName() == 'embeddable') {
|
|
$metadata->isEmbeddedClass = true;
|
|
} else {
|
|
throw MappingException::classIsNotAValidEntityOrMappedSuperClass($className);
|
|
}
|
|
|
|
// Evaluate <entity...> attributes
|
|
$primaryTable = [];
|
|
|
|
if (isset($xmlRoot['table'])) {
|
|
$primaryTable['name'] = (string) $xmlRoot['table'];
|
|
}
|
|
|
|
if (isset($xmlRoot['schema'])) {
|
|
$primaryTable['schema'] = (string) $xmlRoot['schema'];
|
|
}
|
|
|
|
$metadata->setPrimaryTable($primaryTable);
|
|
|
|
// Evaluate second level cache
|
|
if (isset($xmlRoot->cache)) {
|
|
$metadata->enableCache($this->cacheToArray($xmlRoot->cache));
|
|
}
|
|
|
|
// Evaluate named queries
|
|
if (isset($xmlRoot->{'named-queries'})) {
|
|
foreach ($xmlRoot->{'named-queries'}->{'named-query'} as $namedQueryElement) {
|
|
$metadata->addNamedQuery(
|
|
[
|
|
'name' => (string) $namedQueryElement['name'],
|
|
'query' => (string) $namedQueryElement['query']
|
|
]
|
|
);
|
|
}
|
|
}
|
|
|
|
// Evaluate native named queries
|
|
if (isset($xmlRoot->{'named-native-queries'})) {
|
|
foreach ($xmlRoot->{'named-native-queries'}->{'named-native-query'} as $nativeQueryElement) {
|
|
$metadata->addNamedNativeQuery(
|
|
[
|
|
'name' => isset($nativeQueryElement['name']) ? (string) $nativeQueryElement['name'] : null,
|
|
'query' => isset($nativeQueryElement->query) ? (string) $nativeQueryElement->query : null,
|
|
'resultClass' => isset($nativeQueryElement['result-class']) ? (string) $nativeQueryElement['result-class'] : null,
|
|
'resultSetMapping' => isset($nativeQueryElement['result-set-mapping']) ? (string) $nativeQueryElement['result-set-mapping'] : null,
|
|
]
|
|
);
|
|
}
|
|
}
|
|
|
|
// Evaluate sql result set mapping
|
|
if (isset($xmlRoot->{'sql-result-set-mappings'})) {
|
|
foreach ($xmlRoot->{'sql-result-set-mappings'}->{'sql-result-set-mapping'} as $rsmElement) {
|
|
$entities = [];
|
|
$columns = [];
|
|
foreach ($rsmElement as $entityElement) {
|
|
//<entity-result/>
|
|
if (isset($entityElement['entity-class'])) {
|
|
$entityResult = [
|
|
'fields' => [],
|
|
'entityClass' => (string) $entityElement['entity-class'],
|
|
'discriminatorColumn' => isset($entityElement['discriminator-column']) ? (string) $entityElement['discriminator-column'] : null,
|
|
];
|
|
|
|
foreach ($entityElement as $fieldElement) {
|
|
$entityResult['fields'][] = [
|
|
'name' => isset($fieldElement['name']) ? (string) $fieldElement['name'] : null,
|
|
'column' => isset($fieldElement['column']) ? (string) $fieldElement['column'] : null,
|
|
];
|
|
}
|
|
|
|
$entities[] = $entityResult;
|
|
}
|
|
|
|
//<column-result/>
|
|
if (isset($entityElement['name'])) {
|
|
$columns[] = [
|
|
'name' => (string) $entityElement['name'],
|
|
];
|
|
}
|
|
}
|
|
|
|
$metadata->addSqlResultSetMapping(
|
|
[
|
|
'name' => (string) $rsmElement['name'],
|
|
'entities' => $entities,
|
|
'columns' => $columns
|
|
]
|
|
);
|
|
}
|
|
}
|
|
|
|
if (isset($xmlRoot['inheritance-type'])) {
|
|
$inheritanceType = (string) $xmlRoot['inheritance-type'];
|
|
$metadata->setInheritanceType(constant('Doctrine\ORM\Mapping\ClassMetadata::INHERITANCE_TYPE_' . $inheritanceType));
|
|
|
|
if ($metadata->inheritanceType != Metadata::INHERITANCE_TYPE_NONE) {
|
|
// Evaluate <discriminator-column...>
|
|
if (isset($xmlRoot->{'discriminator-column'})) {
|
|
$discrColumn = $xmlRoot->{'discriminator-column'};
|
|
$metadata->setDiscriminatorColumn(
|
|
[
|
|
'name' => isset($discrColumn['name']) ? (string) $discrColumn['name'] : null,
|
|
'type' => isset($discrColumn['type']) ? (string) $discrColumn['type'] : 'string',
|
|
'length' => isset($discrColumn['length']) ? (string) $discrColumn['length'] : 255,
|
|
'columnDefinition' => isset($discrColumn['column-definition']) ? (string) $discrColumn['column-definition'] : null
|
|
]
|
|
);
|
|
} else {
|
|
$metadata->setDiscriminatorColumn(['name' => 'dtype', 'type' => 'string', 'length' => 255]);
|
|
}
|
|
|
|
// Evaluate <discriminator-map...>
|
|
if (isset($xmlRoot->{'discriminator-map'})) {
|
|
$map = [];
|
|
foreach ($xmlRoot->{'discriminator-map'}->{'discriminator-mapping'} as $discrMapElement) {
|
|
$map[(string) $discrMapElement['value']] = (string) $discrMapElement['class'];
|
|
}
|
|
$metadata->setDiscriminatorMap($map);
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
// Evaluate <change-tracking-policy...>
|
|
if (isset($xmlRoot['change-tracking-policy'])) {
|
|
$metadata->setChangeTrackingPolicy(constant('Doctrine\ORM\Mapping\ClassMetadata::CHANGETRACKING_'
|
|
. strtoupper((string) $xmlRoot['change-tracking-policy'])));
|
|
}
|
|
|
|
// Evaluate <indexes...>
|
|
if (isset($xmlRoot->indexes)) {
|
|
$metadata->table['indexes'] = [];
|
|
foreach ($xmlRoot->indexes->index as $indexXml) {
|
|
$index = ['columns' => explode(',', (string) $indexXml['columns'])];
|
|
|
|
if (isset($indexXml['flags'])) {
|
|
$index['flags'] = explode(',', (string) $indexXml['flags']);
|
|
}
|
|
|
|
if (isset($indexXml->options)) {
|
|
$index['options'] = $this->_parseOptions($indexXml->options->children());
|
|
}
|
|
|
|
if (isset($indexXml['name'])) {
|
|
$metadata->table['indexes'][(string) $indexXml['name']] = $index;
|
|
} else {
|
|
$metadata->table['indexes'][] = $index;
|
|
}
|
|
}
|
|
}
|
|
|
|
// Evaluate <unique-constraints..>
|
|
if (isset($xmlRoot->{'unique-constraints'})) {
|
|
$metadata->table['uniqueConstraints'] = [];
|
|
foreach ($xmlRoot->{'unique-constraints'}->{'unique-constraint'} as $uniqueXml) {
|
|
$unique = ['columns' => explode(',', (string) $uniqueXml['columns'])];
|
|
|
|
if (isset($uniqueXml->options)) {
|
|
$unique['options'] = $this->_parseOptions($uniqueXml->options->children());
|
|
}
|
|
|
|
if (isset($uniqueXml['name'])) {
|
|
$metadata->table['uniqueConstraints'][(string) $uniqueXml['name']] = $unique;
|
|
} else {
|
|
$metadata->table['uniqueConstraints'][] = $unique;
|
|
}
|
|
}
|
|
}
|
|
|
|
if (isset($xmlRoot->options)) {
|
|
$metadata->table['options'] = $this->_parseOptions($xmlRoot->options->children());
|
|
}
|
|
|
|
// The mapping assignment is done in 2 times as a bug might occurs on some php/xml lib versions
|
|
// The internal SimpleXmlIterator get resetted, to this generate a duplicate field exception
|
|
$mappings = [];
|
|
// Evaluate <field ...> mappings
|
|
if (isset($xmlRoot->field)) {
|
|
foreach ($xmlRoot->field as $fieldMapping) {
|
|
$mapping = $this->columnToArray($fieldMapping);
|
|
|
|
if (isset($mapping['version'])) {
|
|
$metadata->setVersionMapping($mapping);
|
|
unset($mapping['version']);
|
|
}
|
|
|
|
$metadata->mapField($mapping);
|
|
}
|
|
}
|
|
|
|
if (isset($xmlRoot->embedded)) {
|
|
foreach ($xmlRoot->embedded as $embeddedMapping) {
|
|
$columnPrefix = isset($embeddedMapping['column-prefix'])
|
|
? (string) $embeddedMapping['column-prefix']
|
|
: null;
|
|
|
|
$useColumnPrefix = isset($embeddedMapping['use-column-prefix'])
|
|
? $this->evaluateBoolean($embeddedMapping['use-column-prefix'])
|
|
: true;
|
|
|
|
$mapping = [
|
|
'fieldName' => (string) $embeddedMapping['name'],
|
|
'class' => (string) $embeddedMapping['class'],
|
|
'columnPrefix' => $useColumnPrefix ? $columnPrefix : false
|
|
];
|
|
|
|
$metadata->mapEmbedded($mapping);
|
|
}
|
|
}
|
|
|
|
foreach ($mappings as $mapping) {
|
|
if (isset($mapping['version'])) {
|
|
$metadata->setVersionMapping($mapping);
|
|
}
|
|
|
|
$metadata->mapField($mapping);
|
|
}
|
|
|
|
// Evaluate <id ...> mappings
|
|
$associationIds = [];
|
|
foreach ($xmlRoot->id as $idElement) {
|
|
if (isset($idElement['association-key']) && $this->evaluateBoolean($idElement['association-key'])) {
|
|
$associationIds[(string) $idElement['name']] = true;
|
|
continue;
|
|
}
|
|
|
|
$mapping = [
|
|
'id' => true,
|
|
'fieldName' => (string) $idElement['name']
|
|
];
|
|
|
|
if (isset($idElement['type'])) {
|
|
$mapping['type'] = (string) $idElement['type'];
|
|
}
|
|
|
|
if (isset($idElement['length'])) {
|
|
$mapping['length'] = (string) $idElement['length'];
|
|
}
|
|
|
|
if (isset($idElement['column'])) {
|
|
$mapping['columnName'] = (string) $idElement['column'];
|
|
}
|
|
|
|
if (isset($idElement['column-definition'])) {
|
|
$mapping['columnDefinition'] = (string) $idElement['column-definition'];
|
|
}
|
|
|
|
if (isset($idElement->options)) {
|
|
$mapping['options'] = $this->_parseOptions($idElement->options->children());
|
|
}
|
|
|
|
$metadata->mapField($mapping);
|
|
|
|
if (isset($idElement->generator)) {
|
|
$strategy = isset($idElement->generator['strategy']) ?
|
|
(string) $idElement->generator['strategy'] : 'AUTO';
|
|
$metadata->setIdGeneratorType(constant('Doctrine\ORM\Mapping\ClassMetadata::GENERATOR_TYPE_'
|
|
. $strategy));
|
|
}
|
|
|
|
// Check for SequenceGenerator/TableGenerator definition
|
|
if (isset($idElement->{'sequence-generator'})) {
|
|
$seqGenerator = $idElement->{'sequence-generator'};
|
|
$metadata->setSequenceGeneratorDefinition(
|
|
[
|
|
'sequenceName' => (string) $seqGenerator['sequence-name'],
|
|
'allocationSize' => (string) $seqGenerator['allocation-size'],
|
|
'initialValue' => (string) $seqGenerator['initial-value']
|
|
]
|
|
);
|
|
} else if (isset($idElement->{'custom-id-generator'})) {
|
|
$customGenerator = $idElement->{'custom-id-generator'};
|
|
$metadata->setCustomGeneratorDefinition(
|
|
[
|
|
'class' => (string) $customGenerator['class']
|
|
]
|
|
);
|
|
} else if (isset($idElement->{'table-generator'})) {
|
|
throw MappingException::tableIdGeneratorNotImplemented($className);
|
|
}
|
|
}
|
|
|
|
// Evaluate <one-to-one ...> mappings
|
|
if (isset($xmlRoot->{'one-to-one'})) {
|
|
foreach ($xmlRoot->{'one-to-one'} as $oneToOneElement) {
|
|
$mapping = [
|
|
'fieldName' => (string) $oneToOneElement['field'],
|
|
'targetEntity' => (string) $oneToOneElement['target-entity']
|
|
];
|
|
|
|
if (isset($associationIds[$mapping['fieldName']])) {
|
|
$mapping['id'] = true;
|
|
}
|
|
|
|
if (isset($oneToOneElement['fetch'])) {
|
|
$mapping['fetch'] = constant('Doctrine\ORM\Mapping\ClassMetadata::FETCH_' . (string) $oneToOneElement['fetch']);
|
|
}
|
|
|
|
if (isset($oneToOneElement['mapped-by'])) {
|
|
$mapping['mappedBy'] = (string) $oneToOneElement['mapped-by'];
|
|
} else {
|
|
if (isset($oneToOneElement['inversed-by'])) {
|
|
$mapping['inversedBy'] = (string) $oneToOneElement['inversed-by'];
|
|
}
|
|
$joinColumns = [];
|
|
|
|
if (isset($oneToOneElement->{'join-column'})) {
|
|
$joinColumns[] = $this->joinColumnToArray($oneToOneElement->{'join-column'});
|
|
} else if (isset($oneToOneElement->{'join-columns'})) {
|
|
foreach ($oneToOneElement->{'join-columns'}->{'join-column'} as $joinColumnElement) {
|
|
$joinColumns[] = $this->joinColumnToArray($joinColumnElement);
|
|
}
|
|
}
|
|
|
|
$mapping['joinColumns'] = $joinColumns;
|
|
}
|
|
|
|
if (isset($oneToOneElement->cascade)) {
|
|
$mapping['cascade'] = $this->_getCascadeMappings($oneToOneElement->cascade);
|
|
}
|
|
|
|
if (isset($oneToOneElement['orphan-removal'])) {
|
|
$mapping['orphanRemoval'] = $this->evaluateBoolean($oneToOneElement['orphan-removal']);
|
|
}
|
|
|
|
// Evaluate second level cache
|
|
if (isset($oneToOneElement->cache)) {
|
|
$mapping['cache'] = $metadata->getAssociationCacheDefaults($mapping['fieldName'], $this->cacheToArray($oneToOneElement->cache));
|
|
}
|
|
|
|
$metadata->mapOneToOne($mapping);
|
|
}
|
|
}
|
|
|
|
// Evaluate <one-to-many ...> mappings
|
|
if (isset($xmlRoot->{'one-to-many'})) {
|
|
foreach ($xmlRoot->{'one-to-many'} as $oneToManyElement) {
|
|
$mapping = [
|
|
'fieldName' => (string) $oneToManyElement['field'],
|
|
'targetEntity' => (string) $oneToManyElement['target-entity'],
|
|
'mappedBy' => (string) $oneToManyElement['mapped-by']
|
|
];
|
|
|
|
if (isset($oneToManyElement['fetch'])) {
|
|
$mapping['fetch'] = constant('Doctrine\ORM\Mapping\ClassMetadata::FETCH_' . (string) $oneToManyElement['fetch']);
|
|
}
|
|
|
|
if (isset($oneToManyElement->cascade)) {
|
|
$mapping['cascade'] = $this->_getCascadeMappings($oneToManyElement->cascade);
|
|
}
|
|
|
|
if (isset($oneToManyElement['orphan-removal'])) {
|
|
$mapping['orphanRemoval'] = $this->evaluateBoolean($oneToManyElement['orphan-removal']);
|
|
}
|
|
|
|
if (isset($oneToManyElement->{'order-by'})) {
|
|
$orderBy = [];
|
|
foreach ($oneToManyElement->{'order-by'}->{'order-by-field'} as $orderByField) {
|
|
$orderBy[(string) $orderByField['name']] = (string) $orderByField['direction'];
|
|
}
|
|
$mapping['orderBy'] = $orderBy;
|
|
}
|
|
|
|
if (isset($oneToManyElement['index-by'])) {
|
|
$mapping['indexBy'] = (string) $oneToManyElement['index-by'];
|
|
} else if (isset($oneToManyElement->{'index-by'})) {
|
|
throw new \InvalidArgumentException("<index-by /> is not a valid tag");
|
|
}
|
|
|
|
// Evaluate second level cache
|
|
if (isset($oneToManyElement->cache)) {
|
|
$mapping['cache'] = $metadata->getAssociationCacheDefaults($mapping['fieldName'], $this->cacheToArray($oneToManyElement->cache));
|
|
}
|
|
|
|
$metadata->mapOneToMany($mapping);
|
|
}
|
|
}
|
|
|
|
// Evaluate <many-to-one ...> mappings
|
|
if (isset($xmlRoot->{'many-to-one'})) {
|
|
foreach ($xmlRoot->{'many-to-one'} as $manyToOneElement) {
|
|
$mapping = [
|
|
'fieldName' => (string) $manyToOneElement['field'],
|
|
'targetEntity' => (string) $manyToOneElement['target-entity']
|
|
];
|
|
|
|
if (isset($associationIds[$mapping['fieldName']])) {
|
|
$mapping['id'] = true;
|
|
}
|
|
|
|
if (isset($manyToOneElement['fetch'])) {
|
|
$mapping['fetch'] = constant('Doctrine\ORM\Mapping\ClassMetadata::FETCH_' . (string) $manyToOneElement['fetch']);
|
|
}
|
|
|
|
if (isset($manyToOneElement['inversed-by'])) {
|
|
$mapping['inversedBy'] = (string) $manyToOneElement['inversed-by'];
|
|
}
|
|
|
|
$joinColumns = [];
|
|
|
|
if (isset($manyToOneElement->{'join-column'})) {
|
|
$joinColumns[] = $this->joinColumnToArray($manyToOneElement->{'join-column'});
|
|
} else if (isset($manyToOneElement->{'join-columns'})) {
|
|
foreach ($manyToOneElement->{'join-columns'}->{'join-column'} as $joinColumnElement) {
|
|
$joinColumns[] = $this->joinColumnToArray($joinColumnElement);
|
|
}
|
|
}
|
|
|
|
$mapping['joinColumns'] = $joinColumns;
|
|
|
|
if (isset($manyToOneElement->cascade)) {
|
|
$mapping['cascade'] = $this->_getCascadeMappings($manyToOneElement->cascade);
|
|
}
|
|
|
|
// Evaluate second level cache
|
|
if (isset($manyToOneElement->cache)) {
|
|
$mapping['cache'] = $metadata->getAssociationCacheDefaults($mapping['fieldName'], $this->cacheToArray($manyToOneElement->cache));
|
|
}
|
|
|
|
$metadata->mapManyToOne($mapping);
|
|
|
|
}
|
|
}
|
|
|
|
// Evaluate <many-to-many ...> mappings
|
|
if (isset($xmlRoot->{'many-to-many'})) {
|
|
foreach ($xmlRoot->{'many-to-many'} as $manyToManyElement) {
|
|
$mapping = [
|
|
'fieldName' => (string) $manyToManyElement['field'],
|
|
'targetEntity' => (string) $manyToManyElement['target-entity']
|
|
];
|
|
|
|
if (isset($manyToManyElement['fetch'])) {
|
|
$mapping['fetch'] = constant('Doctrine\ORM\Mapping\ClassMetadata::FETCH_' . (string) $manyToManyElement['fetch']);
|
|
}
|
|
|
|
if (isset($manyToManyElement['orphan-removal'])) {
|
|
$mapping['orphanRemoval'] = $this->evaluateBoolean($manyToManyElement['orphan-removal']);
|
|
}
|
|
|
|
if (isset($manyToManyElement['mapped-by'])) {
|
|
$mapping['mappedBy'] = (string) $manyToManyElement['mapped-by'];
|
|
} else if (isset($manyToManyElement->{'join-table'})) {
|
|
if (isset($manyToManyElement['inversed-by'])) {
|
|
$mapping['inversedBy'] = (string) $manyToManyElement['inversed-by'];
|
|
}
|
|
|
|
$joinTableElement = $manyToManyElement->{'join-table'};
|
|
$joinTable = [
|
|
'name' => (string) $joinTableElement['name']
|
|
];
|
|
|
|
if (isset($joinTableElement['schema'])) {
|
|
$joinTable['schema'] = (string) $joinTableElement['schema'];
|
|
}
|
|
|
|
foreach ($joinTableElement->{'join-columns'}->{'join-column'} as $joinColumnElement) {
|
|
$joinTable['joinColumns'][] = $this->joinColumnToArray($joinColumnElement);
|
|
}
|
|
|
|
foreach ($joinTableElement->{'inverse-join-columns'}->{'join-column'} as $joinColumnElement) {
|
|
$joinTable['inverseJoinColumns'][] = $this->joinColumnToArray($joinColumnElement);
|
|
}
|
|
|
|
$mapping['joinTable'] = $joinTable;
|
|
}
|
|
|
|
if (isset($manyToManyElement->cascade)) {
|
|
$mapping['cascade'] = $this->_getCascadeMappings($manyToManyElement->cascade);
|
|
}
|
|
|
|
if (isset($manyToManyElement->{'order-by'})) {
|
|
$orderBy = [];
|
|
foreach ($manyToManyElement->{'order-by'}->{'order-by-field'} as $orderByField) {
|
|
$orderBy[(string) $orderByField['name']] = (string) $orderByField['direction'];
|
|
}
|
|
$mapping['orderBy'] = $orderBy;
|
|
}
|
|
|
|
if (isset($manyToManyElement['index-by'])) {
|
|
$mapping['indexBy'] = (string) $manyToManyElement['index-by'];
|
|
} else if (isset($manyToManyElement->{'index-by'})) {
|
|
throw new \InvalidArgumentException("<index-by /> is not a valid tag");
|
|
}
|
|
|
|
// Evaluate second level cache
|
|
if (isset($manyToManyElement->cache)) {
|
|
$mapping['cache'] = $metadata->getAssociationCacheDefaults($mapping['fieldName'], $this->cacheToArray($manyToManyElement->cache));
|
|
}
|
|
|
|
$metadata->mapManyToMany($mapping);
|
|
}
|
|
}
|
|
|
|
// Evaluate association-overrides
|
|
if (isset($xmlRoot->{'attribute-overrides'})) {
|
|
foreach ($xmlRoot->{'attribute-overrides'}->{'attribute-override'} as $overrideElement) {
|
|
$fieldName = (string) $overrideElement['name'];
|
|
foreach ($overrideElement->field as $field) {
|
|
$mapping = $this->columnToArray($field);
|
|
$mapping['fieldName'] = $fieldName;
|
|
$metadata->setAttributeOverride($fieldName, $mapping);
|
|
}
|
|
}
|
|
}
|
|
|
|
// Evaluate association-overrides
|
|
if (isset($xmlRoot->{'association-overrides'})) {
|
|
foreach ($xmlRoot->{'association-overrides'}->{'association-override'} as $overrideElement) {
|
|
$fieldName = (string) $overrideElement['name'];
|
|
$override = [];
|
|
|
|
// Check for join-columns
|
|
if (isset($overrideElement->{'join-columns'})) {
|
|
$joinColumns = [];
|
|
foreach ($overrideElement->{'join-columns'}->{'join-column'} as $joinColumnElement) {
|
|
$joinColumns[] = $this->joinColumnToArray($joinColumnElement);
|
|
}
|
|
$override['joinColumns'] = $joinColumns;
|
|
}
|
|
|
|
// Check for join-table
|
|
if ($overrideElement->{'join-table'}) {
|
|
$joinTable = null;
|
|
$joinTableElement = $overrideElement->{'join-table'};
|
|
|
|
$joinTable = [
|
|
'name' => (string) $joinTableElement['name'],
|
|
'schema' => (string) $joinTableElement['schema']
|
|
];
|
|
|
|
if (isset($joinTableElement->{'join-columns'})) {
|
|
foreach ($joinTableElement->{'join-columns'}->{'join-column'} as $joinColumnElement) {
|
|
$joinTable['joinColumns'][] = $this->joinColumnToArray($joinColumnElement);
|
|
}
|
|
}
|
|
|
|
if (isset($joinTableElement->{'inverse-join-columns'})) {
|
|
foreach ($joinTableElement->{'inverse-join-columns'}->{'join-column'} as $joinColumnElement) {
|
|
$joinTable['inverseJoinColumns'][] = $this->joinColumnToArray($joinColumnElement);
|
|
}
|
|
}
|
|
|
|
$override['joinTable'] = $joinTable;
|
|
}
|
|
|
|
// Check for inversed-by
|
|
if (isset($overrideElement->{'inversed-by'})) {
|
|
$override['inversedBy'] = (string) $overrideElement->{'inversed-by'}['name'];
|
|
}
|
|
|
|
// Check for `fetch`
|
|
if (isset($overrideElement['fetch'])) {
|
|
$override['fetch'] = constant(Metadata::class . '::FETCH_' . (string) $overrideElement['fetch']);
|
|
}
|
|
|
|
$metadata->setAssociationOverride($fieldName, $override);
|
|
}
|
|
}
|
|
|
|
// Evaluate <lifecycle-callbacks...>
|
|
if (isset($xmlRoot->{'lifecycle-callbacks'})) {
|
|
foreach ($xmlRoot->{'lifecycle-callbacks'}->{'lifecycle-callback'} as $lifecycleCallback) {
|
|
$metadata->addLifecycleCallback((string) $lifecycleCallback['method'], constant('Doctrine\ORM\Events::' . (string) $lifecycleCallback['type']));
|
|
}
|
|
}
|
|
|
|
// Evaluate entity listener
|
|
if (isset($xmlRoot->{'entity-listeners'})) {
|
|
foreach ($xmlRoot->{'entity-listeners'}->{'entity-listener'} as $listenerElement) {
|
|
$className = (string) $listenerElement['class'];
|
|
// Evaluate the listener using naming convention.
|
|
if ($listenerElement->count() === 0) {
|
|
EntityListenerBuilder::bindEntityListener($metadata, $className);
|
|
|
|
continue;
|
|
}
|
|
|
|
foreach ($listenerElement as $callbackElement) {
|
|
$eventName = (string) $callbackElement['type'];
|
|
$methodName = (string) $callbackElement['method'];
|
|
|
|
$metadata->addEntityListener($eventName, $className, $methodName);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Parses (nested) option elements.
|
|
*
|
|
* @param SimpleXMLElement $options The XML element.
|
|
*
|
|
* @return array The options array.
|
|
*/
|
|
private function _parseOptions(SimpleXMLElement $options)
|
|
{
|
|
$array = [];
|
|
|
|
/* @var $option SimpleXMLElement */
|
|
foreach ($options as $option) {
|
|
if ($option->count()) {
|
|
$value = $this->_parseOptions($option->children());
|
|
} else {
|
|
$value = (string) $option;
|
|
}
|
|
|
|
$attributes = $option->attributes();
|
|
|
|
if (isset($attributes->name)) {
|
|
$nameAttribute = (string) $attributes->name;
|
|
$array[$nameAttribute] = in_array($nameAttribute, ['unsigned', 'fixed'])
|
|
? $this->evaluateBoolean($value)
|
|
: $value;
|
|
} else {
|
|
$array[] = $value;
|
|
}
|
|
}
|
|
|
|
return $array;
|
|
}
|
|
|
|
/**
|
|
* Constructs a joinColumn mapping array based on the information
|
|
* found in the given SimpleXMLElement.
|
|
*
|
|
* @param SimpleXMLElement $joinColumnElement The XML element.
|
|
*
|
|
* @return array The mapping array.
|
|
*/
|
|
private function joinColumnToArray(SimpleXMLElement $joinColumnElement)
|
|
{
|
|
$joinColumn = [
|
|
'name' => (string) $joinColumnElement['name'],
|
|
'referencedColumnName' => (string) $joinColumnElement['referenced-column-name']
|
|
];
|
|
|
|
if (isset($joinColumnElement['unique'])) {
|
|
$joinColumn['unique'] = $this->evaluateBoolean($joinColumnElement['unique']);
|
|
}
|
|
|
|
if (isset($joinColumnElement['nullable'])) {
|
|
$joinColumn['nullable'] = $this->evaluateBoolean($joinColumnElement['nullable']);
|
|
}
|
|
|
|
if (isset($joinColumnElement['on-delete'])) {
|
|
$joinColumn['onDelete'] = (string) $joinColumnElement['on-delete'];
|
|
}
|
|
|
|
if (isset($joinColumnElement['column-definition'])) {
|
|
$joinColumn['columnDefinition'] = (string) $joinColumnElement['column-definition'];
|
|
}
|
|
|
|
return $joinColumn;
|
|
}
|
|
|
|
/**
|
|
* Parses the given field as array.
|
|
*
|
|
* @param SimpleXMLElement $fieldMapping
|
|
*
|
|
* @return array
|
|
*/
|
|
private function columnToArray(SimpleXMLElement $fieldMapping)
|
|
{
|
|
$mapping = [
|
|
'fieldName' => (string) $fieldMapping['name'],
|
|
];
|
|
|
|
if (isset($fieldMapping['type'])) {
|
|
$mapping['type'] = (string) $fieldMapping['type'];
|
|
}
|
|
|
|
if (isset($fieldMapping['column'])) {
|
|
$mapping['columnName'] = (string) $fieldMapping['column'];
|
|
}
|
|
|
|
if (isset($fieldMapping['length'])) {
|
|
$mapping['length'] = (int) $fieldMapping['length'];
|
|
}
|
|
|
|
if (isset($fieldMapping['precision'])) {
|
|
$mapping['precision'] = (int) $fieldMapping['precision'];
|
|
}
|
|
|
|
if (isset($fieldMapping['scale'])) {
|
|
$mapping['scale'] = (int) $fieldMapping['scale'];
|
|
}
|
|
|
|
if (isset($fieldMapping['unique'])) {
|
|
$mapping['unique'] = $this->evaluateBoolean($fieldMapping['unique']);
|
|
}
|
|
|
|
if (isset($fieldMapping['nullable'])) {
|
|
$mapping['nullable'] = $this->evaluateBoolean($fieldMapping['nullable']);
|
|
}
|
|
|
|
if (isset($fieldMapping['version']) && $fieldMapping['version']) {
|
|
$mapping['version'] = $this->evaluateBoolean($fieldMapping['version']);
|
|
}
|
|
|
|
if (isset($fieldMapping['column-definition'])) {
|
|
$mapping['columnDefinition'] = (string) $fieldMapping['column-definition'];
|
|
}
|
|
|
|
if (isset($fieldMapping->options)) {
|
|
$mapping['options'] = $this->_parseOptions($fieldMapping->options->children());
|
|
}
|
|
|
|
return $mapping;
|
|
}
|
|
|
|
/**
|
|
* Parse / Normalize the cache configuration
|
|
*
|
|
* @param SimpleXMLElement $cacheMapping
|
|
*
|
|
* @return array
|
|
*/
|
|
private function cacheToArray(SimpleXMLElement $cacheMapping)
|
|
{
|
|
$region = isset($cacheMapping['region']) ? (string) $cacheMapping['region'] : null;
|
|
$usage = isset($cacheMapping['usage']) ? strtoupper($cacheMapping['usage']) : null;
|
|
|
|
if ($usage && ! defined('Doctrine\ORM\Mapping\ClassMetadata::CACHE_USAGE_' . $usage)) {
|
|
throw new \InvalidArgumentException(sprintf('Invalid cache usage "%s"', $usage));
|
|
}
|
|
|
|
if ($usage) {
|
|
$usage = constant('Doctrine\ORM\Mapping\ClassMetadata::CACHE_USAGE_' . $usage);
|
|
}
|
|
|
|
return [
|
|
'usage' => $usage,
|
|
'region' => $region,
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Gathers a list of cascade options found in the given cascade element.
|
|
*
|
|
* @param SimpleXMLElement $cascadeElement The cascade element.
|
|
*
|
|
* @return array The list of cascade options.
|
|
*/
|
|
private function _getCascadeMappings(SimpleXMLElement $cascadeElement)
|
|
{
|
|
$cascades = [];
|
|
/* @var $action SimpleXmlElement */
|
|
foreach ($cascadeElement->children() as $action) {
|
|
// According to the JPA specifications, XML uses "cascade-persist"
|
|
// instead of "persist". Here, both variations
|
|
// are supported because both YAML and Annotation use "persist"
|
|
// and we want to make sure that this driver doesn't need to know
|
|
// anything about the supported cascading actions
|
|
$cascades[] = str_replace('cascade-', '', $action->getName());
|
|
}
|
|
|
|
return $cascades;
|
|
}
|
|
|
|
/**
|
|
* {@inheritDoc}
|
|
*/
|
|
protected function loadMappingFile($file)
|
|
{
|
|
$result = [];
|
|
$xmlElement = simplexml_load_string(file_get_contents($file));
|
|
|
|
if (isset($xmlElement->entity)) {
|
|
foreach ($xmlElement->entity as $entityElement) {
|
|
$entityName = (string) $entityElement['name'];
|
|
$result[$entityName] = $entityElement;
|
|
}
|
|
} else if (isset($xmlElement->{'mapped-superclass'})) {
|
|
foreach ($xmlElement->{'mapped-superclass'} as $mappedSuperClass) {
|
|
$className = (string) $mappedSuperClass['name'];
|
|
$result[$className] = $mappedSuperClass;
|
|
}
|
|
} else if (isset($xmlElement->embeddable)) {
|
|
foreach ($xmlElement->embeddable as $embeddableElement) {
|
|
$embeddableName = (string) $embeddableElement['name'];
|
|
$result[$embeddableName] = $embeddableElement;
|
|
}
|
|
}
|
|
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* @param mixed $element
|
|
*
|
|
* @return bool
|
|
*/
|
|
protected function evaluateBoolean($element)
|
|
{
|
|
$flag = (string) $element;
|
|
|
|
return ($flag == "true" || $flag == "1");
|
|
}
|
|
}
|