diff options
Diffstat (limited to 'user_guide/general/hooks.html')
| -rw-r--r-- | user_guide/general/hooks.html | 617 |
1 files changed, 0 insertions, 617 deletions
diff --git a/user_guide/general/hooks.html b/user_guide/general/hooks.html deleted file mode 100644 index 4d5935358..000000000 --- a/user_guide/general/hooks.html +++ /dev/null @@ -1,617 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>Hooks - Extending the Framework Core — CodeIgniter 3.1.9 documentation</title> - - - - - <link rel="shortcut icon" href="../_static/ci-icon.ico"/> - - - - <link href='https://fonts.googleapis.com/css?family=Lato:400,700,400italic,700italic|Roboto+Slab:400,700|Inconsolata:400,700&subset=latin,cyrillic' rel='stylesheet' type='text/css'> - - - - - - - - - - <link rel="stylesheet" href="../_static/css/citheme.css" type="text/css" /> - - - - <link rel="index" title="Index" - href="../genindex.html"/> - <link rel="search" title="Search" href="../search.html"/> - <link rel="top" title="CodeIgniter 3.1.9 documentation" href="../index.html"/> - <link rel="up" title="General Topics" href="index.html"/> - <link rel="next" title="Auto-loading Resources" href="autoloader.html"/> - <link rel="prev" title="Creating Ancillary Classes" href="ancillary_classes.html"/> - - - <script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script> - -</head> - -<body class="wy-body-for-nav" role="document"> - - <div id="nav"> - <div id="nav_inner"> - - - - <div id="pulldown-menu" class="ciNav"> - <ul> -<li class="toctree-l1"><a class="reference internal" href="welcome.html">Welcome to CodeIgniter</a></li> -</ul> -<ul> -<li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installation Instructions</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../installation/downloads.html">Downloading CodeIgniter</a></li> -<li class="toctree-l2"><a class="reference internal" href="../installation/index.html">Installation Instructions</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> -</ul> -</li> -</ul> -<ul> -<li class="toctree-l1"><a class="reference internal" href="../overview/index.html">CodeIgniter Overview</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../overview/getting_started.html">Getting Started</a></li> -<li class="toctree-l2"><a class="reference internal" href="../overview/at_a_glance.html">CodeIgniter at a Glance</a></li> -<li class="toctree-l2"><a class="reference internal" href="../overview/features.html">Supported Features</a></li> -<li class="toctree-l2"><a class="reference internal" href="../overview/appflow.html">Application Flow Chart</a></li> -<li class="toctree-l2"><a class="reference internal" href="../overview/mvc.html">Model-View-Controller</a></li> -<li class="toctree-l2"><a class="reference internal" href="../overview/goals.html">Architectural Goals</a></li> -</ul> -</li> -</ul> -<ul> -<li class="toctree-l1"><a class="reference internal" href="../tutorial/index.html">Tutorial</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> -</ul> -<ul> -<li class="toctree-l1"><a class="reference internal" href="../contributing/index.html">Contributing to CodeIgniter</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../documentation/index.html">Writing CodeIgniter Documentation</a></li> -<li class="toctree-l2"><a class="reference internal" href="../DCO.html">Developer’s Certificate of Origin 1.1</a></li> -</ul> -</li> -</ul> -<ul class="current"> -<li class="toctree-l1 current"><a class="reference internal" href="index.html">General Topics</a><ul class="current"> -<li class="toctree-l2"><a class="reference internal" href="urls.html">CodeIgniter URLs</a></li> -<li class="toctree-l2"><a class="reference internal" href="controllers.html">Controllers</a></li> -<li class="toctree-l2"><a class="reference internal" href="reserved_names.html">Reserved Names</a></li> -<li class="toctree-l2"><a class="reference internal" href="views.html">Views</a></li> -<li class="toctree-l2"><a class="reference internal" href="models.html">Models</a></li> -<li class="toctree-l2"><a class="reference internal" href="helpers.html">Helpers</a></li> -<li class="toctree-l2"><a class="reference internal" href="libraries.html">Using CodeIgniter Libraries</a></li> -<li class="toctree-l2"><a class="reference internal" href="creating_libraries.html">Creating Libraries</a></li> -<li class="toctree-l2"><a class="reference internal" href="drivers.html">Using CodeIgniter Drivers</a></li> -<li class="toctree-l2"><a class="reference internal" href="creating_drivers.html">Creating Drivers</a></li> -<li class="toctree-l2"><a class="reference internal" href="core_classes.html">Creating Core System Classes</a></li> -<li class="toctree-l2"><a class="reference internal" href="ancillary_classes.html">Creating Ancillary Classes</a></li> -<li class="toctree-l2 current"><a class="current reference internal" href="#">Hooks - Extending the Framework Core</a></li> -<li class="toctree-l2"><a class="reference internal" href="autoloader.html">Auto-loading Resources</a></li> -<li class="toctree-l2"><a class="reference internal" href="common_functions.html">Common Functions</a></li> -<li class="toctree-l2"><a class="reference internal" href="compatibility_functions.html">Compatibility Functions</a></li> -<li class="toctree-l2"><a class="reference internal" href="routing.html">URI Routing</a></li> -<li class="toctree-l2"><a class="reference internal" href="errors.html">Error Handling</a></li> -<li class="toctree-l2"><a class="reference internal" href="caching.html">Caching</a></li> -<li class="toctree-l2"><a class="reference internal" href="profiling.html">Profiling Your Application</a></li> -<li class="toctree-l2"><a class="reference internal" href="cli.html">Running via the CLI</a></li> -<li class="toctree-l2"><a class="reference internal" href="managing_apps.html">Managing your Applications</a></li> -<li class="toctree-l2"><a class="reference internal" href="environments.html">Handling Multiple Environments</a></li> -<li class="toctree-l2"><a class="reference internal" href="alternative_php.html">Alternate PHP Syntax for View Files</a></li> -<li class="toctree-l2"><a class="reference internal" href="security.html">Security</a></li> -<li class="toctree-l2"><a class="reference internal" href="styleguide.html">PHP Style Guide</a></li> -</ul> -</li> -</ul> -<ul> -<li class="toctree-l1"><a class="reference internal" href="../libraries/index.html">Libraries</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../libraries/benchmark.html">Benchmarking Class</a></li> -<li class="toctree-l2"><a class="reference internal" href="../libraries/caching.html">Caching Driver</a></li> -<li class="toctree-l2"><a class="reference internal" href="../libraries/calendar.html">Calendaring Class</a></li> -<li class="toctree-l2"><a class="reference internal" href="../libraries/cart.html">Shopping Cart Class</a></li> -<li class="toctree-l2"><a class="reference internal" href="../libraries/config.html">Config 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/encrypt.html">Encrypt Class</a></li> -<li class="toctree-l2"><a class="reference internal" href="../libraries/encryption.html">Encryption Library</a></li> -<li class="toctree-l2"><a class="reference internal" href="../libraries/file_uploading.html">File Uploading Class</a></li> -<li class="toctree-l2"><a class="reference internal" href="../libraries/form_validation.html">Form Validation</a></li> -<li class="toctree-l2"><a class="reference internal" href="../libraries/ftp.html">FTP Class</a></li> -<li class="toctree-l2"><a class="reference internal" href="../libraries/image_lib.html">Image Manipulation Class</a></li> -<li class="toctree-l2"><a class="reference internal" href="../libraries/input.html">Input Class</a></li> -<li class="toctree-l2"><a class="reference internal" href="../libraries/javascript.html">Javascript Class</a></li> -<li class="toctree-l2"><a class="reference internal" href="../libraries/language.html">Language Class</a></li> -<li class="toctree-l2"><a class="reference internal" href="../libraries/loader.html">Loader Class</a></li> -<li class="toctree-l2"><a class="reference internal" href="../libraries/migration.html">Migrations Class</a></li> -<li class="toctree-l2"><a class="reference internal" href="../libraries/output.html">Output Class</a></li> -<li class="toctree-l2"><a class="reference internal" href="../libraries/pagination.html">Pagination Class</a></li> -<li class="toctree-l2"><a class="reference internal" href="../libraries/parser.html">Template Parser Class</a></li> -<li class="toctree-l2"><a class="reference internal" href="../libraries/security.html">Security Class</a></li> -<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/table.html">HTML Table Class</a></li> -<li class="toctree-l2"><a class="reference internal" href="../libraries/trackback.html">Trackback Class</a></li> -<li class="toctree-l2"><a class="reference internal" href="../libraries/typography.html">Typography Class</a></li> -<li class="toctree-l2"><a class="reference internal" href="../libraries/unit_testing.html">Unit Testing Class</a></li> -<li class="toctree-l2"><a class="reference internal" href="../libraries/uri.html">URI Class</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/xmlrpc.html">XML-RPC and XML-RPC Server Classes</a></li> -<li class="toctree-l2"><a class="reference internal" href="../libraries/zip.html">Zip Encoding Class</a></li> -</ul> -</li> -</ul> -<ul> -<li class="toctree-l1"><a class="reference internal" href="../database/index.html">Database Reference</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/caching.html">Query Caching</a></li> -<li class="toctree-l2"><a class="reference internal" href="../database/forge.html">Database Manipulation with Database Forge</a></li> -<li class="toctree-l2"><a class="reference internal" href="../database/utilities.html">Database Utilities Class</a></li> -<li class="toctree-l2"><a class="reference internal" href="../database/db_driver_reference.html">Database Driver Reference</a></li> -</ul> -</li> -</ul> -<ul> -<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/captcha_helper.html">CAPTCHA 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/directory_helper.html">Directory Helper</a></li> -<li class="toctree-l2"><a class="reference internal" href="../helpers/download_helper.html">Download Helper</a></li> -<li class="toctree-l2"><a class="reference internal" href="../helpers/email_helper.html">Email Helper</a></li> -<li class="toctree-l2"><a class="reference internal" href="../helpers/file_helper.html">File 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/language_helper.html">Language 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/path_helper.html">Path 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/smiley_helper.html">Smiley Helper</a></li> -<li class="toctree-l2"><a class="reference internal" href="../helpers/string_helper.html">String 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/typography_helper.html">Typography 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> -</ul> - - </div> - - - </div> -</div> -<div id="nav2"> - <a href="#" id="openToc"> - <img src="data:image/jpeg;base64,/9j/4AAQSkZJRgABAgAAZABkAAD/7AARRHVja3kAAQAEAAAARgAA/+4ADkFkb2JlAGTAAAAAAf/bAIQABAMDAwMDBAMDBAYEAwQGBwUEBAUHCAYGBwYGCAoICQkJCQgKCgwMDAwMCgwMDQ0MDBERERERFBQUFBQUFBQUFAEEBQUIBwgPCgoPFA4ODhQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQU/8AAEQgAKwCaAwERAAIRAQMRAf/EAHsAAQAABwEBAAAAAAAAAAAAAAABAwQFBgcIAgkBAQAAAAAAAAAAAAAAAAAAAAAQAAEDAwICBwYEAgsAAAAAAAIBAwQAEQUSBiEHkROTVNQWGDFBUVIUCHEiMtOUFWGBobHRQlMkZIRVEQEAAAAAAAAAAAAAAAAAAAAA/9oADAMBAAIRAxEAPwDSC+ygkOOaUoKigUCgUCgUCgUCgUCgUCgUCgkuGguIP9FBMFb0Hqg7We+3jlmIqqYFf4ub+/QYlnOR/LqIBKGFUbf8qWv971BytQXXE7Y3Lnm3HsFhp2TaZJAdchRXpIgSpdEJWxJEW3xoKV7F5OMy7JkQn2o7D6w33XGjEAkoiqrJEqIiOIiKuhePCgqp22dyYyS3CyWHnQ5joG61HkRnmnTbaFSMhExRVQRRVJU9iUHjE7ez+fJ0MFipmUNhBV8YUd2SoIV9KkjQla9ltegttBdPLW4/qocL+UTfrMiHW4+P9M71shuyrqaHTcxsl7jegpsji8nh5ZwMvDfgTm0RTjSmjYdFCS6KoOIipdFunCgmNYTMv457MMY6U7iI6oMieDDhRm1VbIhuoOkbqtuK0Hpzb+eZcYZexUxt6UyUqK2cd0SdjtgrhOgijcgERUlJOCIl6CpgbP3blRI8XgMjNARAyKNDfeRBdFDBVUAXgQrqH4pxoJTu2NysY97LP4ac1io5q1InHFeGO24LnVKJuKOkSQ/yKir+rh7aCLG1dzypZQI2FnvTgccYOM3FeN0XWERXAUEFVQgQkUktdLpegm+Td3/Xli/L+S/mYNJIOF9G/wBeLKrZHFb0akG6W1WtQWSg3Dyg5e7V3fipE3O4/wCrktyzYA+ufas2LbZIlmnAT2kvuoN1wft95augilglX/tzP3qCu9O3LL/wV/i5v79BvmTADq14UGu91467Z6U9y0HzH/ncj/U/sT/CgynZG7I2NezpZGUjIycJkYkZSG+uQ81pbBNKLxJfjwoMqZ3/ALYHl35AJ7/cuwHcu5k7r1Q5pHetBjquqVVJWGxj9Zrtcl/Ggy3dHMvauR3HFZj5nHNxSyW5JISYDMoIwx8tFIGHZhPNaykGapr6rUAiicEoMG21lMRj8buPAz8xhJrr7uOeiPTCyAwXUaGR1mgozbTusOsFLEiJ7fbQa/h7gcjy2H3V6xppwDNtUSxCJIqp7valBuWVzJ22xuCROXNNZiJkMtms0DbjUkAZjzoDrTMd9dDRI44ZC2YsrYdKWP2WDT2S3N9dNdlRYrGMYc06IURXSYb0igrpWS485xVNS6nF4rwslkoMwnbpgZLB7bmt5uMweAhDEl4B5uSLzzqTnnyVpW2jaJHRMSIjdDiiotvy3DOE5rYTEbkl5yFn28k7JyG4c7AU2HtLH1uKfaiMPI40CdYbpNtmLdwTSn5rewLNld+7TLdeal4WarWBkbVKBjgdElMJJwAAY5fl4kB3b1fp4XvagsGS3FjJfLzDNtS8aeXx7LzT7TyzByQE5PccRGRC0ZRUDRV6y62vbjagzLmJzS2vuPK43JY6aP1TW6Jz+RIWyFtyC06y3EkiiinAo7YCqfq1AqqnGgsOH3lhZO8d1pmcpB8j5XIm9OYlBJSQ/FSS4427DKO0RC8AlcEMhFdViRR1WDWR5t3WXVuL1d106kG9vdeye2g60+1FDyW0shIcXVpyroXt8I8dfd+NB1vioAdWnD3UF1+gD4UFc6CEKpagxXN43rwJLUHz7yX2c8zokt9uHlsPIhA4aRnnHJTLptIS6CNsY7iASpxUUMkReGpfbQW0vtN5pitvrsN28rwtBD0nc0+/Yft5XhaB6TuaXfsP28rwtA9J3NPv2H7eV4Wgek7mn37D9vK8LQPSdzT79h+3leFoHpO5pd+w/byvC0D0nc0u/Yft5XhaB6TuaXfsP28rwtA9J3NLv2H7eV4Wgek7ml37D9vK8LQPSdzS79h+3leFoHpO5p9+w/byvC0E9r7Reazy2HIYVPxkS/CUHVn26cosxyv2g7h89LYmZSXOenvLEQ1YaQ222RATcQCP8rSGqqA8S02W2pQ6FhMoAIlqCtsnwoCpdKClejI4i3Sgtb+GBxVuNBSFt1pV/RQefLjPyUDy4z8lA8uM/JQPLjPyUDy4z8lA8uM/JQPLjPyUDy4z8lA8uM/JQPLjPyUDy4z8lA8utJ/koJ7WCbBU/LQXOPAFq1koK8B0pag90CggtBBf6qB0UDooHRQOigdFA6KB0UDooHRQOigdFA6KB0UDooI0EaBQf//Z" title="Toggle Table of Contents" alt="Toggle Table of Contents" /> - </a> -</div> - - <div class="wy-grid-for-nav"> - - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-nav-search"> - - <a href="../index.html" class="fa fa-home"> CodeIgniter</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> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - <ul> -<li class="toctree-l1"><a class="reference internal" href="welcome.html">Welcome to CodeIgniter</a></li> -</ul> -<ul> -<li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installation Instructions</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../installation/downloads.html">Downloading CodeIgniter</a></li> -<li class="toctree-l2"><a class="reference internal" href="../installation/index.html">Installation Instructions</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> -</ul> -</li> -</ul> -<ul> -<li class="toctree-l1"><a class="reference internal" href="../overview/index.html">CodeIgniter Overview</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../overview/getting_started.html">Getting Started</a></li> -<li class="toctree-l2"><a class="reference internal" href="../overview/at_a_glance.html">CodeIgniter at a Glance</a></li> -<li class="toctree-l2"><a class="reference internal" href="../overview/features.html">Supported Features</a></li> -<li class="toctree-l2"><a class="reference internal" href="../overview/appflow.html">Application Flow Chart</a></li> -<li class="toctree-l2"><a class="reference internal" href="../overview/mvc.html">Model-View-Controller</a></li> -<li class="toctree-l2"><a class="reference internal" href="../overview/goals.html">Architectural Goals</a></li> -</ul> -</li> -</ul> -<ul> -<li class="toctree-l1"><a class="reference internal" href="../tutorial/index.html">Tutorial</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> -</ul> -<ul> -<li class="toctree-l1"><a class="reference internal" href="../contributing/index.html">Contributing to CodeIgniter</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../documentation/index.html">Writing CodeIgniter Documentation</a></li> -<li class="toctree-l2"><a class="reference internal" href="../DCO.html">Developer’s Certificate of Origin 1.1</a></li> -</ul> -</li> -</ul> -<ul class="current"> -<li class="toctree-l1 current"><a class="reference internal" href="index.html">General Topics</a><ul class="current"> -<li class="toctree-l2"><a class="reference internal" href="urls.html">CodeIgniter URLs</a></li> -<li class="toctree-l2"><a class="reference internal" href="controllers.html">Controllers</a></li> -<li class="toctree-l2"><a class="reference internal" href="reserved_names.html">Reserved Names</a></li> -<li class="toctree-l2"><a class="reference internal" href="views.html">Views</a></li> -<li class="toctree-l2"><a class="reference internal" href="models.html">Models</a></li> -<li class="toctree-l2"><a class="reference internal" href="helpers.html">Helpers</a></li> -<li class="toctree-l2"><a class="reference internal" href="libraries.html">Using CodeIgniter Libraries</a></li> -<li class="toctree-l2"><a class="reference internal" href="creating_libraries.html">Creating Libraries</a></li> -<li class="toctree-l2"><a class="reference internal" href="drivers.html">Using CodeIgniter Drivers</a></li> -<li class="toctree-l2"><a class="reference internal" href="creating_drivers.html">Creating Drivers</a></li> -<li class="toctree-l2"><a class="reference internal" href="core_classes.html">Creating Core System Classes</a></li> -<li class="toctree-l2"><a class="reference internal" href="ancillary_classes.html">Creating Ancillary Classes</a></li> -<li class="toctree-l2 current"><a class="current reference internal" href="#">Hooks - Extending the Framework Core</a></li> -<li class="toctree-l2"><a class="reference internal" href="autoloader.html">Auto-loading Resources</a></li> -<li class="toctree-l2"><a class="reference internal" href="common_functions.html">Common Functions</a></li> -<li class="toctree-l2"><a class="reference internal" href="compatibility_functions.html">Compatibility Functions</a></li> -<li class="toctree-l2"><a class="reference internal" href="routing.html">URI Routing</a></li> -<li class="toctree-l2"><a class="reference internal" href="errors.html">Error Handling</a></li> -<li class="toctree-l2"><a class="reference internal" href="caching.html">Caching</a></li> -<li class="toctree-l2"><a class="reference internal" href="profiling.html">Profiling Your Application</a></li> -<li class="toctree-l2"><a class="reference internal" href="cli.html">Running via the CLI</a></li> -<li class="toctree-l2"><a class="reference internal" href="managing_apps.html">Managing your Applications</a></li> -<li class="toctree-l2"><a class="reference internal" href="environments.html">Handling Multiple Environments</a></li> -<li class="toctree-l2"><a class="reference internal" href="alternative_php.html">Alternate PHP Syntax for View Files</a></li> -<li class="toctree-l2"><a class="reference internal" href="security.html">Security</a></li> -<li class="toctree-l2"><a class="reference internal" href="styleguide.html">PHP Style Guide</a></li> -</ul> -</li> -</ul> -<ul> -<li class="toctree-l1"><a class="reference internal" href="../libraries/index.html">Libraries</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../libraries/benchmark.html">Benchmarking Class</a></li> -<li class="toctree-l2"><a class="reference internal" href="../libraries/caching.html">Caching Driver</a></li> -<li class="toctree-l2"><a class="reference internal" href="../libraries/calendar.html">Calendaring Class</a></li> -<li class="toctree-l2"><a class="reference internal" href="../libraries/cart.html">Shopping Cart Class</a></li> -<li class="toctree-l2"><a class="reference internal" href="../libraries/config.html">Config 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/encrypt.html">Encrypt Class</a></li> -<li class="toctree-l2"><a class="reference internal" href="../libraries/encryption.html">Encryption Library</a></li> -<li class="toctree-l2"><a class="reference internal" href="../libraries/file_uploading.html">File Uploading Class</a></li> -<li class="toctree-l2"><a class="reference internal" href="../libraries/form_validation.html">Form Validation</a></li> -<li class="toctree-l2"><a class="reference internal" href="../libraries/ftp.html">FTP Class</a></li> -<li class="toctree-l2"><a class="reference internal" href="../libraries/image_lib.html">Image Manipulation Class</a></li> -<li class="toctree-l2"><a class="reference internal" href="../libraries/input.html">Input Class</a></li> -<li class="toctree-l2"><a class="reference internal" href="../libraries/javascript.html">Javascript Class</a></li> -<li class="toctree-l2"><a class="reference internal" href="../libraries/language.html">Language Class</a></li> -<li class="toctree-l2"><a class="reference internal" href="../libraries/loader.html">Loader Class</a></li> -<li class="toctree-l2"><a class="reference internal" href="../libraries/migration.html">Migrations Class</a></li> -<li class="toctree-l2"><a class="reference internal" href="../libraries/output.html">Output Class</a></li> -<li class="toctree-l2"><a class="reference internal" href="../libraries/pagination.html">Pagination Class</a></li> -<li class="toctree-l2"><a class="reference internal" href="../libraries/parser.html">Template Parser Class</a></li> -<li class="toctree-l2"><a class="reference internal" href="../libraries/security.html">Security Class</a></li> -<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/table.html">HTML Table Class</a></li> -<li class="toctree-l2"><a class="reference internal" href="../libraries/trackback.html">Trackback Class</a></li> -<li class="toctree-l2"><a class="reference internal" href="../libraries/typography.html">Typography Class</a></li> -<li class="toctree-l2"><a class="reference internal" href="../libraries/unit_testing.html">Unit Testing Class</a></li> -<li class="toctree-l2"><a class="reference internal" href="../libraries/uri.html">URI Class</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/xmlrpc.html">XML-RPC and XML-RPC Server Classes</a></li> -<li class="toctree-l2"><a class="reference internal" href="../libraries/zip.html">Zip Encoding Class</a></li> -</ul> -</li> -</ul> -<ul> -<li class="toctree-l1"><a class="reference internal" href="../database/index.html">Database Reference</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/caching.html">Query Caching</a></li> -<li class="toctree-l2"><a class="reference internal" href="../database/forge.html">Database Manipulation with Database Forge</a></li> -<li class="toctree-l2"><a class="reference internal" href="../database/utilities.html">Database Utilities Class</a></li> -<li class="toctree-l2"><a class="reference internal" href="../database/db_driver_reference.html">Database Driver Reference</a></li> -</ul> -</li> -</ul> -<ul> -<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/captcha_helper.html">CAPTCHA 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/directory_helper.html">Directory Helper</a></li> -<li class="toctree-l2"><a class="reference internal" href="../helpers/download_helper.html">Download Helper</a></li> -<li class="toctree-l2"><a class="reference internal" href="../helpers/email_helper.html">Email Helper</a></li> -<li class="toctree-l2"><a class="reference internal" href="../helpers/file_helper.html">File 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/language_helper.html">Language 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/path_helper.html">Path 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/smiley_helper.html">Smiley Helper</a></li> -<li class="toctree-l2"><a class="reference internal" href="../helpers/string_helper.html">String 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/typography_helper.html">Typography 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> -</ul> - - - - </div> - - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">CodeIgniter</a> - </nav> - - - - <div class="wy-nav-content"> - <div class="rst-content"> - <div role="navigation" aria-label="breadcrumbs navigation"> - <ul class="wy-breadcrumbs"> - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="index.html">General Topics</a> »</li> - - <li>Hooks - Extending the Framework Core</li> - <li class="wy-breadcrumbs-aside"> - - </li> - <div style="float:right;margin-left:5px;" id="closeMe"> - <img title="Classic Layout" alt="classic layout" src="data:image/gif;base64,R0lGODlhFAAUAJEAAAAAADMzM////wAAACH5BAUUAAIALAAAAAAUABQAAAImlI+py+0PU5gRBRDM3DxbWoXis42X13USOLauUIqnlsaH/eY6UwAAOw==" /> - </div> - </ul> - <hr/> -</div> - <div role="main" class="document"> - - <div class="section" id="hooks-extending-the-framework-core"> -<h1>Hooks - Extending the Framework Core<a class="headerlink" href="#hooks-extending-the-framework-core" title="Permalink to this headline">¶</a></h1> -<p>CodeIgniter’s Hooks feature provides a means to tap into and modify the -inner workings of the framework without hacking the core files. When -CodeIgniter runs it follows a specific execution process, diagramed in -the <a class="reference internal" href="../overview/appflow.html"><span class="doc">Application Flow</span></a> page. There may be -instances, however, where you’d 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> -<div class="section" id="enabling-hooks"> -<h2>Enabling Hooks<a class="headerlink" href="#enabling-hooks" title="Permalink to this headline">¶</a></h2> -<p>The hooks feature can be globally enabled/disabled by setting the -following item in the <strong>application/config/config.php</strong> file:</p> -<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$config</span><span class="p">[</span><span class="s1">'enable_hooks'</span><span class="p">]</span> <span class="o">=</span> <span class="k">TRUE</span><span class="p">;</span> -</pre></div> -</div> -</div> -<div class="section" id="defining-a-hook"> -<h2>Defining a Hook<a class="headerlink" href="#defining-a-hook" title="Permalink to this headline">¶</a></h2> -<p>Hooks are defined in the <strong>application/config/hooks.php</strong> file. -Each hook is specified as an array with this prototype:</p> -<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$hook</span><span class="p">[</span><span class="s1">'pre_controller'</span><span class="p">]</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span> - <span class="s1">'class'</span> <span class="o">=></span> <span class="s1">'MyClass'</span><span class="p">,</span> - <span class="s1">'function'</span> <span class="o">=></span> <span class="s1">'Myfunction'</span><span class="p">,</span> - <span class="s1">'filename'</span> <span class="o">=></span> <span class="s1">'Myclass.php'</span><span class="p">,</span> - <span class="s1">'filepath'</span> <span class="o">=></span> <span class="s1">'hooks'</span><span class="p">,</span> - <span class="s1">'params'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span><span class="s1">'beer'</span><span class="p">,</span> <span class="s1">'wine'</span><span class="p">,</span> <span class="s1">'snacks'</span><span class="p">)</span> -<span class="p">);</span> -</pre></div> -</div> -<p><strong>Notes:</strong></p> -<p>The array index correlates to the name of the particular hook point you -want to use. In the above example the hook point is pre_controller. A -list of hook points is found below. The following items should be -defined in your associative hook array:</p> -<ul class="simple"> -<li><strong>class</strong> The name of the class you wish to invoke. If you prefer to -use a procedural function instead of a class, leave this item blank.</li> -<li><strong>function</strong> The function (or method) name you wish to call.</li> -<li><strong>filename</strong> The file name containing your class/function.</li> -<li><strong>filepath</strong> The name of the directory containing your script. -Note: -Your script must be located in a directory INSIDE your <em>application/</em> -directory, so the file path is relative to that directory. For example, -if your script is located in <em>application/hooks/</em>, you will simply use -‘hooks’ as your filepath. If your script is located in -<em>application/hooks/utilities/</em> you will use ‘hooks/utilities’ as your -filepath. No trailing slash.</li> -<li><strong>params</strong> Any parameters you wish to pass to your script. This item -is optional.</li> -</ul> -<p>You can also use lambda/anoymous functions (or closures) as hooks, with -a simpler syntax:</p> -<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$hook</span><span class="p">[</span><span class="s1">'post_controller'</span><span class="p">]</span> <span class="o">=</span> <span class="k">function</span><span class="p">()</span> -<span class="p">{</span> - <span class="cm">/* do something here */</span> -<span class="p">};</span> -</pre></div> -</div> -</div> -<div class="section" id="multiple-calls-to-the-same-hook"> -<h2>Multiple Calls to the Same Hook<a class="headerlink" href="#multiple-calls-to-the-same-hook" title="Permalink to this headline">¶</a></h2> -<p>If want to use the same hook point with more than one script, simply -make your array declaration multi-dimensional, like this:</p> -<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$hook</span><span class="p">[</span><span class="s1">'pre_controller'</span><span class="p">][]</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span> - <span class="s1">'class'</span> <span class="o">=></span> <span class="s1">'MyClass'</span><span class="p">,</span> - <span class="s1">'function'</span> <span class="o">=></span> <span class="s1">'MyMethod'</span><span class="p">,</span> - <span class="s1">'filename'</span> <span class="o">=></span> <span class="s1">'Myclass.php'</span><span class="p">,</span> - <span class="s1">'filepath'</span> <span class="o">=></span> <span class="s1">'hooks'</span><span class="p">,</span> - <span class="s1">'params'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span><span class="s1">'beer'</span><span class="p">,</span> <span class="s1">'wine'</span><span class="p">,</span> <span class="s1">'snacks'</span><span class="p">)</span> -<span class="p">);</span> - -<span class="nv">$hook</span><span class="p">[</span><span class="s1">'pre_controller'</span><span class="p">][]</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span> - <span class="s1">'class'</span> <span class="o">=></span> <span class="s1">'MyOtherClass'</span><span class="p">,</span> - <span class="s1">'function'</span> <span class="o">=></span> <span class="s1">'MyOtherMethod'</span><span class="p">,</span> - <span class="s1">'filename'</span> <span class="o">=></span> <span class="s1">'Myotherclass.php'</span><span class="p">,</span> - <span class="s1">'filepath'</span> <span class="o">=></span> <span class="s1">'hooks'</span><span class="p">,</span> - <span class="s1">'params'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span><span class="s1">'red'</span><span class="p">,</span> <span class="s1">'yellow'</span><span class="p">,</span> <span class="s1">'blue'</span><span class="p">)</span> -<span class="p">);</span> -</pre></div> -</div> -<p>Notice the brackets after each array index:</p> -<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$hook</span><span class="p">[</span><span class="s1">'pre_controller'</span><span class="p">][]</span> -</pre></div> -</div> -<p>This permits you to have the same hook point with multiple scripts. The -order you define your array will be the execution order.</p> -</div> -<div class="section" id="hook-points"> -<h2>Hook Points<a class="headerlink" href="#hook-points" title="Permalink to this headline">¶</a></h2> -<p>The following is a list of available hook points.</p> -<ul class="simple"> -<li><strong>pre_system</strong> -Called very early during system execution. Only the benchmark and -hooks class have been loaded at this point. No routing or other -processes have happened.</li> -<li><strong>pre_controller</strong> -Called immediately prior to any of your controllers being called. -All base classes, routing, and security checks have been done.</li> -<li><strong>post_controller_constructor</strong> -Called immediately after your controller is instantiated, but prior -to any method calls happening.</li> -<li><strong>post_controller</strong> -Called immediately after your controller is fully executed.</li> -<li><strong>display_override</strong> -Overrides the <code class="docutils literal"><span class="pre">_display()</span></code> method, used to send the finalized page -to the web browser at the end of system execution. This permits you -to use your own display methodology. Note that you will need to -reference the CI superobject with <code class="docutils literal"><span class="pre">$this->CI</span> <span class="pre">=&</span> <span class="pre">get_instance()</span></code> and -then the finalized data will be available by calling -<code class="docutils literal"><span class="pre">$this->CI->output->get_output()</span></code>.</li> -<li><strong>cache_override</strong> -Enables you to call your own method instead of the <code class="docutils literal"><span class="pre">_display_cache()</span></code> -method in the <a class="reference internal" href="../libraries/output.html"><span class="doc">Output Library</span></a>. This permits -you to use your own cache display mechanism.</li> -<li><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.</li> -</ul> -</div> -</div> - - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="autoloader.html" class="btn btn-neutral float-right" title="Auto-loading Resources">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="ancillary_classes.html" class="btn btn-neutral" title="Creating Ancillary Classes"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2014 - 2018, British Columbia Institute of Technology. - Last updated on Jun 12, 2018. - </p> - </div> - - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - </div> - </div> - - </section> - - </div> - - - - - - <script type="text/javascript"> - var DOCUMENTATION_OPTIONS = { - URL_ROOT:'../', - VERSION:'3.1.9', - COLLAPSE_INDEX:false, - FILE_SUFFIX:'.html', - HAS_SOURCE: false - }; - </script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - - - - - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.StickyNav.enable(); - }); - </script> - - -</body> -</html>
\ No newline at end of file |