vendor/ibexa/http-cache/src/lib/EventSubscriber/RestKernelViewSubscriber.php line 45

Open in your IDE?
  1. <?php
  3. /**
  4. * @copyright Copyright (C) Ibexa AS. All rights reserved.
  5. * @license For full copyright and license information view LICENSE file distributed with this source code.
  6. */
  7. namespace Ibexa\HttpCache\EventSubscriber;
  9. use FOS\HttpCache\ResponseTagger;
  10. use Ibexa\Contracts\Core\Repository\Values\Content\Section;
  11. use Ibexa\Contracts\Core\Repository\Values\ContentType\ContentType;
  12. use Ibexa\Contracts\HttpCache\Handler\ContentTagInterface;
  13. use Ibexa\Rest\Server\Values\CachedValue;
  14. use Ibexa\Rest\Server\Values\ContentTypeGroupList;
  15. use Ibexa\Rest\Server\Values\ContentTypeGroupRefList;
  16. use Ibexa\Rest\Server\Values\RestContentType;
  17. use Ibexa\Rest\Server\Values\VersionList;
  18. use Ibexa\Rest\Values\Root;
  19. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  20. use Symfony\Component\HttpKernel\Event\ViewEvent;
  21. use Symfony\Component\HttpKernel\KernelEvents;
  23. /**
  24. * Set cache tags on a few REST responses used by UI in order to be able to cache them.
  25. *
  26. * @deprecated This is a temprary approach to caching certain parts of REST used by UI, it is deprecated in favour of
  27. * nativly using tags and CachedValue in kernel's REST server itself once we switch to FOSHttpCache 2.x
  28. * where tagger service can be used directly.
  29. */
  30. class RestKernelViewSubscriber implements EventSubscriberInterface
  31. {
  32. /** @var \FOS\HttpCache\ResponseTagger */
  33. private $tagHandler;
  35. public function __construct(ResponseTagger $tagHandler)
  36. {
  37. $this->tagHandler = $tagHandler;
  38. }
  40. public static function getSubscribedEvents()
  41. {
  42. return [KernelEvents::VIEW => ['tagUIRestResult', 10]];
  43. }
  45. public function tagUIRestResult(ViewEvent $event)
  46. {
  47. $request = $event->getRequest();
  48. if (!$request->isMethodCacheable() || !$request->attributes->get('is_rest_request')) {
  49. return;
  50. }
  52. // Get tags, and exit if none where found
  53. $restValue = $event->getControllerResult();
  54. $tags = $this->getTags($restValue);
  55. if (empty($tags)) {
  56. return;
  57. }
  59. // Add tags and swap Rest Value for cached value now that REST server can safely cache it
  60. $this->tagHandler->addTags($tags);
  61. $event->setControllerResult(new CachedValue($restValue));
  62. }
  64. /**
  65. * @param object $value
  66. *
  67. * @return array
  68. */
  69. protected function getTags($value)
  70. {
  71. $tags = [];
  72. switch ($value) {
  73. case $value instanceof VersionList && !empty($value->versions):
  74. $tags[] = ContentTagInterface::CONTENT_PREFIX . $value->versions[0]->contentInfo->id;
  75. $tags[] = ContentTagInterface::CONTENT_VERSION_PREFIX . $value->versions[0]->contentInfo->id;
  77. break;
  79. case $value instanceof Section:
  80. $tags[] = 's' . $value->id;
  81. break;
  83. case $value instanceof ContentTypeGroupRefList:
  84. if ($value->contentType->status !== ContentType::STATUS_DEFINED) {
  85. return [];
  86. }
  87. $tags[] = 't' . $value->contentType->id;
  88. case $value instanceof ContentTypeGroupList:
  89. foreach ($value->contentTypeGroups as $contentTypeGroup) {
  90. $tags[] = 'tg' . $contentTypeGroup->id;
  91. }
  92. break;
  94. case $value instanceof RestContentType:
  95. $value = $value->contentType;
  96. case $value instanceof ContentType:
  97. if ($value->status !== ContentType::STATUS_DEFINED) {
  98. return [];
  99. }
  100. $tags[] = 't' . $value->id;
  101. break;
  103. case $value instanceof Root:
  104. $tags[] = ContentTagInterface::ALL_TAG;
  105. break;
  106. }
  108. return $tags;
  109. }
  110. }
  112. class_alias(RestKernelViewSubscriber::class, 'EzSystems\PlatformHttpCacheBundle\EventSubscriber\RestKernelViewSubscriber');