TreeSlugHandler.php 5.7KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181
  1. <?php
  2. namespace Gedmo\Sluggable\Handler;
  3. use Doctrine\Common\Persistence\ObjectManager;
  4. use Doctrine\Common\Persistence\Mapping\ClassMetadata;
  5. use Gedmo\Sluggable\SluggableListener;
  6. use Gedmo\Sluggable\Mapping\Event\SluggableAdapter;
  7. use Gedmo\Tool\Wrapper\AbstractWrapper;
  8. use Gedmo\Exception\InvalidMappingException;
  9. /**
  10. * Sluggable handler which slugs all parent nodes
  11. * recursively and synchronizes on updates. For instance
  12. * category tree slug could look like "food/fruits/apples"
  13. *
  14. * @author Gediminas Morkevicius <gediminas.morkevicius@gmail.com>
  15. * @package Gedmo.Sluggable.Handler
  16. * @subpackage TreeSlugHandler
  17. * @link http://www.gediminasm.org
  18. * @license MIT License (http://www.opensource.org/licenses/mit-license.php)
  19. */
  20. class TreeSlugHandler implements SlugHandlerInterface
  21. {
  22. const SEPARATOR = '/';
  23. /**
  24. * @var ObjectManager
  25. */
  26. protected $om;
  27. /**
  28. * @var SluggableListener
  29. */
  30. protected $sluggable;
  31. /**
  32. * Callable of original transliterator
  33. * which is used by sluggable
  34. *
  35. * @var callable
  36. */
  37. private $originalTransliterator;
  38. /**
  39. * True if node is being inserted
  40. *
  41. * @var boolean
  42. */
  43. private $isInsert = false;
  44. /**
  45. * Transliterated parent slug
  46. *
  47. * @var string
  48. */
  49. private $parentSlug;
  50. /**
  51. * Used path separator
  52. *
  53. * @var string
  54. */
  55. private $usedPathSeparator;
  56. /**
  57. * {@inheritDoc}
  58. */
  59. public function __construct(SluggableListener $sluggable)
  60. {
  61. $this->sluggable = $sluggable;
  62. }
  63. /**
  64. * {@inheritDoc}
  65. */
  66. public function onChangeDecision(SluggableAdapter $ea, $config, $object, &$slug, &$needToChangeSlug)
  67. {
  68. $this->om = $ea->getObjectManager();
  69. $this->isInsert = $this->om->getUnitOfWork()->isScheduledForInsert($object);
  70. $options = $config['handlers'][get_called_class()];
  71. $this->usedPathSeparator = isset($options['separator']) ? $options['separator'] : self::SEPARATOR;
  72. if (!$this->isInsert && !$needToChangeSlug) {
  73. $changeSet = $ea->getObjectChangeSet($this->om->getUnitOfWork(), $object);
  74. if (isset($changeSet[$options['parentRelationField']])) {
  75. $needToChangeSlug = true;
  76. }
  77. }
  78. }
  79. /**
  80. * {@inheritDoc}
  81. */
  82. public function postSlugBuild(SluggableAdapter $ea, array &$config, $object, &$slug)
  83. {
  84. $options = $config['handlers'][get_called_class()];
  85. $this->originalTransliterator = $this->sluggable->getTransliterator();
  86. $this->sluggable->setTransliterator(array($this, 'transliterate'));
  87. $this->parentSlug = '';
  88. $wrapped = AbstractWrapper::wrap($object, $this->om);
  89. if ($parent = $wrapped->getPropertyValue($options['parentRelationField'])) {
  90. $parent = AbstractWrapper::wrap($parent, $this->om);
  91. $this->parentSlug = $parent->getPropertyValue($config['slug']);
  92. }
  93. }
  94. /**
  95. * {@inheritDoc}
  96. */
  97. public static function validate(array $options, ClassMetadata $meta)
  98. {
  99. if (!$meta->isSingleValuedAssociation($options['parentRelationField'])) {
  100. throw new InvalidMappingException("Unable to find tree parent slug relation through field - [{$options['parentRelationField']}] in class - {$meta->name}");
  101. }
  102. }
  103. /**
  104. * {@inheritDoc}
  105. */
  106. public function onSlugCompletion(SluggableAdapter $ea, array &$config, $object, &$slug)
  107. {
  108. if (!$this->isInsert) {
  109. $wrapped = AbstractWrapper::wrap($object, $this->om);
  110. $meta = $wrapped->getMetadata();
  111. $target = $wrapped->getPropertyValue($config['slug']);
  112. $config['pathSeparator'] = $this->usedPathSeparator;
  113. $ea->replaceRelative($object, $config, $target.$config['pathSeparator'], $slug);
  114. $uow = $this->om->getUnitOfWork();
  115. // update in memory objects
  116. foreach ($uow->getIdentityMap() as $className => $objects) {
  117. // for inheritance mapped classes, only root is always in the identity map
  118. if ($className !== $wrapped->getRootObjectName()) {
  119. continue;
  120. }
  121. foreach ($objects as $object) {
  122. if (property_exists($object, '__isInitialized__') && !$object->__isInitialized__) {
  123. continue;
  124. }
  125. $oid = spl_object_hash($object);
  126. $objectSlug = $meta->getReflectionProperty($config['slug'])->getValue($object);
  127. if (preg_match("@^{$target}{$config['pathSeparator']}@smi", $objectSlug)) {
  128. $objectSlug = str_replace($target, $slug, $objectSlug);
  129. $meta->getReflectionProperty($config['slug'])->setValue($object, $objectSlug);
  130. $ea->setOriginalObjectProperty($uow, $oid, $config['slug'], $objectSlug);
  131. }
  132. }
  133. }
  134. }
  135. }
  136. /**
  137. * Transliterates the slug and prefixes the slug
  138. * by collection of parent slugs
  139. *
  140. * @param string $text
  141. * @param string $separator
  142. * @param object $object
  143. * @return string
  144. */
  145. public function transliterate($text, $separator, $object)
  146. {
  147. $slug = call_user_func_array(
  148. $this->originalTransliterator,
  149. array($text, $separator, $object)
  150. );
  151. if (strlen($this->parentSlug)) {
  152. $slug = $this->parentSlug . $this->usedPathSeparator . $slug;
  153. }
  154. $this->sluggable->setTransliterator($this->originalTransliterator);
  155. return $slug;
  156. }
  157. /**
  158. * {@inheritDoc}
  159. */
  160. public function handlesUrlization()
  161. {
  162. return true;
  163. }
  164. }