2018-09-25 07:00:21 -07:00
<!DOCTYPE html>
2020-08-15 20:48:04 +00:00
< html class = "writer-html5" lang = "en" >
2018-09-25 07:00:21 -07:00
< head >
2021-01-05 01:15:26 +00:00
< meta charset = "utf-8" / >
2018-09-25 07:00:21 -07:00
2021-01-05 01:15:26 +00:00
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" / >
2018-09-25 07:00:21 -07:00
2021-02-01 17:59:39 +00:00
< title > Events — CodeIgniter 4.1.1 documentation< / title >
2018-09-25 07:00:21 -07:00
2020-08-15 20:48:04 +00:00
< link rel = "stylesheet" href = "../_static/css/citheme.css" type = "text/css" / >
< link rel = "stylesheet" href = "../_static/pygments.css" type = "text/css" / >
2018-09-25 07:00:21 -07:00
2020-08-15 20:48:04 +00:00
< link rel = "shortcut icon" href = "../_static/favicon.ico" / >
2018-09-25 07:00:21 -07:00
2021-01-05 01:15:26 +00:00
2018-09-25 07:00:21 -07:00
2021-01-05 01:15:26 +00:00
2018-09-25 07:00:21 -07:00
2020-08-15 20:48:04 +00:00
<!-- [if lt IE 9]>
< script src = "../_static/js/html5shiv.min.js" > < / script >
<![endif]-->
2018-09-25 07:00:21 -07:00
2020-07-05 04:53:02 +00:00
< script type = "text/javascript" id = "documentation_options" data-url_root = "../" src = "../_static/documentation_options.js" > < / script >
2020-08-15 20:48:04 +00:00
< script src = "../_static/jquery.js" > < / script >
< script src = "../_static/underscore.js" > < / script >
< script src = "../_static/doctools.js" > < / script >
< script src = "../_static/language_data.js" > < / script >
< script src = "../_static/js/citheme.js" > < / script >
< script src = "../_static/js/carbon.js" > < / script >
2020-07-05 04:53:02 +00:00
< script type = "text/javascript" src = "../_static/js/theme.js" > < / script >
2018-09-25 07:00:21 -07:00
2020-07-05 04:53:02 +00:00
< link rel = "index" title = "Index" href = "../genindex.html" / >
< link rel = "search" title = "Search" href = "../search.html" / >
< link rel = "next" title = "Extending the Controller" href = "basecontroller.html" / >
< link rel = "prev" title = "Replacing Common Functions" href = "common.html" / >
2018-09-25 07:00:21 -07:00
< / head >
2020-07-05 04:53:02 +00:00
< body class = "wy-body-for-nav" >
2018-09-25 07:00:21 -07:00
< div class = "wy-grid-for-nav" >
< nav data-toggle = "wy-nav-shift" class = "wy-nav-side" >
< div class = "wy-side-scroll" >
2020-07-05 04:53:02 +00:00
< div class = "wy-side-nav-search" style = "background: #DD4814" >
2018-09-25 07:00:21 -07:00
2020-07-05 04:53:02 +00:00
< a href = "../index.html" >
2018-09-25 07:00:21 -07:00
2020-07-05 04:53:02 +00:00
< img src = "../_static/ci-logo-text.png" class = "logo" alt = "Logo" / >
2018-09-25 07:00:21 -07:00
< / a >
< div role = "search" >
< form id = "rtd-search-form" class = "wy-form" action = "../search.html" method = "get" >
< input type = "text" name = "q" placeholder = "Search docs" / >
< input type = "hidden" name = "check_keywords" value = "yes" / >
< input type = "hidden" name = "area" value = "default" / >
< / form >
< / div >
< / div >
2020-08-15 20:48:04 +00:00
2018-09-25 07:00:21 -07:00
< div class = "wy-menu wy-menu-vertical" data-spy = "affix" role = "navigation" aria-label = "main navigation" >
< ul >
2020-07-05 04:53:02 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../intro/index.html" > Welcome to CodeIgniter4< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "../intro/index.html" > Welcome to CodeIgniter4< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../intro/requirements.html" > Server Requirements< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../intro/credits.html" > Credits< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../intro/psr.html" > PSR Compliance< / a > < / li >
< / ul >
< / li >
2018-09-25 07:00:21 -07:00
< / ul >
< ul >
2020-07-05 04:53:02 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../installation/index.html" > Installation< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "../installation/installing_composer.html" > Composer Installation< / a > < / li >
2020-07-27 12:55:41 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "../installation/installing_manual.html" > Manual Installation< / a > < / li >
2020-07-05 04:53:02 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "../installation/running.html" > Running Your App< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../installation/upgrading.html" > Upgrading From a Previous Version< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../installation/troubleshooting.html" > Troubleshooting< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../installation/repositories.html" > CodeIgniter Repositories< / a > < / li >
< / ul >
< / li >
2018-09-25 07:00:21 -07:00
< / ul >
< ul >
2020-07-05 04:53:02 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../tutorial/index.html" > Build Your First Application< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "../tutorial/static_pages.html" > Static pages< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../tutorial/news_section.html" > News section< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../tutorial/create_news_items.html" > Create news items< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../tutorial/conclusion.html" > Conclusion< / a > < / li >
< / ul >
< / li >
2018-09-25 07:00:21 -07:00
< / ul >
< ul >
2020-07-05 04:53:02 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../concepts/index.html" > CodeIgniter4 Overview< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "../concepts/structure.html" > Application Structure< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../concepts/mvc.html" > Models, Views, and Controllers< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../concepts/autoloader.html" > Autoloading Files< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../concepts/services.html" > Services< / a > < / li >
2020-10-10 18:13:39 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "../concepts/factories.html" > Factories< / a > < / li >
2020-07-05 04:53:02 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "../concepts/http.html" > Working With HTTP Requests< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../concepts/security.html" > Security Guidelines< / a > < / li >
< / ul >
< / li >
2018-09-25 07:00:21 -07:00
< / ul >
< ul >
2020-07-05 04:53:02 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../general/index.html" > General Topics< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "../general/configuration.html" > Configuration< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../general/urls.html" > CodeIgniter URLs< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../general/helpers.html" > Helper Functions< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../general/common_functions.html" > Global Functions and Constants< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../general/logging.html" > Logging Information< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../general/errors.html" > Error Handling< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../general/caching.html" > Web Page Caching< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../general/ajax.html" > AJAX Requests< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../general/modules.html" > Code Modules< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../general/managing_apps.html" > Managing your Applications< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../general/environments.html" > Handling Multiple Environments< / a > < / li >
< / ul >
< / li >
2018-09-25 07:00:21 -07:00
< / ul >
< ul >
2020-07-05 04:53:02 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../incoming/index.html" > Controllers and Routing< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "../incoming/controllers.html" > Controllers< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../incoming/routing.html" > URI Routing< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../incoming/filters.html" > Controller Filters< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../incoming/message.html" > HTTP Messages< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../incoming/request.html" > Request Class< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../incoming/incomingrequest.html" > IncomingRequest Class< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../incoming/content_negotiation.html" > Content Negotiation< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../incoming/methodspoofing.html" > HTTP Method Spoofing< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../incoming/restful.html" > RESTful Resource Handling< / a > < / li >
< / ul >
< / li >
2018-09-25 07:00:21 -07:00
< / ul >
< ul >
2020-07-05 04:53:02 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../outgoing/index.html" > Building Responses< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "../outgoing/views.html" > Views< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../outgoing/view_cells.html" > View Cells< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../outgoing/view_renderer.html" > View Renderer< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../outgoing/view_layouts.html" > View Layouts< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../outgoing/view_parser.html" > View Parser< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../outgoing/table.html" > HTML Table Class< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../outgoing/response.html" > HTTP Responses< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../outgoing/api_responses.html" > API Response Trait< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../outgoing/localization.html" > Localization< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../outgoing/alternative_php.html" > Alternate PHP Syntax for View Files< / a > < / li >
< / ul >
< / li >
2018-09-25 07:00:21 -07:00
< / ul >
< ul >
2020-07-05 04:53:02 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../database/index.html" > Working With Databases< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "../database/examples.html" > Quick Start: Usage Examples< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../database/configuration.html" > Database Configuration< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../database/connecting.html" > Connecting to a Database< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../database/queries.html" > Running Queries< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../database/results.html" > Generating Query Results< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../database/helpers.html" > Query Helper Functions< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../database/query_builder.html" > Query Builder Class< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../database/transactions.html" > Transactions< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../database/metadata.html" > Getting MetaData< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../database/call_function.html" > Custom Function Calls< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../database/events.html" > Database Events< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../database/utilities.html" > Database Utilities< / a > < / li >
< / ul >
< / li >
2018-09-25 07:00:21 -07:00
< / ul >
< ul >
2020-07-05 04:53:02 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../models/index.html" > Modeling Data< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "../models/model.html" > Using CodeIgniter's Model< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../models/entities.html" > Using Entity Classes< / a > < / li >
< / ul >
< / li >
2018-09-25 07:00:21 -07:00
< / ul >
< ul >
2020-07-05 04:53:02 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../dbmgmt/index.html" > Managing Databases< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "../dbmgmt/forge.html" > Database Manipulation with Database Forge< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../dbmgmt/migration.html" > Database Migrations< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../dbmgmt/seeds.html" > Database Seeding< / a > < / li >
< / ul >
< / li >
2018-09-25 07:00:21 -07:00
< / ul >
< ul >
2020-07-05 04:53:02 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../libraries/index.html" > Library Reference< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "../libraries/caching.html" > Caching Driver< / a > < / li >
2021-02-12 16:48:37 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "../libraries/cookies.html" > Cookies< / a > < / li >
2020-07-05 04:53:02 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "../libraries/curlrequest.html" > CURLRequest Class< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../libraries/email.html" > Email Class< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../libraries/encryption.html" > Encryption Service< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../libraries/files.html" > Working with Files< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../libraries/honeypot.html" > Honeypot Class< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../libraries/images.html" > Image Manipulation Class< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../libraries/pagination.html" > Pagination< / a > < / li >
2020-12-08 12:00:51 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "../libraries/security.html" > Security< / a > < / li >
2020-07-05 04:53:02 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "../libraries/sessions.html" > Session Library< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../libraries/throttler.html" > Throttler< / a > < / li >
2020-10-17 11:10:17 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "../libraries/time.html" > Times and Dates< / a > < / li >
2020-07-05 04:53:02 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "../libraries/typography.html" > Typography< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../libraries/uploaded_files.html" > Working with Uploaded Files< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../libraries/uri.html" > Working with URIs< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../libraries/user_agent.html" > User Agent Class< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../libraries/validation.html" > Validation< / a > < / li >
< / ul >
< / li >
2018-09-25 07:00:21 -07:00
< / ul >
< ul >
2020-07-05 04:53:02 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../helpers/index.html" > Helpers< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "../helpers/array_helper.html" > Array Helper< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../helpers/cookie_helper.html" > Cookie Helper< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../helpers/date_helper.html" > Date Helper< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../helpers/filesystem_helper.html" > Filesystem Helper< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../helpers/form_helper.html" > Form Helper< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../helpers/html_helper.html" > HTML Helper< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../helpers/inflector_helper.html" > Inflector Helper< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../helpers/number_helper.html" > Number Helper< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../helpers/security_helper.html" > Security Helper< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../helpers/test_helper.html" > Test Helper< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../helpers/text_helper.html" > Text Helper< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../helpers/url_helper.html" > URL Helper< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../helpers/xml_helper.html" > XML Helper< / a > < / li >
< / ul >
< / li >
2018-09-25 07:00:21 -07:00
< / ul >
< ul >
2020-07-05 04:53:02 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../testing/index.html" > Testing< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "../testing/overview.html" > Getting Started< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../testing/database.html" > Database< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../testing/fabricator.html" > Generating Data< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../testing/controllers.html" > Controller Testing< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../testing/feature.html" > HTTP Testing< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../testing/benchmark.html" > Benchmarking< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../testing/debugging.html" > Debugging Your Application< / a > < / li >
< / ul >
< / li >
2018-09-25 07:00:21 -07:00
< / ul >
< ul >
2020-07-05 04:53:02 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../cli/index.html" > Command Line Usage< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "../cli/cli.html" > Running via the Command Line< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../cli/cli_commands.html" > Custom CLI Commands< / a > < / li >
2020-08-18 15:29:39 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "../cli/cli_generators.html" > CLI Generators< / a > < / li >
2020-07-05 04:53:02 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "../cli/cli_library.html" > CLI Library< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../cli/cli_request.html" > CLIRequest Class< / a > < / li >
< / ul >
< / li >
2018-09-25 07:00:21 -07:00
< / ul >
< ul class = "current" >
< li class = "toctree-l1 current" > < a class = "reference internal" href = "index.html" > Extending CodeIgniter< / a > < ul class = "current" >
< li class = "toctree-l2" > < a class = "reference internal" href = "core_classes.html" > Creating Core System Classes< / a > < / li >
2019-09-01 00:54:14 -07:00
< li class = "toctree-l2" > < a class = "reference internal" href = "common.html" > Replacing Common Functions< / a > < / li >
2019-01-31 11:03:24 -08:00
< li class = "toctree-l2 current" > < a class = "current reference internal" href = "#" > Events< / a > < / li >
2019-03-25 21:41:59 -07:00
< li class = "toctree-l2" > < a class = "reference internal" href = "basecontroller.html" > Extending the Controller< / a > < / li >
2020-07-05 04:53:02 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "authentication.html" > Authentication< / a > < / li >
2018-10-02 01:39:12 -07:00
< li class = "toctree-l2" > < a class = "reference internal" href = "contributing.html" > Contributing to CodeIgniter< / a > < / li >
2018-09-25 07:00:21 -07:00
< / ul >
< / li >
< / ul >
< / div >
2020-08-15 20:48:04 +00:00
2018-09-25 07:00:21 -07:00
< / div >
< / nav >
< section data-toggle = "wy-nav-shift" class = "wy-nav-content-wrap" >
2020-07-05 04:53:02 +00:00
< nav class = "wy-nav-top" aria-label = "top navigation" >
2018-09-25 07:00:21 -07:00
< i data-toggle = "wy-nav-top" class = "fa fa-bars" > < / i >
2020-07-05 04:53:02 +00:00
< a href = "../index.html" > CodeIgniter< / a >
2018-09-25 07:00:21 -07:00
< / nav >
< div class = "wy-nav-content" >
2020-07-05 04:53:02 +00:00
2018-09-25 07:00:21 -07:00
< div class = "rst-content" >
2020-07-05 04:53:02 +00:00
2018-09-25 07:00:21 -07:00
2021-01-05 01:15:26 +00:00
2018-09-25 07:00:21 -07:00
< div role = "navigation" aria-label = "breadcrumbs navigation" >
< ul class = "wy-breadcrumbs" >
2020-07-05 04:53:02 +00:00
< li > < a href = "../index.html" class = "icon icon-home" > < / a > » < / li >
2018-09-25 07:00:21 -07:00
< li > < a href = "index.html" > Extending CodeIgniter< / a > » < / li >
2019-01-31 11:03:24 -08:00
< li > Events< / li >
2018-09-25 07:00:21 -07:00
< li class = "wy-breadcrumbs-aside" >
2021-01-05 01:15:26 +00:00
2018-09-25 07:00:21 -07:00
< / li >
< / ul >
< hr / >
< / div >
< div role = "main" class = "document" itemscope = "itemscope" itemtype = "http://schema.org/Article" >
< div itemprop = "articleBody" >
2019-01-31 11:03:24 -08:00
< div class = "section" id = "events" >
< h1 > Events< a class = "headerlink" href = "#events" title = "Permalink to this headline" > ¶< / a > < / h1 >
2020-02-04 23:50:28 -06:00
< p > CodeIgniter’
core files. When CodeIgniter runs it follows a specific execution process. There may be instances, however, when you’
2018-09-25 07:00:21 -07:00
like to cause some action to take place at a particular stage in the execution process. For example, you might want to run
a script right before your controllers get loaded, or right after, or you might want to trigger one of your own scripts
in some other location.< / p >
< p > Events work on a < em > publish/subscribe< / em > pattern, where an event, is triggered at some point during the script execution.
2020-02-04 23:50:28 -06:00
Other scripts can “subscribe” to that event by registering with the Events class to let it know they want to perform an
2018-09-25 07:00:21 -07:00
action when that event is triggered.< / p >
< div class = "section" id = "enabling-events" >
< h2 > Enabling Events< a class = "headerlink" href = "#enabling-events" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > Events are always enabled, and are available globally.< / p >
< / div >
< div class = "section" id = "defining-an-event" >
< h2 > Defining an Event< a class = "headerlink" href = "#defining-an-event" title = "Permalink to this headline" > ¶< / a > < / h2 >
2018-12-26 22:57:58 -08:00
< p > Most events are defined within the < strong > app/Config/Events.php< / strong > file. You can subscribe an action to an event with
2020-02-04 23:50:28 -06:00
the Events class’ < code class = "docutils literal notranslate" > < span class = "pre" > on()< / span > < / code > method. The first parameter is the name of the event to subscribe to. The second parameter is
2018-09-25 07:00:21 -07:00
a callable that will be run when that event is triggered:< / p >
2020-07-05 04:53:02 +00:00
< div class = "highlight-html+php notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "k" > use< / span > < span class = "nx" > CodeIgniter\Events\Events< / span > < span class = "p" > ;< / span >
2018-09-25 07:00:21 -07:00
< span class = "nx" > Events< / span > < span class = "o" > ::< / span > < span class = "na" > on< / span > < span class = "p" > (< / span > < span class = "s1" > ' pre_system' < / span > < span class = "p" > ,< / span > < span class = "p" > [< / span > < span class = "s1" > ' MyClass' < / span > < span class = "p" > ,< / span > < span class = "s1" > ' MyFunction' < / span > < span class = "p" > ]);< / span >
< / pre > < / div >
< / div >
2020-02-04 23:50:28 -06:00
< p > In this example, whenever the < strong > pre_controller< / strong > event is executed, an instance of < code class = "docutils literal notranslate" > < span class = "pre" > MyClass< / span > < / code > is created and the
< code class = "docutils literal notranslate" > < span class = "pre" > MyFunction< / span > < / code > method is run. Note that the second parameter can be < em > any< / em > form of
2020-07-05 04:53:02 +00:00
< a class = "reference external" href = "https://www.php.net/manual/en/function.is-callable.php" > callable< / a > that PHP recognizes:< / p >
< div class = "highlight-html+php notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "c1" > // Call a standalone function< / span >
2018-09-25 07:00:21 -07:00
< span class = "nx" > Events< / span > < span class = "o" > ::< / span > < span class = "na" > on< / span > < span class = "p" > (< / span > < span class = "s1" > ' pre_system' < / span > < span class = "p" > ,< / span > < span class = "s1" > ' some_function' < / span > < span class = "p" > );< / span >
< span class = "c1" > // Call on an instance method< / span >
< span class = "nv" > $user< / span > < span class = "o" > =< / span > < span class = "k" > new< / span > < span class = "nx" > User< / span > < span class = "p" > ();< / span >
< span class = "nx" > Events< / span > < span class = "o" > ::< / span > < span class = "na" > on< / span > < span class = "p" > (< / span > < span class = "s1" > ' pre_system' < / span > < span class = "p" > ,< / span > < span class = "p" > [< / span > < span class = "nv" > $user< / span > < span class = "p" > ,< / span > < span class = "s1" > ' some_method' < / span > < span class = "p" > ]);< / span >
< span class = "c1" > // Call on a static method< / span >
< span class = "nx" > Events< / span > < span class = "o" > ::< / span > < span class = "na" > on< / span > < span class = "p" > (< / span > < span class = "s1" > ' pre_system' < / span > < span class = "p" > ,< / span > < span class = "s1" > ' SomeClass::someMethod' < / span > < span class = "p" > );< / span >
< span class = "c1" > // Use a Closure< / span >
< span class = "nx" > Events< / span > < span class = "o" > ::< / span > < span class = "na" > on< / span > < span class = "p" > (< / span > < span class = "s1" > ' pre_system' < / span > < span class = "p" > ,< / span > < span class = "k" > function< / span > < span class = "p" > (< / span > < span class = "o" > ...< / span > < span class = "nv" > $params< / span > < span class = "p" > )< / span >
< span class = "p" > {< / span >
< span class = "o" > .< / span > < span class = "o" > .< / span > < span class = "o" > .< / span >
< span class = "p" > });< / span >
< / pre > < / div >
< / div >
< div class = "section" id = "setting-priorities" >
< h3 > Setting Priorities< a class = "headerlink" href = "#setting-priorities" title = "Permalink to this headline" > ¶< / a > < / h3 >
< p > Since multiple methods can be subscribed to a single event, you will need a way to define in what order those methods
2020-02-04 23:50:28 -06:00
are called. You can do this by passing a priority value as the third parameter of the < code class = "docutils literal notranslate" > < span class = "pre" > on()< / span > < / code > method. Lower values
2018-09-25 07:00:21 -07:00
are executed first, with a value of 1 having the highest priority, and there being no limit on the lower values:< / p >
2020-07-05 04:53:02 +00:00
< div class = "highlight-html+php notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "nx" > Events< / span > < span class = "o" > ::< / span > < span class = "na" > on< / span > < span class = "p" > (< / span > < span class = "s1" > ' post_controller_constructor' < / span > < span class = "p" > ,< / span > < span class = "s1" > ' some_function' < / span > < span class = "p" > ,< / span > < span class = "mi" > 25< / span > < span class = "p" > );< / span >
2018-09-25 07:00:21 -07:00
< / pre > < / div >
< / div >
< p > Any subscribers with the same priority will be executed in the order they were defined.< / p >
< p > Three constants are defined for your use, that set some helpful ranges on the values. You are not required to use these
but you might find they aid readability:< / p >
2020-07-05 04:53:02 +00:00
< div class = "highlight-html+php notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "nb" > define< / span > < span class = "p" > (< / span > < span class = "s1" > ' EVENT_PRIORITY_LOW' < / span > < span class = "p" > ,< / span > < span class = "mi" > 200< / span > < span class = "p" > );< / span >
2018-09-25 07:00:21 -07:00
< span class = "nb" > define< / span > < span class = "p" > (< / span > < span class = "s1" > ' EVENT_PRIORITY_NORMAL' < / span > < span class = "p" > ,< / span > < span class = "mi" > 100< / span > < span class = "p" > );< / span >
< span class = "nb" > define< / span > < span class = "p" > (< / span > < span class = "s1" > ' EVENT_PRIORITY_HIGH' < / span > < span class = "p" > ,< / span > < span class = "mi" > 10< / span > < span class = "p" > );< / span >
< / pre > < / div >
< / div >
< p > Once sorted, all subscribers are executed in order. If any subscriber returns a boolean false value, then execution of
the subscribers will stop.< / p >
< / div >
< / div >
< div class = "section" id = "publishing-your-own-events" >
< h2 > Publishing your own Events< a class = "headerlink" href = "#publishing-your-own-events" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > The Events library makes it simple for you to create events in your own code, also. To use this feature, you would simply
2020-02-04 23:50:28 -06:00
need to call the < code class = "docutils literal notranslate" > < span class = "pre" > trigger()< / span > < / code > method on the < strong > Events< / strong > class with the name of the event:< / p >
2020-07-05 04:53:02 +00:00
< div class = "highlight-html+php notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "nx" > \CodeIgniter\Events\Events< / span > < span class = "o" > ::< / span > < span class = "na" > trigger< / span > < span class = "p" > (< / span > < span class = "s1" > ' some_event' < / span > < span class = "p" > );< / span >
2018-09-25 07:00:21 -07:00
< / pre > < / div >
< / div >
< p > You can pass any number of arguments to the subscribers by adding them as additional parameters. Subscribers will be
given the arguments in the same order as defined:< / p >
2020-07-05 04:53:02 +00:00
< div class = "highlight-html+php notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "nx" > \CodeIgniter\Events\Events< / span > < span class = "o" > ::< / span > < span class = "na" > trigger< / span > < span class = "p" > (< / span > < span class = "s1" > ' some_events' < / span > < span class = "p" > ,< / span > < span class = "nv" > $foo< / span > < span class = "p" > ,< / span > < span class = "nv" > $bar< / span > < span class = "p" > ,< / span > < span class = "nv" > $baz< / span > < span class = "p" > );< / span >
2018-09-25 07:00:21 -07:00
< span class = "nx" > Events< / span > < span class = "o" > ::< / span > < span class = "na" > on< / span > < span class = "p" > (< / span > < span class = "s1" > ' some_event' < / span > < span class = "p" > ,< / span > < span class = "k" > function< / span > < span class = "p" > (< / span > < span class = "nv" > $foo< / span > < span class = "p" > ,< / span > < span class = "nv" > $bar< / span > < span class = "p" > ,< / span > < span class = "nv" > $baz< / span > < span class = "p" > )< / span > < span class = "p" > {< / span >
< span class = "o" > ...< / span >
< span class = "p" > });< / span >
< / pre > < / div >
< / div >
< / div >
< div class = "section" id = "simulating-events" >
< h2 > Simulating Events< a class = "headerlink" href = "#simulating-events" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > During testing, you might not want the events to actually fire, as sending out hundreds of emails a day is both slow
2020-02-04 23:50:28 -06:00
and counter-productive. You can tell the Events class to only simulate running the events with the < code class = "docutils literal notranslate" > < span class = "pre" > simulate()< / span > < / code > method.
2018-09-25 07:00:21 -07:00
When < strong > true< / strong > , all events will be skipped over during the trigger method. Everything else will work as normal, though.< / p >
2020-07-05 04:53:02 +00:00
< div class = "highlight-html+php notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "nx" > Events< / span > < span class = "o" > ::< / span > < span class = "na" > simulate< / span > < span class = "p" > (< / span > < span class = "k" > true< / span > < span class = "p" > );< / span >
2018-09-25 07:00:21 -07:00
< / pre > < / div >
< / div >
< p > You can stop simulation by passing false:< / p >
2020-07-05 04:53:02 +00:00
< div class = "highlight-html+php notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "nx" > Events< / span > < span class = "o" > ::< / span > < span class = "na" > simulate< / span > < span class = "p" > (< / span > < span class = "k" > false< / span > < span class = "p" > );< / span >
2018-09-25 07:00:21 -07:00
< / pre > < / div >
< / div >
< / div >
< div class = "section" id = "event-points" >
< h2 > Event Points< a class = "headerlink" href = "#event-points" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > The following is a list of available event points within the CodeIgniter core code:< / p >
< ul class = "simple" >
2020-08-15 20:48:04 +00:00
< li > < p > < strong > pre_system< / strong > 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.< / p > < / li >
< li > < p > < strong > post_controller_constructor< / strong > Called immediately after your controller is instantiated, but prior to any method calls happening.< / p > < / li >
< li > < p > < strong > post_system< / strong > 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.< / p > < / li >
< li > < p > < strong > email< / strong > Called after an email sent successfully from < code class = "docutils literal notranslate" > < span class = "pre" > CodeIgniter\Email\Email< / span > < / code > . Receives an array of the < code class = "docutils literal notranslate" > < span class = "pre" > Email< / span > < / code > class’ < / p > < / li >
2020-09-15 05:57:37 +00:00
< li > < p > < strong > DBQuery< / strong > Called after a successfully-completed database query. Receives the < code class = "docutils literal notranslate" > < span class = "pre" > Query< / span > < / code > object.< / p > < / li >
< li > < p > < strong > migrate< / strong > Called after a successful migration call to < code class = "docutils literal notranslate" > < span class = "pre" > latest()< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > regress()< / span > < / code > . Receives the current properties of < code class = "docutils literal notranslate" > < span class = "pre" > MigrationRunner< / span > < / code > as well as the name of the method.< / p > < / li >
2018-09-25 07:00:21 -07:00
< / ul >
< / div >
< / div >
< / div >
2020-07-05 04:53:02 +00:00
2018-09-25 07:00:21 -07:00
< / div >
< footer >
< div class = "rst-footer-buttons" role = "navigation" aria-label = "footer navigation" >
2021-01-05 01:15:26 +00:00
< a href = "basecontroller.html" class = "btn btn-neutral float-right" title = "Extending the Controller" accesskey = "n" rel = "next" > Next < span class = "fa fa-arrow-circle-right" aria-hidden = "true" > < / span > < / a >
< a href = "common.html" class = "btn btn-neutral float-left" title = "Replacing Common Functions" accesskey = "p" rel = "prev" > < span class = "fa fa-arrow-circle-left" aria-hidden = "true" > < / span > Previous< / a >
2018-09-25 07:00:21 -07:00
< / div >
< hr / >
< div role = "contentinfo" >
< p >
2021-01-05 01:15:26 +00:00
© Copyright 2019-2021 CodeIgniter Foundation.
2020-07-05 04:53:02 +00:00
< span class = "lastupdated" >
2021-03-25 01:38:51 +00:00
Last updated on Mar 25, 2021.
2020-07-05 04:53:02 +00:00
< / span >
2018-09-25 07:00:21 -07:00
< / p >
< / div >
2020-07-05 04:53:02 +00:00
2021-01-05 01:15:26 +00:00
Built with < a href = "https://www.sphinx-doc.org/" > Sphinx< / a > using a
2020-07-05 04:53:02 +00:00
2021-01-05 01:15:26 +00:00
< a href = "https://github.com/readthedocs/sphinx_rtd_theme" > theme< / a >
2020-07-05 04:53:02 +00:00
provided by < a href = "https://readthedocs.org" > Read the Docs< / a > .
2018-09-25 07:00:21 -07:00
< / footer >
< / div >
< / div >
< / section >
< / div >
< script type = "text/javascript" >
jQuery(function () {
2020-07-05 04:53:02 +00:00
SphinxRtdTheme.Navigation.enable(false);
2018-09-25 07:00:21 -07:00
});
< / script >
2020-07-05 04:53:02 +00:00
2018-09-25 07:00:21 -07:00
< / body >
< / html >
