vendor/pimcore/pimcore/lib/Twig/Extension/GlossaryExtension.php line 74

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /**
  6. * Pimcore
  7. *
  8. * This source file is available under two different licenses:
  9. * - GNU General Public License version 3 (GPLv3)
  10. * - Pimcore Commercial License (PCL)
  11. * Full copyright and license information is available in
  12. * LICENSE.md which is distributed with this source code.
  13. *
  14. * @copyright Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  15. * @license http://www.pimcore.org/license GPLv3 and PCL
  16. */
  18. namespace Pimcore\Twig\Extension;
  20. use Pimcore\Tool\Glossary\Processor;
  21. use Pimcore\Twig\TokenParser\GlossaryTokenParser;
  22. use Twig\Extension\AbstractExtension;
  23. use Twig\TwigFilter;
  25. /**
  26. * @internal
  27. */
  28. class GlossaryExtension extends AbstractExtension
  29. {
  30. /**
  31. * @var \Pimcore\Tool\Glossary\Processor
  32. */
  33. private $glossaryProcessor;
  35. /**
  36. * @param \Pimcore\Tool\Glossary\Processor $glossaryProcessor
  37. *
  38. */
  39. public function __construct(Processor $glossaryProcessor)
  40. {
  41. $this->glossaryProcessor = $glossaryProcessor;
  42. }
  44. /**
  45. * {@inheritdoc}
  46. */
  47. public function getFilters(): array
  48. {
  49. return [
  50. new TwigFilter('pimcore_glossary', [$this, 'applyGlossary'], ['is_safe' => ['html']]),
  51. ];
  52. }
  54. /**
  55. * @param string $string
  56. * @param array $options
  57. *
  58. * @return string
  59. */
  60. public function applyGlossary(string $string, array $options = []): string
  61. {
  62. if (empty($string) || !is_string($string)) {
  63. return $string;
  64. } else {
  65. return $this->glossaryProcessor->process($string, $options);
  66. }
  67. }
  69. /**
  70. * @deprecated
  71. */
  72. public function getTokenParsers(): array
  73. {
  74. trigger_deprecation('pimcore/pimcore', '10.1', 'Usage of pimcoreglossary tag is deprecated since version 10.1 and will be removed in Pimcore 11. Use pimcore_glossary Twig filter instead.');
  76. return [
  77. new GlossaryTokenParser(),
  78. ];
  79. }
  81. /**
  82. * @deprecated
  83. */
  84. public function start()
  85. {
  86. ob_start();
  87. }
  89. /**
  90. * @deprecated
  91. *
  92. * @param array $options
  93. */
  94. public function stop(array $options = [])
  95. {
  96. $contents = ob_get_clean();
  98. if (empty($contents) || !is_string($contents)) {
  99. $result = $contents;
  100. } else {
  101. $result = $this->glossaryProcessor->process($contents, $options);
  102. }
  104. echo $result;
  105. }
  106. }