Skip to content

Refactor: properly handle callable array even when options are missing #1371

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

Open
matteotrubini wants to merge 12 commits into
base: develop
Choose a base branch
from
Open

Refactor: properly handle callable array even when options are missing #1371

Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
c5de48e
Refactor: properly handle callable array even when options are missing
matteotrubini Jun 22, 2025
e507757
Add tests to MarkupManagerTest
matteotrubini Jun 23, 2025
38fce62
Refactor: makeTwigFilters() and tests
matteotrubini Jul 12, 2025
f2b0047
introduce helpers
matteotrubini Jul 12, 2025
c112769
type hints and return types
matteotrubini Jul 12, 2025
72a0245
makeTwigCallable() helper
matteotrubini Jul 13, 2025
88325e0
fix tests
matteotrubini Jul 13, 2025
7fc5c69
Fix isWildCallable() checks on $callable
matteotrubini Jul 13, 2025
4f88f25
show full classname in exception message
matteotrubini Jul 13, 2025
9b020c9
fix typo in tests
matteotrubini Jul 13, 2025
21c9cbd
Refactor MarkupManagerTest with helpers
matteotrubini Jul 13, 2025
dd08d22
Rename makeTwigCallable to makeTwigCallables
matteotrubini Sep 11, 2025
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
220 changes: 106 additions & 114 deletions modules/system/classes/MarkupManager.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ class MarkupManager
/**
* @var array Globally registered extension items
*/
protected $items;
protected $items = [];

/**
* @var \System\Classes\PluginManager
Expand Down Expand Up @@ -122,10 +122,6 @@ public function registerCallback(callable $callback): void
*/
public function registerExtensions(string $type, array $definitions): void
{
if ($this->items === null) {
$this->items = [];
}

if (!array_key_exists($type, $this->items)) {
$this->items[$type] = [];
}
Expand Down Expand Up @@ -169,29 +165,23 @@ public function registerTokenParsers(array $definitions): void

/**
* Returns a list of the registered Twig extensions of a type.
* @param $type string The Twig extension type
* @param string $type The Twig extension type
* @return array
*/
public function listExtensions($type)
public function listExtensions(string $type): array
{
$results = [];

if ($this->items === null) {
if ($this->items === []) {
$this->loadExtensions();
}

if (isset($this->items[$type]) && is_array($this->items[$type])) {
$results = $this->items[$type];
}

return $results;
return is_array($this->items[$type] ?? null) ? $this->items[$type] : [];
}

/**
* Returns a list of the registered Twig filters.
* @return array
*/
public function listFilters()
public function listFilters(): array
{
return $this->listExtensions(self::EXTENSION_FILTER);
}
Expand All @@ -200,7 +190,7 @@ public function listFilters()
* Returns a list of the registered Twig functions.
* @return array
*/
public function listFunctions()
public function listFunctions(): array
{
return $this->listExtensions(self::EXTENSION_FUNCTION);
}
Expand All @@ -209,121 +199,50 @@ public function listFunctions()
* Returns a list of the registered Twig token parsers.
* @return array
*/
public function listTokenParsers()
public function listTokenParsers(): array
{
return $this->listExtensions(self::EXTENSION_TOKEN_PARSER);
}

/**
* Makes a set of Twig functions for use in a twig extension.
* @param array $functions Current collection
* @param array $functions Current collection
* @return array
*/
public function makeTwigFunctions($functions = [])
public function makeTwigFunctions(array $functions = []): array
{
$defaultOptions = ['is_safe' => ['html']];
if (!is_array($functions)) {
$functions = [];
}

foreach ($this->listFunctions() as $name => $callable) {
$options = [];
if (is_array($callable) && isset($callable['options'])) {
$options = $callable['options'];
$callable = $callable['callable'] ?? $callable[0];

if (isset($options['is_safe']) && !is_array($options['is_safe'])) {
if (is_string($options['is_safe'])) {
$options['is_safe'] = [$options['is_safe']];
} else {
$options['is_safe'] = [];
}
}
}
$options = array_merge($defaultOptions, $options);

/*
* Handle a wildcard function
*/
if (strpos($name, '*') !== false && $this->isWildCallable($callable)) {
$callable = function ($name) use ($callable) {
$arguments = array_slice(func_get_args(), 1);
$method = $this->isWildCallable($callable, Str::camel($name));
return call_user_func_array($method, $arguments);
};
}

if (!is_callable($callable)) {
throw new SystemException(sprintf('The markup function (%s) for %s is not callable.', json_encode($callable), $name));
}

$functions[] = new TwigSimpleFunction($name, $callable, $options);
}

return $functions;
return $this->makeTwigCallable(
$this->listFunctions(),
TwigSimpleFunction::class,
['is_safe' => ['html']],
$functions
);
}

/**
* Makes a set of Twig filters for use in a twig extension.
* @param array $filters Current collection
* @param array $filters Current collection
* @return array
*/
public function makeTwigFilters($filters = [])
public function makeTwigFilters(array $filters = []): array
{
$defaultOptions = ['is_safe' => ['html']];
if (!is_array($filters)) {
$filters = [];
}

foreach ($this->listFilters() as $name => $callable) {
$options = [];
if (is_array($callable) && isset($callable['options'])) {
$options = $callable['options'];
$callable = $callable['callable'] ?? $callable[0];

if (isset($options['is_safe']) && !is_array($options['is_safe'])) {
if (is_string($options['is_safe'])) {
$options['is_safe'] = [$options['is_safe']];
} else {
$options['is_safe'] = [];
}
}
}
$options = array_merge($defaultOptions, $options);

/*
* Handle a wildcard function
*/
if (strpos($name, '*') !== false && $this->isWildCallable($callable)) {
$callable = function ($name) use ($callable) {
$arguments = array_slice(func_get_args(), 1);
$method = $this->isWildCallable($callable, Str::camel($name));
return call_user_func_array($method, $arguments);
};
}

if (!is_callable($callable)) {
throw new SystemException(sprintf('The markup filter (%s) for %s is not callable.', json_encode($callable), $name));
}

$filters[] = new TwigSimpleFilter($name, $callable, $options);
}

return $filters;
return $this->makeTwigCallable(
$this->listFilters(),
TwigSimpleFilter::class,
['is_safe' => ['html']],
$filters
);
}

/**
* Makes a set of Twig token parsers for use in a twig extension.
* @param array $parsers Current collection
* @param array $parsers Current collection
* @return array
*/
public function makeTwigTokenParsers($parsers = [])
public function makeTwigTokenParsers(array $parsers = []): array
{
if (!is_array($parsers)) {
$parsers = [];
}

$extraParsers = $this->listTokenParsers();

foreach ($extraParsers as $obj) {
if (!$obj instanceof TwigTokenParser) {
continue;
Expand All @@ -338,8 +257,8 @@ public function makeTwigTokenParsers($parsers = [])
/**
* Tests if a callable type contains a wildcard, also acts as a
* utility to replace the wildcard with a string.
* @param callable $callable
* @param string|bool $replaceWith
* @param callable $callable
* @param string|bool $replaceWith
* @return mixed
*/
protected function isWildCallable($callable, $replaceWith = false)
Expand All @@ -348,9 +267,8 @@ protected function isWildCallable($callable, $replaceWith = false)

if (is_string($callable) && strpos($callable, '*') !== false) {
$isWild = $replaceWith ? str_replace('*', $replaceWith, $callable) : true;
}

if (is_array($callable)) {
} elseif (is_array($callable)) {
// Check first element of array
if (is_string($callable[0]) && strpos($callable[0], '*') !== false) {
if ($replaceWith) {
$isWild = $callable;
Expand All @@ -361,7 +279,8 @@ protected function isWildCallable($callable, $replaceWith = false)
}
}

if (!empty($callable[1]) && strpos($callable[1], '*') !== false) {
// Check second element of array if it exists
if (!empty($callable[1]) && is_string($callable[1]) && strpos($callable[1], '*') !== false) {
if ($replaceWith) {
$isWild = $isWild ?: $callable;
$isWild[1] = str_replace('*', $replaceWith, $callable[1]);
Expand All @@ -374,4 +293,77 @@ protected function isWildCallable($callable, $replaceWith = false)

return $isWild;
}

/**
* Shared logic for creating Twig callable (functions/filters).
* @param array $definitions
* @param string $twigClass
* @param array $defaultOptions
* @param array $collection
* @return array
*/
private function makeTwigCallable(array $definitions, string $twigClass, array $defaultOptions, array $collection = []): array
Comment thread
matteotrubini marked this conversation as resolved.
Outdated
{
foreach ($definitions as $name => $callable) {
$options = $defaultOptions;
if (is_array($callable) && isset($callable['options'])) {
$options = $this->normalizeOptions($callable['options'], $defaultOptions);
}
$callable = $this->normalizeCallable($callable);

// Handle wildcard
if (strpos($name, '*') !== false && $this->isWildCallable($callable)) {
$callable = function ($name) use ($callable) {
$arguments = array_slice(func_get_args(), 1);
$method = $this->isWildCallable($callable, Str::camel($name));
return call_user_func_array($method, $arguments);
};
}

if (!is_callable($callable)) {
throw new SystemException(sprintf(
'The markup %s (%s) for %s is not callable.',
$twigClass,
json_encode($callable),
$name
));
}

$collection[] = new $twigClass($name, $callable, $options);
}
return $collection;
}

/**
* Normalize a callable definition.
* @param mixed $callable
* @return callable
*/
private function normalizeCallable($callable)
{
if (is_array($callable)) {
if (!empty($callable['callable']) && is_callable($callable['callable'])) {
return $callable['callable'];
} elseif (!empty($callable[0]) && is_callable($callable[0])) {
return $callable[0];
}
}

return $callable;
}

/**
* Normalize options for Twig extension definitions.
* @param array $options
* @param array $defaultOptions
* @return array
*/
private function normalizeOptions(array $options, array $defaultOptions): array
{
if (isset($options['is_safe']) && !is_array($options['is_safe'])) {
$options['is_safe'] = is_string($options['is_safe']) ? [$options['is_safe']] : [];
}

return array_merge($defaultOptions, $options);
}
}
Loading
Loading