Move to namespaces.
Ensure compatibility with TYPO3 CMS 7.
Raise requirements to TYPO3 CMS 6.2.
Resolves: #67313
Releases: 2.0
Change-Id: Ife343335edd1a7c4020686c25588db0e799b5239
Reviewed-on: http://review.typo3.org/39982
Reviewed-by: Francois Suter <francois@typo3.org>
Tested-by: Francois Suter <francois@typo3.org>
+2015-06-05 Francois Suter (Cobweb) <typo3@cobweb.ch>
+
+ * Moved to namespaces, verified compatibility with TYPO3 CMS 7, resolves #67305
+
2015-05-09 Francois Suter (Cobweb) <typo3@cobweb.ch>
* Verified compatibility with TYPO3 CMS 6.2, resolves #58661
--- /dev/null
+<?php
+namespace Cobweb\Expressions\Exception;
+
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+/**
+ * General exception for all expressions parsing errors.
+ *
+ * @author Francois Suter (Cobweb) <typo3@cobweb.ch>
+ * @package TYPO3
+ * @subpackage tx_tesseract
+ */
+class Exception extends \Exception {
+}
--- /dev/null
+<?php
+namespace Cobweb\Expressions;
+
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+use Cobweb\Expressions\Exception\Exception;
+use Cobweb\Expressions\KeyProcessorInterface;
+use Cobweb\Expressions\ValuePostProcessorInterface;
+use TYPO3\CMS\Core\Utility\ArrayUtility;
+use TYPO3\CMS\Core\Utility\GeneralUtility;
+
+/**
+ * Utility class to parse strings and evaluate them as expressions or for any subexpressions they may contain.
+ *
+ * @author Francois Suter (Cobweb) <typo3@cobweb.ch>
+ * @package TYPO3
+ * @subpackage tx_expressions
+ */
+class ExpressionParser {
+ /**
+ * @var string Extension key
+ */
+ public static $extKey = 'expressions';
+
+ /**
+ * @var array Local variables stored in the parser
+ */
+ public static $vars = array();
+
+ /**
+ * @var array Additional values stored in the parser
+ */
+ public static $extraData = array();
+
+ /**
+ * Takes a string and checks for sub-strings inside curly braces {}.
+ *
+ * Each such substring will be evaluated and replaced.
+ * The resulting string is then evaluated or not, depending on the second argument.
+ *
+ * @param string $string The string to parse
+ * @param boolean $doEvaluation TRUE if string should be evaluated before being returned (default)
+ * @return string The parsed string
+ */
+ public static function evaluateString($string, $doEvaluation = TRUE) {
+ $matches = array();
+ $numReplacements = preg_match_all('/(\{.*?\})/', $string, $matches, PREG_SET_ORDER);
+ // If there was nothing to match or the matching failed, return the string as is
+ $result = $string;
+ if (!empty($numReplacements)) {
+ $searches = array();
+ $replacements = array();
+ foreach ($matches as $aMatch) {
+ $searches[] = $aMatch[1];
+ $expression = substr($aMatch[1], 1, strlen($aMatch[1]) - 2);
+ $evaluatedExpression = $expression;
+ try {
+ $evaluatedExpression = self::evaluateExpression($expression);
+ }
+ catch (Exception $e) {
+ if (TYPO3_DLOG) {
+ GeneralUtility::devLog('Bad subexpression: ' . $expression . ' (' . $e->getMessage() . ')', 'expressions', 2);
+ }
+ }
+ $replacements[] = $evaluatedExpression;
+ }
+ $result = str_replace($searches, $replacements, $string);
+ }
+ // Evaluate the string, if necessary
+ $finalString = $result;
+ if ($doEvaluation) {
+ try {
+ $finalString = self::evaluateExpression($result);
+ }
+ // If the evaluation fails, return the original string
+ catch (Exception $e) {
+ if (TYPO3_DLOG) {
+ GeneralUtility::devLog('Could not evaluate string: ' . $result . ' (' . $e->getMessage() . ')', 'expressions', 2);
+ }
+ }
+ }
+ return $finalString;
+ }
+
+ /**
+ * Evaluates the value of a given expression.
+ *
+ * The expected syntax of a filter value is key:index1|index2|...
+ * Simple values will be used as is.
+ *
+ * @param string $expression The expression to evaluate
+ * @throws Exception
+ * @return string The value for the filter
+ */
+ public static function evaluateExpression($expression) {
+ $returnValue = '';
+ $hasValue = FALSE;
+ if (!isset($expression) || $expression === '') {
+ throw new Exception('Empty expression received');
+ } else {
+ // First of all, evaluate any subexpressions that may be contained in the expression
+ $parsedExpression = self::evaluateString($expression, FALSE);
+ // An expression may contain several expressions as alternativtye values, separated by a double slash (//)
+ $allExpressions = GeneralUtility::trimExplode('//', $parsedExpression, TRUE);
+ $numberOfAlternatives = count($allExpressions);
+ foreach ($allExpressions as $anExpression) {
+ // Decrease the number of remaining alternatives
+ $numberOfAlternatives--;
+ // Check if there's a function call
+ $functions = array();
+ if (strpos($anExpression, '->') !== FALSE) {
+ // Split on the function call marker (->)
+ $expressionParts = GeneralUtility::trimExplode('->', $anExpression, TRUE);
+ // The first part is the expression itself
+ $anExpression = array_shift($expressionParts);
+ // All other parts are function definitions
+ $functions = $expressionParts;
+ }
+ // If there's no colon (:) in the expression, take it to be a literal value and return it as is
+ if (strpos($anExpression, ':') === FALSE) {
+ $returnValue = $anExpression;
+ $hasValue = TRUE;
+ } else {
+ $subParts = GeneralUtility::trimExplode(':', $anExpression, TRUE);
+ $key = array_shift($subParts);
+ $indices = implode(':', $subParts);
+ if (empty($indices)) {
+ throw new Exception('No indices in expression: ' . $expression);
+ }
+ $key = strtolower($key);
+ switch ($key) {
+ // Search for a value in the TSFE
+ case 'tsfe':
+ if (TYPO3_MODE == 'FE') {
+ try {
+ $returnValue = self::getValue($GLOBALS['TSFE'], $indices);
+ $hasValue = TRUE;
+ }
+ catch (Exception $e) {
+ continue;
+ }
+ } else {
+ // Throw exception, but only if we have run out of alternatives
+ if ($numberOfAlternatives == 0) {
+ throw new Exception('TSFE not available in this mode (' . TYPO3_MODE . ')');
+ }
+ }
+ break;
+ // Search for a value in the page record
+ // This is a convenience shortcut, as the page record is in the TSFE
+ case 'page':
+ if (TYPO3_MODE == 'FE') {
+ try {
+ $returnValue = self::getValue($GLOBALS['TSFE']->page, $indices);
+ $hasValue = TRUE;
+ }
+ catch (Exception $e) {
+ continue;
+ }
+ } else {
+ // Throw exception, but only if we have run out of alternatives
+ if ($numberOfAlternatives == 0) {
+ throw new Exception('TSFE->page not available in this mode (' . TYPO3_MODE . ')');
+ }
+ }
+ break;
+ // Search for a value in the template configuration
+ // This is a convenience shortcut, as the template configuration is in the TSFE
+ case 'config':
+ if (TYPO3_MODE == 'FE') {
+ try {
+ $returnValue = self::getValue($GLOBALS['TSFE']->config['config'], $indices);
+ $hasValue = TRUE;
+ }
+ catch (Exception $e) {
+ continue;
+ }
+ } else {
+ // Throw exception, but only if we have run out of alternatives
+ if ($numberOfAlternatives == 0) {
+ throw new Exception('TSFE->config not available in this mode (' . TYPO3_MODE . ')');
+ }
+ }
+ break;
+ // Search for a value in the merged GET and POST arrays
+ case 'plugin':
+ if (TYPO3_MODE == 'FE') {
+ try {
+ $returnValue = self::getValue($GLOBALS['TSFE']->tmpl->setup['plugin.'], $indices);
+ $hasValue = TRUE;
+ }
+ catch (Exception $e) {
+ continue;
+ }
+ } else {
+ // Throw exception, but only if we have run out of alternatives
+ if ($numberOfAlternatives == 0) {
+ throw new Exception('Plugin setup not available in this mode (' . TYPO3_MODE . ')');
+ }
+ }
+ break;
+ // Search for a value in the merged GET and POST arrays
+ case 'gp':
+ try {
+ $returnValue = self::getValue(
+ array_merge(
+ GeneralUtility::_GET(),
+ GeneralUtility::_POST()
+ ),
+ $indices
+ );
+ $hasValue = TRUE;
+ }
+ catch (Exception $e) {
+ continue;
+ }
+ break;
+ // Search for a value in the local variables
+ case 'vars':
+ try {
+ $returnValue = self::getValue(self::$vars, $indices);
+ $hasValue = TRUE;
+ }
+ catch (Exception $e) {
+ continue;
+ }
+ break;
+ // Search for a value in the extra data
+ case 'extra':
+ try {
+ $returnValue = self::getValue(self::$extraData, $indices);
+ $hasValue = TRUE;
+ }
+ catch (Exception $e) {
+ continue;
+ }
+ break;
+ // Calculate a value using the PHP date() function
+ case 'date':
+ $returnValue = date($indices);
+ $hasValue = TRUE;
+ break;
+ case 'strtotime':
+ $value = strtotime($indices);
+ if ($value === FALSE || $value === -1) {
+ throw new Exception('Date string could not be parsed: ' . $indices);
+ } else {
+ $returnValue = $value;
+ $hasValue = TRUE;
+ }
+ break;
+ // Get data from the session
+ // The session key is the first segment after the "session" keyword
+ case 'session':
+ $segments = GeneralUtility::trimExplode('|', $indices, TRUE);
+ $cacheKey = array_shift($segments);
+ $indices = implode('|', $segments);
+ $cache = $GLOBALS['TSFE']->fe_user->getKey('ses', $cacheKey);
+ if (empty($cache)) {
+ // Throw exception, but only if we have run out of alternatives
+ if ($numberOfAlternatives == 0) {
+ throw new Exception('No session data found for expression: ' . $expression);
+ } else {
+ continue;
+ }
+ }
+ try {
+ $returnValue = self::getValue($cache, $indices);
+ $hasValue = TRUE;
+ }
+ catch (Exception $e) {
+ continue;
+ }
+ break;
+ // Search for a value in FE User
+ case 'fe_user':
+ if (TYPO3_MODE == 'FE') {
+ try {
+ $returnValue = self::getValue($GLOBALS['TSFE']->fe_user->user, $indices);
+ $hasValue = TRUE;
+ }
+ catch (Exception $e) {
+ continue;
+ }
+ } else {
+ // Throw exception, but only if we have run out of alternatives
+ if ($numberOfAlternatives == 0) {
+ throw new Exception('TSFE->fe_user not available in this mode (' . TYPO3_MODE . ')');
+ }
+ }
+ break;
+ // Search for a value in the environment variables as returned by GeneralUtility::getIndpEnv()
+ case 'env':
+ $returnValue = GeneralUtility::getIndpEnv(strtoupper($indices));
+ $hasValue = TRUE;
+ break;
+ // If none of the standard keys matched, try looking for a hook for that given key
+ default:
+ if (isset($GLOBALS['TYPO3_CONF_VARS']['EXTCONF'][self::$extKey]['keyProcessor'][$key])) {
+ /** @var $keyProcessor KeyProcessorInterface */
+ $keyProcessor = GeneralUtility::getUserObj($GLOBALS['TYPO3_CONF_VARS']['EXTCONF'][self::$extKey]['keyProcessor'][$key]);
+ if ($keyProcessor instanceof KeyProcessorInterface) {
+ $returnValue = $keyProcessor->getValue($indices);
+ $hasValue = TRUE;
+ }
+ }
+ break;
+ }
+ }
+ // If a value was found, process it and exit the loop
+ if ($hasValue) {
+ // Call functions, if any
+ if (count($functions) > 0) {
+ foreach ($functions as $functionDefinition) {
+ try {
+ $returnValue = self::processFunctionCall($returnValue, $functionDefinition);
+ }
+ // Do nothing on exceptions, value is unchanged
+ catch (Exception $e) {
+ continue;
+ }
+ }
+ }
+ break;
+ }
+ }
+ }
+ // If a value was found, call a post-processing hook and return the value
+ if ($hasValue) {
+ if (is_array($GLOBALS['TYPO3_CONF_VARS']['EXTCONF'][self::$extKey]['postprocessReturnValue'])) {
+ foreach($GLOBALS['TYPO3_CONF_VARS']['EXTCONF'][self::$extKey]['postprocessReturnValue'] as $className) {
+ /** @var $postProcessor ValuePostProcessorInterface */
+ $postProcessor = GeneralUtility::getUserObj($className);
+ if ($postProcessor instanceof ValuePostProcessorInterface) {
+ $returnValue = $postProcessor->postprocessReturnValue($returnValue);
+ }
+ }
+ }
+ return $returnValue;
+
+ // No value was found, throw an exception
+ } else {
+ throw new Exception('No value found for expression: ' . $expression);
+ }
+ }
+
+ /**
+ * Gets a value from inside a multi-dimensional array or object.
+ *
+ * NOTE: this code is largely inspired by \TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::getGlobal().
+ *
+ * @param mixed $source Array or object to look into
+ * @param string $indices "Path" of indices inside the multi-dimensional array, of the form index1|index2|...
+ * @throws Exception
+ * @return mixed Whatever value was found in the array, but it should be a simple type
+ */
+ protected static function getValue($source, $indices) {
+ $value = $source;
+ if (empty($indices)) {
+ throw new Exception('No key given for source');
+ } else {
+ $indexList = GeneralUtility::trimExplode('|', $indices, TRUE);
+ foreach ($indexList as $key) {
+ if (is_object($value) && isset($value->$key) && $value->$key !== '') {
+ $value = $value->$key;
+ } elseif (is_array($value) && isset($value[$key]) && $value[$key] !== '') {
+ $value = $value[$key];
+ } else {
+ throw new Exception('Key ' . $indices . ' not found in source');
+ }
+ }
+ }
+ return $value;
+ }
+
+ /**
+ * Handles the function calls that can be made inside expressions.
+ *
+ * NOTE: if the function cannot be called, the original value is returned untouched.
+ *
+ * @param mixed $value The value to pass to the function (the result of an expression)
+ * @param string $functionDefinition The definition of the function to call in the appropriate syntax
+ * @return mixed The value, as processed by the function
+ */
+ protected function processFunctionCall($value, $functionDefinition) {
+ // Initializations
+ $arguments = array();
+ // Separate function key and list of arguments
+ list($function, $argumentsString) = GeneralUtility::trimExplode(':', $functionDefinition, TRUE);
+ // Get arguments as array
+ if (isset($argumentsString) && $argumentsString != '') {
+ $arguments = GeneralUtility::trimExplode(',', $argumentsString, TRUE);
+ }
+ // Execute the function, recursively if value is an array
+ if (is_array($value)) {
+ $processedValue = self::executeFunctionOnArray($value, $function, $arguments);
+ } else {
+ $processedValue = self::executeFunctionOnItem($value, $function, $arguments);
+ }
+ return $processedValue;
+ }
+
+ /**
+ * Loops on all items in an array and executes the function on it
+ * (or calls itself recursively if item is itself an array).
+ *
+ * @param array $value List of values to call the function on
+ * @param string $function The key of the function to call
+ * @param array $arguments The list of arguments to pass in the function call
+ * @return array The processed array of values
+ */
+ protected function executeFunctionOnArray(array $value, $function, $arguments) {
+ foreach ($value as $key => $item) {
+ if (is_array($item)) {
+ $value[$key] = self::executeFunctionOnArray($item, $function, $arguments);
+ } else {
+ $value[$key] = self::executeFunctionOnItem($item, $function, $arguments);
+ }
+ }
+ return $value;
+ }
+
+ /**
+ * Calls the processing function on a given value.
+ *
+ * @param mixed $value Value to call the function on
+ * @param string $function The key of the function to call
+ * @param array $arguments The list of arguments to pass in the function call
+ * @throws Exception
+ * @return array The processed values
+ */
+ protected function executeFunctionOnItem($value, $function, $arguments) {
+ $processedValue = $value;
+ // Execute function
+ switch ($function) {
+ case 'fullQuoteStr':
+ if (count($arguments) < 1) {
+ throw new Exception('fullQuoteStr() requires 1 argument (table name)');
+ } elseif (!isset($GLOBALS['TYPO3_DB'])) {
+ throw new Exception('TYPO3_DB object not available');
+ } else {
+ $processedValue = self::getDatabaseConnection()->fullQuoteStr($value, $arguments[0]);
+ }
+ break;
+ case 'quoteStr':
+ if (count($arguments) < 1) {
+ throw new Exception('quoteStr() requires 1 argument (table name)');
+ } elseif (!isset($GLOBALS['TYPO3_DB'])) {
+ throw new Exception('TYPO3_DB object not available');
+ } else {
+ $processedValue = self::getDatabaseConnection()->quoteStr($value, $arguments[0]);
+ }
+ break;
+ case 'strip_tags':
+ $functionArguments = array($value);
+ if (isset($arguments[0])) {
+ $functionArguments[] = $arguments[0];
+ }
+ $processedValue = call_user_func_array('strip_tags', $functionArguments);
+ break;
+ case 'removeXSS':
+ $processedValue = GeneralUtility::removeXSS($value);
+ break;
+ case 'intval':
+ $functionArguments = array($value);
+ if (isset($arguments[0])) {
+ $functionArguments[] = $arguments[0];
+ }
+ $processedValue = call_user_func_array('intval', $functionArguments);
+ break;
+ case 'floatval':
+ $processedValue = floatval($value);
+ break;
+ case 'boolean':
+ $processedValue = !empty($value);
+ break;
+ case 'hsc':
+ $functionArguments = array($value);
+ if (count($arguments) > 0) {
+ foreach ($arguments as $item) {
+ $functionArguments[] = $item;
+ }
+ }
+ $processedValue = call_user_func_array('htmlspecialchars', $functionArguments);
+ break;
+ case 'strftime':
+ if (count($arguments) < 1) {
+ throw new Exception('strftime() requires 1 argument (date format)');
+ } else {
+ $processedValue = strftime($arguments[0], $value);
+ }
+ break;
+
+ // If no standard key matches, try to call user-defined function
+ default:
+ if (isset($GLOBALS['TYPO3_CONF_VARS']['EXTCONF'][self::$extKey]['customFunction'][$function])) {
+ $functionArguments = array($value);
+ if (count($arguments) > 0) {
+ foreach ($arguments as $item) {
+ $functionArguments[] = $item;
+ }
+ }
+ // Call user function
+ // Note the last parameter: since this class is purely static,
+ // a reference to it cannot be passed to the user function,
+ // so we instantiate a dummy object instead
+ $processedValue = GeneralUtility::callUserFunction(
+ $GLOBALS['TYPO3_CONF_VARS']['EXTCONF'][self::$extKey]['customFunction'][$function],
+ $functionArguments,
+ new \stdClass
+ );
+ }
+ break;
+ }
+ return $processedValue;
+ }
+
+ /**
+ * This method can be used to store whatever local variables make sense into the parser, for later retrieval
+ * In the case of a FE plugin, it would be the piVars
+ *
+ * @param array $vars Array of values
+ * @param boolean $reset TRUE if self::$vars must be reset
+ * @return void
+ */
+ public static function setVars($vars, $reset = FALSE) {
+ if (is_array($vars)) {
+ if ($reset) {
+ self::$vars = $vars;
+ } else {
+ ArrayUtility::mergeRecursiveWithOverrule(self::$vars, $vars);
+ }
+ }
+ }
+
+ /**
+ * Stores additional variables into the parser, that should not be mixed up
+ * with the local variables stored in self::$vars.
+ *
+ * @param array $data Array of values
+ * @param boolean $reset TRUE if self::$extraData must be reset
+ * @return void
+ * @see \Cobweb\Expressions\Parser::setVars()
+ */
+ public static function setExtraData($data, $reset = FALSE) {
+ if (is_array($data)) {
+ if ($reset) {
+ self::$extraData = $data;
+ } else {
+ ArrayUtility::mergeRecursiveWithOverrule(self::$extraData, $data);
+ }
+ }
+ }
+
+ /**
+ * Returns the global database object.
+ *
+ * @return \TYPO3\CMS\Core\Database\DatabaseConnection
+ */
+ protected static function getDatabaseConnection() {
+ return $GLOBALS['TYPO3_DB'];
+ }
+}
--- /dev/null
+<?php
+namespace Cobweb\Expressions;
+
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+/**
+ * Interface which defines the method to implement when creating a special key processor for expressions.
+ *
+ * @author Francois Suter (Cobweb) <typo3@cobweb.ch>
+ * @package TYPO3
+ * @subpackage tx_expressions
+ */
+interface KeyProcessorInterface {
+ /**
+ * This method must be implemented to handle the "indices" part it receives from the parser.
+ *
+ * Assuming an expression such as:
+ *
+ * mykey:foo|bar
+ *
+ * the method will receive the string foo|bar.
+ * It is expected to return a value that makes sense or else throw an exception.
+ *
+ * @param string $indices The string to be interpreted
+ * @return mixed The resulting value
+ */
+ public function getValue($indices);
+}
--- /dev/null
+<?php
+namespace Cobweb\Expressions\Sample;
+
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+/**
+ * Sample class providing an example user function for post-processing expressions.
+ *
+ * To activate that function, enter the following is some localconf file:
+ *
+ * $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['expressions']['customFunction']['offset'] = 'Cobweb\\Expressions\\Sample\\FunctionProcessor->offset';
+ *
+ * To use it in an expression, enter something like:
+ *
+ * gp:foo|bar->offset:10
+ *
+ * This will take the foo[bar] GET/POST variable and offset it by 10
+ *
+ * @author Francois Suter (Cobweb) <typo3@cobweb.ch>
+ * @package TYPO3
+ * @subpackage tx_expressions
+ */
+class FunctionProcessor {
+ /**
+ * Sample method to process expressions using the function-calling syntax
+ * i.e. this method might be called using:
+ *
+ * gp:foo|bar->offset:10
+ *
+ * The method receives an array of parameters and a reference to a dummy object
+ * (there's no real reference to a calling object, because the calling object is static).
+ * The array of parameters always contains the value from the expression first
+ * (i.e. in $parameters[0]).
+ * Any additional parameters required by the function come next. In this sample's
+ * case, the second parameter ($parameters[1]) is a number by which the value
+ * will be offset.
+ *
+ * The method *must* return the expression's value, even if unchanged.
+ *
+ * @param array $parameters Indexed list of parameters. The first one is the expression's result.
+ * @param object $parentObject Dummy object. Not usable.
+ * @return mixed The processed value
+ */
+ public function offset($parameters, $parentObject) {
+ $value = intval($parameters[0]);
+ $offset = 0;
+ if (isset($parameters[1])) {
+ $offset = intval($parameters[1]);
+ }
+ return $value + $offset;
+ }
+}
--- /dev/null
+<?php
+namespace Cobweb\Expressions;
+
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+/**
+ * Interface which defines the method to implement when creating a hook to post-process parsed expressions.
+ *
+ * @author Francois Suter (Cobweb) <typo3@cobweb.ch>
+ * @package TYPO3
+ * @subpackage tx_expressions
+ */
+interface ValuePostProcessorInterface {
+ /**
+ * This method must be implemented for post-processing a parsed value.
+ *
+ * It must return a value too, even if that is the unchanged input value.
+ *
+ * @param mixed $value The value that resulted from parsing an expression
+ * @return mixed The resulting value
+ */
+ public function postprocessReturnValue($value);
+}
<?php
+namespace Cobweb\Expressions\ViewHelpers;
-/* *
- * This script is part of the TYPO3 project - inspiring people to share! *
- * *
- * TYPO3 is free software; you can redistribute it and/or modify it under *
- * the terms of the GNU General Public License version 2 as published by *
- * the Free Software Foundation. *
- * *
- * This script is distributed in the hope that it will be useful, but *
- * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHAN- *
- * TABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General *
- * Public License for more details. *
- * */
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
-require_once(t3lib_extMgm::extPath('expressions', 'class.tx_expressions_parser.php'));
+use Cobweb\Expressions\ExpressionParser;
+use TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper;
/**
* This class is a Expressions view helper for the Fluid templating engine.
*
* @package TYPO3
* @subpackage tx_expressions
- * @version $Id$
+ * @author Fabien Udriot <fabien.udriot@ecodev.ch>
+ * @author Francois Suter <typo3@cobweb.ch>
*/
-class Tx_Expressions_ViewHelpers_EvaluateViewHelper extends Tx_Fluid_Core_ViewHelper_AbstractViewHelper {
+class EvaluateViewHelper extends AbstractViewHelper {
/**
- * Evaluates expression throughout the Expression Parser
+ * Evaluates expression throughout the Expression Parser.
*
* @param string $expression Expression to be evaluated
* @return string the evaluated string.
- * @author Fabien Udriot <fabien.udriot@ecodev.ch>
- * @author Francois Suter <typo3@cobweb.ch>
- * @api
*/
public function render($expression = NULL) {
if ($expression === NULL) {
$expression = $this->renderChildren();
};
- // Replace escaped curly braces
+ // Replace escaped curly braces
$searches[] = '\{';
$replaces[] = '{';
$searches[] = '\}';
$replaces[] = '}';
$expression = str_replace($searches, $replaces, $expression);
- // Evaluate and return
- return tx_expressions_parser::evaluateString($expression);
+ // Evaluate and return
+ return ExpressionParser::evaluateString($expression);
}
}
-
-?>
\ No newline at end of file
+++ /dev/null
-<?php
-/***************************************************************
-* Copyright notice
-*
-* (c) 2009 Francois Suter (Cobweb) <typo3@cobweb.ch>
-* All rights reserved
-*
-* This script is part of the TYPO3 project. The TYPO3 project is
-* free software; you can redistribute it and/or modify
-* it under the terms of the GNU General Public License as published by
-* the Free Software Foundation; either version 2 of the License, or
-* (at your option) any later version.
-*
-* The GNU General Public License can be found at
-* http://www.gnu.org/copyleft/gpl.html.
-*
-* This script is distributed in the hope that it will be useful,
-* but WITHOUT ANY WARRANTY; without even the implied warranty of
-* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-* GNU General Public License for more details.
-*
-* This copyright notice MUST APPEAR in all copies of the script!
-***************************************************************/
-
-/**
- * Utility class to parse strings and evaluate them as expressions or for any subexpressions they may contain
- *
- * @author Francois Suter (Cobweb) <typo3@cobweb.ch>
- * @package TYPO3
- * @subpackage tx_expressions
- *
- * $Id$
- */
-class tx_expressions_parser {
- public static $extKey = 'expressions';
- public static $vars = array(); // Local variables stored in the parser
- public static $extraData = array(); // Additional values stored in the parser
-
- /**
- * This method takes a string and checks for substrings inside curly braces {}
- * Each such substring will be evaluated and replaced
- * The resulting string is then evaluated or not, depending on the second argument
- *
- * @param string $string: the string to parse
- * @param boolean $doEvaluation: TRUE if string should be evaluated before being returned (default)
- * @return string The parsed string
- */
- public static function evaluateString($string, $doEvaluation = TRUE) {
- $matches = array();
- $numReplacements = preg_match_all('/(\{.*?\})/', $string, $matches, PREG_SET_ORDER);
- // If there was nothing to match or the matching failed, return the string as is
- $result = $string;
- if (!empty($numReplacements)) {
- $searches = array();
- $replacements = array();
- foreach ($matches as $aMatch) {
- $searches[] = $aMatch[1];
- $expression = substr($aMatch[1], 1, strlen($aMatch[1]) - 2);
- $evaluatedExpression = $expression;
- try {
- $evaluatedExpression = self::evaluateExpression($expression);
- }
- catch (Exception $e) {
- if (TYPO3_DLOG) {
- t3lib_div::devLog('Bad subexpression: ' . $expression . ' (' . $e->getMessage() . ')', 'expressions', 2);
- }
- }
- $replacements[] = $evaluatedExpression;
- }
- $result = str_replace($searches, $replacements, $string);
- }
- // Evaluate the string, if necessary
- $finalString = $result;
- if ($doEvaluation) {
- try {
- $finalString = self::evaluateExpression($result);
- }
- // If the evaluation fails, return the original string
- catch (Exception $e) {
- if (TYPO3_DLOG) {
- t3lib_div::devLog('Could not evaluate string: ' . $result . ' (' . $e->getMessage() . ')', 'expressions', 2);
- }
- }
- }
- return $finalString;
- }
-
- /**
- * This method evaluates the value of a given expression for a filter
- * The expected syntax of a filter value is key:index1|index2|...
- * Simple values will be used as is
- *
- * @param string $expression The expression to evaluate
- * @throws Exception
- * @return string The value for the filter
- */
- public static function evaluateExpression($expression) {
- $returnValue = '';
- $hasValue = FALSE;
- if (!isset($expression) || $expression === '') {
- throw new Exception('Empty expression received');
- } else {
- // First of all, evaluate any subexpressions that may be contained in the expression
- $parsedExpression = self::evaluateString($expression, FALSE);
- // An expression may contain several expressions as alternativtye values, separated by a double slash (//)
- $allExpressions = t3lib_div::trimExplode('//', $parsedExpression, TRUE);
- $numberOfAlternatives = count($allExpressions);
- foreach ($allExpressions as $anExpression) {
- // Decrease the number of remaining alternatives
- $numberOfAlternatives--;
- // Check if there's a function call
- $functions = array();
- if (strpos($anExpression, '->') !== FALSE) {
- // Split on the function call marker (->)
- $expressionParts = t3lib_div::trimExplode('->', $anExpression, TRUE);
- // The first part is the expression itself
- $anExpression = array_shift($expressionParts);
- // All other parts are function definitions
- $functions = $expressionParts;
- }
- // If there's no colon (:) in the expression, take it to be a litteral value and return it as is
- if (strpos($anExpression, ':') === FALSE) {
- $returnValue = $anExpression;
- $hasValue = TRUE;
- } else {
- $subParts = t3lib_div::trimExplode(':', $anExpression, TRUE);
- $key = array_shift($subParts);
- $indices = implode(':', $subParts);
- if (empty($indices)) {
- throw new Exception('No indices in expression: ' . $expression);
- }
- $key = strtolower($key);
- switch ($key) {
- // Search for a value in the TSFE
- case 'tsfe':
- if (TYPO3_MODE == 'FE') {
- try {
- $returnValue = self::getValue($GLOBALS['TSFE'], $indices);
- $hasValue = TRUE;
- }
- catch (Exception $e) {
- continue;
- }
- } else {
- // Throw exception, but only if we have run out of alternatives
- if ($numberOfAlternatives == 0) {
- throw new Exception('TSFE not available in this mode (' . TYPO3_MODE . ')');
- }
- }
- break;
- // Search for a value in the page record
- // This is a convenience shortcut, as the page record is in the TSFE
- case 'page':
- if (TYPO3_MODE == 'FE') {
- try {
- $returnValue = self::getValue($GLOBALS['TSFE']->page, $indices);
- $hasValue = TRUE;
- }
- catch (Exception $e) {
- continue;
- }
- } else {
- // Throw exception, but only if we have run out of alternatives
- if ($numberOfAlternatives == 0) {
- throw new Exception('TSFE->page not available in this mode (' . TYPO3_MODE . ')');
- }
- }
- break;
- // Search for a value in the template configuration
- // This is a convenience shortcut, as the template configuration is in the TSFE
- case 'config':
- if (TYPO3_MODE == 'FE') {
- try {
- $returnValue = self::getValue($GLOBALS['TSFE']->config['config'], $indices);
- $hasValue = TRUE;
- }
- catch (Exception $e) {
- continue;
- }
- } else {
- // Throw exception, but only if we have run out of alternatives
- if ($numberOfAlternatives == 0) {
- throw new Exception('TSFE->config not available in this mode (' . TYPO3_MODE . ')');
- }
- }
- break;
- // Search for a value in the merged GET and POST arrays
- case 'plugin':
- if (TYPO3_MODE == 'FE') {
- try {
- $returnValue = self::getValue($GLOBALS['TSFE']->tmpl->setup['plugin.'], $indices);
- $hasValue = TRUE;
- }
- catch (Exception $e) {
- continue;
- }
- } else {
- // Throw exception, but only if we have run out of alternatives
- if ($numberOfAlternatives == 0) {
- throw new Exception('Plugin setup not available in this mode (' . TYPO3_MODE . ')');
- }
- }
- break;
- // Search for a value in the merged GET and POST arrays
- case 'gp':
- try {
- $returnValue = self::getValue(array_merge(t3lib_div::_GET(), t3lib_div::_POST()), $indices);
- $hasValue = TRUE;
- }
- catch (Exception $e) {
- continue;
- }
- break;
- // Search for a value in the local variables
- case 'vars':
- try {
- $returnValue = self::getValue(self::$vars, $indices);
- $hasValue = TRUE;
- }
- catch (Exception $e) {
- continue;
- }
- break;
- // Search for a value in the extra data
- case 'extra':
- try {
- $returnValue = self::getValue(self::$extraData, $indices);
- $hasValue = TRUE;
- }
- catch (Exception $e) {
- continue;
- }
- break;
- // Calculate a value using the PHP date() function
- case 'date':
- $returnValue = date($indices);
- $hasValue = TRUE;
- break;
- case 'strtotime':
- $value = strtotime($indices);
- if ($value === FALSE || $value === -1) {
- throw new Exception('Date string could not be parsed: ' . $indices);
- } else {
- $returnValue = $value;
- $hasValue = TRUE;
- }
- break;
- // Get data from the session
- // The session key is the first segment after the "session" keyword
- case 'session':
- $segments = t3lib_div::trimExplode('|', $indices, TRUE);
- $cacheKey = array_shift($segments);
- $indices = implode('|', $segments);
- $cache = $GLOBALS['TSFE']->fe_user->getKey('ses', $cacheKey);
- if (empty($cache)) {
- // Throw exception, but only if we have run out of alternatives
- if ($numberOfAlternatives == 0) {
- throw new Exception('No session data found for expression: ' . $expression);
- } else {
- continue;
- }
- }
- try {
- $returnValue = self::getValue($cache, $indices);
- $hasValue = TRUE;
- }
- catch (Exception $e) {
- continue;
- }
- break;
- // Search for a value in FE User
- case 'fe_user':
- if (TYPO3_MODE == 'FE') {
- try {
- $returnValue = self::getValue($GLOBALS['TSFE']->fe_user->user, $indices);
- $hasValue = TRUE;
- }
- catch (Exception $e) {
- continue;
- }
- } else {
- // Throw exception, but only if we have run out of alternatives
- if ($numberOfAlternatives == 0) {
- throw new Exception('TSFE->fe_user not available in this mode (' . TYPO3_MODE . ')');
- }
- }
- break;
- // Search for a value in the environment variables as returned by t3lib_div::getIndpEnv()
- case 'env':
- $returnValue = t3lib_div::getIndpEnv(strtoupper($indices));
- $hasValue = TRUE;
- break;
- // If none of the standard keys matched, try looking for a hook for that given key
- default:
- if (isset($GLOBALS['TYPO3_CONF_VARS']['EXTCONF'][self::$extKey]['keyProcessor'][$key])) {
- /** @var $keyProcessor tx_expressions_keyProcessor */
- $keyProcessor = &t3lib_div::getUserObj($GLOBALS['TYPO3_CONF_VARS']['EXTCONF'][self::$extKey]['keyProcessor'][$key]);
- if ($keyProcessor instanceof tx_expressions_keyProcessor) {
- $returnValue = $keyProcessor->getValue($indices);
- $hasValue = TRUE;
- }
- }
- break;
- }
- }
- // If a value was found, process it and exit the loop
- if ($hasValue) {
- // Call functions, if any
- if (count($functions) > 0) {
- foreach ($functions as $functionDefinition) {
- try {
- $returnValue = self::processFunctionCall($returnValue, $functionDefinition);
- }
- // Do nothing on exceptions, value is unchanged
- catch (Exception $e) {
- continue;
- }
- }
- }
- break;
- }
- }
- }
- // If a value was found, call a post-processing hook and return the value
- if ($hasValue) {
- if (is_array($GLOBALS['TYPO3_CONF_VARS']['EXTCONF'][self::$extKey]['postprocessReturnValue'])) {
- foreach($GLOBALS['TYPO3_CONF_VARS']['EXTCONF'][self::$extKey]['postprocessReturnValue'] as $className) {
- /** @var $postProcessor tx_expressions_valuePostProcessor */
- $postProcessor = &t3lib_div::getUserObj($className);
- if ($postProcessor instanceof tx_expressions_valuePostProcessor) {
- $returnValue = $postProcessor->postprocessReturnValue($returnValue);
- }
- }
- }
- return $returnValue;
-
- // No value was found, throw an exception
- } else {
- throw new Exception('No value found for expression: ' . $expression);
- }
- }
-
- /**
- * This method is used to get a value from inside a multi-dimensional array or object
- * NOTE: this code is largely inspired by tslib_content::getGlobal()
- *
- * @param mixed $source Array or object to look into
- * @param string $indices "Path" of indices inside the multi-dimensional array, of the form index1|index2|...
- * @throws Exception
- * @return mixed Whatever value was found in the array, but it should be a simple type
- */
- protected static function getValue($source, $indices) {
- $value = $source;
- if (empty($indices)) {
- throw new Exception('No key given for source');
- } else {
- $indexList = t3lib_div::trimExplode('|', $indices, TRUE);
- foreach ($indexList as $key) {
- if (is_object($value) && isset($value->$key) && $value->$key !== '') {
- $value = $value->$key;
- } elseif (is_array($value) && isset($value[$key]) && $value[$key] !== '') {
- $value = $value[$key];
- } else {
- throw new Exception('Key ' . $indices . ' not found in source');
- }
- }
- }
- return $value;
- }
-
- /**
- * This method handles the function calls that can be made inside expressions
- * NOTE: if the function cannot be called, the original value is returned untouched
- *
- * @param mixed $value: The value to pass to the function (the result of an expression)
- * @param string $functionDefinition: the definition of the function to call in the appropriate syntax
- * @return mixed The value, as processed by the function
- */
- protected function processFunctionCall($value, $functionDefinition) {
- // Initializations
- $arguments = array();
- // Separate function key and list of arguments
- list($function, $argumentsString) = t3lib_div::trimExplode(':', $functionDefinition, TRUE);
- // Get arguments as array
- if (isset($argumentsString) && $argumentsString != '') {
- $arguments = t3lib_div::trimExplode(',', $argumentsString, TRUE);
- }
- // Execute the function, recursively if value is an array
- if (is_array($value)) {
- $processedValue = self::executeFunctionOnArray($value, $function, $arguments);
- } else {
- $processedValue = self::executeFunctionOnItem($value, $function, $arguments);
- }
- return $processedValue;
- }
-
- /**
- * This method loops on all items in an array and executes the function on it
- * (or calls itself recursively if item is itself an array)
- *
- * @param array $value: list of values to call the function on
- * @param string $function: the key of the function to call
- * @param array $arguments: the list of arguments to pass in the function call
- * @return array The processed array of values
- */
- protected function executeFunctionOnArray(array $value, $function, $arguments) {
- foreach ($value as $key => $item) {
- if (is_array($item)) {
- $value[$key] = self::executeFunctionOnArray($item, $function, $arguments);
- } else {
- $value[$key] = self::executeFunctionOnItem($item, $function, $arguments);
- }
- }
- return $value;
- }
-
- /**
- * This method calls the processing function on a given value
- *
- * @param mixed $value Value to call the function on
- * @param string $function The key of the function to call
- * @param array $arguments The list of arguments to pass in the function call
- * @throws Exception
- * @return array The processed values
- */
- protected function executeFunctionOnItem($value, $function, $arguments) {
- $processedValue = $value;
- // Execute function
- switch ($function) {
- case 'fullQuoteStr':
- if (count($arguments) < 1) {
- throw new Exception('fullQuoteStr() requires 1 argument (table name)');
- } elseif (!isset($GLOBALS['TYPO3_DB'])) {
- throw new Exception('TYPO3_DB object not available');
- } else {
- $processedValue = $GLOBALS['TYPO3_DB']->fullQuoteStr($value, $arguments[0]);
- }
- break;
- case 'quoteStr':
- if (count($arguments) < 1) {
- throw new Exception('quoteStr() requires 1 argument (table name)');
- } elseif (!isset($GLOBALS['TYPO3_DB'])) {
- throw new Exception('TYPO3_DB object not available');
- } else {
- $processedValue = $GLOBALS['TYPO3_DB']->quoteStr($value, $arguments[0]);
- }
- break;
- case 'strip_tags':
- $functionArguments = array($value);
- if (isset($arguments[0])) {
- $functionArguments[] = $arguments[0];
- }
- $processedValue = call_user_func_array('strip_tags', $functionArguments);
- break;
- case 'removeXSS':
- $processedValue = t3lib_div::removeXSS($value);
- break;
- case 'intval':
- $functionArguments = array($value);
- if (isset($arguments[0])) {
- $functionArguments[] = $arguments[0];
- }
- $processedValue = call_user_func_array('intval', $functionArguments);
- break;
- case 'floatval':
- $processedValue = floatval($value);
- break;
- case 'boolean':
- $processedValue = !empty($value);
- break;
- case 'hsc':
- $functionArguments = array($value);
- if (count($arguments) > 0) {
- foreach ($arguments as $item) {
- $functionArguments[] = $item;
- }
- }
- $processedValue = call_user_func_array('htmlspecialchars', $functionArguments);
- break;
- case 'strftime':
- if (count($arguments) < 1) {
- throw new Exception('strftime() requires 1 argument (date format)');
- } else {
- $processedValue = strftime($arguments[0], $value);
- }
- break;
-
- // If no standard key matches, try to call user-defined function
- default:
- if (isset($GLOBALS['TYPO3_CONF_VARS']['EXTCONF'][self::$extKey]['customFunction'][$function])) {
- $functionArguments = array($value);
- if (count($arguments) > 0) {
- foreach ($arguments as $item) {
- $functionArguments[] = $item;
- }
- }
- // Call user function
- // Note the last parameter: since this class is purely static,
- // a reference to it cannot be passed to the user function,
- // so we instantiate a dummy object instead
- $processedValue = t3lib_div::callUserFunction($GLOBALS['TYPO3_CONF_VARS']['EXTCONF'][self::$extKey]['customFunction'][$function], $functionArguments, new stdClass);
- }
- break;
- }
- return $processedValue;
- }
-
- /**
- * This method can be used to store whatever local variables make sense into the parser, for later retrieval
- * In the case of a FE plugin, it would be the piVars
- *
- * @param array $vars: array of values
- * @param boolean $reset: TRUE if self::$vars must be reset
- * @return void
- */
- public static function setVars($vars, $reset = FALSE) {
- if (is_array($vars)) {
- if ($reset) {
- self::$vars = $vars;
- } else {
- self::$vars = t3lib_div::array_merge_recursive_overrule(self::$vars, $vars);
- }
- }
- }
-
- /**
- * This method can be used to store additional variables into the parser,
- * that should not be mixed up with the local variables stored in self::$vars
- *
- * @param array $data: array of values
- * @param boolean $reset: TRUE if self::$extraData must be reset
- * @return void
- * @see tx_expressions_parser::setVars()
- */
- public static function setExtraData($data, $reset = FALSE) {
- if (is_array($data)) {
- if ($reset) {
- self::$extraData = $data;
- } else {
- self::$extraData = t3lib_div::array_merge_recursive_overrule(self::$extraData, $data);
- }
- }
- }
-}
-
-
-
-if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['ext/expressions/class.tx_expressions_parser.php']) {
- include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['ext/expressions/class.tx_expressions_parser.php']);
-}
-
-?>
\ No newline at end of file
+++ /dev/null
-<?php
-/*
- * Register necessary class names with autoloader
- *
- * $Id: ext_autoload.php 219 2009-09-01 11:48:35Z fsuter $
- */
-$extensionPath = t3lib_extMgm::extPath('expressions');
-return array(
- 'tx_expressions_parser' => $extensionPath . 'class.tx_expressions_parser.php',
- 'tx_expressions_viewhelpers_evaluateviewhelper' => $extensionPath . 'Classes/ViewHelpers/EvaluateViewHelper.php',
-);
-?>
'clearCacheOnLoad' => 0,
'lockType' => '',
'author_company' => '',
- 'version' => '1.8.0',
- 'constraints' =>
+ 'version' => '2.0.0-dev',
+ 'constraints' =>
array (
- 'depends' =>
+ 'depends' =>
array (
- 'php' => '5.0.0-0.0.0',
- 'typo3' => '4.5.0-6.2.99',
+ 'typo3' => '6.2.0-7.3.99',
),
- 'conflicts' =>
+ 'conflicts' =>
array (
),
- 'suggests' =>
+ 'suggests' =>
array (
),
),
'_md5_values_when_last_written' => 'a:11:{s:9:"ChangeLog";s:4:"c6b6";s:31:"class.tx_expressions_parser.php";s:4:"d32e";s:16:"ext_autoload.php";s:4:"20d3";s:12:"ext_icon.gif";s:4:"160e";s:10:"README.txt";s:4:"ee2d";s:42:"Classes/ViewHelpers/EvaluateViewHelper.php";s:4:"8e4a";s:14:"doc/manual.pdf";s:4:"287c";s:14:"doc/manual.sxw";s:4:"08f1";s:52:"interfaces/interface.tx_expressions_keyprocessor.php";s:4:"6cf4";s:58:"interfaces/interface.tx_expressions_valuepostprocessor.php";s:4:"d945";s:50:"samples/class.tx_expressions_functionProcessor.php";s:4:"c39a";}',
- 'suggests' =>
+ 'suggests' =>
array (
),
'comment' => 'Verified compatibility with TYPO3 CMS 6.2',
+++ /dev/null
-<?php
-/***************************************************************
-* Copyright notice
-*
-* (c) 2009 Francois Suter (Cobweb) <typo3@cobweb.ch>
-* All rights reserved
-*
-* This script is part of the TYPO3 project. The TYPO3 project is
-* free software; you can redistribute it and/or modify
-* it under the terms of the GNU General Public License as published by
-* the Free Software Foundation; either version 2 of the License, or
-* (at your option) any later version.
-*
-* The GNU General Public License can be found at
-* http://www.gnu.org/copyleft/gpl.html.
-*
-* This script is distributed in the hope that it will be useful,
-* but WITHOUT ANY WARRANTY; without even the implied warranty of
-* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-* GNU General Public License for more details.
-*
-* This copyright notice MUST APPEAR in all copies of the script!
-***************************************************************/
-
-
-/**
- * Interface which defines the method to implement when creating a special key processor for expressions
- *
- * @author Francois Suter (Cobweb) <typo3@cobweb.ch>
- * @package TYPO3
- * @subpackage tx_expressions
- *
- * $Id: interface.tx_expressions_keyprocessor.php 235 2009-09-15 20:00:34Z fsuter $
- */
-interface tx_expressions_keyProcessor {
- /**
- * This method must be implemented to handle the "indices" part it receives from the parser
- * Assuming an expression such as:
- *
- * mykey:foo|bar
- *
- * the method will receive the string foo|bar
- * It is expected to return a value that makes sense or else throw an exception
- *
- * @param string $indices: the string to be interpreted
- * @return mixed The resulting value
- */
- public function getValue($indices);
-}
-?>
\ No newline at end of file
+++ /dev/null
-<?php
-/***************************************************************
-* Copyright notice
-*
-* (c) 2009 Francois Suter (Cobweb) <typo3@cobweb.ch>
-* All rights reserved
-*
-* This script is part of the TYPO3 project. The TYPO3 project is
-* free software; you can redistribute it and/or modify
-* it under the terms of the GNU General Public License as published by
-* the Free Software Foundation; either version 2 of the License, or
-* (at your option) any later version.
-*
-* The GNU General Public License can be found at
-* http://www.gnu.org/copyleft/gpl.html.
-*
-* This script is distributed in the hope that it will be useful,
-* but WITHOUT ANY WARRANTY; without even the implied warranty of
-* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-* GNU General Public License for more details.
-*
-* This copyright notice MUST APPEAR in all copies of the script!
-***************************************************************/
-
-
-/**
- * Interface which defines the method to implement when creating a hook to post-process parsed expressions
- *
- * @author Francois Suter (Cobweb) <typo3@cobweb.ch>
- * @package TYPO3
- * @subpackage tx_expressions
- *
- * $Id: interface.tx_expressions_valuepostprocessor.php 241 2009-09-29 15:38:23Z fsuter $
- */
-interface tx_expressions_valuePostProcessor {
- /**
- * This method must be implemented for post-processing a parsed value
- * It must return a value too, even if that is the unchanged input value
- *
- * @param mixed $value: the value that resulted from parsing an expression
- * @return mixed The resulting value
- */
- public function postprocessReturnValue($value);
-}
-?>
\ No newline at end of file
+++ /dev/null
-<?php
-/***************************************************************
-* Copyright notice
-*
-* (c) 2010 Francois Suter (Cobweb) <typo3@cobweb.ch>
-* All rights reserved
-*
-* This script is part of the TYPO3 project. The TYPO3 project is
-* free software; you can redistribute it and/or modify
-* it under the terms of the GNU General Public License as published by
-* the Free Software Foundation; either version 2 of the License, or
-* (at your option) any later version.
-*
-* The GNU General Public License can be found at
-* http://www.gnu.org/copyleft/gpl.html.
-*
-* This script is distributed in the hope that it will be useful,
-* but WITHOUT ANY WARRANTY; without even the implied warranty of
-* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-* GNU General Public License for more details.
-*
-* This copyright notice MUST APPEAR in all copies of the script!
-***************************************************************/
-
-/**
- * Sample class providing an example user function for post-processing expressions
- *
- * To activate that function, enter the following is some localconf file:
- *
- * $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['expressions']['customFunction']['offset'] = 'EXT:test/class.tx_test_functionprocessor.php:&tx_test_functionProcessor->offset';
- *
- * To use it in an expression, enter something like:
- *
- * gp:foo|bar->offset:10
- *
- * This will take the foo[bar] GET/POST variable and offset it by 10
- *
- * @author Francois Suter (Cobweb) <typo3@cobweb.ch>
- * @package TYPO3
- * @subpackage tx_expressions
- *
- * $Id$
- */
-class tx_expressions_functionProcessor {
- /**
- * Sample method to process expressions using the function-calling syntax
- * i.e. this method might be called using:
- *
- * gp:foo|bar->offset:10
- *
- * The method receives an array of parameters and a reference to a dummy object
- * (there's no real reference to a calling object, because the calling object is static)
- * The array of parameters always contains the value from the expression first
- * (i.e. in $parameters[0])
- * Any additional parameters required by the function come next. In this sample's
- * case, the second parameter ($parameters[1]) is a number by which the value
- * will be offset
- *
- * The method *must* return the expression's value, even if unchanged
- *
- * @param array $parameters: indexed list of parameters. The first one is the expression's result
- * @param object $pObj: dummy object. Not usable.
- * @return mixed The processed value
- */
- public function offset($parameters, $pObj) {
- $value = intval($parameters[0]);
- $offset = 0;
- if (isset($parameters[1])) {
- $offset = intval($parameters[1]);
- }
- return $value + $offset;
- }
-}
-?>
projects / TYPO3CMS / Extensions / expressions.git / commitdiff