Skip to content

Commit 91c351c

Browse files
committed
docs: fix indentation on 4.8.0 changelog
1 parent b4f86bf commit 91c351c

1 file changed

Lines changed: 25 additions & 25 deletions

File tree

user_guide_src/source/changelogs/v4.8.0.rst

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -24,24 +24,24 @@ Behavior Changes
2424
================
2525

2626
- The static ``Boot::initializeConsole()`` method no longer handles the display of the console header. This is now handled within ``Console::run()``.
27-
If you have overridden ``Boot::initializeConsole()``, you should remove any code related to displaying the console header, as this is now the responsibility of the ``Console`` class.
28-
- **Commands:** The ``-h`` option to ``routes`` command which was mapped previously to the ``--handler`` option is now removed.
29-
Use ``--handler`` instead to sort the routes by handler when running the ``routes`` command.
27+
If you have overridden ``Boot::initializeConsole()``, you should remove any code related to displaying the console header, as this is now the responsibility of the ``Console`` class.
28+
- **Commands:** The ``-h`` option to ``routes`` command which was mapped previously to the ``--sort-by-handler`` option is now removed.
29+
Use ``--sort-by-handler`` instead to sort the routes by handler when running the ``routes`` command.
3030
- **Commands:** The ``filter:check`` command now requires the HTTP method argument to be uppercase (e.g., ``spark filter:check GET /`` instead of ``spark filter:check get /``).
3131
- **Commands:** Several built-in commands have been migrated from ``BaseCommand`` to the modern ``AbstractCommand`` style. Applications that extend a built-in command to override
32-
behaviour may need to re-implement against the modern API (``configure()`` + ``execute()`` and the ``#[Command]`` attribute) once the class it extends is migrated, or, preferably, compose instead of extending. Invocations on the command line are unaffected.
32+
behaviour may need to re-implement against the modern API (``configure()`` + ``execute()`` and the ``#[Command]`` attribute) once the class it extends is migrated, or, preferably, compose instead of extending. Invocations on the command line are unaffected.
3333
- **Database:** The Postgre driver's ``$db->error()['code']`` previously always returned ``''``. It now returns the 5-character SQLSTATE string for query and transaction failures (e.g., ``'42P01'``), or ``'08006'`` for connection-level failures. Code that relied on ``$db->error()['code'] === ''`` will need updating.
3434
- **Filters:** HTTP method matching for method-based filters is now case-sensitive. The keys in ``Config\Filters::$methods`` must exactly match the request method
35-
(e.g., ``GET``, ``POST``). Lowercase method names (e.g., ``post``) will no longer match.
35+
(e.g., ``GET``, ``POST``). Lowercase method names (e.g., ``post``) will no longer match.
3636
- **Testing:** Tests using the ``FeatureTestTrait`` must now use uppercase HTTP method names when performing a request when using the ``call()`` method directly
37-
(e.g., ``$this->call('GET', '/path')`` instead of ``$this->call('get', '/path')``). Additionally, setting method-based routes using ``withRoutes()`` must
38-
also use uppercase method names (e.g., ``$this->withRoutes([['GET', 'home', 'Home::index']])``).
37+
(e.g., ``$this->call('GET', '/path')`` instead of ``$this->call('get', '/path')``). Additionally, setting method-based routes using ``withRoutes()`` must
38+
also use uppercase method names (e.g., ``$this->withRoutes([['GET', 'home', 'Home::index']])``).
3939

4040
Interface Changes
4141
=================
4242

4343
**NOTE:** If you've implemented your own classes that implement these interfaces from scratch, you will need to
44-
update your implementations to include the new methods or method changes to ensure compatibility.
44+
update your implementations to include the new methods or method changes to ensure compatibility.
4545

4646
- **Logging:** ``CodeIgniter\Log\Handlers\HandlerInterface::handle()`` now requires a third parameter ``array $context = []``. Any custom log handler that overrides ``handle()`` - whether implementing ``HandlerInterface`` directly or extending a built-in handler class - must add the parameter to its ``handle()`` method signature.
4747
- **Security:** The ``SecurityInterface``'s ``verify()`` method now has a native return type of ``static``.
@@ -52,11 +52,11 @@ Method Signature Changes
5252
- **CLI:** The ``Console::run()`` method now accepts an optional ``array $tokens`` parameter. This allows you to pass an array of command tokens directly to the console runner, which is useful for testing or programmatically running commands. If not provided, it will default to using the global ``$argv``.
5353
- **CodeIgniter:** The deprecated parameters in methods have been removed:
5454
- ``CodeIgniter\CodeIgniter::handleRequest()`` no longer accepts the deprecated ``$cacheConfig`` and ``$returnResponse`` parameters.
55-
- ``$cacheConfig`` is no longer used and is now hard deprecated. A deprecation notice will be triggered if this is passed to the method.
56-
- ``$returnResponse`` is now removed since already deprecated and unused.
57-
- The updated method signature is now ``handleRequest(?RouteCollectionInterface $routes, ?Cache $cacheConfig = null)``.
55+
- ``$cacheConfig`` is no longer used and is now hard deprecated. A deprecation notice will be triggered if this is passed to the method.
56+
- ``$returnResponse`` is now removed since already deprecated and unused.
57+
- The updated method signature is now ``handleRequest(?RouteCollectionInterface $routes, ?Cache $cacheConfig = null)``.
5858
- ``CodeIgniter\CodeIgniter::gatherOutput()`` no longer accepts the deprecated ``$cacheConfig`` parameter.
59-
As this is the first parameter, custom uses of this method will need to be updated to remove the parameter.
59+
As this is the first parameter, custom uses of this method will need to be updated to remove the parameter.
6060
- **Config:** ``CodeIgniter\Config\Services::request()`` no longer accepts any parameter.
6161
- **Database:** The following methods have had their signatures updated to remove deprecated parameters:
6262
- ``CodeIgniter\Database\Forge::_createTable()`` no longer accepts the deprecated ``$ifNotExists`` parameter. The method signature is now ``_createTable(string $table, array $attributes)``.
@@ -177,15 +177,15 @@ Commands
177177
========
178178

179179
- Added a new attribute-based command style built on :php:class:`AbstractCommand <CodeIgniter\\CLI\\AbstractCommand>` and the ``#[Command]`` attribute,
180-
with ``configure()`` / ``initialize()`` / ``interact()`` / ``execute()`` hooks and typed ``Argument`` / ``Option`` definitions.
181-
The legacy ``BaseCommand`` style continues to work. See :doc:`../cli/cli_modern_commands`.
180+
with ``configure()`` / ``initialize()`` / ``interact()`` / ``execute()`` hooks and typed ``Argument`` / ``Option`` definitions.
181+
The legacy ``BaseCommand`` style continues to work. See :doc:`../cli/cli_modern_commands`.
182182
- You can now retrieve the last executed command in the console using the new ``Console::getCommand()`` method. This is useful for logging, debugging, or any situation where you need to know which command was run.
183183
- ``CLI`` now supports the ``--`` separator to mean that what follows are arguments, not options. This allows you to have arguments that start with ``-`` without them being treated as options.
184-
For example: ``spark my:command -- --myarg`` will pass ``--myarg`` as an argument instead of an option.
184+
For example: ``spark my:command -- --myarg`` will pass ``--myarg`` as an argument instead of an option.
185185
- ``CLI`` now supports options with values specified using an equals sign (e.g., ``--option=value``) in addition to the existing space-separated syntax (e.g., ``--option value``).
186-
This provides more flexibility in how you can pass options to commands.
186+
This provides more flexibility in how you can pass options to commands.
187187
- ``CLI`` now supports parsing array options written multiple times (e.g., ``--option=value1 --option=value2``) into an array of values. This allows you to easily pass multiple values for the same option without needing to use a comma-separated string.
188-
When used with ``CLI::getOption()``, an array option will return its last value (for example, in this case, ``value2``). To retrieve all values for an array option, use ``CLI::getRawOption()``.
188+
When used with ``CLI::getOption()``, an array option will return its last value (for example, in this case, ``value2``). To retrieve all values for an array option, use ``CLI::getRawOption()``.
189189
- Likewise, the ``command()`` function now also supports the above enhancements for command-line option parsing when using the function to run commands from code.
190190
- Added ``make:request`` generator command to scaffold :ref:`Form Request <form-requests>` classes.
191191

@@ -238,20 +238,20 @@ HTTP
238238
- Added :ref:`Form Requests <form-requests>` - a new ``FormRequest`` base class that encapsulates validation rules, custom error messages, and authorization logic for a single HTTP request.
239239
- Added ``SSEResponse`` class for streaming Server-Sent Events (SSE) over HTTP. See :ref:`server-sent-events`.
240240
- ``Response`` and its child classes no longer require ``Config\App`` passed to their constructors.
241-
Consequently, ``CURLRequest``'s ``$config`` parameter is unused and will be removed in a future release.
241+
Consequently, ``CURLRequest``'s ``$config`` parameter is unused and will be removed in a future release.
242242
- ``Response`` now lazily loads the ``ContentSecurityPolicy``, ``Cookie``, and ``CookieStore`` classes only when used,
243-
instead of instantiating them on every request in the constructor. Requests that do not touch CSP or cookies no longer
244-
incur the cost of loading these classes.
243+
instead of instantiating them on every request in the constructor. Requests that do not touch CSP or cookies no longer
244+
incur the cost of loading these classes.
245245
- ``CLIRequest`` now supports the ``--`` separator to mean that what follows are arguments, not options. This allows you to have arguments that start with ``-`` without them being treated as options.
246-
For example: ``php index.php command -- --myarg`` will pass ``--myarg`` as an argument instead of an option.
246+
For example: ``php index.php command -- --myarg`` will pass ``--myarg`` as an argument instead of an option.
247247
- ``CLIRequest`` now supports options with values specified using an equals sign (e.g., ``--option=value``) in addition to the existing space-separated syntax (e.g., ``--option value``).
248-
This provides more flexibility in how you can pass options to CLI requests.
248+
This provides more flexibility in how you can pass options to CLI requests.
249249
- Added ``$enableStyleNonce`` and ``$enableScriptNonce`` options to ``Config\App`` to automatically add nonces to control whether to add nonces to style-* and script-* directives in the Content Security Policy (CSP) header when CSP is enabled. See :ref:`csp-control-nonce-generation` for details.
250250
- ``URI`` now accepts an optional boolean second parameter in the constructor, defaulting to ``false``, to control how the query string is parsed in instantiation.
251-
This is the behavior of ``->useRawQueryString()`` brought into the constructor for convenience. Previously, you need to call ``$uri->useRawQueryString(true)->setURI($uri)`` to get this behavior.
252-
Now you can simply do ``new URI($uri, true)``.
251+
This is the behavior of ``->useRawQueryString()`` brought into the constructor for convenience. Previously, you need to call ``$uri->useRawQueryString(true)->setURI($uri)`` to get this behavior.
252+
Now you can simply do ``new URI($uri, true)``.
253253
- ``CLIRequest`` now supports parsing array options written multiple times (e.g., ``--option=value1 --option=value2``) into an array of values. This allows you to easily pass multiple values for the same option without needing to use a comma-separated string.
254-
When used with ``CLIRequest::getOption()``, an array option will return its last value (for example, in this case, ``value2``). To retrieve all values for an array option, use ``CLIRequest::getRawOption()``.
254+
When used with ``CLIRequest::getOption()``, an array option will return its last value (for example, in this case, ``value2``). To retrieve all values for an array option, use ``CLIRequest::getRawOption()``.
255255

256256
Validation
257257
==========

0 commit comments

Comments
 (0)