Skip to content

Commit

Permalink
Merge pull request codeigniter4#8055 from kenjis/docs-fix-event-points
Browse files Browse the repository at this point in the history
docs: fix event points descriptions
  • Loading branch information
kenjis authored Oct 22, 2023
2 parents 3d2f80c + 82ccf15 commit 0ab6fb9
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 2 deletions.
2 changes: 2 additions & 0 deletions user_guide_src/source/changelogs/v4.4.2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ Bugs Fixed
- **Forge:** Fixed a bug where adding a Primary Key to an existing table was
ignored if there were no other Keys added too.
- **Routing:** Fixed a bug that ``spark routes`` may show incorrect route names.
- **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>`_
Expand Down
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

0 comments on commit 0ab6fb9

Please sign in to comment.