Skip to content

Commit 680525a

Browse files
authored
Update docs (#761)
1 parent 740b68d commit 680525a

File tree

7 files changed

+11
-15
lines changed

7 files changed

+11
-15
lines changed

docs/en/authenticators.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ example.
143143
If provided will be used instead of the secret key.
144144

145145
You need to add the lib `firebase/php-jwt <https://github.com/firebase/php-jwt>`_
146-
v6.2 or above to your app to use the ``JwtAuthenticator``.
146+
v7.0 or above to your app to use the ``JwtAuthenticator``.
147147

148148
By default the ``JwtAuthenticator`` uses ``HS256`` symmetric key algorithm and uses
149149
the value of ``Cake\Utility\Security::salt()`` as encryption key.
@@ -430,7 +430,7 @@ There is only one event that is fired by authentication:
430430
``Authentication.afterIdentify``.
431431

432432
If you don’t know what events are and how to use them `check the
433-
documentation <https://book.cakephp.org/4/en/core-libraries/events.html>`__.
433+
documentation <https://book.cakephp.org/5/en/core-libraries/events.html>`__.
434434

435435
The ``Authentication.afterIdentify`` event is fired by the
436436
``AuthenticationComponent`` after an identity was successfully

docs/en/identifiers.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ Configuration options:
172172
- **userModel**: The user model identities are located in. Default is
173173
``Users``.
174174
- **finder**: The finder to use with the model. Default is ``all``.
175-
You can read more about model finders `here <https://book.cakephp.org/4/en/orm/retrieving-data-and-resultsets.html#custom-finder-methods>`__.
175+
You can read more about model finders `here <https://book.cakephp.org/5/en/orm/retrieving-data-and-resultsets.html#custom-finder-methods>`__.
176176

177177
In order to use ORM resolver you must require ``cakephp/orm`` in your
178178
``composer.json`` file (if you are not already using the full CakePHP framework).

docs/en/index.rst

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,20 +10,16 @@ Project's ROOT directory (where the **composer.json** file is located)
1010
1111
Version 4 of the Authentication Plugin is compatible with CakePHP 5.
1212

13-
Load the plugin by adding the following statement in your project's ``src/Application.php``::
13+
Load the plugin using the following command::
1414

15-
public function bootstrap(): void
16-
{
17-
parent::bootstrap();
18-
19-
$this->addPlugin('Authentication');
20-
}
15+
.. code-block:: shell
2116
17+
bin/cake plugin load Authentication
2218
2319
Getting Started
2420
===============
2521

26-
The authentication plugin integrates with your application as a `middleware <https://book.cakephp.org/4/en/controllers/middleware.html>`_. It can also
22+
The authentication plugin integrates with your application as a `middleware <https://book.cakephp.org/5/en/controllers/middleware.html>`_. It can also
2723
be used as a component to make unauthenticated access simpler. First, let's
2824
apply the middleware. In **src/Application.php**, add the following to the class
2925
imports::

docs/es/identifiers.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ Opciones de configuración:
163163
- **userModel**: El modelo donde están localizadas las indentidades. Por defecto es
164164
``Users``.
165165
- **finder**: El finder a usar con el modelo. Por defecto es ``all``.
166-
Puede leer mas sobre los finders de los modelos `aquí <https://book.cakephp.org/4/en/orm/retrieving-data-and-resultsets.html#custom-finder-methods>`__.
166+
Puede leer mas sobre los finders de los modelos `aquí <https://book.cakephp.org/5/en/orm/retrieving-data-and-resultsets.html#custom-finder-methods>`__.
167167

168168
Para usar el resolver ORM se requiere tener ``cakephp/orm`` en su archivo
169169
``composer.json`` (si no estás usando el framework CakePHP completo).

docs/es/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Carge el plugin agregando la siguiente declaración en ``src/Application.php``::
2121
Empezando
2222
=========
2323

24-
El plugin authentication se integra con su aplicación como un `middleware <https://book.cakephp.org/4/en/controllers/middleware.html>`_. También, se
24+
El plugin authentication se integra con su aplicación como un `middleware <https://book.cakephp.org/5/en/controllers/middleware.html>`_. También, se
2525
puede utilizar como un componente para simplificar el acceso no autenticado. Primero
2626
aplique el middleware. En **src/Application.php**, agregue las siguientes importaciones
2727
de clase::

docs/fr/identifiers.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ Options de configuration:
169169
Par défaut ``Users``.
170170
- **finder**: Le finder à utiliser avec le modèle. Par défaut ``all``.
171171
Pour en savoir plus sur les finders de modèle, consultez
172-
`cette documentation <https://book.cakephp.org/4/en/orm/retrieving-data-and-resultsets.html#custom-finder-methods>`__.
172+
`cette documentation <https://book.cakephp.org/5/en/orm/retrieving-data-and-resultsets.html#custom-finder-methods>`__.
173173

174174
Afin d'utiliser le résolveur ORM, vous devez requérir ``cakephp/orm`` dans votre
175175
fichier ``composer.json`` (si vous n'utilisez pas déjà le framework CakePHP

docs/ja/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ CakePHPから `composer <https://getcomposer.org/>`_ でプラグインをイン
2222
はじめに
2323
===============
2424

25-
認証プラグインは、ミドルウェアとしてアプリケーションと統合します。 `middleware <https://book.cakephp.org/4/en/controllers/middleware.html>`_
25+
認証プラグインは、ミドルウェアとしてアプリケーションと統合します。 `middleware <https://book.cakephp.org/5/en/controllers/middleware.html>`_
2626
また、認証されていないアクセスをより簡単にするためのコンポーネントとして使用することもできます。 まずはミドルウェアを適用してみましょう。
2727

2828
**src/Application.php** に以下のクラスを追加します。

0 commit comments

Comments
 (0)