diff options
Diffstat (limited to 'user_guide/helpers/html_helper.html')
| -rw-r--r-- | user_guide/helpers/html_helper.html | 1092 |
1 files changed, 1092 insertions, 0 deletions
diff --git a/user_guide/helpers/html_helper.html b/user_guide/helpers/html_helper.html new file mode 100644 index 000000000..3782e8341 --- /dev/null +++ b/user_guide/helpers/html_helper.html @@ -0,0 +1,1092 @@ + + +<!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>HTML Helper — CodeIgniter 3.1.5 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.5 documentation" href="../index.html"/> + <link rel="up" title="Helpers" href="index.html"/> + <link rel="next" title="Inflector Helper" href="inflector_helper.html"/> + <link rel="prev" title="Form Helper" href="form_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"><a class="reference internal" href="form_helper.html">Form Helper</a></li> +<li class="toctree-l2 current"><a class="current reference internal" href="">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"><a class="reference internal" href="form_helper.html">Form Helper</a></li> +<li class="toctree-l2 current"><a class="current reference internal" href="">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>HTML 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="html-helper"> +<h1>HTML Helper<a class="headerlink" href="#html-helper" title="Permalink to this headline">¶</a></h1> +<p>The HTML Helper file contains functions that assist in working with +HTML.</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="#available-functions" id="id2">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">'html'</span><span class="p">);</span> +</pre></div> +</div> +</div> +<div class="section" id="available-functions"> +<h2><a class="toc-backref" href="#id2">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="heading"> +<tt class="descname">heading</tt><big>(</big><span class="optional">[</span><em>$data = ''</em><span class="optional">[</span>, <em>$h = '1'</em><span class="optional">[</span>, <em>$attributes = ''</em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#heading" 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>) – Content</li> +<li><strong>$h</strong> (<em>string</em>) – Heading level</li> +<li><strong>$attributes</strong> (<em>mixed</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">HTML heading 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 HTML heading tags. The first parameter will contain the +data, the second the size of the heading. Example:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">echo</span> <span class="nx">heading</span><span class="p">(</span><span class="s1">'Welcome!'</span><span class="p">,</span> <span class="mi">3</span><span class="p">);</span> +</pre></div> +</div> +<p>The above would produce: <h3>Welcome!</h3></p> +<p>Additionally, in order to add attributes to the heading tag such as HTML +classes, ids or inline styles, a third parameter accepts either a string +or an array:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">echo</span> <span class="nx">heading</span><span class="p">(</span><span class="s1">'Welcome!'</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="s1">'class="pink"'</span><span class="p">);</span> +<span class="k">echo</span> <span class="nx">heading</span><span class="p">(</span><span class="s1">'How are you?'</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="k">array</span><span class="p">(</span><span class="s1">'id'</span> <span class="o">=></span> <span class="s1">'question'</span><span class="p">,</span> <span class="s1">'class'</span> <span class="o">=></span> <span class="s1">'green'</span><span class="p">));</span> +</pre></div> +</div> +<p>The above code produces:</p> +<div class="highlight-html"><div class="highlight"><pre><span></span><span class="p"><</span><span class="nt">h3</span> <span class="na">class</span><span class="o">=</span><span class="s">"pink"</span><span class="p">></span>Welcome!<span class="p"><</span><span class="nt">h3</span><span class="p">></span> +<span class="p"><</span><span class="nt">h4</span> <span class="na">id</span><span class="o">=</span><span class="s">"question"</span> <span class="na">class</span><span class="o">=</span><span class="s">"green"</span><span class="p">></span>How are you?<span class="p"></</span><span class="nt">h4</span><span class="p">></span> +</pre></div> +</div> +</dd></dl> + +<dl class="function"> +<dt id="img"> +<tt class="descname">img</tt><big>(</big><span class="optional">[</span><em>$src = ''</em><span class="optional">[</span>, <em>$index_page = FALSE</em><span class="optional">[</span>, <em>$attributes = ''</em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#img" 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>$src</strong> (<em>string</em>) – Image source data</li> +<li><strong>$index_page</strong> (<em>bool</em>) – Whether to treat $src as a routed URI string</li> +<li><strong>$attributes</strong> (<em>array</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">HTML image 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 HTML <img /> tags. The first parameter contains the +image source. Example:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">echo</span> <span class="nx">img</span><span class="p">(</span><span class="s1">'images/picture.jpg'</span><span class="p">);</span> <span class="c1">// gives <img src="http://site.com/images/picture.jpg" /></span> +</pre></div> +</div> +<p>There is an optional second parameter that is a TRUE/FALSE value that +specifics if the <em>src</em> should have the page specified by +<tt class="docutils literal"><span class="pre">$config['index_page']</span></tt> added to the address it creates. +Presumably, this would be if you were using a media controller:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">echo</span> <span class="nx">img</span><span class="p">(</span><span class="s1">'images/picture.jpg'</span><span class="p">,</span> <span class="k">TRUE</span><span class="p">);</span> <span class="c1">// gives <img src="http://site.com/index.php/images/picture.jpg" alt="" /></span> +</pre></div> +</div> +<p>Additionally, an associative array can be passed to the <tt class="docutils literal"><span class="pre">img()</span></tt> function +for complete control over all attributes and values. If an <em>alt</em> attribute +is not provided, CodeIgniter will generate an empty string.</p> +<p>Example:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$image_properties</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span> + <span class="s1">'src'</span> <span class="o">=></span> <span class="s1">'images/picture.jpg'</span><span class="p">,</span> + <span class="s1">'alt'</span> <span class="o">=></span> <span class="s1">'Me, demonstrating how to eat 4 slices of pizza at one time'</span><span class="p">,</span> + <span class="s1">'class'</span> <span class="o">=></span> <span class="s1">'post_images'</span><span class="p">,</span> + <span class="s1">'width'</span> <span class="o">=></span> <span class="s1">'200'</span><span class="p">,</span> + <span class="s1">'height'</span><span class="o">=></span> <span class="s1">'200'</span><span class="p">,</span> + <span class="s1">'title'</span> <span class="o">=></span> <span class="s1">'That was quite a night'</span><span class="p">,</span> + <span class="s1">'rel'</span> <span class="o">=></span> <span class="s1">'lightbox'</span> +<span class="p">);</span> + +<span class="nx">img</span><span class="p">(</span><span class="nv">$image_properties</span><span class="p">);</span> +<span class="c1">// <img src="http://site.com/index.php/images/picture.jpg" alt="Me, demonstrating how to eat 4 slices of pizza at one time" class="post_images" width="200" height="200" title="That was quite a night" rel="lightbox" /></span> +</pre></div> +</div> +</dd></dl> + +<dl class="function"> +<dt id="link_tag"> +<tt class="descname">link_tag</tt><big>(</big><span class="optional">[</span><em>$href = ''</em><span class="optional">[</span>, <em>$rel = 'stylesheet'</em><span class="optional">[</span>, <em>$type = 'text/css'</em><span class="optional">[</span>, <em>$title = ''</em><span class="optional">[</span>, <em>$media = ''</em><span class="optional">[</span>, <em>$index_page = FALSE</em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#link_tag" 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>$href</strong> (<em>string</em>) – What are we linking to</li> +<li><strong>$rel</strong> (<em>string</em>) – Relation type</li> +<li><strong>$type</strong> (<em>string</em>) – Type of the related document</li> +<li><strong>$title</strong> (<em>string</em>) – Link title</li> +<li><strong>$media</strong> (<em>string</em>) – Media type</li> +<li><strong>$index_page</strong> (<em>bool</em>) – Whether to treat $src as a routed URI string</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">HTML link 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 HTML <link /> tags. This is useful for stylesheet links, +as well as other links. The parameters are <em>href</em>, with optional <em>rel</em>, +<em>type</em>, <em>title</em>, <em>media</em> and <em>index_page</em>.</p> +<p><em>index_page</em> is a boolean value that specifies if the <em>href</em> should have +the page specified by <tt class="docutils literal"><span class="pre">$config['index_page']</span></tt> added to the address it creates.</p> +<p>Example:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">echo</span> <span class="nx">link_tag</span><span class="p">(</span><span class="s1">'css/mystyles.css'</span><span class="p">);</span> +<span class="c1">// gives <link href="http://site.com/css/mystyles.css" rel="stylesheet" type="text/css" /></span> +</pre></div> +</div> +<p>Further examples:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">echo</span> <span class="nx">link_tag</span><span class="p">(</span><span class="s1">'favicon.ico'</span><span class="p">,</span> <span class="s1">'shortcut icon'</span><span class="p">,</span> <span class="s1">'image/ico'</span><span class="p">);</span> +<span class="c1">// <link href="http://site.com/favicon.ico" rel="shortcut icon" type="image/ico" /></span> + +<span class="k">echo</span> <span class="nx">link_tag</span><span class="p">(</span><span class="s1">'feed'</span><span class="p">,</span> <span class="s1">'alternate'</span><span class="p">,</span> <span class="s1">'application/rss+xml'</span><span class="p">,</span> <span class="s1">'My RSS Feed'</span><span class="p">);</span> +<span class="c1">// <link href="http://site.com/feed" rel="alternate" type="application/rss+xml" title="My RSS Feed" /></span> +</pre></div> +</div> +<p>Additionally, an associative array can be passed to the <tt class="docutils literal"><span class="pre">link()</span></tt> function +for complete control over all attributes and values:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$link</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span> + <span class="s1">'href'</span> <span class="o">=></span> <span class="s1">'css/printer.css'</span><span class="p">,</span> + <span class="s1">'rel'</span> <span class="o">=></span> <span class="s1">'stylesheet'</span><span class="p">,</span> + <span class="s1">'type'</span> <span class="o">=></span> <span class="s1">'text/css'</span><span class="p">,</span> + <span class="s1">'media'</span> <span class="o">=></span> <span class="s1">'print'</span> +<span class="p">);</span> + +<span class="k">echo</span> <span class="nx">link_tag</span><span class="p">(</span><span class="nv">$link</span><span class="p">);</span> +<span class="c1">// <link href="http://site.com/css/printer.css" rel="stylesheet" type="text/css" media="print" /></span> +</pre></div> +</div> +</dd></dl> + +<dl class="function"> +<dt id="ul"> +<tt class="descname">ul</tt><big>(</big><em>$list</em><span class="optional">[</span>, <em>$attributes = ''</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#ul" 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>$list</strong> (<em>array</em>) – List entries</li> +<li><strong>$attributes</strong> (<em>array</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">HTML-formatted unordered list</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 generate unordered HTML lists from simple or +multi-dimensional arrays. Example:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$list</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span> + <span class="s1">'red'</span><span class="p">,</span> + <span class="s1">'blue'</span><span class="p">,</span> + <span class="s1">'green'</span><span class="p">,</span> + <span class="s1">'yellow'</span> +<span class="p">);</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">'boldlist'</span><span class="p">,</span> + <span class="s1">'id'</span> <span class="o">=></span> <span class="s1">'mylist'</span> +<span class="p">);</span> + +<span class="k">echo</span> <span class="nx">ul</span><span class="p">(</span><span class="nv">$list</span><span class="p">,</span> <span class="nv">$attributes</span><span class="p">);</span> +</pre></div> +</div> +<p>The above code will produce this:</p> +<div class="highlight-html"><div class="highlight"><pre><span></span><span class="p"><</span><span class="nt">ul</span> <span class="na">class</span><span class="o">=</span><span class="s">"boldlist"</span> <span class="na">id</span><span class="o">=</span><span class="s">"mylist"</span><span class="p">></span> + <span class="p"><</span><span class="nt">li</span><span class="p">></span>red<span class="p"></</span><span class="nt">li</span><span class="p">></span> + <span class="p"><</span><span class="nt">li</span><span class="p">></span>blue<span class="p"></</span><span class="nt">li</span><span class="p">></span> + <span class="p"><</span><span class="nt">li</span><span class="p">></span>green<span class="p"></</span><span class="nt">li</span><span class="p">></span> + <span class="p"><</span><span class="nt">li</span><span class="p">></span>yellow<span class="p"></</span><span class="nt">li</span><span class="p">></span> +<span class="p"></</span><span class="nt">ul</span><span class="p">></span> +</pre></div> +</div> +<p>Here is a more complex example, using a multi-dimensional array:</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">'boldlist'</span><span class="p">,</span> + <span class="s1">'id'</span> <span class="o">=></span> <span class="s1">'mylist'</span> +<span class="p">);</span> + +<span class="nv">$list</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span> + <span class="s1">'colors'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span> + <span class="s1">'red'</span><span class="p">,</span> + <span class="s1">'blue'</span><span class="p">,</span> + <span class="s1">'green'</span> + <span class="p">),</span> + <span class="s1">'shapes'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span> + <span class="s1">'round'</span><span class="p">,</span> + <span class="s1">'square'</span><span class="p">,</span> + <span class="s1">'circles'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span> + <span class="s1">'ellipse'</span><span class="p">,</span> + <span class="s1">'oval'</span><span class="p">,</span> + <span class="s1">'sphere'</span> + <span class="p">)</span> + <span class="p">),</span> + <span class="s1">'moods'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span> + <span class="s1">'happy'</span><span class="p">,</span> + <span class="s1">'upset'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span> + <span class="s1">'defeated'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span> + <span class="s1">'dejected'</span><span class="p">,</span> + <span class="s1">'disheartened'</span><span class="p">,</span> + <span class="s1">'depressed'</span> + <span class="p">),</span> + <span class="s1">'annoyed'</span><span class="p">,</span> + <span class="s1">'cross'</span><span class="p">,</span> + <span class="s1">'angry'</span> + <span class="p">)</span> + <span class="p">)</span> +<span class="p">);</span> + +<span class="k">echo</span> <span class="nx">ul</span><span class="p">(</span><span class="nv">$list</span><span class="p">,</span> <span class="nv">$attributes</span><span class="p">);</span> +</pre></div> +</div> +<p>The above code will produce this:</p> +<div class="highlight-html"><div class="highlight"><pre><span></span><span class="p"><</span><span class="nt">ul</span> <span class="na">class</span><span class="o">=</span><span class="s">"boldlist"</span> <span class="na">id</span><span class="o">=</span><span class="s">"mylist"</span><span class="p">></span> + <span class="p"><</span><span class="nt">li</span><span class="p">></span>colors + <span class="p"><</span><span class="nt">ul</span><span class="p">></span> + <span class="p"><</span><span class="nt">li</span><span class="p">></span>red<span class="p"></</span><span class="nt">li</span><span class="p">></span> + <span class="p"><</span><span class="nt">li</span><span class="p">></span>blue<span class="p"></</span><span class="nt">li</span><span class="p">></span> + <span class="p"><</span><span class="nt">li</span><span class="p">></span>green<span class="p"></</span><span class="nt">li</span><span class="p">></span> + <span class="p"></</span><span class="nt">ul</span><span class="p">></span> + <span class="p"></</span><span class="nt">li</span><span class="p">></span> + <span class="p"><</span><span class="nt">li</span><span class="p">></span>shapes + <span class="p"><</span><span class="nt">ul</span><span class="p">></span> + <span class="p"><</span><span class="nt">li</span><span class="p">></span>round<span class="p"></</span><span class="nt">li</span><span class="p">></span> + <span class="p"><</span><span class="nt">li</span><span class="p">></span>suare<span class="p"></</span><span class="nt">li</span><span class="p">></span> + <span class="p"><</span><span class="nt">li</span><span class="p">></span>circles + <span class="p"><</span><span class="nt">ul</span><span class="p">></span> + <span class="p"><</span><span class="nt">li</span><span class="p">></span>elipse<span class="p"></</span><span class="nt">li</span><span class="p">></span> + <span class="p"><</span><span class="nt">li</span><span class="p">></span>oval<span class="p"></</span><span class="nt">li</span><span class="p">></span> + <span class="p"><</span><span class="nt">li</span><span class="p">></span>sphere<span class="p"></</span><span class="nt">li</span><span class="p">></span> + <span class="p"></</span><span class="nt">ul</span><span class="p">></span> + <span class="p"></</span><span class="nt">li</span><span class="p">></span> + <span class="p"></</span><span class="nt">ul</span><span class="p">></span> + <span class="p"></</span><span class="nt">li</span><span class="p">></span> + <span class="p"><</span><span class="nt">li</span><span class="p">></span>moods + <span class="p"><</span><span class="nt">ul</span><span class="p">></span> + <span class="p"><</span><span class="nt">li</span><span class="p">></span>happy<span class="p"></</span><span class="nt">li</span><span class="p">></span> + <span class="p"><</span><span class="nt">li</span><span class="p">></span>upset + <span class="p"><</span><span class="nt">ul</span><span class="p">></span> + <span class="p"><</span><span class="nt">li</span><span class="p">></span>defeated + <span class="p"><</span><span class="nt">ul</span><span class="p">></span> + <span class="p"><</span><span class="nt">li</span><span class="p">></span>dejected<span class="p"></</span><span class="nt">li</span><span class="p">></span> + <span class="p"><</span><span class="nt">li</span><span class="p">></span>disheartened<span class="p"></</span><span class="nt">li</span><span class="p">></span> + <span class="p"><</span><span class="nt">li</span><span class="p">></span>depressed<span class="p"></</span><span class="nt">li</span><span class="p">></span> + <span class="p"></</span><span class="nt">ul</span><span class="p">></span> + <span class="p"></</span><span class="nt">li</span><span class="p">></span> + <span class="p"><</span><span class="nt">li</span><span class="p">></span>annoyed<span class="p"></</span><span class="nt">li</span><span class="p">></span> + <span class="p"><</span><span class="nt">li</span><span class="p">></span>cross<span class="p"></</span><span class="nt">li</span><span class="p">></span> + <span class="p"><</span><span class="nt">li</span><span class="p">></span>angry<span class="p"></</span><span class="nt">li</span><span class="p">></span> + <span class="p"></</span><span class="nt">ul</span><span class="p">></span> + <span class="p"></</span><span class="nt">li</span><span class="p">></span> + <span class="p"></</span><span class="nt">ul</span><span class="p">></span> + <span class="p"></</span><span class="nt">li</span><span class="p">></span> +<span class="p"></</span><span class="nt">ul</span><span class="p">></span> +</pre></div> +</div> +</dd></dl> + +<dl class="function"> +<dt id="ol"> +<tt class="descname">ol</tt><big>(</big><em>$list</em>, <em>$attributes = ''</em><big>)</big><a class="headerlink" href="#ol" 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>$list</strong> (<em>array</em>) – List entries</li> +<li><strong>$attributes</strong> (<em>array</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">HTML-formatted ordered list</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>Identical to <a class="reference internal" href="#ul" title="ul"><tt class="xref php php-func docutils literal"><span class="pre">ul()</span></tt></a>, only it produces the <ol> tag for +ordered lists instead of <ul>.</p> +</dd></dl> + +<dl class="function"> +<dt id="meta"> +<tt class="descname">meta</tt><big>(</big><span class="optional">[</span><em>$name = ''</em><span class="optional">[</span>, <em>$content = ''</em><span class="optional">[</span>, <em>$type = 'name'</em><span class="optional">[</span>, <em>$newline = "n"</em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#meta" 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>) – Meta name</li> +<li><strong>$content</strong> (<em>string</em>) – Meta content</li> +<li><strong>$type</strong> (<em>string</em>) – Meta type</li> +<li><strong>$newline</strong> (<em>string</em>) – Newline character</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">HTML meta 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>Helps you generate meta tags. You can pass strings to the function, or +simple arrays, or multidimensional ones.</p> +<p>Examples:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">echo</span> <span class="nx">meta</span><span class="p">(</span><span class="s1">'description'</span><span class="p">,</span> <span class="s1">'My Great site'</span><span class="p">);</span> +<span class="c1">// Generates: <meta name="description" content="My Great Site" /></span> + +<span class="k">echo</span> <span class="nx">meta</span><span class="p">(</span><span class="s1">'Content-type'</span><span class="p">,</span> <span class="s1">'text/html; charset=utf-8'</span><span class="p">,</span> <span class="s1">'equiv'</span><span class="p">);</span> +<span class="c1">// Note the third parameter. Can be "equiv" or "name"</span> +<span class="c1">// Generates: <meta http-equiv="Content-type" content="text/html; charset=utf-8" /></span> + +<span class="k">echo</span> <span class="nx">meta</span><span class="p">(</span><span class="k">array</span><span class="p">(</span><span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'robots'</span><span class="p">,</span> <span class="s1">'content'</span> <span class="o">=></span> <span class="s1">'no-cache'</span><span class="p">));</span> +<span class="c1">// Generates: <meta name="robots" content="no-cache" /></span> + +<span class="nv">$meta</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span> + <span class="k">array</span><span class="p">(</span> + <span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'robots'</span><span class="p">,</span> + <span class="s1">'content'</span> <span class="o">=></span> <span class="s1">'no-cache'</span> + <span class="p">),</span> + <span class="k">array</span><span class="p">(</span> + <span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'description'</span><span class="p">,</span> + <span class="s1">'content'</span> <span class="o">=></span> <span class="s1">'My Great Site'</span> + <span class="p">),</span> + <span class="k">array</span><span class="p">(</span> + <span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'keywords'</span><span class="p">,</span> + <span class="s1">'content'</span> <span class="o">=></span> <span class="s1">'love, passion, intrigue, deception'</span> + <span class="p">),</span> + <span class="k">array</span><span class="p">(</span> + <span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'robots'</span><span class="p">,</span> + <span class="s1">'content'</span> <span class="o">=></span> <span class="s1">'no-cache'</span> + <span class="p">),</span> + <span class="k">array</span><span class="p">(</span> + <span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'Content-type'</span><span class="p">,</span> + <span class="s1">'content'</span> <span class="o">=></span> <span class="s1">'text/html; charset=utf-8'</span><span class="p">,</span> <span class="s1">'type'</span> <span class="o">=></span> <span class="s1">'equiv'</span> + <span class="p">)</span> +<span class="p">);</span> + +<span class="k">echo</span> <span class="nx">meta</span><span class="p">(</span><span class="nv">$meta</span><span class="p">);</span> +<span class="c1">// Generates:</span> +<span class="c1">// <meta name="robots" content="no-cache" /></span> +<span class="c1">// <meta name="description" content="My Great Site" /></span> +<span class="c1">// <meta name="keywords" content="love, passion, intrigue, deception" /></span> +<span class="c1">// <meta name="robots" content="no-cache" /></span> +<span class="c1">// <meta http-equiv="Content-type" content="text/html; charset=utf-8" /></span> +</pre></div> +</div> +</dd></dl> + +<dl class="function"> +<dt id="doctype"> +<tt class="descname">doctype</tt><big>(</big><span class="optional">[</span><em>$type = 'xhtml1-strict'</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#doctype" 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>$type</strong> (<em>string</em>) – Doctype name</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">HTML DocType 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>Helps you generate document type declarations, or DTD’s. XHTML 1.0 +Strict is used by default, but many doctypes are available.</p> +<p>Example:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">echo</span> <span class="nx">doctype</span><span class="p">();</span> <span class="c1">// <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"></span> + +<span class="k">echo</span> <span class="nx">doctype</span><span class="p">(</span><span class="s1">'html4-trans'</span><span class="p">);</span> <span class="c1">// <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"></span> +</pre></div> +</div> +<p>The following is a list of doctype choices. These are configurable, and +pulled from application/config/doctypes.php</p> +<table border="1" class="docutils"> +<colgroup> +<col width="16%" /> +<col width="10%" /> +<col width="74%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Document type</th> +<th class="head">Option</th> +<th class="head">Result</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td>XHTML 1.1</td> +<td>xhtml11</td> +<td><!DOCTYPE html PUBLIC “-//W3C//DTD XHTML 1.1//EN” “<a class="reference external" href="http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd</a>“></td> +</tr> +<tr class="row-odd"><td>XHTML 1.0 Strict</td> +<td>xhtml1-strict</td> +<td><!DOCTYPE html PUBLIC “-//W3C//DTD XHTML 1.0 Strict//EN” “<a class="reference external" href="http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd</a>“></td> +</tr> +<tr class="row-even"><td>XHTML 1.0 Transitional</td> +<td>xhtml1-trans</td> +<td><!DOCTYPE html PUBLIC “-//W3C//DTD XHTML 1.0 Transitional//EN” “<a class="reference external" href="http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd</a>“></td> +</tr> +<tr class="row-odd"><td>XHTML 1.0 Frameset</td> +<td>xhtml1-frame</td> +<td><!DOCTYPE html PUBLIC “-//W3C//DTD XHTML 1.0 Frameset//EN” “<a class="reference external" href="http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd</a>“></td> +</tr> +<tr class="row-even"><td>XHTML Basic 1.1</td> +<td>xhtml-basic11</td> +<td><!DOCTYPE html PUBLIC “-//W3C//DTD XHTML Basic 1.1//EN” “<a class="reference external" href="http://www.w3.org/TR/xhtml-basic/xhtml-basic11.dtd">http://www.w3.org/TR/xhtml-basic/xhtml-basic11.dtd</a>“></td> +</tr> +<tr class="row-odd"><td>HTML 5</td> +<td>html5</td> +<td><!DOCTYPE html></td> +</tr> +<tr class="row-even"><td>HTML 4 Strict</td> +<td>html4-strict</td> +<td><!DOCTYPE HTML PUBLIC “-//W3C//DTD HTML 4.01//EN” “<a class="reference external" href="http://www.w3.org/TR/html4/strict.dtd">http://www.w3.org/TR/html4/strict.dtd</a>“></td> +</tr> +<tr class="row-odd"><td>HTML 4 Transitional</td> +<td>html4-trans</td> +<td><!DOCTYPE HTML PUBLIC “-//W3C//DTD HTML 4.01 Transitional//EN” “<a class="reference external" href="http://www.w3.org/TR/html4/loose.dtd">http://www.w3.org/TR/html4/loose.dtd</a>“></td> +</tr> +<tr class="row-even"><td>HTML 4 Frameset</td> +<td>html4-frame</td> +<td><!DOCTYPE HTML PUBLIC “-//W3C//DTD HTML 4.01 Frameset//EN” “<a class="reference external" href="http://www.w3.org/TR/html4/frameset.dtd">http://www.w3.org/TR/html4/frameset.dtd</a>“></td> +</tr> +<tr class="row-odd"><td>MathML 1.01</td> +<td>mathml1</td> +<td><!DOCTYPE math SYSTEM “<a class="reference external" href="http://www.w3.org/Math/DTD/mathml1/mathml.dtd">http://www.w3.org/Math/DTD/mathml1/mathml.dtd</a>“></td> +</tr> +<tr class="row-even"><td>MathML 2.0</td> +<td>mathml2</td> +<td><!DOCTYPE math PUBLIC “-//W3C//DTD MathML 2.0//EN” “<a class="reference external" href="http://www.w3.org/Math/DTD/mathml2/mathml2.dtd">http://www.w3.org/Math/DTD/mathml2/mathml2.dtd</a>“></td> +</tr> +<tr class="row-odd"><td>SVG 1.0</td> +<td>svg10</td> +<td><!DOCTYPE svg PUBLIC “-//W3C//DTD SVG 1.0//EN” “<a class="reference external" href="http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd">http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd</a>“></td> +</tr> +<tr class="row-even"><td>SVG 1.1 Full</td> +<td>svg11</td> +<td><!DOCTYPE svg PUBLIC “-//W3C//DTD SVG 1.1//EN” “<a class="reference external" href="http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd</a>“></td> +</tr> +<tr class="row-odd"><td>SVG 1.1 Basic</td> +<td>svg11-basic</td> +<td><!DOCTYPE svg PUBLIC “-//W3C//DTD SVG 1.1 Basic//EN” “<a class="reference external" href="http://www.w3.org/Graphics/SVG/1.1/DTD/svg11-basic.dtd">http://www.w3.org/Graphics/SVG/1.1/DTD/svg11-basic.dtd</a>“></td> +</tr> +<tr class="row-even"><td>SVG 1.1 Tiny</td> +<td>svg11-tiny</td> +<td><!DOCTYPE svg PUBLIC “-//W3C//DTD SVG 1.1 Tiny//EN” “<a class="reference external" href="http://www.w3.org/Graphics/SVG/1.1/DTD/svg11-tiny.dtd">http://www.w3.org/Graphics/SVG/1.1/DTD/svg11-tiny.dtd</a>“></td> +</tr> +<tr class="row-odd"><td>XHTML+MathML+SVG (XHTML host)</td> +<td>xhtml-math-svg-xh</td> +<td><!DOCTYPE html PUBLIC “-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN” “<a class="reference external" href="http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg.dtd">http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg.dtd</a>“></td> +</tr> +<tr class="row-even"><td>XHTML+MathML+SVG (SVG host)</td> +<td>xhtml-math-svg-sh</td> +<td><!DOCTYPE svg:svg PUBLIC “-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN” “http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg.dtd”></td> +</tr> +<tr class="row-odd"><td>XHTML+RDFa 1.0</td> +<td>xhtml-rdfa-1</td> +<td><!DOCTYPE html PUBLIC “-//W3C//DTD XHTML+RDFa 1.0//EN” “<a class="reference external" href="http://www.w3.org/MarkUp/DTD/xhtml-rdfa-1.dtd">http://www.w3.org/MarkUp/DTD/xhtml-rdfa-1.dtd</a>“></td> +</tr> +<tr class="row-even"><td>XHTML+RDFa 1.1</td> +<td>xhtml-rdfa-2</td> +<td><!DOCTYPE html PUBLIC “-//W3C//DTD XHTML+RDFa 1.1//EN” “<a class="reference external" href="http://www.w3.org/MarkUp/DTD/xhtml-rdfa-2.dtd">http://www.w3.org/MarkUp/DTD/xhtml-rdfa-2.dtd</a>“></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> +<dt id="br"> +<tt class="descname">br</tt><big>(</big><span class="optional">[</span><em>$count = 1</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#br" 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>$count</strong> (<em>int</em>) – Number of times to repeat the tag</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">HTML line break 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>Generates line break tags (<br />) based on the number you submit. +Example:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">echo</span> <span class="nx">br</span><span class="p">(</span><span class="mi">3</span><span class="p">);</span> +</pre></div> +</div> +<p>The above would produce:</p> +<div class="highlight-html"><div class="highlight"><pre><span></span><span class="p"><</span><span class="nt">br</span> <span class="p">/><</span><span class="nt">br</span> <span class="p">/><</span><span class="nt">br</span> <span class="p">/></span> +</pre></div> +</div> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">This function is DEPRECATED. Use the native <tt class="docutils literal"><span class="pre">str_repeat()</span></tt> +in combination with <tt class="docutils literal"><span class="pre"><br</span> <span class="pre">/></span></tt> instead.</p> +</div> +</dd></dl> + +<dl class="function"> +<dt id="nbs"> +<tt class="descname">nbs</tt><big>(</big><span class="optional">[</span><em>$num = 1</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#nbs" 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>$num</strong> (<em>int</em>) – Number of space entities to produce</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">A sequence of non-breaking space HTML entities</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>Generates non-breaking spaces (&nbsp;) based on the number you submit. +Example:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">echo</span> <span class="nx">nbs</span><span class="p">(</span><span class="mi">3</span><span class="p">);</span> +</pre></div> +</div> +<p>The above would produce:</p> +<div class="highlight-html"><div class="highlight"><pre><span></span><span class="ni">&nbsp;&nbsp;&nbsp;</span> +</pre></div> +</div> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">This function is DEPRECATED. Use the native <tt class="docutils literal"><span class="pre">str_repeat()</span></tt> +in combination with <tt class="docutils literal"><span class="pre">&nbsp;</span></tt> instead.</p> +</div> +</dd></dl> + +</div> +</div> + + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="inflector_helper.html" class="btn btn-neutral float-right" title="Inflector Helper">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="form_helper.html" class="btn btn-neutral" title="Form 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 Jun 19, 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.5', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: false + }; + </script> + <script type="text/javascript" src="../_static/jquery.js"></script> + <script type="text/javascript" src="../_static/underscore.js"></script> + <script type="text/javascript" src="../_static/doctools.js"></script> + + + + + + <script type="text/javascript" src="../_static/js/theme.js"></script> + + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.StickyNav.enable(); + }); + </script> + + +</body> +</html>
\ No newline at end of file |