SlugHandlerInterface.php 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778
  1. <?php
  2. namespace Gedmo\Sluggable\Handler;
  3. use Gedmo\Sluggable\SluggableListener;
  4. use Gedmo\Sluggable\Mapping\Event\SluggableAdapter;
  5. use Doctrine\Common\Persistence\Mapping\ClassMetadata;
  6. /**
  7. * Sluggable handler interface is a common pattern for all
  8. * slug handlers which can be attached to the sluggable listener.
  9. * Usage is intended only for internal access of sluggable.
  10. * Should not be used outside of sluggable extension
  11. *
  12. * @author Gediminas Morkevicius <gediminas.morkevicius@gmail.com>
  13. * @license MIT License (http://www.opensource.org/licenses/mit-license.php)
  14. */
  15. interface SlugHandlerInterface
  16. {
  17. /**
  18. * Construct the slug handler
  19. *
  20. * @param SluggableListener $sluggable
  21. */
  22. public function __construct(SluggableListener $sluggable);
  23. /**
  24. * Callback on slug handlers before the decision
  25. * is made whether or not the slug needs to be
  26. * recalculated
  27. *
  28. * @param SluggableAdapter $ea
  29. * @param array $config
  30. * @param object $object
  31. * @param string $slug
  32. * @param boolean $needToChangeSlug
  33. *
  34. * @return void
  35. */
  36. public function onChangeDecision(SluggableAdapter $ea, array &$config, $object, &$slug, &$needToChangeSlug);
  37. /**
  38. * Callback on slug handlers right after the slug is built
  39. *
  40. * @param SluggableAdapter $ea
  41. * @param array $config
  42. * @param object $object
  43. * @param string $slug
  44. *
  45. * @return void
  46. */
  47. public function postSlugBuild(SluggableAdapter $ea, array &$config, $object, &$slug);
  48. /**
  49. * Callback for slug handlers on slug completion
  50. *
  51. * @param SluggableAdapter $ea
  52. * @param array $config
  53. * @param object $object
  54. * @param string $slug
  55. *
  56. * @return void
  57. */
  58. public function onSlugCompletion(SluggableAdapter $ea, array &$config, $object, &$slug);
  59. /**
  60. * @return boolean whether or not this handler has already urlized the slug
  61. */
  62. public function handlesUrlization();
  63. /**
  64. * Validate handler options
  65. *
  66. * @param array $options
  67. * @param ClassMetadata $meta
  68. */
  69. public static function validate(array $options, ClassMetadata $meta);
  70. }