From bf6655a534a6775d30cafa67bd801276bda1d98d Mon Sep 17 00:00:00 2001 From: polo Date: Tue, 13 Aug 2024 23:45:21 +0200 Subject: =?UTF-8?q?VERSION=200.2=20doctrine=20ORM=20et=20entit=C3=A9s?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- vendor/doctrine/collections/UPGRADE.md | 112 +++++++++++++++++++++++++++++++++ 1 file changed, 112 insertions(+) create mode 100644 vendor/doctrine/collections/UPGRADE.md (limited to 'vendor/doctrine/collections/UPGRADE.md') diff --git a/vendor/doctrine/collections/UPGRADE.md b/vendor/doctrine/collections/UPGRADE.md new file mode 100644 index 0000000..44232f7 --- /dev/null +++ b/vendor/doctrine/collections/UPGRADE.md @@ -0,0 +1,112 @@ +Note about upgrading: Doctrine uses static and runtime mechanisms to raise +awareness about deprecated code. + +- Use of `@deprecated` docblock that is detected by IDEs (like PHPStorm) or + Static Analysis tools (like Psalm, phpstan) +- Use of our low-overhead runtime deprecation API, details: + https://github.com/doctrine/deprecations/ + +# Upgrade to 2.2 + +## Deprecated string representation of sort order + +Criteria orderings direction is now represented by the +`Doctrine\Common\Collection\Order` enum. + +As a consequence: + +- `Criteria::ASC` and `Criteria::DESC` are deprecated in favor of + `Order::Ascending` and `Order::Descending`, respectively. +- `Criteria::getOrderings()` is deprecated in favor of `Criteria::orderings()`, + which returns `array`. +- `Criteria::orderBy()` accepts `array`, but passing + anything other than `array` is deprecated. + +# Upgrade to 2.0 + +## BC breaking changes + +Native parameter types were added. Native return types will be added in 3.0.x +As a consequence, some signatures were changed and will have to be adjusted in sub-classes. + +Note that in order to keep compatibility with both 1.x and 2.x versions, +extending code would have to omit the added parameter types. +This would only work in PHP 7.2+ which is the first version featuring +[parameter widening](https://wiki.php.net/rfc/parameter-no-type-variance). +It is also recommended to add return types according to the tables below + +You can find a list of major changes to public API below. + +### Doctrine\Common\Collections\Collection + +| 1.0.x | 3.0.x | +|---------------------------------:|:-------------------------------------------------| +| `add($element)` | `add(mixed $element): void` | +| `clear()` | `clear(): void` | +| `contains($element)` | `contains(mixed $element): bool` | +| `isEmpty()` | `isEmpty(): bool` | +| `removeElement($element)` | `removeElement(mixed $element): bool` | +| `containsKey($key)` | `containsKey(string\|int $key): bool` | +| `get()` | `get(string\|int $key): mixed` | +| `getKeys()` | `getKeys(): array` | +| `getValues()` | `getValues(): array` | +| `set($key, $value)` | `set(string\|int $key, $value): void` | +| `toArray()` | `toArray(): array` | +| `first()` | `first(): mixed` | +| `last()` | `last(): mixed` | +| `key()` | `key(): int\|string\|null` | +| `current()` | `current(): mixed` | +| `next()` | `next(): mixed` | +| `exists(Closure $p)` | `exists(Closure $p): bool` | +| `filter(Closure $p)` | `filter(Closure $p): self` | +| `forAll(Closure $p)` | `forAll(Closure $p): bool` | +| `map(Closure $func)` | `map(Closure $func): self` | +| `partition(Closure $p)` | `partition(Closure $p): array` | +| `indexOf($element)` | `indexOf(mixed $element): int\|string\|false` | +| `slice($offset, $length = null)` | `slice(int $offset, ?int $length = null): array` | +| `count()` | `count(): int` | +| `getIterator()` | `getIterator(): \Traversable` | +| `offsetSet($offset, $value)` | `offsetSet(mixed $offset, mixed $value): void` | +| `offsetUnset($offset)` | `offsetUnset(mixed $offset): void` | +| `offsetExists($offset)` | `offsetExists(mixed $offset): bool` | + +### Doctrine\Common\Collections\AbstractLazyCollection + +| 1.0.x | 3.0.x | +|------------------:|:------------------------| +| `isInitialized()` | `isInitialized(): bool` | +| `initialize()` | `initialize(): void` | +| `doInitialize()` | `doInitialize(): void` | + +### Doctrine\Common\Collections\ArrayCollection + +| 1.0.x | 3.0.x | +|------------------------------:|:--------------------------------------| +| `createFrom(array $elements)` | `createFrom(array $elements): static` | +| `__toString()` | `__toString(): string` | + +### Doctrine\Common\Collections\Criteria + +| 1.0.x | 3.0.x | +|------------------------------------------:|:--------------------------------------------| +| `where(Expression $expression): self` | `where(Expression $expression): static` | +| `andWhere(Expression $expression): self` | `andWhere(Expression $expression): static` | +| `orWhere(Expression $expression): self` | `orWhere(Expression $expression): static` | +| `orderBy(array $orderings): self` | `orderBy(array $orderings): static` | +| `setFirstResult(?int $firstResult): self` | `setFirstResult(?int $firstResult): static` | +| `setMaxResult(?int $maxResults): self` | `setMaxResults(?int $maxResults): static` | + +### Doctrine\Common\Collections\Selectable + +| 1.0.x | 3.0.x | +|-------------------------------:|:-------------------------------------------| +| `matching(Criteria $criteria)` | `matching(Criteria $criteria): Collection` | + +# Upgrade to 1.7 + +## Deprecated null first result + +Passing null as `$firstResult` to +`Doctrine\Common\Collections\Criteria::__construct()` and to +`Doctrine\Common\Collections\Criteria::setFirstResult()` is deprecated. +Use `0` instead. -- cgit v1.2.3