diff options
Diffstat (limited to 'user_guide/general/controllers.html')
| -rw-r--r-- | user_guide/general/controllers.html | 845 |
1 files changed, 845 insertions, 0 deletions
diff --git a/user_guide/general/controllers.html b/user_guide/general/controllers.html new file mode 100644 index 000000000..bcb5155d0 --- /dev/null +++ b/user_guide/general/controllers.html @@ -0,0 +1,845 @@ + + +<!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>Controllers — 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="Reserved Names" href="reserved_names.html"/> + <link rel="prev" title="CodeIgniter URLs" href="urls.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 current"><a class="current reference internal" href="#">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"><a class="reference internal" href="hooks.html">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 current"><a class="current reference internal" href="#">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"><a class="reference internal" href="hooks.html">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>Controllers</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="controllers"> +<h1><a class="toc-backref" href="#id1">Controllers</a><a class="headerlink" href="#controllers" title="Permalink to this headline">¶</a></h1> +<p>Controllers are the heart of your application, as they determine how +HTTP requests should be handled.</p> +<div class="contents topic" id="page-contents"> +<p class="topic-title first">Page Contents</p> +<ul class="simple"> +<li><a class="reference internal" href="#controllers" id="id1">Controllers</a><ul> +<li><a class="reference internal" href="#what-is-a-controller" id="id2">What is a Controller?</a></li> +<li><a class="reference internal" href="#let-s-try-it-hello-world" id="id3">Let’s try it: Hello World!</a></li> +<li><a class="reference internal" href="#methods" id="id4">Methods</a></li> +<li><a class="reference internal" href="#passing-uri-segments-to-your-methods" id="id5">Passing URI Segments to your methods</a></li> +<li><a class="reference internal" href="#defining-a-default-controller" id="id6">Defining a Default Controller</a></li> +<li><a class="reference internal" href="#remapping-method-calls" id="id7">Remapping Method Calls</a></li> +<li><a class="reference internal" href="#processing-output" id="id8">Processing Output</a></li> +<li><a class="reference internal" href="#private-methods" id="id9">Private methods</a></li> +<li><a class="reference internal" href="#organizing-your-controllers-into-sub-directories" id="id10">Organizing Your Controllers into Sub-directories</a></li> +<li><a class="reference internal" href="#class-constructors" id="id11">Class Constructors</a></li> +<li><a class="reference internal" href="#reserved-method-names" id="id12">Reserved method names</a></li> +<li><a class="reference internal" href="#that-s-it" id="id13">That’s it!</a></li> +</ul> +</li> +</ul> +</div> +<div class="section" id="what-is-a-controller"> +<h2><a class="toc-backref" href="#id2">What is a Controller?</a><a class="headerlink" href="#what-is-a-controller" title="Permalink to this headline">¶</a></h2> +<p><strong>A Controller is simply a class file that is named in a way that can be +associated with a URI.</strong></p> +<p>Consider this URI:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nx">example</span><span class="o">.</span><span class="nx">com</span><span class="o">/</span><span class="nx">index</span><span class="o">.</span><span class="nx">php</span><span class="o">/</span><span class="nx">blog</span><span class="o">/</span> +</pre></div> +</div> +<p>In the above example, CodeIgniter would attempt to find a controller +named Blog.php and load it.</p> +<p><strong>When a controller’s name matches the first segment of a URI, it will +be loaded.</strong></p> +</div> +<div class="section" id="let-s-try-it-hello-world"> +<h2><a class="toc-backref" href="#id3">Let’s try it: Hello World!</a><a class="headerlink" href="#let-s-try-it-hello-world" title="Permalink to this headline">¶</a></h2> +<p>Let’s create a simple controller so you can see it in action. Using your +text editor, create a file called Blog.php, and put the following code +in it:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="o"><?</span><span class="nx">php</span> +<span class="k">class</span> <span class="nc">Blog</span> <span class="k">extends</span> <span class="nx">CI_Controller</span> <span class="p">{</span> + + <span class="k">public</span> <span class="k">function</span> <span class="nf">index</span><span class="p">()</span> + <span class="p">{</span> + <span class="k">echo</span> <span class="s1">'Hello World!'</span><span class="p">;</span> + <span class="p">}</span> +<span class="p">}</span> +</pre></div> +</div> +<p>Then save the file to your <em>application/controllers/</em> directory.</p> +<div class="admonition important"> +<p class="first admonition-title">Important</p> +<p class="last">The file must be called ‘Blog.php’, with a capital ‘B’.</p> +</div> +<p>Now visit the your site using a URL similar to this:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nx">example</span><span class="o">.</span><span class="nx">com</span><span class="o">/</span><span class="nx">index</span><span class="o">.</span><span class="nx">php</span><span class="o">/</span><span class="nx">blog</span><span class="o">/</span> +</pre></div> +</div> +<p>If you did it right, you should see:</p> +<blockquote> +<div>Hello World!</div></blockquote> +<div class="admonition important"> +<p class="first admonition-title">Important</p> +<p class="last">Class names must start with an uppercase letter.</p> +</div> +<p>This is valid:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="o"><?</span><span class="nx">php</span> +<span class="k">class</span> <span class="nc">Blog</span> <span class="k">extends</span> <span class="nx">CI_Controller</span> <span class="p">{</span> + +<span class="p">}</span> +</pre></div> +</div> +<p>This is <strong>not</strong> valid:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="o"><?</span><span class="nx">php</span> +<span class="k">class</span> <span class="nc">blog</span> <span class="k">extends</span> <span class="nx">CI_Controller</span> <span class="p">{</span> + +<span class="p">}</span> +</pre></div> +</div> +<p>Also, always make sure your controller extends the parent controller +class so that it can inherit all its methods.</p> +</div> +<div class="section" id="methods"> +<h2><a class="toc-backref" href="#id4">Methods</a><a class="headerlink" href="#methods" title="Permalink to this headline">¶</a></h2> +<p>In the above example the method name is <code class="docutils literal"><span class="pre">index()</span></code>. The “index” method +is always loaded by default if the <strong>second segment</strong> of the URI is +empty. Another way to show your “Hello World” message would be this:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nx">example</span><span class="o">.</span><span class="nx">com</span><span class="o">/</span><span class="nx">index</span><span class="o">.</span><span class="nx">php</span><span class="o">/</span><span class="nx">blog</span><span class="o">/</span><span class="nx">index</span><span class="o">/</span> +</pre></div> +</div> +<p><strong>The second segment of the URI determines which method in the +controller gets called.</strong></p> +<p>Let’s try it. Add a new method to your controller:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="o"><?</span><span class="nx">php</span> +<span class="k">class</span> <span class="nc">Blog</span> <span class="k">extends</span> <span class="nx">CI_Controller</span> <span class="p">{</span> + + <span class="k">public</span> <span class="k">function</span> <span class="nf">index</span><span class="p">()</span> + <span class="p">{</span> + <span class="k">echo</span> <span class="s1">'Hello World!'</span><span class="p">;</span> + <span class="p">}</span> + + <span class="k">public</span> <span class="k">function</span> <span class="nf">comments</span><span class="p">()</span> + <span class="p">{</span> + <span class="k">echo</span> <span class="s1">'Look at this!'</span><span class="p">;</span> + <span class="p">}</span> +<span class="p">}</span> +</pre></div> +</div> +<p>Now load the following URL to see the comment method:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nx">example</span><span class="o">.</span><span class="nx">com</span><span class="o">/</span><span class="nx">index</span><span class="o">.</span><span class="nx">php</span><span class="o">/</span><span class="nx">blog</span><span class="o">/</span><span class="nx">comments</span><span class="o">/</span> +</pre></div> +</div> +<p>You should see your new message.</p> +</div> +<div class="section" id="passing-uri-segments-to-your-methods"> +<h2><a class="toc-backref" href="#id5">Passing URI Segments to your methods</a><a class="headerlink" href="#passing-uri-segments-to-your-methods" title="Permalink to this headline">¶</a></h2> +<p>If your URI contains more than two segments they will be passed to your +method as parameters.</p> +<p>For example, let’s say you have a URI like this:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nx">example</span><span class="o">.</span><span class="nx">com</span><span class="o">/</span><span class="nx">index</span><span class="o">.</span><span class="nx">php</span><span class="o">/</span><span class="nx">products</span><span class="o">/</span><span class="nx">shoes</span><span class="o">/</span><span class="nx">sandals</span><span class="o">/</span><span class="mi">123</span> +</pre></div> +</div> +<p>Your method will be passed URI segments 3 and 4 (“sandals” and “123”):</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="o"><?</span><span class="nx">php</span> +<span class="k">class</span> <span class="nc">Products</span> <span class="k">extends</span> <span class="nx">CI_Controller</span> <span class="p">{</span> + + <span class="k">public</span> <span class="k">function</span> <span class="nf">shoes</span><span class="p">(</span><span class="nv">$sandals</span><span class="p">,</span> <span class="nv">$id</span><span class="p">)</span> + <span class="p">{</span> + <span class="k">echo</span> <span class="nv">$sandals</span><span class="p">;</span> + <span class="k">echo</span> <span class="nv">$id</span><span class="p">;</span> + <span class="p">}</span> +<span class="p">}</span> +</pre></div> +</div> +<div class="admonition important"> +<p class="first admonition-title">Important</p> +<p class="last">If you are using the <a class="reference internal" href="routing.html"><span class="doc">URI Routing</span></a> +feature, the segments passed to your method will be the re-routed +ones.</p> +</div> +</div> +<div class="section" id="defining-a-default-controller"> +<h2><a class="toc-backref" href="#id6">Defining a Default Controller</a><a class="headerlink" href="#defining-a-default-controller" title="Permalink to this headline">¶</a></h2> +<p>CodeIgniter can be told to load a default controller when a URI is not +present, as will be the case when only your site root URL is requested. +To specify a default controller, open your <strong>application/config/routes.php</strong> +file and set this variable:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$route</span><span class="p">[</span><span class="s1">'default_controller'</span><span class="p">]</span> <span class="o">=</span> <span class="s1">'blog'</span><span class="p">;</span> +</pre></div> +</div> +<p>Where ‘blog’ is the name of the controller class you want used. If you now +load your main index.php file without specifying any URI segments you’ll +see your “Hello World” message by default.</p> +<p>For more information, please refer to the “Reserved Routes” section of the +<a class="reference internal" href="routing.html"><span class="doc">URI Routing</span></a> documentation.</p> +</div> +<div class="section" id="remapping-method-calls"> +<h2><a class="toc-backref" href="#id7">Remapping Method Calls</a><a class="headerlink" href="#remapping-method-calls" title="Permalink to this headline">¶</a></h2> +<p>As noted above, the second segment of the URI typically determines which +method in the controller gets called. CodeIgniter permits you to override +this behavior through the use of the <code class="docutils literal"><span class="pre">_remap()</span></code> method:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">public</span> <span class="k">function</span> <span class="nf">_remap</span><span class="p">()</span> +<span class="p">{</span> + <span class="c1">// Some code here...</span> +<span class="p">}</span> +</pre></div> +</div> +<div class="admonition important"> +<p class="first admonition-title">Important</p> +<p class="last">If your controller contains a method named _remap(), +it will <strong>always</strong> get called regardless of what your URI contains. It +overrides the normal behavior in which the URI determines which method +is called, allowing you to define your own method routing rules.</p> +</div> +<p>The overridden method call (typically the second segment of the URI) will +be passed as a parameter to the <code class="docutils literal"><span class="pre">_remap()</span></code> method:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">public</span> <span class="k">function</span> <span class="nf">_remap</span><span class="p">(</span><span class="nv">$method</span><span class="p">)</span> +<span class="p">{</span> + <span class="k">if</span> <span class="p">(</span><span class="nv">$method</span> <span class="o">===</span> <span class="s1">'some_method'</span><span class="p">)</span> + <span class="p">{</span> + <span class="nv">$this</span><span class="o">-></span><span class="nv">$method</span><span class="p">();</span> + <span class="p">}</span> + <span class="k">else</span> + <span class="p">{</span> + <span class="nv">$this</span><span class="o">-></span><span class="na">default_method</span><span class="p">();</span> + <span class="p">}</span> +<span class="p">}</span> +</pre></div> +</div> +<p>Any extra segments after the method name are passed into <code class="docutils literal"><span class="pre">_remap()</span></code> as an +optional second parameter. This array can be used in combination with +PHP’s <a class="reference external" href="http://php.net/call_user_func_array">call_user_func_array()</a> +to emulate CodeIgniter’s default behavior.</p> +<p>Example:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">public</span> <span class="k">function</span> <span class="nf">_remap</span><span class="p">(</span><span class="nv">$method</span><span class="p">,</span> <span class="nv">$params</span> <span class="o">=</span> <span class="k">array</span><span class="p">())</span> +<span class="p">{</span> + <span class="nv">$method</span> <span class="o">=</span> <span class="s1">'process_'</span><span class="o">.</span><span class="nv">$method</span><span class="p">;</span> + <span class="k">if</span> <span class="p">(</span><span class="nb">method_exists</span><span class="p">(</span><span class="nv">$this</span><span class="p">,</span> <span class="nv">$method</span><span class="p">))</span> + <span class="p">{</span> + <span class="k">return</span> <span class="nb">call_user_func_array</span><span class="p">(</span><span class="k">array</span><span class="p">(</span><span class="nv">$this</span><span class="p">,</span> <span class="nv">$method</span><span class="p">),</span> <span class="nv">$params</span><span class="p">);</span> + <span class="p">}</span> + <span class="nx">show_404</span><span class="p">();</span> +<span class="p">}</span> +</pre></div> +</div> +</div> +<div class="section" id="processing-output"> +<h2><a class="toc-backref" href="#id8">Processing Output</a><a class="headerlink" href="#processing-output" title="Permalink to this headline">¶</a></h2> +<p>CodeIgniter has an output class that takes care of sending your final +rendered data to the web browser automatically. More information on this +can be found in the <a class="reference internal" href="views.html"><span class="doc">Views</span></a> and <a class="reference internal" href="../libraries/output.html"><span class="doc">Output Class</span></a> pages. In some cases, however, you might want to +post-process the finalized data in some way and send it to the browser +yourself. CodeIgniter permits you to add a method named <code class="docutils literal"><span class="pre">_output()</span></code> +to your controller that will receive the finalized output data.</p> +<div class="admonition important"> +<p class="first admonition-title">Important</p> +<p class="last">If your controller contains a method named <code class="docutils literal"><span class="pre">_output()</span></code>, +it will <strong>always</strong> be called by the output class instead of +echoing the finalized data directly. The first parameter of the +method will contain the finalized output.</p> +</div> +<p>Here is an example:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">public</span> <span class="k">function</span> <span class="nf">_output</span><span class="p">(</span><span class="nv">$output</span><span class="p">)</span> +<span class="p">{</span> + <span class="k">echo</span> <span class="nv">$output</span><span class="p">;</span> +<span class="p">}</span> +</pre></div> +</div> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p>Please note that your <code class="docutils literal"><span class="pre">_output()</span></code> method will receive the +data in its finalized state. Benchmark and memory usage data +will be rendered, cache files written (if you have caching +enabled), and headers will be sent (if you use that +<a class="reference internal" href="../libraries/output.html"><span class="doc">feature</span></a>) before it is handed off +to the <code class="docutils literal"><span class="pre">_output()</span></code> method. +To have your controller’s output cached properly, its +<code class="docutils literal"><span class="pre">_output()</span></code> method can use:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">if</span> <span class="p">(</span><span class="nv">$this</span><span class="o">-></span><span class="na">output</span><span class="o">-></span><span class="na">cache_expiration</span> <span class="o">></span> <span class="mi">0</span><span class="p">)</span> +<span class="p">{</span> + <span class="nv">$this</span><span class="o">-></span><span class="na">output</span><span class="o">-></span><span class="na">_write_cache</span><span class="p">(</span><span class="nv">$output</span><span class="p">);</span> +<span class="p">}</span> +</pre></div> +</div> +<p class="last">If you are using this feature the page execution timer and +memory usage stats might not be perfectly accurate since they +will not take into account any further processing you do. +For an alternate way to control output <em>before</em> any of the +final processing is done, please see the available methods +in the <a class="reference internal" href="../libraries/output.html"><span class="doc">Output Library</span></a>.</p> +</div> +</div> +<div class="section" id="private-methods"> +<h2><a class="toc-backref" href="#id9">Private methods</a><a class="headerlink" href="#private-methods" title="Permalink to this headline">¶</a></h2> +<p>In some cases you may want certain methods hidden from public access. +In order to achieve this, simply declare the method as being private +or protected and it will not be served via a URL request. For example, +if you were to have a method like this:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">private</span> <span class="k">function</span> <span class="nf">_utility</span><span class="p">()</span> +<span class="p">{</span> + <span class="c1">// some code</span> +<span class="p">}</span> +</pre></div> +</div> +<p>Trying to access it via the URL, like this, will not work:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nx">example</span><span class="o">.</span><span class="nx">com</span><span class="o">/</span><span class="nx">index</span><span class="o">.</span><span class="nx">php</span><span class="o">/</span><span class="nx">blog</span><span class="o">/</span><span class="nx">_utility</span><span class="o">/</span> +</pre></div> +</div> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">Prefixing method names with an underscore will also prevent +them from being called. This is a legacy feature that is left +for backwards-compatibility.</p> +</div> +</div> +<div class="section" id="organizing-your-controllers-into-sub-directories"> +<h2><a class="toc-backref" href="#id10">Organizing Your Controllers into Sub-directories</a><a class="headerlink" href="#organizing-your-controllers-into-sub-directories" title="Permalink to this headline">¶</a></h2> +<p>If you are building a large application you might want to hierarchically +organize or structure your controllers into sub-directories. CodeIgniter +permits you to do this.</p> +<p>Simply create sub-directories under the main <em>application/controllers/</em> +one and place your controller classes within them.</p> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p>When using this feature the first segment of your URI must +specify the folder. For example, let’s say you have a controller located +here:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nx">application</span><span class="o">/</span><span class="nx">controllers</span><span class="o">/</span><span class="nx">products</span><span class="o">/</span><span class="nx">Shoes</span><span class="o">.</span><span class="nx">php</span> +</pre></div> +</div> +<p>To call the above controller your URI will look something like this:</p> +<div class="last highlight-ci"><div class="highlight"><pre><span></span><span class="nx">example</span><span class="o">.</span><span class="nx">com</span><span class="o">/</span><span class="nx">index</span><span class="o">.</span><span class="nx">php</span><span class="o">/</span><span class="nx">products</span><span class="o">/</span><span class="nx">shoes</span><span class="o">/</span><span class="nx">show</span><span class="o">/</span><span class="mi">123</span> +</pre></div> +</div> +</div> +<p>Each of your sub-directories may contain a default controller which will be +called if the URL contains <em>only</em> the sub-directory. Simply put a controller +in there that matches the name of your ‘default_controller’ as specified in +your <em>application/config/routes.php</em> file.</p> +<p>CodeIgniter also permits you to remap your URIs using its <a class="reference internal" href="routing.html"><span class="doc">URI +Routing</span></a> feature.</p> +</div> +<div class="section" id="class-constructors"> +<h2><a class="toc-backref" href="#id11">Class Constructors</a><a class="headerlink" href="#class-constructors" title="Permalink to this headline">¶</a></h2> +<p>If you intend to use a constructor in any of your Controllers, you +<strong>MUST</strong> place the following line of code in it:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">parent</span><span class="o">::</span><span class="na">__construct</span><span class="p">();</span> +</pre></div> +</div> +<p>The reason this line is necessary is because your local constructor will +be overriding the one in the parent controller class so we need to +manually call it.</p> +<p>Example:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="o"><?</span><span class="nx">php</span> +<span class="k">class</span> <span class="nc">Blog</span> <span class="k">extends</span> <span class="nx">CI_Controller</span> <span class="p">{</span> + + <span class="k">public</span> <span class="k">function</span> <span class="nf">__construct</span><span class="p">()</span> + <span class="p">{</span> + <span class="k">parent</span><span class="o">::</span><span class="na">__construct</span><span class="p">();</span> + <span class="c1">// Your own constructor code</span> + <span class="p">}</span> +<span class="p">}</span> +</pre></div> +</div> +<p>Constructors are useful if you need to set some default values, or run a +default process when your class is instantiated. Constructors can’t +return a value, but they can do some default work.</p> +</div> +<div class="section" id="reserved-method-names"> +<h2><a class="toc-backref" href="#id12">Reserved method names</a><a class="headerlink" href="#reserved-method-names" title="Permalink to this headline">¶</a></h2> +<p>Since your controller classes will extend the main application +controller you must be careful not to name your methods identically to +the ones used by that class, otherwise your local functions will +override them. See <a class="reference internal" href="reserved_names.html"><span class="doc">Reserved Names</span></a> for a full +list.</p> +<div class="admonition important"> +<p class="first admonition-title">Important</p> +<p class="last">You should also never have a method named identically +to its class name. If you do, and there is no <code class="docutils literal"><span class="pre">__construct()</span></code> +method in the same class, then your e.g. <code class="docutils literal"><span class="pre">Index::index()</span></code> +method will be executed as a class constructor! This is a PHP4 +backwards-compatibility feature.</p> +</div> +</div> +<div class="section" id="that-s-it"> +<h2><a class="toc-backref" href="#id13">That’s it!</a><a class="headerlink" href="#that-s-it" title="Permalink to this headline">¶</a></h2> +<p>That, in a nutshell, is all there is to know about controllers.</p> +</div> +</div> + + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="reserved_names.html" class="btn btn-neutral float-right" title="Reserved Names">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="urls.html" class="btn btn-neutral" title="CodeIgniter URLs"><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 |