3 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
4 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
5 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
6 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
7 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
8 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
9 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
10 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
11 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
12 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
13 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
15 * This software consists of voluntary contributions made by many individuals
16 * and is licensed under the MIT license. For more information, see
17 * <http://www.doctrine-project.org>.
20 namespace Doctrine\ORM\Mapping\Driver;
22 use Doctrine\Common\Persistence\Mapping\ClassMetadata,
23 Doctrine\Common\Persistence\Mapping\Driver\FileDriver,
24 Doctrine\ORM\Mapping\MappingException,
25 Symfony\Component\Yaml\Yaml;
28 * The YamlDriver reads the mapping metadata from yaml schema files.
31 * @author Benjamin Eberlei <kontakt@beberlei.de>
32 * @author Guilherme Blanco <guilhermeblanco@hotmail.com>
33 * @author Jonathan H. Wage <jonwage@gmail.com>
34 * @author Roman Borschel <roman@code-factory.org>
36 class YamlDriver extends FileDriver
38 const DEFAULT_FILE_EXTENSION = '.dcm.yml';
43 public function __construct($locator, $fileExtension = self::DEFAULT_FILE_EXTENSION)
45 parent::__construct($locator, $fileExtension);
51 public function loadMetadataForClass($className, ClassMetadata $metadata)
53 /* @var $metadata \Doctrine\ORM\Mapping\ClassMetadataInfo */
54 $element = $this->getElement($className);
56 if ($element['type'] == 'entity') {
57 if (isset($element['repositoryClass'])) {
58 $metadata->setCustomRepositoryClass($element['repositoryClass']);
60 if (isset($element['readOnly']) && $element['readOnly'] == true) {
61 $metadata->markReadOnly();
63 } else if ($element['type'] == 'mappedSuperclass') {
64 $metadata->setCustomRepositoryClass(
65 isset($element['repositoryClass']) ? $element['repositoryClass'] : null
67 $metadata->isMappedSuperclass = true;
69 throw MappingException::classIsNotAValidEntityOrMappedSuperClass($className);
72 // Evaluate root level properties
74 if (isset($element['table'])) {
75 $table['name'] = $element['table'];
77 $metadata->setPrimaryTable($table);
79 // Evaluate named queries
80 if (isset($element['namedQueries'])) {
81 foreach ($element['namedQueries'] as $name => $queryMapping) {
82 if (is_string($queryMapping)) {
83 $queryMapping = array('query' => $queryMapping);
86 if ( ! isset($queryMapping['name'])) {
87 $queryMapping['name'] = $name;
90 $metadata->addNamedQuery($queryMapping);
94 // Evaluate named native queries
95 if (isset($element['namedNativeQueries'])) {
96 foreach ($element['namedNativeQueries'] as $name => $mappingElement) {
97 if (!isset($mappingElement['name'])) {
98 $mappingElement['name'] = $name;
100 $metadata->addNamedNativeQuery(array(
101 'name' => $mappingElement['name'],
102 'query' => isset($mappingElement['query']) ? $mappingElement['query'] : null,
103 'resultClass' => isset($mappingElement['resultClass']) ? $mappingElement['resultClass'] : null,
104 'resultSetMapping' => isset($mappingElement['resultSetMapping']) ? $mappingElement['resultSetMapping'] : null,
109 // Evaluate sql result set mappings
110 if (isset($element['sqlResultSetMappings'])) {
111 foreach ($element['sqlResultSetMappings'] as $name => $resultSetMapping) {
112 if (!isset($resultSetMapping['name'])) {
113 $resultSetMapping['name'] = $name;
118 if (isset($resultSetMapping['entityResult'])) {
119 foreach ($resultSetMapping['entityResult'] as $entityResultElement) {
120 $entityResult = array(
122 'entityClass' => isset($entityResultElement['entityClass']) ? $entityResultElement['entityClass'] : null,
123 'discriminatorColumn' => isset($entityResultElement['discriminatorColumn']) ? $entityResultElement['discriminatorColumn'] : null,
126 if (isset($entityResultElement['fieldResult'])) {
127 foreach ($entityResultElement['fieldResult'] as $fieldResultElement) {
128 $entityResult['fields'][] = array(
129 'name' => isset($fieldResultElement['name']) ? $fieldResultElement['name'] : null,
130 'column' => isset($fieldResultElement['column']) ? $fieldResultElement['column'] : null,
135 $entities[] = $entityResult;
140 if (isset($resultSetMapping['columnResult'])) {
141 foreach ($resultSetMapping['columnResult'] as $columnResultAnnot) {
143 'name' => isset($columnResultAnnot['name']) ? $columnResultAnnot['name'] : null,
148 $metadata->addSqlResultSetMapping(array(
149 'name' => $resultSetMapping['name'],
150 'entities' => $entities,
151 'columns' => $columns
156 /* not implemented specially anyway. use table = schema.table
157 if (isset($element['schema'])) {
158 $metadata->table['schema'] = $element['schema'];
161 if (isset($element['inheritanceType'])) {
162 $metadata->setInheritanceType(constant('Doctrine\ORM\Mapping\ClassMetadata::INHERITANCE_TYPE_' . strtoupper($element['inheritanceType'])));
164 if ($metadata->inheritanceType != \Doctrine\ORM\Mapping\ClassMetadata::INHERITANCE_TYPE_NONE) {
165 // Evaluate discriminatorColumn
166 if (isset($element['discriminatorColumn'])) {
167 $discrColumn = $element['discriminatorColumn'];
168 $metadata->setDiscriminatorColumn(array(
169 'name' => isset($discrColumn['name']) ? (string)$discrColumn['name'] : null,
170 'type' => isset($discrColumn['type']) ? (string)$discrColumn['type'] : null,
171 'length' => isset($discrColumn['length']) ? (string)$discrColumn['length'] : null,
172 'columnDefinition' => isset($discrColumn['columnDefinition']) ? (string)$discrColumn['columnDefinition'] : null
175 $metadata->setDiscriminatorColumn(array('name' => 'dtype', 'type' => 'string', 'length' => 255));
178 // Evaluate discriminatorMap
179 if (isset($element['discriminatorMap'])) {
180 $metadata->setDiscriminatorMap($element['discriminatorMap']);
186 // Evaluate changeTrackingPolicy
187 if (isset($element['changeTrackingPolicy'])) {
188 $metadata->setChangeTrackingPolicy(constant('Doctrine\ORM\Mapping\ClassMetadata::CHANGETRACKING_'
189 . strtoupper($element['changeTrackingPolicy'])));
193 if (isset($element['indexes'])) {
194 foreach ($element['indexes'] as $name => $index) {
195 if ( ! isset($index['name'])) {
196 $index['name'] = $name;
199 if (is_string($index['columns'])) {
200 $columns = explode(',', $index['columns']);
202 $columns = $index['columns'];
205 $metadata->table['indexes'][$index['name']] = array(
206 'columns' => $columns
211 // Evaluate uniqueConstraints
212 if (isset($element['uniqueConstraints'])) {
213 foreach ($element['uniqueConstraints'] as $name => $unique) {
214 if ( ! isset($unique['name'])) {
215 $unique['name'] = $name;
218 if (is_string($unique['columns'])) {
219 $columns = explode(',', $unique['columns']);
221 $columns = $unique['columns'];
224 $metadata->table['uniqueConstraints'][$unique['name']] = array(
225 'columns' => $columns
230 if (isset($element['options'])) {
231 $metadata->table['options'] = $element['options'];
234 $associationIds = array();
235 if (isset($element['id'])) {
236 // Evaluate identifier settings
237 foreach ($element['id'] as $name => $idElement) {
238 if (isset($idElement['associationKey']) && $idElement['associationKey'] == true) {
239 $associationIds[$name] = true;
248 if (isset($idElement['type'])) {
249 $mapping['type'] = $idElement['type'];
252 if (isset($idElement['column'])) {
253 $mapping['columnName'] = $idElement['column'];
256 if (isset($idElement['length'])) {
257 $mapping['length'] = $idElement['length'];
260 if (isset($idElement['columnDefinition'])) {
261 $mapping['columnDefinition'] = $idElement['columnDefinition'];
264 $metadata->mapField($mapping);
266 if (isset($idElement['generator'])) {
267 $metadata->setIdGeneratorType(constant('Doctrine\ORM\Mapping\ClassMetadata::GENERATOR_TYPE_'
268 . strtoupper($idElement['generator']['strategy'])));
270 // Check for SequenceGenerator/TableGenerator definition
271 if (isset($idElement['sequenceGenerator'])) {
272 $metadata->setSequenceGeneratorDefinition($idElement['sequenceGenerator']);
273 } else if (isset($idElement['customIdGenerator'])) {
274 $customGenerator = $idElement['customIdGenerator'];
275 $metadata->setCustomGeneratorDefinition(array(
276 'class' => (string) $customGenerator['class']
278 } else if (isset($idElement['tableGenerator'])) {
279 throw MappingException::tableIdGeneratorNotImplemented($className);
285 if (isset($element['fields'])) {
286 foreach ($element['fields'] as $name => $fieldMapping) {
288 $mapping = $this->columnToArray($name, $fieldMapping);
290 if (isset($fieldMapping['id'])) {
291 $mapping['id'] = true;
292 if (isset($fieldMapping['generator']['strategy'])) {
293 $metadata->setIdGeneratorType(constant('Doctrine\ORM\Mapping\ClassMetadata::GENERATOR_TYPE_'
294 . strtoupper($fieldMapping['generator']['strategy'])));
298 $metadata->mapField($mapping);
302 // Evaluate oneToOne relationships
303 if (isset($element['oneToOne'])) {
304 foreach ($element['oneToOne'] as $name => $oneToOneElement) {
306 'fieldName' => $name,
307 'targetEntity' => $oneToOneElement['targetEntity']
310 if (isset($associationIds[$mapping['fieldName']])) {
311 $mapping['id'] = true;
314 if (isset($oneToOneElement['fetch'])) {
315 $mapping['fetch'] = constant('Doctrine\ORM\Mapping\ClassMetadata::FETCH_' . $oneToOneElement['fetch']);
318 if (isset($oneToOneElement['mappedBy'])) {
319 $mapping['mappedBy'] = $oneToOneElement['mappedBy'];
321 if (isset($oneToOneElement['inversedBy'])) {
322 $mapping['inversedBy'] = $oneToOneElement['inversedBy'];
325 $joinColumns = array();
327 if (isset($oneToOneElement['joinColumn'])) {
328 $joinColumns[] = $this->joinColumnToArray($oneToOneElement['joinColumn']);
329 } else if (isset($oneToOneElement['joinColumns'])) {
330 foreach ($oneToOneElement['joinColumns'] as $joinColumnName => $joinColumnElement) {
331 if ( ! isset($joinColumnElement['name'])) {
332 $joinColumnElement['name'] = $joinColumnName;
335 $joinColumns[] = $this->joinColumnToArray($joinColumnElement);
339 $mapping['joinColumns'] = $joinColumns;
342 if (isset($oneToOneElement['cascade'])) {
343 $mapping['cascade'] = $oneToOneElement['cascade'];
346 if (isset($oneToOneElement['orphanRemoval'])) {
347 $mapping['orphanRemoval'] = (bool)$oneToOneElement['orphanRemoval'];
350 $metadata->mapOneToOne($mapping);
354 // Evaluate oneToMany relationships
355 if (isset($element['oneToMany'])) {
356 foreach ($element['oneToMany'] as $name => $oneToManyElement) {
358 'fieldName' => $name,
359 'targetEntity' => $oneToManyElement['targetEntity'],
360 'mappedBy' => $oneToManyElement['mappedBy']
363 if (isset($oneToManyElement['fetch'])) {
364 $mapping['fetch'] = constant('Doctrine\ORM\Mapping\ClassMetadata::FETCH_' . $oneToManyElement['fetch']);
367 if (isset($oneToManyElement['cascade'])) {
368 $mapping['cascade'] = $oneToManyElement['cascade'];
371 if (isset($oneToManyElement['orphanRemoval'])) {
372 $mapping['orphanRemoval'] = (bool)$oneToManyElement['orphanRemoval'];
375 if (isset($oneToManyElement['orderBy'])) {
376 $mapping['orderBy'] = $oneToManyElement['orderBy'];
379 if (isset($oneToManyElement['indexBy'])) {
380 $mapping['indexBy'] = $oneToManyElement['indexBy'];
383 $metadata->mapOneToMany($mapping);
387 // Evaluate manyToOne relationships
388 if (isset($element['manyToOne'])) {
389 foreach ($element['manyToOne'] as $name => $manyToOneElement) {
391 'fieldName' => $name,
392 'targetEntity' => $manyToOneElement['targetEntity']
395 if (isset($associationIds[$mapping['fieldName']])) {
396 $mapping['id'] = true;
399 if (isset($manyToOneElement['fetch'])) {
400 $mapping['fetch'] = constant('Doctrine\ORM\Mapping\ClassMetadata::FETCH_' . $manyToOneElement['fetch']);
403 if (isset($manyToOneElement['inversedBy'])) {
404 $mapping['inversedBy'] = $manyToOneElement['inversedBy'];
407 $joinColumns = array();
409 if (isset($manyToOneElement['joinColumn'])) {
410 $joinColumns[] = $this->joinColumnToArray($manyToOneElement['joinColumn']);
411 } else if (isset($manyToOneElement['joinColumns'])) {
412 foreach ($manyToOneElement['joinColumns'] as $joinColumnName => $joinColumnElement) {
413 if ( ! isset($joinColumnElement['name'])) {
414 $joinColumnElement['name'] = $joinColumnName;
417 $joinColumns[] = $this->joinColumnToArray($joinColumnElement);
421 $mapping['joinColumns'] = $joinColumns;
423 if (isset($manyToOneElement['cascade'])) {
424 $mapping['cascade'] = $manyToOneElement['cascade'];
427 $metadata->mapManyToOne($mapping);
431 // Evaluate manyToMany relationships
432 if (isset($element['manyToMany'])) {
433 foreach ($element['manyToMany'] as $name => $manyToManyElement) {
435 'fieldName' => $name,
436 'targetEntity' => $manyToManyElement['targetEntity']
439 if (isset($manyToManyElement['fetch'])) {
440 $mapping['fetch'] = constant('Doctrine\ORM\Mapping\ClassMetadata::FETCH_' . $manyToManyElement['fetch']);
443 if (isset($manyToManyElement['mappedBy'])) {
444 $mapping['mappedBy'] = $manyToManyElement['mappedBy'];
445 } else if (isset($manyToManyElement['joinTable'])) {
447 $joinTableElement = $manyToManyElement['joinTable'];
449 'name' => $joinTableElement['name']
452 if (isset($joinTableElement['schema'])) {
453 $joinTable['schema'] = $joinTableElement['schema'];
456 foreach ($joinTableElement['joinColumns'] as $joinColumnName => $joinColumnElement) {
457 if ( ! isset($joinColumnElement['name'])) {
458 $joinColumnElement['name'] = $joinColumnName;
461 $joinTable['joinColumns'][] = $this->joinColumnToArray($joinColumnElement);
464 foreach ($joinTableElement['inverseJoinColumns'] as $joinColumnName => $joinColumnElement) {
465 if ( ! isset($joinColumnElement['name'])) {
466 $joinColumnElement['name'] = $joinColumnName;
469 $joinTable['inverseJoinColumns'][] = $this->joinColumnToArray($joinColumnElement);
472 $mapping['joinTable'] = $joinTable;
475 if (isset($manyToManyElement['inversedBy'])) {
476 $mapping['inversedBy'] = $manyToManyElement['inversedBy'];
479 if (isset($manyToManyElement['cascade'])) {
480 $mapping['cascade'] = $manyToManyElement['cascade'];
483 if (isset($manyToManyElement['orderBy'])) {
484 $mapping['orderBy'] = $manyToManyElement['orderBy'];
487 if (isset($manyToManyElement['indexBy'])) {
488 $mapping['indexBy'] = $manyToManyElement['indexBy'];
491 if (isset($manyToManyElement['orphanRemoval'])) {
492 $mapping['orphanRemoval'] = (bool)$manyToManyElement['orphanRemoval'];
495 $metadata->mapManyToMany($mapping);
499 // Evaluate associationOverride
500 if (isset($element['associationOverride']) && is_array($element['associationOverride'])) {
502 foreach ($element['associationOverride'] as $fieldName => $associationOverrideElement) {
505 // Check for joinColumn
506 if (isset($associationOverrideElement['joinColumn'])) {
507 $joinColumns = array();
508 foreach ($associationOverrideElement['joinColumn'] as $name => $joinColumnElement) {
509 if ( ! isset($joinColumnElement['name'])) {
510 $joinColumnElement['name'] = $name;
512 $joinColumns[] = $this->joinColumnToArray($joinColumnElement);
514 $override['joinColumns'] = $joinColumns;
517 // Check for joinTable
518 if (isset($associationOverrideElement['joinTable'])) {
520 $joinTableElement = $associationOverrideElement['joinTable'];
522 'name' => $joinTableElement['name']
525 if (isset($joinTableElement['schema'])) {
526 $joinTable['schema'] = $joinTableElement['schema'];
529 foreach ($joinTableElement['joinColumns'] as $name => $joinColumnElement) {
530 if ( ! isset($joinColumnElement['name'])) {
531 $joinColumnElement['name'] = $name;
534 $joinTable['joinColumns'][] = $this->joinColumnToArray($joinColumnElement);
537 foreach ($joinTableElement['inverseJoinColumns'] as $name => $joinColumnElement) {
538 if ( ! isset($joinColumnElement['name'])) {
539 $joinColumnElement['name'] = $name;
542 $joinTable['inverseJoinColumns'][] = $this->joinColumnToArray($joinColumnElement);
545 $override['joinTable'] = $joinTable;
548 $metadata->setAssociationOverride($fieldName, $override);
552 // Evaluate associationOverride
553 if (isset($element['attributeOverride']) && is_array($element['attributeOverride'])) {
555 foreach ($element['attributeOverride'] as $fieldName => $attributeOverrideElement) {
556 $mapping = $this->columnToArray($fieldName, $attributeOverrideElement);
557 $metadata->setAttributeOverride($fieldName, $mapping);
561 // Evaluate lifeCycleCallbacks
562 if (isset($element['lifecycleCallbacks'])) {
563 foreach ($element['lifecycleCallbacks'] as $type => $methods) {
564 foreach ($methods as $method) {
565 $metadata->addLifecycleCallback($method, constant('Doctrine\ORM\Events::' . $type));
572 * Constructs a joinColumn mapping array based on the information
573 * found in the given join column element.
575 * @param array $joinColumnElement The array join column element
576 * @return array The mapping array.
578 private function joinColumnToArray($joinColumnElement)
580 $joinColumn = array();
581 if (isset($joinColumnElement['referencedColumnName'])) {
582 $joinColumn['referencedColumnName'] = (string) $joinColumnElement['referencedColumnName'];
585 if (isset($joinColumnElement['name'])) {
586 $joinColumn['name'] = (string) $joinColumnElement['name'];
589 if (isset($joinColumnElement['fieldName'])) {
590 $joinColumn['fieldName'] = (string) $joinColumnElement['fieldName'];
593 if (isset($joinColumnElement['unique'])) {
594 $joinColumn['unique'] = (bool) $joinColumnElement['unique'];
597 if (isset($joinColumnElement['nullable'])) {
598 $joinColumn['nullable'] = (bool) $joinColumnElement['nullable'];
601 if (isset($joinColumnElement['onDelete'])) {
602 $joinColumn['onDelete'] = $joinColumnElement['onDelete'];
605 if (isset($joinColumnElement['columnDefinition'])) {
606 $joinColumn['columnDefinition'] = $joinColumnElement['columnDefinition'];
613 * Parse the given column as array
615 * @param string $fieldName
616 * @param array $column
619 private function columnToArray($fieldName, $column)
622 'fieldName' => $fieldName
625 if (isset($column['type'])) {
626 $params = explode('(', $column['type']);
627 $column['type'] = $params[0];
628 $mapping['type'] = $column['type'];
630 if (isset($params[1])) {
631 $column['length'] = substr($params[1], 0, strlen($params[1]) - 1);
635 if (isset($column['column'])) {
636 $mapping['columnName'] = $column['column'];
639 if (isset($column['length'])) {
640 $mapping['length'] = $column['length'];
643 if (isset($column['precision'])) {
644 $mapping['precision'] = $column['precision'];
647 if (isset($column['scale'])) {
648 $mapping['scale'] = $column['scale'];
651 if (isset($column['unique'])) {
652 $mapping['unique'] = (bool)$column['unique'];
655 if (isset($column['options'])) {
656 $mapping['options'] = $column['options'];
659 if (isset($column['nullable'])) {
660 $mapping['nullable'] = $column['nullable'];
663 if (isset($column['version']) && $column['version']) {
664 $mapping['version'] = $column['version'];
667 if (isset($column['columnDefinition'])) {
668 $mapping['columnDefinition'] = $column['columnDefinition'];
677 protected function loadMappingFile($file)
679 return Yaml::parse($file);