1. class
  2. Symfony
  3. Component
  4. Form
  5. Extension
  6. Csrf
  7. CsrfExtension

CsrfExtension

class CsrfExtension extends AbstractExtension

This extension protects forms by using a CSRF token.

Methods

FormTypeInterface
getType(string $name)

Returns a type by name.

from AbstractExtension
bool
hasType(string $name)

Returns whether the given type is supported.

from AbstractExtension
FormTypeExtensionInterface[]
getTypeExtensions(string $name)

Returns the extensions for the given type.

from AbstractExtension
bool
hasTypeExtensions(string $name)

Returns whether this extension provides type extensions for the given type.

from AbstractExtension
FormTypeGuesserInterface|null
getTypeGuesser()

Returns the type guesser provided by this extension.

from AbstractExtension
__construct(CsrfTokenManagerInterface $tokenManager, TranslatorInterface $translator = null, null|string $translationDomain = null)

Constructor.

Details

in AbstractExtension at line line 53
FormTypeInterface getType(string $name)

Returns a type by name.

Parameters

string $name The name of the type

Return Value

FormTypeInterface The type

Exceptions

InvalidArgumentException if the given type is not supported by this extension

in AbstractExtension at line line 69
bool hasType(string $name)

Returns whether the given type is supported.

Parameters

string $name The name of the type

Return Value

bool Whether the type is supported by this extension

in AbstractExtension at line line 81
FormTypeExtensionInterface[] getTypeExtensions(string $name)

Returns the extensions for the given type.

Parameters

string $name The name of the type

Return Value

FormTypeExtensionInterface[] An array of extensions as FormTypeExtensionInterface instances

in AbstractExtension at line line 95
bool hasTypeExtensions(string $name)

Returns whether this extension provides type extensions for the given type.

Parameters

string $name The name of the type

Return Value

bool Whether the given type has extensions

in AbstractExtension at line line 107
FormTypeGuesserInterface|null getTypeGuesser()

Returns the type guesser provided by this extension.

Return Value

FormTypeGuesserInterface|null The type guesser

at line line 47
__construct(CsrfTokenManagerInterface $tokenManager, TranslatorInterface $translator = null, null|string $translationDomain = null)

Constructor.

Parameters

CsrfTokenManagerInterface $tokenManager The CSRF token manager
TranslatorInterface $translator The translator for translating error messages
null|string $translationDomain The translation domain for translating