Protects against form tampering. It ensures that:
string
'Form tampering protection token validation failed.'
array
A component lookup table used to lazy load component objects.
array
Runtime config
bool
Whether the config property has already been configured with defaults
array
Default config
\Cake\Controller\ComponentRegistry
Component registry class used to lazy load components.
array
Other Components this component uses.
Returns an array that can be used to describe the internal state of this object.
Merge provided config with existing config. Unlike config()
which does a recursive merge for nested keys, this method does a simple merge.
Convenience method to write a message to Log. See Log::write() for more information on writing to logs.
__construct(\Cake\Controller\ComponentRegistry $registry, array $config)
Constructor
\Cake\Controller\ComponentRegistry
$registry A component registry this component can use to lazy load its components.
array
$config optional Array of configuration settings.
__debugInfo()
Returns an array that can be used to describe the internal state of this object.
array
__get(string $name)
Magic method for lazy loading $components.
string
$name Name of component to get.
\Cake\Controller\Component|null
A Component object or null.
_configDelete(string $key)
Deletes a single config key.
string
$key Key to delete.
Cake\Core\Exception\Exception
_configRead(?string $key)
Reads a config key.
string|null
$key Key to read.
mixed
_configWrite(mixed $key, mixed $value, mixed $merge)
Writes a config key.
string|array
$key Key to write to.
mixed
$value Value to write.
bool|string
$merge optional True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
Cake\Core\Exception\Exception
configShallow(mixed $key, mixed $value)
Merge provided config with existing config. Unlike config()
which does a recursive merge for nested keys, this method does a simple merge.
Setting a specific value:
$this->configShallow('key', $value);
Setting a nested value:
$this->configShallow('some.nested.key', $value);
Updating multiple config settings at the same time:
$this->configShallow(['one' => 'value', 'another' => 'value']);
string|array
$key The key to set, or a complete array of configs.
mixed|null
$value optional The value to set.
$this
executeCallback(\Closure $callback, \Cake\Http\Exception\BadRequestException $exception)
Execute callback.
\Closure
$callback A valid callable
\Cake\Http\Exception\BadRequestException
$exception Exception instance.
\Cake\Http\Response|null
getConfig(?string $key, mixed $default)
Returns the config.
Reading the whole config:
$this->getConfig();
Reading a specific value:
$this->getConfig('key');
Reading a nested value:
$this->getConfig('some.nested.key');
Reading with default value:
$this->getConfig('some-key', 'default-value');
string|null
$key optional The key to get or null for the whole config.
mixed
$default optional The return value when the key does not exist.
mixed
Configuration data at the named key or null if the key does not exist.
getConfigOrFail(string $key)
Returns the config for this specific key.
The config value for this key must exist, it can never be null.
string
$key The key to get.
mixed
Configuration data at the named key
InvalidArgumentException
getController()
Get the controller this component is bound to.
\Cake\Controller\Controller
The bound controller.
implementedEvents()
Events supported by this component.
array
initialize(array $config)
Constructor hook method.
Implement this method to avoid having to overwrite the constructor and call parent.
array
$config The configuration settings provided to this component.
log(string $message, mixed $level, mixed $context)
Convenience method to write a message to Log. See Log::write() for more information on writing to logs.
string
$message Log message.
int|string
$level optional Error level.
string|array
$context optional Additional log data relevant to this message.
bool
Success of log write.
setConfig(mixed $key, mixed $value, mixed $merge)
Sets the config.
Setting a specific value:
$this->setConfig('key', $value);
Setting a nested value:
$this->setConfig('some.nested.key', $value);
Updating multiple config settings at the same time:
$this->setConfig(['one' => 'value', 'another' => 'value']);
string|array
$key The key to set, or a complete array of configs.
mixed|null
$value optional The value to set.
bool
$merge optional Whether to recursively merge or overwrite existing config, defaults to true.
$this
Cake\Core\Exception\Exception
startup(\Cake\Event\EventInterface $event)
Component startup.
Token check happens here.
\Cake\Event\EventInterface
$event An Event instance
\Cake\Http\Response|null
validationFailure(\Cake\Form\FormProtector $formProtector)
Throws a 400 - Bad request exception or calls custom callback.
If validationFailureCallback
config is specified, it will use this callback by executing the method passing the argument as exception.
\Cake\Form\FormProtector
$formProtector Form Protector instance.
\Cake\Http\Response|null
If specified, validationFailureCallback's response, or no return otherwise.
Cake\Http\Exception\BadRequestException
A component lookup table used to lazy load component objects.
array
Runtime config
array
Whether the config property has already been configured with defaults
bool
Default config
validate
- Whether to validate request body / data. Set to false to disable for data coming from 3rd party services, etc.unlockedFields
- Form fields to exclude from validation. Fields can be unlocked either in the Component, or with FormHelper::unlockField(). Fields that have been unlocked are not required to be part of the POST and hidden unlocked fields do not have their values checked.unlockedActions
- Actions to exclude from POST validation checks.validationFailureCallback
- Callback to call in case of validation failure. Must be a valid Closure. Unset by default in which case exception is thrown on validation failure.array
Component registry class used to lazy load components.
\Cake\Controller\ComponentRegistry
Other Components this component uses.
array
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.1/class-Cake.Controller.Component.FormProtectionComponent.html