| Current Path : /var/www/surf/TYPO3/vendor/typo3/cms-extbase/Classes/Persistence/Generic/Qom/ |
| Current File : /var/www/surf/TYPO3/vendor/typo3/cms-extbase/Classes/Persistence/Generic/Qom/Comparison.php |
<?php
declare(strict_types=1);
/*
* 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!
*/
namespace TYPO3\CMS\Extbase\Persistence\Generic\Qom;
use TYPO3\CMS\Extbase\Persistence\QueryInterface;
/**
* Filters node-tuples based on the outcome of a binary operation.
*
* For any comparison, operand2 always evaluates to a scalar value. In contrast,
* operand1 may evaluate to an array of values (for example, the value of a multi-valued
* property), in which case the comparison is separately performed for each element
* of the array, and the Comparison constraint is satisfied as a whole if the
* comparison against any element of the array is satisfied.
*
* If operand1 and operand2 evaluate to values of different property types, the
* value of operand2 is converted to the property type of the value of operand1.
* If the type conversion fails, the query is invalid.
*
* If operator is not supported for the property type of operand1, the query is invalid.
*
* If operand1 evaluates to null (for example, if the operand evaluates the value
* of a property which does not exist), the constraint is not satisfied.
*
* The OPERATOR_EQUAL_TO operator is satisfied only if the value of operand1
* equals the value of operand2.
*
* The OPERATOR_NOT_EQUAL_TO operator is satisfied unless the value of
* operand1 equals the value of operand2.
*
* The OPERATOR_LESS_THAN operator is satisfied only if the value of
* operand1 is ordered before the value of operand2.
*
* The OPERATOR_LESS_THAN_OR_EQUAL_TO operator is satisfied unless the value
* of operand1 is ordered after the value of operand2.
*
* The OPERATOR_GREATER_THAN operator is satisfied only if the value of
* operand1 is ordered after the value of operand2.
*
* The OPERATOR_GREATER_THAN_OR_EQUAL_TO operator is satisfied unless the
* value of operand1 is ordered before the value of operand2.
*
* The OPERATOR_LIKE operator is satisfied only if the value of operand1
* matches the pattern specified by the value of operand2, where in the pattern:
* the character "%" matches zero or more characters, and
* the character "_" (underscore) matches exactly one character, and
* the string "\x" matches the character "x", and
* all other characters match themselves.
*
* @internal only to be used within Extbase, not part of TYPO3 Core API.
*/
class Comparison implements ComparisonInterface
{
protected PropertyValueInterface $operand1;
/**
* @var QueryInterface::OPERATOR_*
*/
protected int $operator;
/**
* The type of the second operand will vary depending on the operator.
*
* @var mixed
* @todo Type this as mixed in v13.
*/
protected $operand2;
/**
* Constructs this Comparison instance
*
* @param QueryInterface::OPERATOR_* $operator
* @param mixed $operand2
*/
public function __construct(PropertyValueInterface $operand1, int $operator, $operand2)
{
$this->operand1 = $operand1;
$this->operator = $operator;
$this->operand2 = $operand2;
}
/**
* Gets the first operand.
*/
public function getOperand1(): PropertyValueInterface
{
return $this->operand1;
}
/**
* Gets the operator.
*
* @return QueryInterface::OPERATOR_*
*/
public function getOperator(): int
{
$operator = $this->operator;
if ($this->getOperand2() === null) {
if ($operator === QueryInterface::OPERATOR_EQUAL_TO) {
$operator = QueryInterface::OPERATOR_EQUAL_TO_NULL;
} elseif ($operator === QueryInterface::OPERATOR_NOT_EQUAL_TO) {
$operator = QueryInterface::OPERATOR_NOT_EQUAL_TO_NULL;
}
}
return $operator;
}
/**
* @return mixed
*/
public function getOperand2()
{
return $this->operand2;
}
/**
* Fills an array with the names of all bound variables in the constraints
*
* @param array $boundVariables
*/
public function collectBoundVariableNames(&$boundVariables): array
{
return [];
}
}