You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1599 lines
113 KiB
1599 lines
113 KiB
|
|
|
|
<!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>Form Helper — CodeIgniter 3.1.4 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="top" title="CodeIgniter 3.1.4 documentation" href="../index.html"/>
|
|
<link rel="up" title="Helpers" href="index.html"/>
|
|
<link rel="next" title="HTML Helper" href="html_helper.html"/>
|
|
<link rel="prev" title="File Helper" href="file_helper.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><ul class="simple">
|
|
</ul>
|
|
</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>
|
|
<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 class="current">
|
|
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Helpers</a><ul class="current">
|
|
<li class="toctree-l2"><a class="reference internal" href="array_helper.html">Array Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="captcha_helper.html">CAPTCHA Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cookie_helper.html">Cookie Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="date_helper.html">Date Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="directory_helper.html">Directory Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="download_helper.html">Download Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="email_helper.html">Email Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="file_helper.html">File Helper</a></li>
|
|
<li class="toctree-l2 current"><a class="current reference internal" href="">Form Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="html_helper.html">HTML Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="inflector_helper.html">Inflector Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="language_helper.html">Language Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="number_helper.html">Number Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="path_helper.html">Path Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="security_helper.html">Security Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="smiley_helper.html">Smiley Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="string_helper.html">String Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="text_helper.html">Text Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="typography_helper.html">Typography Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="url_helper.html">URL Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="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><ul class="simple">
|
|
</ul>
|
|
</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>
|
|
<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 class="current">
|
|
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Helpers</a><ul class="current">
|
|
<li class="toctree-l2"><a class="reference internal" href="array_helper.html">Array Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="captcha_helper.html">CAPTCHA Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cookie_helper.html">Cookie Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="date_helper.html">Date Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="directory_helper.html">Directory Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="download_helper.html">Download Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="email_helper.html">Email Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="file_helper.html">File Helper</a></li>
|
|
<li class="toctree-l2 current"><a class="current reference internal" href="">Form Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="html_helper.html">HTML Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="inflector_helper.html">Inflector Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="language_helper.html">Language Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="number_helper.html">Number Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="path_helper.html">Path Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="security_helper.html">Security Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="smiley_helper.html">Smiley Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="string_helper.html">String Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="text_helper.html">Text Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="typography_helper.html">Typography Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="url_helper.html">URL Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="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">Helpers</a> »</li>
|
|
|
|
<li>Form Helper</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="form-helper">
|
|
<h1>Form Helper<a class="headerlink" href="#form-helper" title="Permalink to this headline">¶</a></h1>
|
|
<p>The Form Helper file contains functions that assist in working with
|
|
forms.</p>
|
|
<div class="contents local topic" id="contents">
|
|
<ul class="simple">
|
|
<li><a class="reference internal" href="#loading-this-helper" id="id1">Loading this Helper</a></li>
|
|
<li><a class="reference internal" href="#escaping-field-values" id="id2">Escaping field values</a></li>
|
|
<li><a class="reference internal" href="#available-functions" id="id3">Available Functions</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="custom-index container"></div><div class="section" id="loading-this-helper">
|
|
<h2><a class="toc-backref" href="#id1">Loading this Helper</a><a class="headerlink" href="#loading-this-helper" title="Permalink to this headline">¶</a></h2>
|
|
<p>This helper is loaded using the following code:</p>
|
|
<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">helper</span><span class="p">(</span><span class="s1">'form'</span><span class="p">);</span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="escaping-field-values">
|
|
<h2><a class="toc-backref" href="#id2">Escaping field values</a><a class="headerlink" href="#escaping-field-values" title="Permalink to this headline">¶</a></h2>
|
|
<p>You may need to use HTML and characters such as quotes within your form
|
|
elements. In order to do that safely, you’ll need to use
|
|
<a class="reference internal" href="../general/common_functions.html"><em>common function</em></a>
|
|
<tt class="xref py py-func docutils literal"><span class="pre">html_escape()</span></tt>.</p>
|
|
<p>Consider the following example:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$string</span> <span class="o">=</span> <span class="s1">'Here is a string containing "quoted" text.'</span><span class="p">;</span>
|
|
|
|
<span class="o"><</span><span class="nx">input</span> <span class="nx">type</span><span class="o">=</span><span class="s2">"text"</span> <span class="nx">name</span><span class="o">=</span><span class="s2">"myfield"</span> <span class="nx">value</span><span class="o">=</span><span class="s2">"<?php echo </span><span class="si">$string</span><span class="s2">; ?>"</span> <span class="o">/></span>
|
|
</pre></div>
|
|
</div>
|
|
<p>Since the above string contains a set of quotes, it will cause the form
|
|
to break. The <a class="reference internal" href="../general/common_functions.html#html_escape" title="html_escape"><tt class="xref php php-func docutils literal"><span class="pre">html_escape()</span></tt></a> function converts HTML special
|
|
characters so that it can be used safely:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="o"><</span><span class="nx">input</span> <span class="nx">type</span><span class="o">=</span><span class="s2">"text"</span> <span class="nx">name</span><span class="o">=</span><span class="s2">"myfield"</span> <span class="nx">value</span><span class="o">=</span><span class="s2">"<?php echo html_escape(</span><span class="si">$string</span><span class="s2">); ?>"</span> <span class="o">/></span>
|
|
</pre></div>
|
|
</div>
|
|
<div class="admonition note">
|
|
<p class="first admonition-title">Note</p>
|
|
<p class="last">If you use any of the form helper functions listed on this page,
|
|
the form values will be automatically escaped, so there is no need
|
|
to call this function. Use it only if you are creating your own
|
|
form elements.</p>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="available-functions">
|
|
<h2><a class="toc-backref" href="#id3">Available Functions</a><a class="headerlink" href="#available-functions" title="Permalink to this headline">¶</a></h2>
|
|
<p>The following functions are available:</p>
|
|
<dl class="function">
|
|
<dt id="form_open">
|
|
<tt class="descname">form_open</tt><big>(</big><span class="optional">[</span><em>$action = ''</em><span class="optional">[</span>, <em>$attributes = ''</em><span class="optional">[</span>, <em>$hidden = array()</em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#form_open" 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">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
<li><strong>$action</strong> (<em>string</em>) – Form action/target URI string</li>
|
|
<li><strong>$attributes</strong> (<em>array</em>) – HTML attributes</li>
|
|
<li><strong>$hidden</strong> (<em>array</em>) – An array of hidden fields’ definitions</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">An HTML form opening tag</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Creates an opening form tag with a base URL <strong>built from your config preferences</strong>.
|
|
It will optionally let you add form attributes and hidden input fields, and
|
|
will always add the <cite>accept-charset</cite> attribute based on the charset value in your
|
|
config file.</p>
|
|
<p>The main benefit of using this tag rather than hard coding your own HTML is that
|
|
it permits your site to be more portable in the event your URLs ever change.</p>
|
|
<p>Here’s a simple example:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">echo</span> <span class="nx">form_open</span><span class="p">(</span><span class="s1">'email/send'</span><span class="p">);</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>The above example would create a form that points to your base URL plus the
|
|
“email/send” URI segments, like this:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="o"><</span><span class="nx">form</span> <span class="nx">method</span><span class="o">=</span><span class="s2">"post"</span> <span class="nx">accept</span><span class="o">-</span><span class="nx">charset</span><span class="o">=</span><span class="s2">"utf-8"</span> <span class="nx">action</span><span class="o">=</span><span class="s2">"http://example.com/index.php/email/send"</span><span class="o">></span>
|
|
</pre></div>
|
|
</div>
|
|
<p><strong>Adding Attributes</strong></p>
|
|
<blockquote>
|
|
<div><p>Attributes can be added by passing an associative array to the second
|
|
parameter, like this:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$attributes</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span><span class="s1">'class'</span> <span class="o">=></span> <span class="s1">'email'</span><span class="p">,</span> <span class="s1">'id'</span> <span class="o">=></span> <span class="s1">'myform'</span><span class="p">);</span>
|
|
<span class="k">echo</span> <span class="nx">form_open</span><span class="p">(</span><span class="s1">'email/send'</span><span class="p">,</span> <span class="nv">$attributes</span><span class="p">);</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>Alternatively, you can specify the second parameter as a string:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">echo</span> <span class="nx">form_open</span><span class="p">(</span><span class="s1">'email/send'</span><span class="p">,</span> <span class="s1">'class="email" id="myform"'</span><span class="p">);</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>The above examples would create a form similar to this:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="o"><</span><span class="nx">form</span> <span class="nx">method</span><span class="o">=</span><span class="s2">"post"</span> <span class="nx">accept</span><span class="o">-</span><span class="nx">charset</span><span class="o">=</span><span class="s2">"utf-8"</span> <span class="nx">action</span><span class="o">=</span><span class="s2">"http://example.com/index.php/email/send"</span> <span class="nx">class</span><span class="o">=</span><span class="s2">"email"</span> <span class="nx">id</span><span class="o">=</span><span class="s2">"myform"</span><span class="o">></span>
|
|
</pre></div>
|
|
</div>
|
|
</div></blockquote>
|
|
<p><strong>Adding Hidden Input Fields</strong></p>
|
|
<blockquote>
|
|
<div><p>Hidden fields can be added by passing an associative array to the
|
|
third parameter, like this:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$hidden</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span><span class="s1">'username'</span> <span class="o">=></span> <span class="s1">'Joe'</span><span class="p">,</span> <span class="s1">'member_id'</span> <span class="o">=></span> <span class="s1">'234'</span><span class="p">);</span>
|
|
<span class="k">echo</span> <span class="nx">form_open</span><span class="p">(</span><span class="s1">'email/send'</span><span class="p">,</span> <span class="s1">''</span><span class="p">,</span> <span class="nv">$hidden</span><span class="p">);</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>You can skip the second parameter by passing any falsy value to it.</p>
|
|
<p>The above example would create a form similar to this:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="o"><</span><span class="nx">form</span> <span class="nx">method</span><span class="o">=</span><span class="s2">"post"</span> <span class="nx">accept</span><span class="o">-</span><span class="nx">charset</span><span class="o">=</span><span class="s2">"utf-8"</span> <span class="nx">action</span><span class="o">=</span><span class="s2">"http://example.com/index.php/email/send"</span><span class="o">></span>
|
|
<span class="o"><</span><span class="nx">input</span> <span class="nx">type</span><span class="o">=</span><span class="s2">"hidden"</span> <span class="nx">name</span><span class="o">=</span><span class="s2">"username"</span> <span class="nx">value</span><span class="o">=</span><span class="s2">"Joe"</span> <span class="o">/></span>
|
|
<span class="o"><</span><span class="nx">input</span> <span class="nx">type</span><span class="o">=</span><span class="s2">"hidden"</span> <span class="nx">name</span><span class="o">=</span><span class="s2">"member_id"</span> <span class="nx">value</span><span class="o">=</span><span class="s2">"234"</span> <span class="o">/></span>
|
|
</pre></div>
|
|
</div>
|
|
</div></blockquote>
|
|
</dd></dl>
|
|
|
|
<dl class="function">
|
|
<dt id="form_open_multipart">
|
|
<tt class="descname">form_open_multipart</tt><big>(</big><span class="optional">[</span><em>$action = ''</em><span class="optional">[</span>, <em>$attributes = array()</em><span class="optional">[</span>, <em>$hidden = array()</em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#form_open_multipart" 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">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
<li><strong>$action</strong> (<em>string</em>) – Form action/target URI string</li>
|
|
<li><strong>$attributes</strong> (<em>array</em>) – HTML attributes</li>
|
|
<li><strong>$hidden</strong> (<em>array</em>) – An array of hidden fields’ definitions</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">An HTML multipart form opening tag</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>This function is absolutely identical to <a class="reference internal" href="#form_open" title="form_open"><tt class="xref php php-func docutils literal"><span class="pre">form_open()</span></tt></a> above,
|
|
except that it adds a <em>multipart</em> attribute, which is necessary if you
|
|
would like to use the form to upload files with.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="function">
|
|
<dt id="form_hidden">
|
|
<tt class="descname">form_hidden</tt><big>(</big><em>$name</em><span class="optional">[</span>, <em>$value = ''</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#form_hidden" 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">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
<li><strong>$name</strong> (<em>string</em>) – Field name</li>
|
|
<li><strong>$value</strong> (<em>string</em>) – Field value</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">An HTML hidden input field tag</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Lets you generate hidden input fields. You can either submit a
|
|
name/value string to create one field:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nx">form_hidden</span><span class="p">(</span><span class="s1">'username'</span><span class="p">,</span> <span class="s1">'johndoe'</span><span class="p">);</span>
|
|
<span class="c1">// Would produce: <input type="hidden" name="username" value="johndoe" /></span>
|
|
</pre></div>
|
|
</div>
|
|
<p>... or you can submit an associative array to create multiple fields:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$data</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'John Doe'</span><span class="p">,</span>
|
|
<span class="s1">'email'</span> <span class="o">=></span> <span class="s1">'john@example.com'</span><span class="p">,</span>
|
|
<span class="s1">'url'</span> <span class="o">=></span> <span class="s1">'http://example.com'</span>
|
|
<span class="p">);</span>
|
|
|
|
<span class="k">echo</span> <span class="nx">form_hidden</span><span class="p">(</span><span class="nv">$data</span><span class="p">);</span>
|
|
|
|
<span class="cm">/*</span>
|
|
<span class="cm"> Would produce:</span>
|
|
<span class="cm"> <input type="hidden" name="name" value="John Doe" /></span>
|
|
<span class="cm"> <input type="hidden" name="email" value="john@example.com" /></span>
|
|
<span class="cm"> <input type="hidden" name="url" value="http://example.com" /></span>
|
|
<span class="cm">*/</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>You can also pass an associative array to the value field:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$data</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'John Doe'</span><span class="p">,</span>
|
|
<span class="s1">'email'</span> <span class="o">=></span> <span class="s1">'john@example.com'</span><span class="p">,</span>
|
|
<span class="s1">'url'</span> <span class="o">=></span> <span class="s1">'http://example.com'</span>
|
|
<span class="p">);</span>
|
|
|
|
<span class="k">echo</span> <span class="nx">form_hidden</span><span class="p">(</span><span class="s1">'my_array'</span><span class="p">,</span> <span class="nv">$data</span><span class="p">);</span>
|
|
|
|
<span class="cm">/*</span>
|
|
<span class="cm"> Would produce:</span>
|
|
|
|
<span class="cm"> <input type="hidden" name="my_array[name]" value="John Doe" /></span>
|
|
<span class="cm"> <input type="hidden" name="my_array[email]" value="john@example.com" /></span>
|
|
<span class="cm"> <input type="hidden" name="my_array[url]" value="http://example.com" /></span>
|
|
<span class="cm">*/</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>If you want to create hidden input fields with extra attributes:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$data</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'type'</span> <span class="o">=></span> <span class="s1">'hidden'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'email'</span><span class="p">,</span>
|
|
<span class="s1">'id'</span> <span class="o">=></span> <span class="s1">'hiddenemail'</span><span class="p">,</span>
|
|
<span class="s1">'value'</span> <span class="o">=></span> <span class="s1">'john@example.com'</span><span class="p">,</span>
|
|
<span class="s1">'class'</span> <span class="o">=></span> <span class="s1">'hiddenemail'</span>
|
|
<span class="p">);</span>
|
|
|
|
<span class="k">echo</span> <span class="nx">form_input</span><span class="p">(</span><span class="nv">$data</span><span class="p">);</span>
|
|
|
|
<span class="cm">/*</span>
|
|
<span class="cm"> Would produce:</span>
|
|
|
|
<span class="cm"> <input type="hidden" name="email" value="john@example.com" id="hiddenemail" class="hiddenemail" /></span>
|
|
<span class="cm">*/</span>
|
|
</pre></div>
|
|
</div>
|
|
</dd></dl>
|
|
|
|
<dl class="function">
|
|
<dt id="form_input">
|
|
<tt class="descname">form_input</tt><big>(</big><span class="optional">[</span><em>$data = ''</em><span class="optional">[</span>, <em>$value = ''</em><span class="optional">[</span>, <em>$extra = ''</em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#form_input" 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">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
<li><strong>$data</strong> (<em>array</em>) – Field attributes data</li>
|
|
<li><strong>$value</strong> (<em>string</em>) – Field value</li>
|
|
<li><strong>$extra</strong> (<em>mixed</em>) – Extra attributes to be added to the tag either as an array or a literal string</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">An HTML text input field tag</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Lets you generate a standard text input field. You can minimally pass
|
|
the field name and value in the first and second parameter:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">echo</span> <span class="nx">form_input</span><span class="p">(</span><span class="s1">'username'</span><span class="p">,</span> <span class="s1">'johndoe'</span><span class="p">);</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>Or you can pass an associative array containing any data you wish your
|
|
form to contain:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$data</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'username'</span><span class="p">,</span>
|
|
<span class="s1">'id'</span> <span class="o">=></span> <span class="s1">'username'</span><span class="p">,</span>
|
|
<span class="s1">'value'</span> <span class="o">=></span> <span class="s1">'johndoe'</span><span class="p">,</span>
|
|
<span class="s1">'maxlength'</span> <span class="o">=></span> <span class="s1">'100'</span><span class="p">,</span>
|
|
<span class="s1">'size'</span> <span class="o">=></span> <span class="s1">'50'</span><span class="p">,</span>
|
|
<span class="s1">'style'</span> <span class="o">=></span> <span class="s1">'width:50%'</span>
|
|
<span class="p">);</span>
|
|
|
|
<span class="k">echo</span> <span class="nx">form_input</span><span class="p">(</span><span class="nv">$data</span><span class="p">);</span>
|
|
|
|
<span class="cm">/*</span>
|
|
<span class="cm"> Would produce:</span>
|
|
|
|
<span class="cm"> <input type="text" name="username" value="johndoe" id="username" maxlength="100" size="50" style="width:50%" /></span>
|
|
<span class="cm">*/</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>If you would like your form to contain some additional data, like
|
|
JavaScript, you can pass it as a string in the third parameter:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$js</span> <span class="o">=</span> <span class="s1">'onClick="some_function()"'</span><span class="p">;</span>
|
|
<span class="k">echo</span> <span class="nx">form_input</span><span class="p">(</span><span class="s1">'username'</span><span class="p">,</span> <span class="s1">'johndoe'</span><span class="p">,</span> <span class="nv">$js</span><span class="p">);</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>Or you can pass it as an array:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$js</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span><span class="s1">'onClick'</span> <span class="o">=></span> <span class="s1">'some_function();'</span><span class="p">);</span>
|
|
<span class="k">echo</span> <span class="nx">form_input</span><span class="p">(</span><span class="s1">'username'</span><span class="p">,</span> <span class="s1">'johndoe'</span><span class="p">,</span> <span class="nv">$js</span><span class="p">);</span>
|
|
</pre></div>
|
|
</div>
|
|
</dd></dl>
|
|
|
|
<dl class="function">
|
|
<dt id="form_password">
|
|
<tt class="descname">form_password</tt><big>(</big><span class="optional">[</span><em>$data = ''</em><span class="optional">[</span>, <em>$value = ''</em><span class="optional">[</span>, <em>$extra = ''</em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#form_password" 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">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
<li><strong>$data</strong> (<em>array</em>) – Field attributes data</li>
|
|
<li><strong>$value</strong> (<em>string</em>) – Field value</li>
|
|
<li><strong>$extra</strong> (<em>mixed</em>) – Extra attributes to be added to the tag either as an array or a literal string</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">An HTML password input field tag</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>This function is identical in all respects to the <a class="reference internal" href="#form_input" title="form_input"><tt class="xref php php-func docutils literal"><span class="pre">form_input()</span></tt></a>
|
|
function above except that it uses the “password” input type.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="function">
|
|
<dt id="form_upload">
|
|
<tt class="descname">form_upload</tt><big>(</big><span class="optional">[</span><em>$data = ''</em><span class="optional">[</span>, <em>$value = ''</em><span class="optional">[</span>, <em>$extra = ''</em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#form_upload" 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">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
<li><strong>$data</strong> (<em>array</em>) – Field attributes data</li>
|
|
<li><strong>$value</strong> (<em>string</em>) – Field value</li>
|
|
<li><strong>$extra</strong> (<em>mixed</em>) – Extra attributes to be added to the tag either as an array or a literal string</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">An HTML file upload input field tag</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>This function is identical in all respects to the <a class="reference internal" href="#form_input" title="form_input"><tt class="xref php php-func docutils literal"><span class="pre">form_input()</span></tt></a>
|
|
function above except that it uses the “file” input type, allowing it to
|
|
be used to upload files.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="function">
|
|
<dt id="form_textarea">
|
|
<tt class="descname">form_textarea</tt><big>(</big><span class="optional">[</span><em>$data = ''</em><span class="optional">[</span>, <em>$value = ''</em><span class="optional">[</span>, <em>$extra = ''</em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#form_textarea" 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">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
<li><strong>$data</strong> (<em>array</em>) – Field attributes data</li>
|
|
<li><strong>$value</strong> (<em>string</em>) – Field value</li>
|
|
<li><strong>$extra</strong> (<em>mixed</em>) – Extra attributes to be added to the tag either as an array or a literal string</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">An HTML textarea tag</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>This function is identical in all respects to the <a class="reference internal" href="#form_input" title="form_input"><tt class="xref php php-func docutils literal"><span class="pre">form_input()</span></tt></a>
|
|
function above except that it generates a “textarea” type.</p>
|
|
<div class="admonition note">
|
|
<p class="first admonition-title">Note</p>
|
|
<p class="last">Instead of the <em>maxlength</em> and <em>size</em> attributes in the above example,
|
|
you will instead specify <em>rows</em> and <em>cols</em>.</p>
|
|
</div>
|
|
</dd></dl>
|
|
|
|
<dl class="function">
|
|
<dt id="form_dropdown">
|
|
<tt class="descname">form_dropdown</tt><big>(</big><span class="optional">[</span><em>$name = ''</em><span class="optional">[</span>, <em>$options = array()</em><span class="optional">[</span>, <em>$selected = array()</em><span class="optional">[</span>, <em>$extra = ''</em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#form_dropdown" 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">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
<li><strong>$name</strong> (<em>string</em>) – Field name</li>
|
|
<li><strong>$options</strong> (<em>array</em>) – An associative array of options to be listed</li>
|
|
<li><strong>$selected</strong> (<em>array</em>) – List of fields to mark with the <em>selected</em> attribute</li>
|
|
<li><strong>$extra</strong> (<em>mixed</em>) – Extra attributes to be added to the tag either as an array or a literal string</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">An HTML dropdown select field tag</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Lets you create a standard drop-down field. The first parameter will
|
|
contain the name of the field, the second parameter will contain an
|
|
associative array of options, and the third parameter will contain the
|
|
value you wish to be selected. You can also pass an array of multiple
|
|
items through the third parameter, and CodeIgniter will create a
|
|
multiple select for you.</p>
|
|
<p>Example:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$options</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'small'</span> <span class="o">=></span> <span class="s1">'Small Shirt'</span><span class="p">,</span>
|
|
<span class="s1">'med'</span> <span class="o">=></span> <span class="s1">'Medium Shirt'</span><span class="p">,</span>
|
|
<span class="s1">'large'</span> <span class="o">=></span> <span class="s1">'Large Shirt'</span><span class="p">,</span>
|
|
<span class="s1">'xlarge'</span> <span class="o">=></span> <span class="s1">'Extra Large Shirt'</span><span class="p">,</span>
|
|
<span class="p">);</span>
|
|
|
|
<span class="nv">$shirts_on_sale</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span><span class="s1">'small'</span><span class="p">,</span> <span class="s1">'large'</span><span class="p">);</span>
|
|
<span class="k">echo</span> <span class="nx">form_dropdown</span><span class="p">(</span><span class="s1">'shirts'</span><span class="p">,</span> <span class="nv">$options</span><span class="p">,</span> <span class="s1">'large'</span><span class="p">);</span>
|
|
|
|
<span class="cm">/*</span>
|
|
<span class="cm"> Would produce:</span>
|
|
|
|
<span class="cm"> <select name="shirts"></span>
|
|
<span class="cm"> <option value="small">Small Shirt</option></span>
|
|
<span class="cm"> <option value="med">Medium Shirt</option></span>
|
|
<span class="cm"> <option value="large" selected="selected">Large Shirt</option></span>
|
|
<span class="cm"> <option value="xlarge">Extra Large Shirt</option></span>
|
|
<span class="cm"> </select></span>
|
|
<span class="cm">*/</span>
|
|
|
|
<span class="k">echo</span> <span class="nx">form_dropdown</span><span class="p">(</span><span class="s1">'shirts'</span><span class="p">,</span> <span class="nv">$options</span><span class="p">,</span> <span class="nv">$shirts_on_sale</span><span class="p">);</span>
|
|
|
|
<span class="cm">/*</span>
|
|
<span class="cm"> Would produce:</span>
|
|
|
|
<span class="cm"> <select name="shirts" multiple="multiple"></span>
|
|
<span class="cm"> <option value="small" selected="selected">Small Shirt</option></span>
|
|
<span class="cm"> <option value="med">Medium Shirt</option></span>
|
|
<span class="cm"> <option value="large" selected="selected">Large Shirt</option></span>
|
|
<span class="cm"> <option value="xlarge">Extra Large Shirt</option></span>
|
|
<span class="cm"> </select></span>
|
|
<span class="cm">*/</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>If you would like the opening <select> to contain additional data, like
|
|
an id attribute or JavaScript, you can pass it as a string in the fourth
|
|
parameter:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$js</span> <span class="o">=</span> <span class="s1">'id="shirts" onChange="some_function();"'</span><span class="p">;</span>
|
|
<span class="k">echo</span> <span class="nx">form_dropdown</span><span class="p">(</span><span class="s1">'shirts'</span><span class="p">,</span> <span class="nv">$options</span><span class="p">,</span> <span class="s1">'large'</span><span class="p">,</span> <span class="nv">$js</span><span class="p">);</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>Or you can pass it as an array:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$js</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'id'</span> <span class="o">=></span> <span class="s1">'shirts'</span><span class="p">,</span>
|
|
<span class="s1">'onChange'</span> <span class="o">=></span> <span class="s1">'some_function();'</span>
|
|
<span class="p">);</span>
|
|
<span class="k">echo</span> <span class="nx">form_dropdown</span><span class="p">(</span><span class="s1">'shirts'</span><span class="p">,</span> <span class="nv">$options</span><span class="p">,</span> <span class="s1">'large'</span><span class="p">,</span> <span class="nv">$js</span><span class="p">);</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>If the array passed as <tt class="docutils literal"><span class="pre">$options</span></tt> is a multidimensional array, then
|
|
<tt class="docutils literal"><span class="pre">form_dropdown()</span></tt> will produce an <optgroup> with the array key as the
|
|
label.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="function">
|
|
<dt id="form_multiselect">
|
|
<tt class="descname">form_multiselect</tt><big>(</big><span class="optional">[</span><em>$name = ''</em><span class="optional">[</span>, <em>$options = array()</em><span class="optional">[</span>, <em>$selected = array()</em><span class="optional">[</span>, <em>$extra = ''</em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#form_multiselect" 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">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
<li><strong>$name</strong> (<em>string</em>) – Field name</li>
|
|
<li><strong>$options</strong> (<em>array</em>) – An associative array of options to be listed</li>
|
|
<li><strong>$selected</strong> (<em>array</em>) – List of fields to mark with the <em>selected</em> attribute</li>
|
|
<li><strong>$extra</strong> (<em>mixed</em>) – Extra attributes to be added to the tag either as an array or a literal string</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">An HTML dropdown multiselect field tag</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Lets you create a standard multiselect field. The first parameter will
|
|
contain the name of the field, the second parameter will contain an
|
|
associative array of options, and the third parameter will contain the
|
|
value or values you wish to be selected.</p>
|
|
<p>The parameter usage is identical to using <a class="reference internal" href="#form_dropdown" title="form_dropdown"><tt class="xref php php-func docutils literal"><span class="pre">form_dropdown()</span></tt></a> above,
|
|
except of course that the name of the field will need to use POST array
|
|
syntax, e.g. foo[].</p>
|
|
</dd></dl>
|
|
|
|
<dl class="function">
|
|
<dt id="form_fieldset">
|
|
<tt class="descname">form_fieldset</tt><big>(</big><span class="optional">[</span><em>$legend_text = ''</em><span class="optional">[</span>, <em>$attributes = array()</em><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#form_fieldset" 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">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
<li><strong>$legend_text</strong> (<em>string</em>) – Text to put in the <legend> tag</li>
|
|
<li><strong>$attributes</strong> (<em>array</em>) – Attributes to be set on the <fieldset> tag</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">An HTML fieldset opening tag</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Lets you generate fieldset/legend fields.</p>
|
|
<p>Example:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">echo</span> <span class="nx">form_fieldset</span><span class="p">(</span><span class="s1">'Address Information'</span><span class="p">);</span>
|
|
<span class="k">echo</span> <span class="s2">"<p>fieldset content here</p></span><span class="se">\n</span><span class="s2">"</span><span class="p">;</span>
|
|
<span class="k">echo</span> <span class="nx">form_fieldset_close</span><span class="p">();</span>
|
|
|
|
<span class="cm">/*</span>
|
|
<span class="cm"> Produces:</span>
|
|
|
|
<span class="cm"> <fieldset></span>
|
|
<span class="cm"> <legend>Address Information</legend></span>
|
|
<span class="cm"> <p>form content here</p></span>
|
|
<span class="cm"> </fieldset></span>
|
|
<span class="cm">*/</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>Similar to other functions, you can submit an associative array in the
|
|
second parameter if you prefer to set additional attributes:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$attributes</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'id'</span> <span class="o">=></span> <span class="s1">'address_info'</span><span class="p">,</span>
|
|
<span class="s1">'class'</span> <span class="o">=></span> <span class="s1">'address_info'</span>
|
|
<span class="p">);</span>
|
|
|
|
<span class="k">echo</span> <span class="nx">form_fieldset</span><span class="p">(</span><span class="s1">'Address Information'</span><span class="p">,</span> <span class="nv">$attributes</span><span class="p">);</span>
|
|
<span class="k">echo</span> <span class="s2">"<p>fieldset content here</p></span><span class="se">\n</span><span class="s2">"</span><span class="p">;</span>
|
|
<span class="k">echo</span> <span class="nx">form_fieldset_close</span><span class="p">();</span>
|
|
|
|
<span class="cm">/*</span>
|
|
<span class="cm"> Produces:</span>
|
|
|
|
<span class="cm"> <fieldset id="address_info" class="address_info"></span>
|
|
<span class="cm"> <legend>Address Information</legend></span>
|
|
<span class="cm"> <p>form content here</p></span>
|
|
<span class="cm"> </fieldset></span>
|
|
<span class="cm">*/</span>
|
|
</pre></div>
|
|
</div>
|
|
</dd></dl>
|
|
|
|
<dl class="function">
|
|
<dt id="form_fieldset_close">
|
|
<tt class="descname">form_fieldset_close</tt><big>(</big><span class="optional">[</span><em>$extra = ''</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#form_fieldset_close" 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">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
<li><strong>$extra</strong> (<em>string</em>) – Anything to append after the closing tag, <em>as is</em></li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">An HTML fieldset closing tag</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Produces a closing </fieldset> tag. The only advantage to using this
|
|
function is it permits you to pass data to it which will be added below
|
|
the tag. For example</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$string</span> <span class="o">=</span> <span class="s1">'</div></div>'</span><span class="p">;</span>
|
|
<span class="k">echo</span> <span class="nx">form_fieldset_close</span><span class="p">(</span><span class="nv">$string</span><span class="p">);</span>
|
|
<span class="c1">// Would produce: </fieldset></div></div></span>
|
|
</pre></div>
|
|
</div>
|
|
</dd></dl>
|
|
|
|
<dl class="function">
|
|
<dt id="form_checkbox">
|
|
<tt class="descname">form_checkbox</tt><big>(</big><span class="optional">[</span><em>$data = ''</em><span class="optional">[</span>, <em>$value = ''</em><span class="optional">[</span>, <em>$checked = FALSE</em><span class="optional">[</span>, <em>$extra = ''</em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#form_checkbox" 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">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
<li><strong>$data</strong> (<em>array</em>) – Field attributes data</li>
|
|
<li><strong>$value</strong> (<em>string</em>) – Field value</li>
|
|
<li><strong>$checked</strong> (<em>bool</em>) – Whether to mark the checkbox as being <em>checked</em></li>
|
|
<li><strong>$extra</strong> (<em>mixed</em>) – Extra attributes to be added to the tag either as an array or a literal string</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">An HTML checkbox input tag</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Lets you generate a checkbox field. Simple example:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">echo</span> <span class="nx">form_checkbox</span><span class="p">(</span><span class="s1">'newsletter'</span><span class="p">,</span> <span class="s1">'accept'</span><span class="p">,</span> <span class="k">TRUE</span><span class="p">);</span>
|
|
<span class="c1">// Would produce: <input type="checkbox" name="newsletter" value="accept" checked="checked" /></span>
|
|
</pre></div>
|
|
</div>
|
|
<p>The third parameter contains a boolean TRUE/FALSE to determine whether
|
|
the box should be checked or not.</p>
|
|
<p>Similar to the other form functions in this helper, you can also pass an
|
|
array of attributes to the function:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$data</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'newsletter'</span><span class="p">,</span>
|
|
<span class="s1">'id'</span> <span class="o">=></span> <span class="s1">'newsletter'</span><span class="p">,</span>
|
|
<span class="s1">'value'</span> <span class="o">=></span> <span class="s1">'accept'</span><span class="p">,</span>
|
|
<span class="s1">'checked'</span> <span class="o">=></span> <span class="k">TRUE</span><span class="p">,</span>
|
|
<span class="s1">'style'</span> <span class="o">=></span> <span class="s1">'margin:10px'</span>
|
|
<span class="p">);</span>
|
|
|
|
<span class="k">echo</span> <span class="nx">form_checkbox</span><span class="p">(</span><span class="nv">$data</span><span class="p">);</span>
|
|
<span class="c1">// Would produce: <input type="checkbox" name="newsletter" id="newsletter" value="accept" checked="checked" style="margin:10px" /></span>
|
|
</pre></div>
|
|
</div>
|
|
<p>Also as with other functions, if you would like the tag to contain
|
|
additional data like JavaScript, you can pass it as a string in the
|
|
fourth parameter:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$js</span> <span class="o">=</span> <span class="s1">'onClick="some_function()"'</span><span class="p">;</span>
|
|
<span class="k">echo</span> <span class="nx">form_checkbox</span><span class="p">(</span><span class="s1">'newsletter'</span><span class="p">,</span> <span class="s1">'accept'</span><span class="p">,</span> <span class="k">TRUE</span><span class="p">,</span> <span class="nv">$js</span><span class="p">);</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>Or you can pass it as an array:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$js</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span><span class="s1">'onClick'</span> <span class="o">=></span> <span class="s1">'some_function();'</span><span class="p">);</span>
|
|
<span class="k">echo</span> <span class="nx">form_checkbox</span><span class="p">(</span><span class="s1">'newsletter'</span><span class="p">,</span> <span class="s1">'accept'</span><span class="p">,</span> <span class="k">TRUE</span><span class="p">,</span> <span class="nv">$js</span><span class="p">);</span>
|
|
</pre></div>
|
|
</div>
|
|
</dd></dl>
|
|
|
|
<dl class="function">
|
|
<dt id="form_radio">
|
|
<tt class="descname">form_radio</tt><big>(</big><span class="optional">[</span><em>$data = ''</em><span class="optional">[</span>, <em>$value = ''</em><span class="optional">[</span>, <em>$checked = FALSE</em><span class="optional">[</span>, <em>$extra = ''</em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#form_radio" 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">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
<li><strong>$data</strong> (<em>array</em>) – Field attributes data</li>
|
|
<li><strong>$value</strong> (<em>string</em>) – Field value</li>
|
|
<li><strong>$checked</strong> (<em>bool</em>) – Whether to mark the radio button as being <em>checked</em></li>
|
|
<li><strong>$extra</strong> (<em>mixed</em>) – Extra attributes to be added to the tag either as an array or a literal string</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">An HTML radio input tag</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>This function is identical in all respects to the <a class="reference internal" href="#form_checkbox" title="form_checkbox"><tt class="xref php php-func docutils literal"><span class="pre">form_checkbox()</span></tt></a>
|
|
function above except that it uses the “radio” input type.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="function">
|
|
<dt id="form_label">
|
|
<tt class="descname">form_label</tt><big>(</big><span class="optional">[</span><em>$label_text = ''</em><span class="optional">[</span>, <em>$id = ''</em><span class="optional">[</span>, <em>$attributes = array()</em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#form_label" 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">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
<li><strong>$label_text</strong> (<em>string</em>) – Text to put in the <label> tag</li>
|
|
<li><strong>$id</strong> (<em>string</em>) – ID of the form element that we’re making a label for</li>
|
|
<li><strong>$attributes</strong> (<em>string</em>) – HTML attributes</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">An HTML field label tag</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Lets you generate a <label>. Simple example:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">echo</span> <span class="nx">form_label</span><span class="p">(</span><span class="s1">'What is your Name'</span><span class="p">,</span> <span class="s1">'username'</span><span class="p">);</span>
|
|
<span class="c1">// Would produce: <label for="username">What is your Name</label></span>
|
|
</pre></div>
|
|
</div>
|
|
<p>Similar to other functions, you can submit an associative array in the
|
|
third parameter if you prefer to set additional attributes.</p>
|
|
<p>Example:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$attributes</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'class'</span> <span class="o">=></span> <span class="s1">'mycustomclass'</span><span class="p">,</span>
|
|
<span class="s1">'style'</span> <span class="o">=></span> <span class="s1">'color: #000;'</span>
|
|
<span class="p">);</span>
|
|
|
|
<span class="k">echo</span> <span class="nx">form_label</span><span class="p">(</span><span class="s1">'What is your Name'</span><span class="p">,</span> <span class="s1">'username'</span><span class="p">,</span> <span class="nv">$attributes</span><span class="p">);</span>
|
|
<span class="c1">// Would produce: <label for="username" class="mycustomclass" style="color: #000;">What is your Name</label></span>
|
|
</pre></div>
|
|
</div>
|
|
</dd></dl>
|
|
|
|
<dl class="function">
|
|
<dt id="form_submit">
|
|
<tt class="descname">form_submit</tt><big>(</big><span class="optional">[</span><em>$data = ''</em><span class="optional">[</span>, <em>$value = ''</em><span class="optional">[</span>, <em>$extra = ''</em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#form_submit" 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">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
<li><strong>$data</strong> (<em>string</em>) – Button name</li>
|
|
<li><strong>$value</strong> (<em>string</em>) – Button value</li>
|
|
<li><strong>$extra</strong> (<em>mixed</em>) – Extra attributes to be added to the tag either as an array or a literal string</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">An HTML input submit tag</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Lets you generate a standard submit button. Simple example:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">echo</span> <span class="nx">form_submit</span><span class="p">(</span><span class="s1">'mysubmit'</span><span class="p">,</span> <span class="s1">'Submit Post!'</span><span class="p">);</span>
|
|
<span class="c1">// Would produce: <input type="submit" name="mysubmit" value="Submit Post!" /></span>
|
|
</pre></div>
|
|
</div>
|
|
<p>Similar to other functions, you can submit an associative array in the
|
|
first parameter if you prefer to set your own attributes. The third
|
|
parameter lets you add extra data to your form, like JavaScript.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="function">
|
|
<dt id="form_reset">
|
|
<tt class="descname">form_reset</tt><big>(</big><span class="optional">[</span><em>$data = ''</em><span class="optional">[</span>, <em>$value = ''</em><span class="optional">[</span>, <em>$extra = ''</em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#form_reset" 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">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
<li><strong>$data</strong> (<em>string</em>) – Button name</li>
|
|
<li><strong>$value</strong> (<em>string</em>) – Button value</li>
|
|
<li><strong>$extra</strong> (<em>mixed</em>) – Extra attributes to be added to the tag either as an array or a literal string</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">An HTML input reset button tag</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Lets you generate a standard reset button. Use is identical to
|
|
<tt class="xref py py-func docutils literal"><span class="pre">form_submit()</span></tt>.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="function">
|
|
<dt id="form_button">
|
|
<tt class="descname">form_button</tt><big>(</big><span class="optional">[</span><em>$data = ''</em><span class="optional">[</span>, <em>$content = ''</em><span class="optional">[</span>, <em>$extra = ''</em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#form_button" 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">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
<li><strong>$data</strong> (<em>string</em>) – Button name</li>
|
|
<li><strong>$content</strong> (<em>string</em>) – Button label</li>
|
|
<li><strong>$extra</strong> (<em>mixed</em>) – Extra attributes to be added to the tag either as an array or a literal string</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">An HTML button tag</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Lets you generate a standard button element. You can minimally pass the
|
|
button name and content in the first and second parameter:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">echo</span> <span class="nx">form_button</span><span class="p">(</span><span class="s1">'name'</span><span class="p">,</span><span class="s1">'content'</span><span class="p">);</span>
|
|
<span class="c1">// Would produce: <button name="name" type="button">Content</button></span>
|
|
</pre></div>
|
|
</div>
|
|
<p>Or you can pass an associative array containing any data you wish your
|
|
form to contain:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$data</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'button'</span><span class="p">,</span>
|
|
<span class="s1">'id'</span> <span class="o">=></span> <span class="s1">'button'</span><span class="p">,</span>
|
|
<span class="s1">'value'</span> <span class="o">=></span> <span class="s1">'true'</span><span class="p">,</span>
|
|
<span class="s1">'type'</span> <span class="o">=></span> <span class="s1">'reset'</span><span class="p">,</span>
|
|
<span class="s1">'content'</span> <span class="o">=></span> <span class="s1">'Reset'</span>
|
|
<span class="p">);</span>
|
|
|
|
<span class="k">echo</span> <span class="nx">form_button</span><span class="p">(</span><span class="nv">$data</span><span class="p">);</span>
|
|
<span class="c1">// Would produce: <button name="button" id="button" value="true" type="reset">Reset</button></span>
|
|
</pre></div>
|
|
</div>
|
|
<p>If you would like your form to contain some additional data, like
|
|
JavaScript, you can pass it as a string in the third parameter:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$js</span> <span class="o">=</span> <span class="s1">'onClick="some_function()"'</span><span class="p">;</span>
|
|
<span class="k">echo</span> <span class="nx">form_button</span><span class="p">(</span><span class="s1">'mybutton'</span><span class="p">,</span> <span class="s1">'Click Me'</span><span class="p">,</span> <span class="nv">$js</span><span class="p">);</span>
|
|
</pre></div>
|
|
</div>
|
|
</dd></dl>
|
|
|
|
<dl class="function">
|
|
<dt id="form_close">
|
|
<tt class="descname">form_close</tt><big>(</big><span class="optional">[</span><em>$extra = ''</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#form_close" 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">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
<li><strong>$extra</strong> (<em>string</em>) – Anything to append after the closing tag, <em>as is</em></li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">An HTML form closing tag</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Produces a closing </form> tag. The only advantage to using this
|
|
function is it permits you to pass data to it which will be added below
|
|
the tag. For example:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$string</span> <span class="o">=</span> <span class="s1">'</div></div>'</span><span class="p">;</span>
|
|
<span class="k">echo</span> <span class="nx">form_close</span><span class="p">(</span><span class="nv">$string</span><span class="p">);</span>
|
|
<span class="c1">// Would produce: </form> </div></div></span>
|
|
</pre></div>
|
|
</div>
|
|
</dd></dl>
|
|
|
|
<dl class="function">
|
|
<dt id="set_value">
|
|
<tt class="descname">set_value</tt><big>(</big><em>$field</em><span class="optional">[</span>, <em>$default = ''</em><span class="optional">[</span>, <em>$html_escape = TRUE</em><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#set_value" 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">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
<li><strong>$field</strong> (<em>string</em>) – Field name</li>
|
|
<li><strong>$default</strong> (<em>string</em>) – Default value</li>
|
|
<li><strong>$html_escape</strong> (<em>bool</em>) – Whether to turn off HTML escaping of the value</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Field value</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Permits you to set the value of an input form or textarea. You must
|
|
supply the field name via the first parameter of the function. The
|
|
second (optional) parameter allows you to set a default value for the
|
|
form. The third (optional) parameter allows you to turn off HTML escaping
|
|
of the value, in case you need to use this function in combination with
|
|
i.e. <a class="reference internal" href="#form_input" title="form_input"><tt class="xref php php-func docutils literal"><span class="pre">form_input()</span></tt></a> and avoid double-escaping.</p>
|
|
<p>Example:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="o"><</span><span class="nx">input</span> <span class="nx">type</span><span class="o">=</span><span class="s2">"text"</span> <span class="nx">name</span><span class="o">=</span><span class="s2">"quantity"</span> <span class="nx">value</span><span class="o">=</span><span class="s2">"<?php echo set_value('quantity', '0'); ?>"</span> <span class="nx">size</span><span class="o">=</span><span class="s2">"50"</span> <span class="o">/></span>
|
|
</pre></div>
|
|
</div>
|
|
<p>The above form will show “0” when loaded for the first time.</p>
|
|
<div class="admonition note">
|
|
<p class="first admonition-title">Note</p>
|
|
<p class="last">If you’ve loaded the <a class="reference internal" href="../libraries/form_validation.html"><em>Form Validation Library</em></a> and
|
|
have set a validation rule for the field name in use with this helper, then it will
|
|
forward the call to the <a class="reference internal" href="../libraries/form_validation.html"><em>Form Validation Library</em></a>‘s
|
|
own <tt class="docutils literal"><span class="pre">set_value()</span></tt> method. Otherwise, this function looks in <tt class="docutils literal"><span class="pre">$_POST</span></tt> for the
|
|
field value.</p>
|
|
</div>
|
|
</dd></dl>
|
|
|
|
<dl class="function">
|
|
<dt id="set_select">
|
|
<tt class="descname">set_select</tt><big>(</big><em>$field</em><span class="optional">[</span>, <em>$value = ''</em><span class="optional">[</span>, <em>$default = FALSE</em><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#set_select" 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">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
<li><strong>$field</strong> (<em>string</em>) – Field name</li>
|
|
<li><strong>$value</strong> (<em>string</em>) – Value to check for</li>
|
|
<li><strong>$default</strong> (<em>string</em>) – Whether the value is also a default one</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">‘selected’ attribute or an empty string</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>If you use a <select> menu, this function permits you to display the
|
|
menu item that was selected.</p>
|
|
<p>The first parameter must contain the name of the select menu, the second
|
|
parameter must contain the value of each item, and the third (optional)
|
|
parameter lets you set an item as the default (use boolean TRUE/FALSE).</p>
|
|
<p>Example:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="o"><</span><span class="nx">select</span> <span class="nx">name</span><span class="o">=</span><span class="s2">"myselect"</span><span class="o">></span>
|
|
<span class="o"><</span><span class="nx">option</span> <span class="nx">value</span><span class="o">=</span><span class="s2">"one"</span> <span class="o"><?</span><span class="nx">php</span> <span class="k">echo</span> <span class="nx">set_select</span><span class="p">(</span><span class="s1">'myselect'</span><span class="p">,</span> <span class="s1">'one'</span><span class="p">,</span> <span class="k">TRUE</span><span class="p">);</span> <span class="cp">?></span> >One<span class="p"></</span><span class="nt">option</span><span class="p">></span>
|
|
<span class="p"><</span><span class="nt">option</span> <span class="na">value</span><span class="o">=</span><span class="s">"two"</span> <span class="cp"><?php</span> <span class="k">echo</span> <span class="nx">set_select</span><span class="p">(</span><span class="s1">'myselect'</span><span class="p">,</span> <span class="s1">'two'</span><span class="p">);</span> <span class="cp">?></span> <span class="p">></span>Two<span class="p"></</span><span class="nt">option</span><span class="p">></span>
|
|
<span class="p"><</span><span class="nt">option</span> <span class="na">value</span><span class="o">=</span><span class="s">"three"</span> <span class="cp"><?php</span> <span class="k">echo</span> <span class="nx">set_select</span><span class="p">(</span><span class="s1">'myselect'</span><span class="p">,</span> <span class="s1">'three'</span><span class="p">);</span> <span class="cp">?></span> <span class="p">></span>Three<span class="p"></</span><span class="nt">option</span><span class="p">></span>
|
|
<span class="p"></</span><span class="nt">select</span><span class="p">></span>
|
|
</pre></div>
|
|
</div>
|
|
</dd></dl>
|
|
|
|
<dl class="function">
|
|
<dt id="set_checkbox">
|
|
<tt class="descname">set_checkbox</tt><big>(</big><em>$field</em><span class="optional">[</span>, <em>$value = ''</em><span class="optional">[</span>, <em>$default = FALSE</em><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#set_checkbox" 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">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
<li><strong>$field</strong> (<em>string</em>) – Field name</li>
|
|
<li><strong>$value</strong> (<em>string</em>) – Value to check for</li>
|
|
<li><strong>$default</strong> (<em>string</em>) – Whether the value is also a default one</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">‘checked’ attribute or an empty string</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Permits you to display a checkbox in the state it was submitted.</p>
|
|
<p>The first parameter must contain the name of the checkbox, the second
|
|
parameter must contain its value, and the third (optional) parameter
|
|
lets you set an item as the default (use boolean TRUE/FALSE).</p>
|
|
<p>Example:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="o"><</span><span class="nx">input</span> <span class="nx">type</span><span class="o">=</span><span class="s2">"checkbox"</span> <span class="nx">name</span><span class="o">=</span><span class="s2">"mycheck"</span> <span class="nx">value</span><span class="o">=</span><span class="s2">"1"</span> <span class="o"><?</span><span class="nx">php</span> <span class="k">echo</span> <span class="nx">set_checkbox</span><span class="p">(</span><span class="s1">'mycheck'</span><span class="p">,</span> <span class="s1">'1'</span><span class="p">);</span> <span class="cp">?></span> />
|
|
<span class="p"><</span><span class="nt">input</span> <span class="na">type</span><span class="o">=</span><span class="s">"checkbox"</span> <span class="na">name</span><span class="o">=</span><span class="s">"mycheck"</span> <span class="na">value</span><span class="o">=</span><span class="s">"2"</span> <span class="cp"><?php</span> <span class="k">echo</span> <span class="nx">set_checkbox</span><span class="p">(</span><span class="s1">'mycheck'</span><span class="p">,</span> <span class="s1">'2'</span><span class="p">);</span> <span class="cp">?></span> <span class="p">/></span>
|
|
</pre></div>
|
|
</div>
|
|
</dd></dl>
|
|
|
|
<dl class="function">
|
|
<dt id="set_radio">
|
|
<tt class="descname">set_radio</tt><big>(</big><em>$field</em><span class="optional">[</span>, <em>$value = ''</em><span class="optional">[</span>, <em>$default = FALSE</em><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#set_radio" 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">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
<li><strong>$field</strong> (<em>string</em>) – Field name</li>
|
|
<li><strong>$value</strong> (<em>string</em>) – Value to check for</li>
|
|
<li><strong>$default</strong> (<em>string</em>) – Whether the value is also a default one</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">‘checked’ attribute or an empty string</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Permits you to display radio buttons in the state they were submitted.
|
|
This function is identical to the <a class="reference internal" href="#set_checkbox" title="set_checkbox"><tt class="xref php php-func docutils literal"><span class="pre">set_checkbox()</span></tt></a> function above.</p>
|
|
<p>Example:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="o"><</span><span class="nx">input</span> <span class="nx">type</span><span class="o">=</span><span class="s2">"radio"</span> <span class="nx">name</span><span class="o">=</span><span class="s2">"myradio"</span> <span class="nx">value</span><span class="o">=</span><span class="s2">"1"</span> <span class="o"><?</span><span class="nx">php</span> <span class="k">echo</span> <span class="nx">set_radio</span><span class="p">(</span><span class="s1">'myradio'</span><span class="p">,</span> <span class="s1">'1'</span><span class="p">,</span> <span class="k">TRUE</span><span class="p">);</span> <span class="cp">?></span> />
|
|
<span class="p"><</span><span class="nt">input</span> <span class="na">type</span><span class="o">=</span><span class="s">"radio"</span> <span class="na">name</span><span class="o">=</span><span class="s">"myradio"</span> <span class="na">value</span><span class="o">=</span><span class="s">"2"</span> <span class="cp"><?php</span> <span class="k">echo</span> <span class="nx">set_radio</span><span class="p">(</span><span class="s1">'myradio'</span><span class="p">,</span> <span class="s1">'2'</span><span class="p">);</span> <span class="cp">?></span> <span class="p">/></span>
|
|
</pre></div>
|
|
</div>
|
|
<div class="admonition note">
|
|
<p class="first admonition-title">Note</p>
|
|
<p class="last">If you are using the Form Validation class, you must always specify
|
|
a rule for your field, even if empty, in order for the <tt class="docutils literal"><span class="pre">set_*()</span></tt>
|
|
functions to work. This is because if a Form Validation object is
|
|
defined, the control for <tt class="docutils literal"><span class="pre">set_*()</span></tt> is handed over to a method of the
|
|
class instead of the generic helper function.</p>
|
|
</div>
|
|
</dd></dl>
|
|
|
|
<dl class="function">
|
|
<dt id="form_error">
|
|
<tt class="descname">form_error</tt><big>(</big><span class="optional">[</span><em>$field = ''</em><span class="optional">[</span>, <em>$prefix = ''</em><span class="optional">[</span>, <em>$suffix = ''</em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#form_error" 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">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
<li><strong>$field</strong> (<em>string</em>) – Field name</li>
|
|
<li><strong>$prefix</strong> (<em>string</em>) – Error opening tag</li>
|
|
<li><strong>$suffix</strong> (<em>string</em>) – Error closing tag</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">HTML-formatted form validation error message(s)</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Returns a validation error message from the <a class="reference internal" href="../libraries/form_validation.html"><em>Form Validation Library</em></a>, associated with the specified field name.
|
|
You can optionally specify opening and closing tag(s) to put around the error
|
|
message.</p>
|
|
<p>Example:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="c1">// Assuming that the 'username' field value was incorrect:</span>
|
|
<span class="k">echo</span> <span class="nx">form_error</span><span class="p">(</span><span class="s1">'myfield'</span><span class="p">,</span> <span class="s1">'<div class="error">'</span><span class="p">,</span> <span class="s1">'</div>'</span><span class="p">);</span>
|
|
|
|
<span class="c1">// Would produce: <div class="error">Error message associated with the "username" field.</div></span>
|
|
</pre></div>
|
|
</div>
|
|
</dd></dl>
|
|
|
|
<dl class="function">
|
|
<dt id="validation_errors">
|
|
<tt class="descname">validation_errors</tt><big>(</big><span class="optional">[</span><em>$prefix = ''</em><span class="optional">[</span>, <em>$suffix = ''</em><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#validation_errors" 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">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
<li><strong>$prefix</strong> (<em>string</em>) – Error opening tag</li>
|
|
<li><strong>$suffix</strong> (<em>string</em>) – Error closing tag</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">HTML-formatted form validation error message(s)</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Similarly to the <a class="reference internal" href="#form_error" title="form_error"><tt class="xref php php-func docutils literal"><span class="pre">form_error()</span></tt></a> function, returns all validation
|
|
error messages produced by the <a class="reference internal" href="../libraries/form_validation.html"><em>Form Validation Library</em></a>, with optional opening and closing tags
|
|
around each of the messages.</p>
|
|
<p>Example:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">echo</span> <span class="nx">validation_errors</span><span class="p">(</span><span class="s1">'<span class="error">'</span><span class="p">,</span> <span class="s1">'</span>'</span><span class="p">);</span>
|
|
|
|
<span class="cm">/*</span>
|
|
<span class="cm"> Would produce, e.g.:</span>
|
|
|
|
<span class="cm"> <span class="error">The "email" field doesn't contain a valid e-mail address!</span></span>
|
|
<span class="cm"> <span class="error">The "password" field doesn't match the "repeat_password" field!</span></span>
|
|
|
|
<span class="cm"> */</span>
|
|
</pre></div>
|
|
</div>
|
|
</dd></dl>
|
|
|
|
<dl class="function">
|
|
<dt id="form_prep">
|
|
<tt class="descname">form_prep</tt><big>(</big><em>$str</em><big>)</big><a class="headerlink" href="#form_prep" 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">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
<li><strong>$str</strong> (<em>string</em>) – Value to escape</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Escaped value</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Allows you to safely use HTML and characters such as quotes within form
|
|
elements without breaking out of the form.</p>
|
|
<div class="admonition note">
|
|
<p class="first admonition-title">Note</p>
|
|
<p class="last">If you use any of the form helper functions listed in this page the form
|
|
values will be prepped automatically, so there is no need to call this
|
|
function. Use it only if you are creating your own form elements.</p>
|
|
</div>
|
|
<div class="admonition note">
|
|
<p class="first admonition-title">Note</p>
|
|
<p class="last">This function is DEPRECATED and is just an alias for
|
|
<a class="reference internal" href="../general/common_functions.html"><em>common function</em></a>
|
|
<tt class="xref py py-func docutils literal"><span class="pre">html_escape()</span></tt> - please use that instead.</p>
|
|
</div>
|
|
</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
<footer>
|
|
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|
|
|
<a href="html_helper.html" class="btn btn-neutral float-right" title="HTML Helper">Next <span class="fa fa-arrow-circle-right"></span></a>
|
|
|
|
|
|
<a href="file_helper.html" class="btn btn-neutral" title="File Helper"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
|
|
|
</div>
|
|
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>
|
|
© Copyright 2014 - 2017, British Columbia Institute of Technology.
|
|
Last updated on Mar 20, 2017.
|
|
</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.4',
|
|
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> |