Skip to content
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

Jump to bottom

Update references to defunct SecurityComponent #7956

Merged
merged 1 commit into from
Nov 21, 2024
Merged

Update references to defunct SecurityComponent #7956

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 9 additions & 9 deletions en/views/helpers/form.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2054,7 +2054,7 @@ Will output:
.. note::

If you are using
:php:class:`Cake\\Controller\\Component\\SecurityComponent` in your
:php:class:`Cake\\Controller\\Component\\FormProtectionComponent` in your
application you should always end your forms with ``end()``.

Creating Standalone Buttons and POST Links
Expand All @@ -2074,7 +2074,7 @@ Creating POST Buttons

Creates a ``<button>`` tag with a surrounding ``<form>`` element that submits
via POST, by default. Also, by default, it generates hidden input fields for the
SecurityComponent.
FormProtectionComponent.

**Options for POST Button**

Expand Down Expand Up @@ -2588,23 +2588,23 @@ widget using the magic method::

echo $this->Form->autocomplete('search', $options);

Working with SecurityComponent
==============================
Working with FormProtectionComponent
====================================

:php:meth:`\\Cake\\Controller\\Component\\SecurityComponent` offers several
:php:meth:`\\Cake\\Controller\\Component\\FormProtectionComponent` offers several
features that make your forms safer and more secure. By simply including the
``SecurityComponent`` in your controller, you'll automatically benefit from
``FormProtectionComponent`` in your controller, you'll automatically benefit from
form tampering-prevention features.

As mentioned previously when using SecurityComponent, you should always close
As mentioned previously when using FormProtectionComponent, you should always close
your forms using :php:meth:`\\Cake\\View\\Helper\\FormHelper::end()`. This will
ensure that the special ``_Token`` inputs are generated.

.. php:method:: unlockField($name)

* ``$name`` - Optional. The dot-separated name for the field.

Unlocks a field making it exempt from the ``SecurityComponent`` field
Unlocks a field making it exempt from the ``FormProtectionComponent`` field
hashing. This also allows the fields to be manipulated by JavaScript.
The ``$name`` parameter should be the entity property name for the field::

Expand All @@ -2620,7 +2620,7 @@ The ``$name`` parameter should be the entity property name for the field::
Generates a hidden ``input`` field with a security hash based on the fields used
in the form or an empty string when secured forms are not in use.
If ``$secureAttributes`` is set, these HTML attributes will be
merged into the hidden input tags generated for the SecurityComponent. This is
merged into the hidden input tags generated for the FormProtectionComponent. This is
especially useful to set HTML5 attributes like ``'form'``.

.. meta::
Expand Down