129 lines
3.0 KiB
PHP
129 lines
3.0 KiB
PHP
<?php
|
|
|
|
/*
|
|
* This file is part of Twig.
|
|
*
|
|
* (c) Fabien Potencier
|
|
*
|
|
* For the full copyright and license information, please view the LICENSE
|
|
* file that was distributed with this source code.
|
|
*/
|
|
|
|
namespace Twig;
|
|
|
|
use Twig\Node\Expression\FunctionExpression;
|
|
use Twig\Node\Node;
|
|
|
|
/**
|
|
* Represents a template function.
|
|
*
|
|
* @author Fabien Potencier <fabien@symfony.com>
|
|
*
|
|
* @see https://twig.symfony.com/doc/templates.html#functions
|
|
*/
|
|
final class TwigFunction
|
|
{
|
|
private $name;
|
|
private $callable;
|
|
private $options;
|
|
private $arguments = [];
|
|
|
|
/**
|
|
* @param callable|array{class-string, string}|null $callable A callable implementing the function. If null, you need to overwrite the "node_class" option to customize compilation.
|
|
*/
|
|
public function __construct(string $name, $callable = null, array $options = [])
|
|
{
|
|
$this->name = $name;
|
|
$this->callable = $callable;
|
|
$this->options = array_merge([
|
|
'needs_environment' => false,
|
|
'needs_context' => false,
|
|
'needs_charset' => false,
|
|
'is_variadic' => false,
|
|
'is_safe' => null,
|
|
'is_safe_callback' => null,
|
|
'node_class' => FunctionExpression::class,
|
|
'deprecated' => false,
|
|
'alternative' => null,
|
|
], $options);
|
|
}
|
|
|
|
public function getName(): string
|
|
{
|
|
return $this->name;
|
|
}
|
|
|
|
/**
|
|
* Returns the callable to execute for this function.
|
|
*
|
|
* @return callable|array{class-string, string}|null
|
|
*/
|
|
public function getCallable()
|
|
{
|
|
return $this->callable;
|
|
}
|
|
|
|
public function getNodeClass(): string
|
|
{
|
|
return $this->options['node_class'];
|
|
}
|
|
|
|
public function setArguments(array $arguments): void
|
|
{
|
|
$this->arguments = $arguments;
|
|
}
|
|
|
|
public function getArguments(): array
|
|
{
|
|
return $this->arguments;
|
|
}
|
|
|
|
public function needsCharset(): bool
|
|
{
|
|
return $this->options['needs_charset'];
|
|
}
|
|
|
|
public function needsEnvironment(): bool
|
|
{
|
|
return $this->options['needs_environment'];
|
|
}
|
|
|
|
public function needsContext(): bool
|
|
{
|
|
return $this->options['needs_context'];
|
|
}
|
|
|
|
public function getSafe(Node $functionArgs): ?array
|
|
{
|
|
if (null !== $this->options['is_safe']) {
|
|
return $this->options['is_safe'];
|
|
}
|
|
|
|
if (null !== $this->options['is_safe_callback']) {
|
|
return $this->options['is_safe_callback']($functionArgs);
|
|
}
|
|
|
|
return [];
|
|
}
|
|
|
|
public function isVariadic(): bool
|
|
{
|
|
return (bool) $this->options['is_variadic'];
|
|
}
|
|
|
|
public function isDeprecated(): bool
|
|
{
|
|
return (bool) $this->options['deprecated'];
|
|
}
|
|
|
|
public function getDeprecatedVersion(): string
|
|
{
|
|
return \is_bool($this->options['deprecated']) ? '' : $this->options['deprecated'];
|
|
}
|
|
|
|
public function getAlternative(): ?string
|
|
{
|
|
return $this->options['alternative'];
|
|
}
|
|
}
|