init

backend/vendor/doctrine/collections/src/Expr/ClosureExpressionVisitor.php

@@ -0,0 +1,272 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Common\Collections\Expr;
+
+use ArrayAccess;
+use Closure;
+use Doctrine\Deprecations\Deprecation;
+use ReflectionClass;
+use RuntimeException;
+
+use function array_all;
+use function array_any;
+use function explode;
+use function func_get_arg;
+use function func_num_args;
+use function in_array;
+use function is_array;
+use function is_scalar;
+use function iterator_to_array;
+use function method_exists;
+use function preg_match;
+use function preg_replace_callback;
+use function sprintf;
+use function str_contains;
+use function str_ends_with;
+use function str_starts_with;
+use function strtoupper;
+
+use const PHP_VERSION_ID;
+
+/**
+ * Walks an expression graph and turns it into a PHP closure.
+ *
+ * This closure can be used with {@Collection#filter()} and is used internally
+ * by {@ArrayCollection#select()}.
+ *
+ * @final since 2.5
+ */
+class ClosureExpressionVisitor extends ExpressionVisitor
+{
+    public function __construct(
+        private readonly bool $accessRawFieldValues = false,
+    ) {
+    }
+
+    /**
+     * Accesses the field of a given object. This field has to be public
+     * directly or indirectly (through an accessor get*, is*, or a magic
+     * method, __get, __call).
+     *
+     * @param object|mixed[] $object
+     *
+     * @return mixed
+     */
+    public static function getObjectFieldValue(object|array $object, string $field, /* bool $accessRawFieldValues = false */)
+    {
+        $accessRawFieldValues = 3 <= func_num_args() ? func_get_arg(2) : false;
+
+        if (str_contains($field, '.')) {
+            [$field, $subField] = explode('.', $field, 2);
+            $object             = self::getObjectFieldValue($object, $field, $accessRawFieldValues);
+
+            return self::getObjectFieldValue($object, $subField, $accessRawFieldValues);
+        }
+
+        if (is_array($object)) {
+            return $object[$field];
+        }
+
+        if ($accessRawFieldValues) {
+            return self::getNearestFieldValue($object, $field);
+        }
+
+        Deprecation::trigger(
+            'doctrine/collections',
+            'https://github.com/doctrine/collections/pull/472',
+            'Not enabling raw field value access for %s is deprecated. Raw field access will be the only supported method in 3.0',
+            __METHOD__,
+        );
+
+        $accessors = ['get', 'is', ''];
+
+        foreach ($accessors as $accessor) {
+            $accessor .= $field;
+
+            if (method_exists($object, $accessor)) {
+                return $object->$accessor();
+            }
+        }
+
+        if (preg_match('/^is[A-Z]+/', $field) === 1 && method_exists($object, $field)) {
+            return $object->$field();
+        }
+
+        // __call should be triggered for get.
+        $accessor = $accessors[0] . $field;
+
+        if (method_exists($object, '__call')) {
+            return $object->$accessor();
+        }
+
+        if ($object instanceof ArrayAccess) {
+            return $object[$field];
+        }
+
+        if (isset($object->$field)) {
+            return $object->$field;
+        }
+
+        // camelcase field name to support different variable naming conventions
+        $ccField = preg_replace_callback('/_(.?)/', static fn ($matches) => strtoupper((string) $matches[1]), $field);
+
+        foreach ($accessors as $accessor) {
+            $accessor .= $ccField;
+
+            if (method_exists($object, $accessor)) {
+                return $object->$accessor();
+            }
+        }
+
+        return $object->$field;
+    }
+
+    private static function getNearestFieldValue(object $object, string $field): mixed
+    {
+        $reflectionClass = new ReflectionClass($object);
+
+        while ($reflectionClass && ! $reflectionClass->hasProperty($field)) {
+            $reflectionClass = $reflectionClass->getParentClass();
+        }
+
+        if ($reflectionClass === false) {
+            throw new RuntimeException(sprintf('Field "%s" does not exist in class "%s"', $field, $object::class));
+        }
+
+        $property = $reflectionClass->getProperty($field);
+
+        if (PHP_VERSION_ID >= 80400) {
+            return $property->getRawValue($object);
+        }
+
+        return $property->getValue($object);
+    }
+
+    /**
+     * Helper for sorting arrays of objects based on multiple fields + orientations.
+     *
+     * @return Closure
+     */
+    public static function sortByField(string $name, int $orientation = 1, Closure|null $next = null, /* bool $accessRawFieldValues = false */)
+    {
+        $accessRawFieldValues = 4 <= func_num_args() ? func_get_arg(3) : false;
+
+        if (! $accessRawFieldValues) {
+            Deprecation::trigger(
+                'doctrine/collections',
+                'https://github.com/doctrine/collections/pull/472',
+                'Not enabling raw field value access for %s is deprecated. Raw field access will be the only supported method in 3.0',
+                __METHOD__,
+            );
+        }
+
+        if (! $next) {
+            $next = static fn (): int => 0;
+        }
+
+        return static function ($a, $b) use ($name, $next, $orientation, $accessRawFieldValues): int {
+            $aValue = ClosureExpressionVisitor::getObjectFieldValue($a, $name, $accessRawFieldValues);
+            $bValue = ClosureExpressionVisitor::getObjectFieldValue($b, $name, $accessRawFieldValues);
+
+            if ($aValue === $bValue) {
+                return $next($a, $b);
+            }
+
+            return ($aValue > $bValue ? 1 : -1) * $orientation;
+        };
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function walkComparison(Comparison $comparison)
+    {
+        $field = $comparison->getField();
+        $value = $comparison->getValue()->getValue();
+
+        return match ($comparison->getOperator()) {
+            Comparison::EQ => fn ($object): bool => self::getObjectFieldValue($object, $field, $this->accessRawFieldValues) === $value,
+            Comparison::NEQ => fn ($object): bool => self::getObjectFieldValue($object, $field, $this->accessRawFieldValues) !== $value,
+            Comparison::LT => fn ($object): bool => self::getObjectFieldValue($object, $field, $this->accessRawFieldValues) < $value,
+            Comparison::LTE => fn ($object): bool => self::getObjectFieldValue($object, $field, $this->accessRawFieldValues) <= $value,
+            Comparison::GT => fn ($object): bool => self::getObjectFieldValue($object, $field, $this->accessRawFieldValues) > $value,
+            Comparison::GTE => fn ($object): bool => self::getObjectFieldValue($object, $field, $this->accessRawFieldValues) >= $value,
+            Comparison::IN => function ($object) use ($field, $value): bool {
+                $fieldValue = ClosureExpressionVisitor::getObjectFieldValue($object, $field, $this->accessRawFieldValues);
+
+                return in_array($fieldValue, $value, is_scalar($fieldValue));
+            },
+            Comparison::NIN => function ($object) use ($field, $value): bool {
+                $fieldValue = ClosureExpressionVisitor::getObjectFieldValue($object, $field, $this->accessRawFieldValues);
+
+                return ! in_array($fieldValue, $value, is_scalar($fieldValue));
+            },
+            Comparison::CONTAINS => fn ($object): bool => str_contains((string) self::getObjectFieldValue($object, $field, $this->accessRawFieldValues), (string) $value),
+            Comparison::MEMBER_OF => function ($object) use ($field, $value): bool {
+                $fieldValues = ClosureExpressionVisitor::getObjectFieldValue($object, $field, $this->accessRawFieldValues);
+
+                if (! is_array($fieldValues)) {
+                    $fieldValues = iterator_to_array($fieldValues);
+                }
+
+                return in_array($value, $fieldValues, true);
+            },
+            Comparison::STARTS_WITH => fn ($object): bool => str_starts_with((string) self::getObjectFieldValue($object, $field, $this->accessRawFieldValues), (string) $value),
+            Comparison::ENDS_WITH => fn ($object): bool => str_ends_with((string) self::getObjectFieldValue($object, $field, $this->accessRawFieldValues), (string) $value),
+            default => throw new RuntimeException('Unknown comparison operator: ' . $comparison->getOperator()),
+        };
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function walkValue(Value $value)
+    {
+        return $value->getValue();
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function walkCompositeExpression(CompositeExpression $expr)
+    {
+        $expressionList = [];
+
+        foreach ($expr->getExpressionList() as $child) {
+            $expressionList[] = $this->dispatch($child);
+        }
+
+        return match ($expr->getType()) {
+            CompositeExpression::TYPE_AND => $this->andExpressions($expressionList),
+            CompositeExpression::TYPE_OR => $this->orExpressions($expressionList),
+            CompositeExpression::TYPE_NOT => $this->notExpression($expressionList),
+            default => throw new RuntimeException('Unknown composite ' . $expr->getType()),
+        };
+    }
+
+    /** @param callable[] $expressions */
+    private function andExpressions(array $expressions): Closure
+    {
+        return static fn ($object): bool => array_all(
+            $expressions,
+            static fn (callable $expression): bool => (bool) $expression($object),
+        );
+    }
+
+    /** @param callable[] $expressions */
+    private function orExpressions(array $expressions): Closure
+    {
+        return static fn ($object): bool => array_any(
+            $expressions,
+            static fn (callable $expression): bool => (bool) $expression($object),
+        );
+    }
+
+    /** @param callable[] $expressions */
+    private function notExpression(array $expressions): Closure
+    {
+        return static fn ($object) => ! $expressions[0]($object);
+    }
+}

backend/vendor/doctrine/collections/src/Expr/Comparison.php

@@ -0,0 +1,64 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Common\Collections\Expr;
+
+/**
+ * Comparison of a field with a value by the given operator.
+ *
+ * @final since 2.5
+ */
+class Comparison implements Expression
+{
+    final public const EQ          = '=';
+    final public const NEQ         = '<>';
+    final public const LT          = '<';
+    final public const LTE         = '<=';
+    final public const GT          = '>';
+    final public const GTE         = '>=';
+    final public const IS          = '='; // no difference with EQ
+    final public const IN          = 'IN';
+    final public const NIN         = 'NIN';
+    final public const CONTAINS    = 'CONTAINS';
+    final public const MEMBER_OF   = 'MEMBER_OF';
+    final public const STARTS_WITH = 'STARTS_WITH';
+    final public const ENDS_WITH   = 'ENDS_WITH';
+
+    private readonly Value $value;
+
+    public function __construct(private readonly string $field, private readonly string $op, mixed $value)
+    {
+        if (! ($value instanceof Value)) {
+            $value = new Value($value);
+        }
+
+        $this->value = $value;
+    }
+
+    /** @return string */
+    public function getField()
+    {
+        return $this->field;
+    }
+
+    /** @return Value */
+    public function getValue()
+    {
+        return $this->value;
+    }
+
+    /** @return string */
+    public function getOperator()
+    {
+        return $this->op;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function visit(ExpressionVisitor $visitor)
+    {
+        return $visitor->walkComparison($this);
+    }
+}

backend/vendor/doctrine/collections/src/Expr/CompositeExpression.php

@@ -0,0 +1,72 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Common\Collections\Expr;
+
+use RuntimeException;
+
+use function count;
+
+/**
+ * Expression of Expressions combined by AND or OR operation.
+ *
+ * @final since 2.5
+ */
+class CompositeExpression implements Expression
+{
+    final public const TYPE_AND = 'AND';
+    final public const TYPE_OR  = 'OR';
+    final public const TYPE_NOT = 'NOT';
+
+    /** @var list<Expression> */
+    private array $expressions = [];
+
+    /**
+     * @param Expression[] $expressions
+     *
+     * @throws RuntimeException
+     */
+    public function __construct(private readonly string $type, array $expressions)
+    {
+        foreach ($expressions as $expr) {
+            if ($expr instanceof Value) {
+                throw new RuntimeException('Values are not supported expressions as children of and/or expressions.');
+            }
+
+            if (! ($expr instanceof Expression)) {
+                throw new RuntimeException('No expression given to CompositeExpression.');
+            }
+
+            $this->expressions[] = $expr;
+        }
+
+        if ($type === self::TYPE_NOT && count($this->expressions) !== 1) {
+            throw new RuntimeException('Not expression only allows one expression as child.');
+        }
+    }
+
+    /**
+     * Returns the list of expressions nested in this composite.
+     *
+     * @return list<Expression>
+     */
+    public function getExpressionList()
+    {
+        return $this->expressions;
+    }
+
+    /** @return string */
+    public function getType()
+    {
+        return $this->type;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function visit(ExpressionVisitor $visitor)
+    {
+        return $visitor->walkCompositeExpression($this);
+    }
+}

backend/vendor/doctrine/collections/src/Expr/Expression.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Common\Collections\Expr;
+
+/**
+ * Expression for the {@link Selectable} interface.
+ */
+interface Expression
+{
+    /** @return mixed */
+    public function visit(ExpressionVisitor $visitor);
+}

backend/vendor/doctrine/collections/src/Expr/ExpressionVisitor.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Common\Collections\Expr;
+
+/**
+ * An Expression visitor walks a graph of expressions and turns them into a
+ * query for the underlying implementation.
+ */
+abstract class ExpressionVisitor
+{
+    /**
+     * Converts a comparison expression into the target query language output.
+     *
+     * @return mixed
+     */
+    abstract public function walkComparison(Comparison $comparison);
+
+    /**
+     * Converts a value expression into the target query language part.
+     *
+     * @return mixed
+     */
+    abstract public function walkValue(Value $value);
+
+    /**
+     * Converts a composite expression into the target query language output.
+     *
+     * @return mixed
+     */
+    abstract public function walkCompositeExpression(CompositeExpression $expr);
+
+    /**
+     * Dispatches walking an expression to the appropriate handler.
+     *
+     * @return mixed
+     */
+    public function dispatch(Expression $expr)
+    {
+        return $expr->visit($this);
+    }
+}

backend/vendor/doctrine/collections/src/Expr/Value.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Common\Collections\Expr;
+
+/** @final since 2.5 */
+class Value implements Expression
+{
+    public function __construct(private readonly mixed $value)
+    {
+    }
+
+    /** @return mixed */
+    public function getValue()
+    {
+        return $this->value;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function visit(ExpressionVisitor $visitor)
+    {
+        return $visitor->walkValue($this);
+    }
+}