Yaml.php 2.5 KB

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