702 lines
47 KiB
HTML
702 lines
47 KiB
HTML
|
|
|||
|
|
|
|||
|
|
<!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>Writing CodeIgniter Documentation — CodeIgniter 3.1.11 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.11 documentation" href="../index.html"/>
|
|||
|
|
<link rel="up" title="Contributing to CodeIgniter" href="../contributing/index.html"/>
|
|||
|
|
<link rel="next" title="Developer’s Certificate of Origin 1.1" href="../DCO.html"/>
|
|||
|
|
<link rel="prev" title="Contributing to CodeIgniter" href="../contributing/index.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="../general/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 class="current">
|
|||
|
|
<li class="toctree-l1 current"><a class="reference internal" href="../contributing/index.html">Contributing to CodeIgniter</a><ul class="current">
|
|||
|
|
<li class="toctree-l2 current"><a class="current reference internal" href="#">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>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="../general/index.html">General Topics</a><ul>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/urls.html">CodeIgniter URLs</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/controllers.html">Controllers</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/reserved_names.html">Reserved Names</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/views.html">Views</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/models.html">Models</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/helpers.html">Helpers</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/libraries.html">Using CodeIgniter Libraries</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/creating_libraries.html">Creating Libraries</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/drivers.html">Using CodeIgniter Drivers</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/creating_drivers.html">Creating Drivers</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/core_classes.html">Creating Core System Classes</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/ancillary_classes.html">Creating Ancillary Classes</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/hooks.html">Hooks - Extending the Framework Core</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/autoloader.html">Auto-loading Resources</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/common_functions.html">Common Functions</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/compatibility_functions.html">Compatibility Functions</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/routing.html">URI Routing</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/errors.html">Error Handling</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/caching.html">Caching</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/profiling.html">Profiling Your Application</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/cli.html">Running via the CLI</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/managing_apps.html">Managing your Applications</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/environments.html">Handling Multiple Environments</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/alternative_php.html">Alternate PHP Syntax for View Files</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/security.html">Security</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/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="../general/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 class="current">
|
|||
|
|
<li class="toctree-l1 current"><a class="reference internal" href="../contributing/index.html">Contributing to CodeIgniter</a><ul class="current">
|
|||
|
|
<li class="toctree-l2 current"><a class="current reference internal" href="#">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>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="../general/index.html">General Topics</a><ul>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/urls.html">CodeIgniter URLs</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/controllers.html">Controllers</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/reserved_names.html">Reserved Names</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/views.html">Views</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/models.html">Models</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/helpers.html">Helpers</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/libraries.html">Using CodeIgniter Libraries</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/creating_libraries.html">Creating Libraries</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/drivers.html">Using CodeIgniter Drivers</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/creating_drivers.html">Creating Drivers</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/core_classes.html">Creating Core System Classes</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/ancillary_classes.html">Creating Ancillary Classes</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/hooks.html">Hooks - Extending the Framework Core</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/autoloader.html">Auto-loading Resources</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/common_functions.html">Common Functions</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/compatibility_functions.html">Compatibility Functions</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/routing.html">URI Routing</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/errors.html">Error Handling</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/caching.html">Caching</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/profiling.html">Profiling Your Application</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/cli.html">Running via the CLI</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/managing_apps.html">Managing your Applications</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/environments.html">Handling Multiple Environments</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/alternative_php.html">Alternate PHP Syntax for View Files</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/security.html">Security</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/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="../contributing/index.html">Contributing to CodeIgniter</a> »</li>
|
|||
|
|
|
|||
|
|
<li>Writing CodeIgniter Documentation</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="writing-codeigniter-documentation">
|
|||
|
|
<h1>Writing CodeIgniter Documentation<a class="headerlink" href="#writing-codeigniter-documentation" title="Permalink to this headline">¶</a></h1>
|
|||
|
|
<p>CodeIgniter uses Sphinx to generate its documentation in a variety of formats,
|
|||
|
|
using reStructuredText to handle the formatting. If you are familiar with
|
|||
|
|
Markdown or Textile, you will quickly grasp reStructuredText. The focus is
|
|||
|
|
on readability and user friendliness.
|
|||
|
|
While they can be quite technical, we always write for humans!</p>
|
|||
|
|
<p>A local table of contents should always be included, like the one below.
|
|||
|
|
It is created automatically by inserting the following:</p>
|
|||
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="o">..</span> <span class="nx">contents</span><span class="o">::</span>
|
|||
|
|
<span class="o">:</span><span class="nx">local</span><span class="o">:</span>
|
|||
|
|
|
|||
|
|
<span class="o">..</span> <span class="nx">raw</span><span class="o">::</span> <span class="na">html</span>
|
|||
|
|
|
|||
|
|
<span class="o"><</span><span class="nx">div</span> <span class="nx">class</span><span class="o">=</span><span class="s2">"custom-index container"</span><span class="o">></</span><span class="nx">div</span><span class="o">></span>
|
|||
|
|
</pre></div>
|
|||
|
|
</div>
|
|||
|
|
<div class="contents local topic" id="contents">
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><a class="reference internal" href="#tools-required" id="id1">Tools Required</a></li>
|
|||
|
|
<li><a class="reference internal" href="#page-and-section-headings-and-subheadings" id="id2">Page and Section Headings and Subheadings</a></li>
|
|||
|
|
<li><a class="reference internal" href="#method-documentation" id="id3">Method Documentation</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</div>
|
|||
|
|
<div class="custom-index container"></div><p>The <div> that is inserted as raw HTML is a hook for the documentation’s
|
|||
|
|
JavaScript to dynamically add links to any function and method definitions
|
|||
|
|
contained in the current page.</p>
|
|||
|
|
<div class="section" id="tools-required">
|
|||
|
|
<h2><a class="toc-backref" href="#id1">Tools Required</a><a class="headerlink" href="#tools-required" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<p>To see the rendered HTML, ePub, PDF, etc., you will need to install Sphinx
|
|||
|
|
along with the PHP domain extension for Sphinx. The underlying requirement
|
|||
|
|
is to have Python installed. Lastly, you will install the CI Lexer for
|
|||
|
|
Pygments, so that code blocks can be properly highlighted.</p>
|
|||
|
|
<div class="highlight-bash"><div class="highlight"><pre><span></span>easy_install <span class="s2">"sphinx==1.2.3"</span>
|
|||
|
|
easy_install <span class="s2">"sphinxcontrib-phpdomain==0.1.3.post1"</span>
|
|||
|
|
</pre></div>
|
|||
|
|
</div>
|
|||
|
|
<p>Then follow the directions in the README file in the <code class="samp docutils literal"><span class="pre">cilexer</span></code> folder
|
|||
|
|
inside the documentation repository to install the CI Lexer.</p>
|
|||
|
|
</div>
|
|||
|
|
<div class="section" id="page-and-section-headings-and-subheadings">
|
|||
|
|
<h2><a class="toc-backref" href="#id2">Page and Section Headings and Subheadings</a><a class="headerlink" href="#page-and-section-headings-and-subheadings" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<p>Headings not only provide order and sections within a page, but they also
|
|||
|
|
are used to automatically build both the page and document table of contents.
|
|||
|
|
Headings are formed by using certain characters as underlines for a bit of
|
|||
|
|
text. Major headings, like page titles and section headings also use
|
|||
|
|
overlines. Other headings just use underlines, with the following hierarchy:</p>
|
|||
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="c1"># with overline for page titles</span>
|
|||
|
|
<span class="o">*</span> <span class="nx">with</span> <span class="nx">overline</span> <span class="k">for</span> <span class="nx">major</span> <span class="nx">sections</span>
|
|||
|
|
<span class="o">=</span> <span class="k">for</span> <span class="nx">subsections</span>
|
|||
|
|
<span class="o">-</span> <span class="k">for</span> <span class="nx">subsubsections</span>
|
|||
|
|
<span class="o">^</span> <span class="k">for</span> <span class="nx">subsubsubsections</span>
|
|||
|
|
<span class="s2">" for subsubsubsubsections (!)</span>
|
|||
|
|
</pre></div>
|
|||
|
|
</div>
|
|||
|
|
<p>The <a class="reference download internal" href="../_downloads/ELDocs.tmbundle.zip" download=""><code class="xref download docutils literal"><span class="pre">TextMate</span> <span class="pre">ELDocs</span> <span class="pre">Bundle</span></code></a> can help you
|
|||
|
|
create these with the following tab triggers:</p>
|
|||
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nx">title</span><span class="o">-></span>
|
|||
|
|
|
|||
|
|
<span class="c1">##########</span>
|
|||
|
|
<span class="nx">Page</span> <span class="nx">Title</span>
|
|||
|
|
<span class="c1">##########</span>
|
|||
|
|
|
|||
|
|
<span class="nx">sec</span><span class="o">-></span>
|
|||
|
|
|
|||
|
|
<span class="o">*************</span>
|
|||
|
|
<span class="nx">Major</span> <span class="nx">Section</span>
|
|||
|
|
<span class="o">*************</span>
|
|||
|
|
|
|||
|
|
<span class="nx">sub</span><span class="o">-></span>
|
|||
|
|
|
|||
|
|
<span class="na">Subsection</span>
|
|||
|
|
<span class="o">==========</span>
|
|||
|
|
|
|||
|
|
<span class="nx">sss</span><span class="o">-></span>
|
|||
|
|
|
|||
|
|
<span class="na">SubSubSection</span>
|
|||
|
|
<span class="o">-------------</span>
|
|||
|
|
|
|||
|
|
<span class="nx">ssss</span><span class="o">-></span>
|
|||
|
|
|
|||
|
|
<span class="na">SubSubSubSection</span>
|
|||
|
|
<span class="o">^^^^^^^^^^^^^^^^</span>
|
|||
|
|
|
|||
|
|
<span class="nx">sssss</span><span class="o">-></span>
|
|||
|
|
|
|||
|
|
<span class="na">SubSubSubSubSection</span> <span class="p">(</span><span class="o">!</span><span class="p">)</span>
|
|||
|
|
<span class="s2">"""""""""""""""""""""""</span>
|
|||
|
|
</pre></div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<div class="section" id="method-documentation">
|
|||
|
|
<h2><a class="toc-backref" href="#id3">Method Documentation</a><a class="headerlink" href="#method-documentation" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<p>When documenting class methods for third party developers, Sphinx provides
|
|||
|
|
directives to assist and keep things simple.
|
|||
|
|
For example, consider the following ReST:</p>
|
|||
|
|
<div class="highlight-rst"><div class="highlight"><pre><span></span><span class="p">..</span> <span class="ow">php:class</span><span class="p">::</span> Some_class
|
|||
|
|
|
|||
|
|
<span class="p"> ..</span> <span class="ow">php:method</span><span class="p">::</span> some_method ( $foo [, $bar [, $bat]])
|
|||
|
|
|
|||
|
|
This function will perform some action. The <span class="s">``$bar``</span> array must contain
|
|||
|
|
a something and something else, and along with <span class="s">``$bat``</span> is an optional
|
|||
|
|
parameter.
|
|||
|
|
|
|||
|
|
<span class="nc">:param int $foo:</span> <span class="nf">the foo id to do something in</span>
|
|||
|
|
<span class="nc">:param mixed $bar:</span> <span class="nf">A data array that must contain a something and something else</span>
|
|||
|
|
<span class="nc">:param bool $bat:</span> <span class="nf">whether or not to do something</span>
|
|||
|
|
<span class="nc">:returns:</span> <span class="nf">FALSE on failure, TRUE if successful</span>
|
|||
|
|
<span class="nc">:rtype:</span> <span class="nf">bool</span>
|
|||
|
|
|
|||
|
|
<span class="se">::</span>
|
|||
|
|
|
|||
|
|
<span class="s"> $this->load->library('some_class');</span>
|
|||
|
|
|
|||
|
|
<span class="s"> $bar = array(</span>
|
|||
|
|
<span class="s"> 'something' => 'Here is this parameter!',</span>
|
|||
|
|
<span class="s"> 'something_else' => 42</span>
|
|||
|
|
<span class="s"> );</span>
|
|||
|
|
|
|||
|
|
<span class="s"> $bat = $this->some_class->should_do_something();</span>
|
|||
|
|
|
|||
|
|
<span class="s"> if ($this->some_class->some_method(4, $bar, $bat) === FALSE)</span>
|
|||
|
|
<span class="s"> {</span>
|
|||
|
|
<span class="s"> show_error('An Error Occurred Doing Some Method');</span>
|
|||
|
|
<span class="s"> }</span>
|
|||
|
|
|
|||
|
|
<span class="p"> ..</span> <span class="ow">note</span><span class="p">::</span> Here is something that you should be aware of when using some_method().
|
|||
|
|
For real.
|
|||
|
|
|
|||
|
|
See also <span class="na">:meth:</span><span class="nv">`Some_class::should_do_something`</span>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<span class="p"> ..</span> <span class="ow">php:method</span><span class="p">::</span> should_do_something()
|
|||
|
|
|
|||
|
|
<span class="nc">:returns:</span> <span class="nf">Whether or not something should be done</span>
|
|||
|
|
<span class="nc">:rtype:</span> <span class="nf">bool</span>
|
|||
|
|
</pre></div>
|
|||
|
|
</div>
|
|||
|
|
<p>It creates the following display:</p>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="Some_class">
|
|||
|
|
<em class="property">class </em><code class="descname">Some_class</code><a class="headerlink" href="#Some_class" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><dl class="method">
|
|||
|
|
<dt id="Some_class::some_method">
|
|||
|
|
<code class="descname">some_method</code><span class="sig-paren">(</span><em>$foo</em><span class="optional">[</span>, <em>$bar</em><span class="optional">[</span>, <em>$bat</em><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#Some_class::some_method" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>This function will perform some action. The <code class="docutils literal"><span class="pre">$bar</span></code> array must contain
|
|||
|
|
a something and something else, and along with <code class="docutils literal"><span class="pre">$bat</span></code> is an optional
|
|||
|
|
parameter.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
|||
|
|
<li><strong>$foo</strong> (<em>int</em>) – the foo id to do something in</li>
|
|||
|
|
<li><strong>$bar</strong> (<em>mixed</em>) – A data array that must contain a something and something else</li>
|
|||
|
|
<li><strong>$bat</strong> (<em>bool</em>) – whether or not to do something</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">FALSE on failure, TRUE if successful</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">bool</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$this</span><span class="o">-></span><span class="na">load</span><span class="o">-></span><span class="na">library</span><span class="p">(</span><span class="s1">'some_class'</span><span class="p">);</span>
|
|||
|
|
|
|||
|
|
<span class="nv">$bar</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span>
|
|||
|
|
<span class="s1">'something'</span> <span class="o">=></span> <span class="s1">'Here is this parameter!'</span><span class="p">,</span>
|
|||
|
|
<span class="s1">'something_else'</span> <span class="o">=></span> <span class="mi">42</span>
|
|||
|
|
<span class="p">);</span>
|
|||
|
|
|
|||
|
|
<span class="nv">$bat</span> <span class="o">=</span> <span class="nv">$this</span><span class="o">-></span><span class="na">some_class</span><span class="o">-></span><span class="na">should_do_something</span><span class="p">();</span>
|
|||
|
|
|
|||
|
|
<span class="k">if</span> <span class="p">(</span><span class="nv">$this</span><span class="o">-></span><span class="na">some_class</span><span class="o">-></span><span class="na">some_method</span><span class="p">(</span><span class="mi">4</span><span class="p">,</span> <span class="nv">$bar</span><span class="p">,</span> <span class="nv">$bat</span><span class="p">)</span> <span class="o">===</span> <span class="k">FALSE</span><span class="p">)</span>
|
|||
|
|
<span class="p">{</span>
|
|||
|
|
<span class="nx">show_error</span><span class="p">(</span><span class="s1">'An Error Occurred Doing Some Method'</span><span class="p">);</span>
|
|||
|
|
<span class="p">}</span>
|
|||
|
|
</pre></div>
|
|||
|
|
</div>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="first admonition-title">Note</p>
|
|||
|
|
<p class="last">Here is something that you should be aware of when using some_method().
|
|||
|
|
For real.</p>
|
|||
|
|
</div>
|
|||
|
|
<p>See also <code class="xref py py-meth docutils literal"><span class="pre">Some_class::should_do_something()</span></code></p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="Some_class::should_do_something">
|
|||
|
|
<code class="descname">should_do_something</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Some_class::should_do_something" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Whether or not something should be done</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<footer>
|
|||
|
|
|
|||
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|||
|
|
|
|||
|
|
<a href="../DCO.html" class="btn btn-neutral float-right" title="Developer’s Certificate of Origin 1.1">Next <span class="fa fa-arrow-circle-right"></span></a>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a href="../contributing/index.html" class="btn btn-neutral" title="Contributing to CodeIgniter"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<hr/>
|
|||
|
|
|
|||
|
|
<div role="contentinfo">
|
|||
|
|
<p>
|
|||
|
|
© Copyright 2014 - 2019, British Columbia Institute of Technology.
|
|||
|
|
Last updated on Sep 19, 2019.
|
|||
|
|
</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.11',
|
|||
|
|
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>
|