Yaml.php 2.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677
  1. <?php
  2. namespace Gedmo\Translatable\Mapping\Driver;
  3. use Gedmo\Mapping\Driver\File,
  4. Gedmo\Mapping\Driver,
  5. Doctrine\Common\Persistence\Mapping\ClassMetadata,
  6. Gedmo\Exception\InvalidMappingException;
  7. /**
  8. * This is a yaml mapping driver for Translatable
  9. * behavioral extension. Used for extraction of extended
  10. * metadata from yaml specificaly for Translatable
  11. * extension.
  12. *
  13. * @author Gediminas Morkevicius <gediminas.morkevicius@gmail.com>
  14. * @package Gedmo.Translatable.Mapping.Driver
  15. * @subpackage Yaml
  16. * @link http://www.gediminasm.org
  17. * @license MIT License (http://www.opensource.org/licenses/mit-license.php)
  18. */
  19. class Yaml extends File implements Driver
  20. {
  21. /**
  22. * File extension
  23. * @var string
  24. */
  25. protected $_extension = '.dcm.yml';
  26. /**
  27. * {@inheritDoc}
  28. */
  29. public function readExtendedMetadata(ClassMetadata $meta, array &$config)
  30. {
  31. $mapping = $this->_getMapping($meta->name);
  32. if (isset($mapping['gedmo'])) {
  33. $classMapping = $mapping['gedmo'];
  34. if (isset($classMapping['translation']['entity'])) {
  35. $translationEntity = $classMapping['translation']['entity'];
  36. if (!class_exists($translationEntity)) {
  37. throw new InvalidMappingException("Translation entity class: {$translationEntity} does not exist.");
  38. }
  39. $config['translationClass'] = $translationEntity;
  40. }
  41. if (isset($classMapping['translation']['locale'])) {
  42. $config['locale'] = $classMapping['translation']['locale'];
  43. } elseif (isset($classMapping['translation']['language'])) {
  44. $config['locale'] = $classMapping['translation']['language'];
  45. }
  46. }
  47. if (isset($mapping['fields'])) {
  48. foreach ($mapping['fields'] as $field => $fieldMapping) {
  49. if (isset($fieldMapping['gedmo'])) {
  50. if (in_array('translatable', $fieldMapping['gedmo'])) {
  51. // fields cannot be overrided and throws mapping exception
  52. $config['fields'][] = $field;
  53. }
  54. }
  55. }
  56. }
  57. if (!$meta->isMappedSuperclass && $config) {
  58. if (is_array($meta->identifier) && count($meta->identifier) > 1) {
  59. throw new InvalidMappingException("Translatable does not support composite identifiers in class - {$meta->name}");
  60. }
  61. }
  62. }
  63. /**
  64. * {@inheritDoc}
  65. */
  66. protected function _loadMappingFile($file)
  67. {
  68. return \Symfony\Component\Yaml\Yaml::load($file);
  69. }
  70. }