53 lines
2.0 KiB
PHP
53 lines
2.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\Attribute;
|
|
|
|
use Twig\DeprecatedCallableInfo;
|
|
use Twig\TwigFunction;
|
|
|
|
/**
|
|
* Registers a method as template function.
|
|
*
|
|
* If the first argument of the method has Twig\Environment type-hint, the function will receive the current environment.
|
|
* Additional arguments of the method come from the function call.
|
|
*
|
|
* #[AsTwigFunction(name: 'foo')]
|
|
* function fooFunction(Environment $env, string $string, $arg1 = null, ...) { ... }
|
|
*
|
|
* {{ foo('string', arg1) }}
|
|
*
|
|
* @see TwigFunction
|
|
*/
|
|
#[\Attribute(\Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)]
|
|
final class AsTwigFunction
|
|
{
|
|
/**
|
|
* @param non-empty-string $name The name of the function in Twig.
|
|
* @param bool|null $needsCharset Whether the function needs the charset passed as the first argument.
|
|
* @param bool|null $needsEnvironment Whether the function needs the environment passed as the first argument, or after the charset.
|
|
* @param bool|null $needsContext Whether the function needs the context array passed as the first argument, or after the charset and the environment.
|
|
* @param string[]|null $isSafe List of formats in which you want the raw output to be printed unescaped.
|
|
* @param string|array|null $isSafeCallback Function called at compilation time to determine if the function is safe.
|
|
* @param DeprecatedCallableInfo|null $deprecationInfo Information about the deprecation
|
|
*/
|
|
public function __construct(
|
|
public string $name,
|
|
public ?bool $needsCharset = null,
|
|
public ?bool $needsEnvironment = null,
|
|
public ?bool $needsContext = null,
|
|
public ?array $isSafe = null,
|
|
public string|array|null $isSafeCallback = null,
|
|
public ?DeprecatedCallableInfo $deprecationInfo = null,
|
|
) {
|
|
}
|
|
}
|