Merge pull request #6966 from morozov/more-table-editor-methods

Add more TableEditor methods

Author: morozov

src/Schema/Collections/Exception.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\DBAL\Schema\Collections;
+
+use Doctrine\DBAL\Schema\SchemaException;
+
+/** @internal */
+interface Exception extends SchemaException
+{
+}

src/Schema/Collections/Exception/ObjectAlreadyExists.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\DBAL\Schema\Collections\Exception;
+
+use Doctrine\DBAL\Schema\Collections\Exception;
+use Doctrine\DBAL\Schema\Name\UnqualifiedName;
+use LogicException;
+
+use function sprintf;
+
+/** @internal */
+final class ObjectAlreadyExists extends LogicException implements Exception
+{
+    public function __construct(string $message, private readonly UnqualifiedName $objectName)
+    {
+        parent::__construct($message);
+    }
+
+    public function getObjectName(): UnqualifiedName
+    {
+        return $this->objectName;
+    }
+
+    public static function new(UnqualifiedName $objectName): self
+    {
+        return new self(sprintf('Object %s already exists.', $objectName->toString()), $objectName);
+    }
+}

src/Schema/Collections/Exception/ObjectDoesNotExist.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\DBAL\Schema\Collections\Exception;
+
+use Doctrine\DBAL\Schema\Collections\Exception;
+use Doctrine\DBAL\Schema\Name\UnqualifiedName;
+use LogicException;
+
+use function sprintf;
+
+/** @internal */
+final class ObjectDoesNotExist extends LogicException implements Exception
+{
+    public function __construct(string $message, private readonly UnqualifiedName $objectName)
+    {
+        parent::__construct($message);
+    }
+
+    public function getObjectName(): UnqualifiedName
+    {
+        return $this->objectName;
+    }
+
+    public static function new(UnqualifiedName $objectName): self
+    {
+        return new self(sprintf('Object %s does not exist.', $objectName->toString()), $objectName);
+    }
+}

src/Schema/Collections/ObjectSet.php

@@ -0,0 +1,69 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\DBAL\Schema\Collections;
+
+use Doctrine\DBAL\Schema\Collections\Exception\ObjectAlreadyExists;
+use Doctrine\DBAL\Schema\Collections\Exception\ObjectDoesNotExist;
+use Doctrine\DBAL\Schema\Name\UnqualifiedName;
+
+/**
+ * A set of objects where each object is uniquely identified by its {@link UnqualifiedName}.
+ *
+ * @internal
+ *
+ * @template E of object
+ */
+interface ObjectSet
+{
+    /**
+     * Checks if the set is empty.
+     */
+    public function isEmpty(): bool;
+
+    /**
+     * Returns the element with the given name. If no such element exists, null is returned.
+     *
+     * @phpstan-return E|null
+     */
+    public function get(UnqualifiedName $elementName): ?object;
+
+    /**
+     * Adds the given element to the set.
+     *
+     * @phpstan-param E $element
+     *
+     * @throws ObjectAlreadyExists If an element with the same name already exists.
+     */
+    public function add(object $element): void;
+
+    /**
+     * Removes the element with the given name from the set.
+     *
+     * @throws ObjectDoesNotExist If no element with the given name exists.
+     */
+    public function remove(UnqualifiedName $elementName): void;
+
+    /**
+     * Modifies the element with the given name using the provided callable.
+     *
+     * @param callable(E): E $modification
+     *
+     * @throws ObjectDoesNotExist If no element with the given name exists.
+     * @throws ObjectAlreadyExists If an element with the name after modification already exists.
+     */
+    public function modify(UnqualifiedName $elementName, callable $modification): void;
+
+    /**
+     * Clears the set, removing all elements.
+     */
+    public function clear(): void;
+
+    /**
+     * Returns the elements of the set represented as a list.
+     *
+     * @phpstan-return list<E>
+     */
+    public function toList(): array;
+}

src/Schema/Collections/OptionallyUnqualifiedNamedObjectSet.php

@@ -0,0 +1,164 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\DBAL\Schema\Collections;
+
+use Doctrine\DBAL\Schema\Collections\Exception\ObjectAlreadyExists;
+use Doctrine\DBAL\Schema\Collections\Exception\ObjectDoesNotExist;
+use Doctrine\DBAL\Schema\Name\UnqualifiedName;
+use Doctrine\DBAL\Schema\OptionallyNamedObject;
+
+use function array_splice;
+use function count;
+use function strtolower;
+
+/**
+ * An ordered set of {@link OptionallyNamedObject}s with names being {@link UnqualifiedName}.
+ *
+ * New objects are added to the end of the set. The order of elements is preserved during modification.
+ *
+ * If an object is unnamed, it can be added to the set but cannot be referenced and, therefore, modified or removed
+ * from the set. Two unnamed objects are considered as having different names.
+ *
+ * @internal
+ *
+ * @template E of OptionallyNamedObject<UnqualifiedName>
+ * @template-implements ObjectSet<E>
+ */
+final class OptionallyUnqualifiedNamedObjectSet implements ObjectSet
+{
+    /** @var list<E> */
+    private array $elements = [];
+
+    /** @var array<string, int> */
+    private array $elementPositionsByKey = [];
+
+    /** @phpstan-param E ...$elements */
+    public function __construct(OptionallyNamedObject ...$elements)
+    {
+        foreach ($elements as $element) {
+            $this->add($element);
+        }
+    }
+
+    public function isEmpty(): bool
+    {
+        return count($this->elements) === 0;
+    }
+
+    public function get(UnqualifiedName $elementName): ?OptionallyNamedObject
+    {
+        $key = $this->getKey($elementName);
+
+        if (isset($this->elementPositionsByKey[$key])) {
+            return $this->elements[$this->elementPositionsByKey[$key]];
+        }
+
+        return null;
+    }
+
+    public function add(object $element): void
+    {
+        $elementName = $element->getObjectName();
+
+        if ($elementName !== null) {
+            $key = $this->getKey($elementName);
+
+            if (isset($this->elementPositionsByKey[$key])) {
+                throw ObjectAlreadyExists::new($elementName);
+            }
+
+            $this->elementPositionsByKey[$key] = count($this->elements);
+        }
+
+        $this->elements[] = $element;
+    }
+
+    public function remove(UnqualifiedName $elementName): void
+    {
+        $key = $this->getKey($elementName);
+
+        if (! isset($this->elementPositionsByKey[$key])) {
+            throw ObjectDoesNotExist::new($elementName);
+        }
+
+        $this->removeByKey($key);
+    }
+
+    public function modify(UnqualifiedName $elementName, callable $modification): void
+    {
+        $key = $this->getKey($elementName);
+
+        if (! isset($this->elementPositionsByKey[$key])) {
+            throw ObjectDoesNotExist::new($elementName);
+        }
+
+        $position = $this->elementPositionsByKey[$key];
+
+        $this->replace($key, $position, $modification($this->elements[$position]));
+    }
+
+    public function clear(): void
+    {
+        $this->elements = $this->elementPositionsByKey = [];
+    }
+
+    /** {@inheritDoc} */
+    public function toList(): array
+    {
+        return $this->elements;
+    }
+
+    /**
+     * Replaces the element corresponding to the old key with the provided element.
+     *
+     * @phpstan-param E $element
+     *
+     * @throws ObjectAlreadyExists If an element with the same name as the element name already exists.
+     */
+    private function replace(string $oldKey, int $position, OptionallyNamedObject $element): void
+    {
+        $elementName = $element->getObjectName();
+
+        if ($elementName !== null) {
+            $newKey = $this->getKey($elementName);
+
+            if ($newKey !== $oldKey) {
+                if (isset($this->elementPositionsByKey[$newKey])) {
+                    throw ObjectAlreadyExists::new($elementName);
+                }
+
+                unset($this->elementPositionsByKey[$oldKey]);
+
+                $this->elementPositionsByKey[$newKey] = $position;
+            }
+        } else {
+            unset($this->elementPositionsByKey[$oldKey]);
+        }
+
+        // @phpstan-ignore assign.propertyType
+        $this->elements[$position] = $element;
+    }
+
+    private function removeByKey(string $key): void
+    {
+        $position = $this->elementPositionsByKey[$key];
+
+        array_splice($this->elements, $position, 1);
+        unset($this->elementPositionsByKey[$key]);
+
+        foreach ($this->elementPositionsByKey as $elementKey => $elementPosition) {
+            if ($elementPosition <= $position) {
+                continue;
+            }
+
+            $this->elementPositionsByKey[$elementKey]--;
+        }
+    }
+
+    private function getKey(UnqualifiedName $name): string
+    {
+        return strtolower($name->getIdentifier()->getValue());
+    }
+}