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.

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

docs: fix event points descriptions #8076

Merged
merged 3 commits into from
Oct 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions user_guide_src/source/changelogs/v4.4.3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@ Deprecations
Bugs Fixed
**********

- **UserGuide:** Fixed the descriptions for ``pre_system`` and ``post_system``
in :ref:`event-points`.

See the repo's
`CHANGELOG.md <https://github.com/codeigniter4/CodeIgniter4/blob/develop/CHANGELOG.md>`_
for a complete list of bugs fixed.
9 changes: 7 additions & 2 deletions user_guide_src/source/extending/events.rst
Original file line number Diff line number Diff line change
Expand Up @@ -82,14 +82,19 @@ You can stop simulation by passing false:

.. literalinclude:: events/008.php

.. _event-points:

Event Points
============

The following is a list of available event points within the CodeIgniter core code:

* **pre_system** Called very early during system execution. Only the benchmark and events class have been loaded at this point. No routing or other processes have happened.
* **pre_system** Called early during system execution. The URI, Request, and
Response have been instantiated, but page cache checking, routing, and execution
of "before" controller filters have not yet occurred.
* **post_controller_constructor** Called immediately after your controller is instantiated, but prior to any method calls happening.
* **post_system** Called after the final rendered page is sent to the browser, at the end of system execution after the finalized data is sent to the browser.
* **post_system** Called right before the final rendered page is sent to the browser,
at the end of system execution, after the execution of "after" controller filters.
* **email** Called after an email sent successfully from ``CodeIgniter\Email\Email``. Receives an array of the ``Email`` class's properties as a parameter.
* **DBQuery** Called after a database query whether successful or not. Receives the ``Query`` object.
* **migrate** Called after a successful migration call to ``latest()`` or ``regress()``. Receives the current properties of ``MigrationRunner`` as well as the name of the method.
6 changes: 6 additions & 0 deletions user_guide_src/source/installation/upgrade_4xx.rst
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,12 @@ Hooks
- Instead of CI3's ``$hook['post_controller_constructor']`` you now use
``Events::on('post_controller_constructor', ['MyClass', 'MyFunction']);``, with the namespace ``CodeIgniter\Events\Events;``.
- Events are always enabled, and are available globally.
- The hook point ``pre_controller`` and ``post_controller`` have been removed.
Use :doc:`../incoming/filters` instead.
- The hook point ``display_override`` and ``cache_override`` have been removed.
Because the base methods have been removed.
- The hook point ``post_system`` has moved just before sending the final rendered
page.

Extending the Framework
=======================
Expand Down