Skip to content

Detect recursion in scheme extension #944

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
giuscris merged 2 commits into from
Aug 27, 2026
Merged

Detect recursion in scheme extension #944

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c49b336
Detect recursion in scheme extension
giuscris Aug 27, 2026
a12ddf4
Add missing exception from docblock
giuscris Aug 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 29 additions & 4 deletions formwork/src/Schemes/Scheme.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

use Formwork\Data\Contracts\Arrayable;
use Formwork\Data\Traits\DataArrayable;
use Formwork\Exceptions\RecursionException;
use Formwork\Fields\FieldCollection;
use Formwork\Fields\FieldFactory;
use Formwork\Fields\Layout\Layout;
Expand All @@ -28,6 +29,13 @@ class Scheme implements Arrayable
*/
protected array $data = [];

/**
* Scheme IDs currently being extended.
*
* @var array<string, true>
*/
protected static array $extending = [];

/**
* Scheme path
*/
Expand All @@ -54,6 +62,7 @@ class Scheme implements Arrayable
*
* @throws InvalidArgumentException If the extended scheme ID is invalid
* @throws InvalidArgumentException If a scheme tries to extend itself
* @throws RecursionException If there is recursion in scheme extension
*/
public function __construct(
protected string $id,
Expand All @@ -65,7 +74,7 @@ public function __construct(
$this->data = $data;

if (isset($this->data['extend'])) {
$this->extend($this->schemes->get($this->data['extend']));
$this->extend($this->data['extend']);
}

$this->options = new SchemeOptions($this->data['options'] ?? []);
Expand Down Expand Up @@ -135,15 +144,31 @@ public function fields(): FieldCollection
/**
* Extend the scheme with another scheme
*
* @param Scheme|string $scheme Scheme instance or scheme id to extend with
*
* @throws InvalidArgumentException If the scheme tries to extend itself
* @throws RecursionException If there is recursion in scheme extension
*/
Comment thread
giuscris marked this conversation as resolved.
public function extend(Scheme $scheme): void
public function extend(Scheme|string $scheme): void
{
if ($scheme->id === $this->id) {
$id = $scheme instanceof Scheme ? $scheme->id : $scheme;

if ($id === $this->id) {
throw new InvalidArgumentException(sprintf('Scheme "%s" cannot be extended by itself', $this->id));
}

$this->extendWith($scheme->data);
if (isset(self::$extending[$this->id])) {
throw new RecursionException(sprintf('Recursion in the extension of the scheme "%s". Extension chain: "%s"', $this->id, implode('" > "', [...array_keys(self::$extending), $this->id])));
}

self::$extending[$this->id] = true;

try {
$base = $scheme instanceof Scheme ? $scheme : $this->schemes->get($id);
$this->extendWith($base->data);
} finally {
unset(self::$extending[$this->id]);
}
}

/**
Expand Down