‪TYPO3CMS  9.5
•All Classes Namespaces Files Functions Variables Pages
DefaultFunctionsProvider.php
Go to the documentation of this file.
1 <?php
2 declare(strict_types = 1);
3 namespace ‪TYPO3\CMS\Core\ExpressionLanguage\FunctionsProvider;
4 
5 /*
6  * This file is part of the TYPO3 CMS project.
7  *
8  * It is free software; you can redistribute it and/or modify it under
9  * the terms of the GNU General Public License, either version 2
10  * of the License, or any later version.
11  *
12  * For the full copyright and license information, please read the
13  * LICENSE.txt file that was distributed with this source code.
14  *
15  * The TYPO3 project - inspiring people to share!
16  */
17 
18 use Symfony\Component\ExpressionLanguage\ExpressionFunction;
19 use Symfony\Component\ExpressionLanguage\ExpressionFunctionProviderInterface;
20 use ‪TYPO3\CMS\Core\Configuration\Features;
21 use ‪TYPO3\CMS\Core\Context\Context;
22 use ‪TYPO3\CMS\Core\Utility\ArrayUtility;
23 use ‪TYPO3\CMS\Core\Utility\Exception\MissingArrayPathException;
24 use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
25 use ‪TYPO3\CMS\Core\Utility\StringUtility;
26 use ‪TYPO3\CMS\Core\Utility\VersionNumberUtility;
27 
32 class ‪DefaultFunctionsProvider implements ExpressionFunctionProviderInterface
33 {
37  public function ‪getFunctions()
38  {
39  return [
40  $this->‪getIpFunction(),
41  $this->‪getCompatVersionFunction(),
42  $this->‪getLikeFunction(),
43  $this->‪getEnvFunction(),
44  $this->‪getDateFunction(),
45  $this->‪getFeatureToggleFunction(),
46  $this->‪getTraverseArrayFunction(),
47  ];
48  }
49 
50  protected function ‪getIpFunction(): ExpressionFunction
51  {
52  return new ExpressionFunction(
53  'ip',
54  function () {
55  // Not implemented, we only use the evaluator
56  },
57  function ($arguments, $str) {
58  if ($str === 'devIP') {
59  $str = trim(‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['devIPmask'] ?? '');
60  }
61  return (bool)GeneralUtility::cmpIP(GeneralUtility::getIndpEnv('REMOTE_ADDR'), $str);
62  }
63  );
64  }
65 
66  protected function ‪getCompatVersionFunction(): ExpressionFunction
67  {
68  return new ExpressionFunction(
69  'compatVersion',
70  function () {
71  // Not implemented, we only use the evaluator
72  },
73  function ($arguments, $str) {
74  return ‪VersionNumberUtility::convertVersionNumberToInteger(TYPO3_branch) >=
75  ‪VersionNumberUtility::convertVersionNumberToInteger($str);
76  }
77  );
78  }
79 
80  protected function ‪getLikeFunction(): ExpressionFunction
81  {
82  return new ExpressionFunction('like', function () {
83  // Not implemented, we only use the evaluator
84  }, function ($arguments, $haystack, $needle) {
85  $result = ‪StringUtility::searchStringWildcard((string)$haystack, (string)$needle);
86  return $result;
87  });
88  }
89 
90  protected function ‪getEnvFunction(): ExpressionFunction
91  {
92  return ExpressionFunction::fromPhp('getenv');
93  }
94 
95  protected function ‪getDateFunction(): ExpressionFunction
96  {
97  return new ExpressionFunction('date', function () {
98  // Not implemented, we only use the evaluator
99  }, function ($arguments, $format) {
100  return GeneralUtility::makeInstance(Context::class)
101  ->getAspect('date')->getDateTime()->format($format);
102  });
103  }
104 
105  protected function ‪getFeatureToggleFunction(): ExpressionFunction
106  {
107  return new ExpressionFunction('feature', function () {
108  // Not implemented, we only use the evaluator
109  }, function ($arguments, $featureName) {
110  return GeneralUtility::makeInstance(Features::class)
111  ->isFeatureEnabled($featureName);
112  });
113  }
114 
115  public function ‪getTraverseArrayFunction(): ExpressionFunction
116  {
117  return new ExpressionFunction('traverse', function () {
118  // Not implemented, we only use the evaluator
119  }, function ($arguments, $array, $path) {
120  if (!is_array($array) || !is_string($path) || $path === '') {
121  return '';
122  }
123  try {
124  return ‪ArrayUtility::getValueByPath($array, $path);
125  } catch (‪MissingArrayPathException $e) {
126  return '';
127  }
128  });
129  }
130 }
‪TYPO3\CMS\Core\Utility\VersionNumberUtility
Definition: VersionNumberUtility.php:21
‪TYPO3\CMS\Core\Utility\StringUtility\searchStringWildcard
‪static bool searchStringWildcard($haystack, $needle)
Definition: StringUtility.php:133
‪TYPO3\CMS\Core\ExpressionLanguage\FunctionsProvider
Definition: DefaultFunctionsProvider.php:3
‪TYPO3\CMS\Core\Utility\Exception\MissingArrayPathException
Definition: MissingArrayPathException.php:26
‪TYPO3\CMS\Core\ExpressionLanguage\FunctionsProvider\DefaultFunctionsProvider\getEnvFunction
‪getEnvFunction()
Definition: DefaultFunctionsProvider.php:90
‪TYPO3\CMS\Core\Context\Context
Definition: Context.php:49
‪TYPO3\CMS\Core\ExpressionLanguage\FunctionsProvider\DefaultFunctionsProvider\getFunctions
‪ExpressionFunction[] getFunctions()
Definition: DefaultFunctionsProvider.php:37
‪TYPO3\CMS\Core\Utility\VersionNumberUtility\convertVersionNumberToInteger
‪static int convertVersionNumberToInteger($versionNumber)
Definition: VersionNumberUtility.php:28
‪TYPO3\CMS\Core\Utility\ArrayUtility\getValueByPath
‪static mixed getValueByPath(array $array, $path, $delimiter='/')
Definition: ArrayUtility.php:179
‪TYPO3\CMS\Core\ExpressionLanguage\FunctionsProvider\DefaultFunctionsProvider\getDateFunction
‪getDateFunction()
Definition: DefaultFunctionsProvider.php:95
‪TYPO3\CMS\Core\Configuration\Features
Definition: Features.php:54
‪TYPO3\CMS\Core\ExpressionLanguage\FunctionsProvider\DefaultFunctionsProvider\getTraverseArrayFunction
‪getTraverseArrayFunction()
Definition: DefaultFunctionsProvider.php:115
‪TYPO3\CMS\Core\ExpressionLanguage\FunctionsProvider\DefaultFunctionsProvider
Definition: DefaultFunctionsProvider.php:33
‪TYPO3\CMS\Core\Utility\ArrayUtility
Definition: ArrayUtility.php:23
‪$GLOBALS
‪$GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['adminpanel']['modules']
Definition: ext_localconf.php:5
‪TYPO3\CMS\Core\ExpressionLanguage\FunctionsProvider\DefaultFunctionsProvider\getCompatVersionFunction
‪getCompatVersionFunction()
Definition: DefaultFunctionsProvider.php:66
‪TYPO3\CMS\Core\ExpressionLanguage\FunctionsProvider\DefaultFunctionsProvider\getLikeFunction
‪getLikeFunction()
Definition: DefaultFunctionsProvider.php:80
‪TYPO3\CMS\Core\ExpressionLanguage\FunctionsProvider\DefaultFunctionsProvider\getIpFunction
‪getIpFunction()
Definition: DefaultFunctionsProvider.php:50
‪TYPO3\CMS\Core\ExpressionLanguage\FunctionsProvider\DefaultFunctionsProvider\getFeatureToggleFunction
‪getFeatureToggleFunction()
Definition: DefaultFunctionsProvider.php:105
‪TYPO3\CMS\Core\Utility\GeneralUtility
Definition: GeneralUtility.php:45
‪TYPO3\CMS\Core\Utility\StringUtility
Definition: StringUtility.php:21