diff options
| author | Andrey Andreev <narf@devilix.net> | 2018-03-22 15:48:55 +0100 |
|---|---|---|
| committer | Andrey Andreev <narf@devilix.net> | 2018-03-22 15:48:55 +0100 |
| commit | 71e647782764184e3aab4faffe6d99176758979f (patch) | |
| tree | 74dbdd50a61cd5674915c144aca9ebbc00b235b8 /user_guide/helpers/url_helper.html | |
| parent | b12fbad77bd69ca0c7624a9094c29b7691ea6107 (diff) | |
[ci skip] 3.1.8 release
Diffstat (limited to 'user_guide/helpers/url_helper.html')
| -rw-r--r-- | user_guide/helpers/url_helper.html | 1044 |
1 files changed, 1044 insertions, 0 deletions
diff --git a/user_guide/helpers/url_helper.html b/user_guide/helpers/url_helper.html new file mode 100644 index 000000000..beb0a980d --- /dev/null +++ b/user_guide/helpers/url_helper.html @@ -0,0 +1,1044 @@ + + +<!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>URL Helper — CodeIgniter 3.1.8 documentation</title> + + + + + <link rel="shortcut icon" href="../_static/ci-icon.ico"/> + + + + <link href='https://fonts.googleapis.com/css?family=Lato:400,700,400italic,700italic|Roboto+Slab:400,700|Inconsolata:400,700&subset=latin,cyrillic' rel='stylesheet' type='text/css'> + + + + + + + + + + <link rel="stylesheet" href="../_static/css/citheme.css" type="text/css" /> + + + + <link rel="index" title="Index" + href="../genindex.html"/> + <link rel="search" title="Search" href="../search.html"/> + <link rel="top" title="CodeIgniter 3.1.8 documentation" href="../index.html"/> + <link rel="up" title="Helpers" href="index.html"/> + <link rel="next" title="XML Helper" href="xml_helper.html"/> + <link rel="prev" title="Typography Helper" href="typography_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></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"><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 current"><a class="current reference internal" href="#">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></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"><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 current"><a class="current reference internal" href="#">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>URL 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="url-helper"> +<h1>URL Helper<a class="headerlink" href="#url-helper" title="Permalink to this headline">¶</a></h1> +<p>The URL Helper file contains functions that assist in working with URLs.</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">'url'</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="site_url"> +<code class="descname">site_url</code><span class="sig-paren">(</span><span class="optional">[</span><em>$uri = ''</em><span class="optional">[</span>, <em>$protocol = NULL</em><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#site_url" 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>$uri</strong> (<em>string</em>) – URI string</li> +<li><strong>$protocol</strong> (<em>string</em>) – Protocol, e.g. ‘http’ or ‘https’</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Site URL</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 your site URL, as specified in your config file. The index.php +file (or whatever you have set as your site <strong>index_page</strong> in your config +file) will be added to the URL, as will any URI segments you pass to the +function, plus the <strong>url_suffix</strong> as set in your config file.</p> +<p>You are encouraged to use this function any time you need to generate a +local URL so that your pages become more portable in the event your URL +changes.</p> +<p>Segments can be optionally passed to the function as a string or an +array. Here is a string example:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">echo</span> <span class="nx">site_url</span><span class="p">(</span><span class="s1">'news/local/123'</span><span class="p">);</span> +</pre></div> +</div> +<p>The above example would return something like: +<em>http://example.com/index.php/news/local/123</em></p> +<p>Here is an example of segments passed as an array:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$segments</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span><span class="s1">'news'</span><span class="p">,</span> <span class="s1">'local'</span><span class="p">,</span> <span class="s1">'123'</span><span class="p">);</span> +<span class="k">echo</span> <span class="nx">site_url</span><span class="p">(</span><span class="nv">$segments</span><span class="p">);</span> +</pre></div> +</div> +<p>This function is an alias for <code class="docutils literal"><span class="pre">CI_Config::site_url()</span></code>. For more info, +please see the <a class="reference internal" href="../libraries/config.html"><span class="doc">Config Library</span></a> documentation.</p> +</dd></dl> + +<dl class="function"> +<dt id="base_url"> +<code class="descname">base_url</code><span class="sig-paren">(</span><em>$uri = ''</em>, <em>$protocol = NULL</em><span class="sig-paren">)</span><a class="headerlink" href="#base_url" 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>$uri</strong> (<em>string</em>) – URI string</li> +<li><strong>$protocol</strong> (<em>string</em>) – Protocol, e.g. ‘http’ or ‘https’</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Base URL</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 your site base URL, as specified in your config file. Example:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">echo</span> <span class="nx">base_url</span><span class="p">();</span> +</pre></div> +</div> +<p>This function returns the same thing as <a class="reference internal" href="#site_url" title="site_url"><code class="xref php php-func docutils literal"><span class="pre">site_url()</span></code></a>, without +the <em>index_page</em> or <em>url_suffix</em> being appended.</p> +<p>Also like <a class="reference internal" href="#site_url" title="site_url"><code class="xref php php-func docutils literal"><span class="pre">site_url()</span></code></a>, you can supply segments as a string or +an array. Here is a string example:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">echo</span> <span class="nx">base_url</span><span class="p">(</span><span class="s2">"blog/post/123"</span><span class="p">);</span> +</pre></div> +</div> +<p>The above example would return something like: +<em>http://example.com/blog/post/123</em></p> +<p>This is useful because unlike <a class="reference internal" href="#site_url" title="site_url"><code class="xref php php-func docutils literal"><span class="pre">site_url()</span></code></a>, you can supply a +string to a file, such as an image or stylesheet. For example:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">echo</span> <span class="nx">base_url</span><span class="p">(</span><span class="s2">"images/icons/edit.png"</span><span class="p">);</span> +</pre></div> +</div> +<p>This would give you something like: +<em>http://example.com/images/icons/edit.png</em></p> +<p>This function is an alias for <code class="docutils literal"><span class="pre">CI_Config::base_url()</span></code>. For more info, +please see the <a class="reference internal" href="../libraries/config.html"><span class="doc">Config Library</span></a> documentation.</p> +</dd></dl> + +<dl class="function"> +<dt id="current_url"> +<code class="descname">current_url</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#current_url" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The current URL</td> +</tr> +<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">string</td> +</tr> +</tbody> +</table> +<p>Returns the full URL (including segments) of the page being currently +viewed.</p> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">Calling this function is the same as doing this: +| +| site_url(uri_string());</p> +</div> +</dd></dl> + +<dl class="function"> +<dt id="uri_string"> +<code class="descname">uri_string</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#uri_string" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">An URI string</td> +</tr> +<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">string</td> +</tr> +</tbody> +</table> +<p>Returns the URI segments of any page that contains this function. +For example, if your URL was this:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nx">http</span><span class="o">://</span><span class="nx">some</span><span class="o">-</span><span class="nx">site</span><span class="o">.</span><span class="nx">com</span><span class="o">/</span><span class="nx">blog</span><span class="o">/</span><span class="nx">comments</span><span class="o">/</span><span class="mi">123</span> +</pre></div> +</div> +<p>The function would return:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nx">blog</span><span class="o">/</span><span class="nx">comments</span><span class="o">/</span><span class="mi">123</span> +</pre></div> +</div> +<p>This function is an alias for <code class="docutils literal"><span class="pre">CI_Config::uri_string()</span></code>. For more info, +please see the <a class="reference internal" href="../libraries/config.html"><span class="doc">Config Library</span></a> documentation.</p> +</dd></dl> + +<dl class="function"> +<dt id="index_page"> +<code class="descname">index_page</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#index_page" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">‘index_page’ value</td> +</tr> +<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">mixed</td> +</tr> +</tbody> +</table> +<p>Returns your site <strong>index_page</strong>, as specified in your config file. +Example:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">echo</span> <span class="nx">index_page</span><span class="p">();</span> +</pre></div> +</div> +</dd></dl> + +<dl class="function"> +<dt id="anchor"> +<code class="descname">anchor</code><span class="sig-paren">(</span><em>$uri = ''</em>, <em>$title = ''</em>, <em>$attributes = ''</em><span class="sig-paren">)</span><a class="headerlink" href="#anchor" 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>$uri</strong> (<em>string</em>) – URI string</li> +<li><strong>$title</strong> (<em>string</em>) – Anchor title</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 hyperlink (anchor 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 a standard HTML anchor link based on your local site URL.</p> +<p>The first parameter can contain any segments you wish appended to the +URL. As with the <a class="reference internal" href="#site_url" title="site_url"><code class="xref php php-func docutils literal"><span class="pre">site_url()</span></code></a> function above, segments can +be a string or an array.</p> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">If you are building links that are internal to your application +do not include the base URL (http://…). This will be added +automatically from the information specified in your config file. +Include only the URI segments you wish appended to the URL.</p> +</div> +<p>The second segment is the text you would like the link to say. If you +leave it blank, the URL will be used.</p> +<p>The third parameter can contain a list of attributes you would like +added to the link. The attributes can be a simple string or an +associative array.</p> +<p>Here are some examples:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">echo</span> <span class="nx">anchor</span><span class="p">(</span><span class="s1">'news/local/123'</span><span class="p">,</span> <span class="s1">'My News'</span><span class="p">,</span> <span class="s1">'title="News title"'</span><span class="p">);</span> +<span class="c1">// Prints: <a href="http://example.com/index.php/news/local/123" title="News title">My News</a></span> + +<span class="k">echo</span> <span class="nx">anchor</span><span class="p">(</span><span class="s1">'news/local/123'</span><span class="p">,</span> <span class="s1">'My News'</span><span class="p">,</span> <span class="k">array</span><span class="p">(</span><span class="s1">'title'</span> <span class="o">=></span> <span class="s1">'The best news!'</span><span class="p">));</span> +<span class="c1">// Prints: <a href="http://example.com/index.php/news/local/123" title="The best news!">My News</a></span> + +<span class="k">echo</span> <span class="nx">anchor</span><span class="p">(</span><span class="s1">''</span><span class="p">,</span> <span class="s1">'Click here'</span><span class="p">);</span> +<span class="c1">// Prints: <a href="http://example.com">Click Here</a></span> +</pre></div> +</div> +</dd></dl> + +<dl class="function"> +<dt id="anchor_popup"> +<code class="descname">anchor_popup</code><span class="sig-paren">(</span><em>$uri = ''</em>, <em>$title = ''</em>, <em>$attributes = FALSE</em><span class="sig-paren">)</span><a class="headerlink" href="#anchor_popup" 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>$uri</strong> (<em>string</em>) – URI string</li> +<li><strong>$title</strong> (<em>string</em>) – Anchor title</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">Pop-up hyperlink</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>Nearly identical to the <a class="reference internal" href="#anchor" title="anchor"><code class="xref php php-func docutils literal"><span class="pre">anchor()</span></code></a> function except that it +opens the URL in a new window. You can specify JavaScript window +attributes in the third parameter to control how the window is opened. +If the third parameter is not set it will simply open a new window with +your own browser settings.</p> +<p>Here is an example with attributes:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$atts</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span> + <span class="s1">'width'</span> <span class="o">=></span> <span class="mi">800</span><span class="p">,</span> + <span class="s1">'height'</span> <span class="o">=></span> <span class="mi">600</span><span class="p">,</span> + <span class="s1">'scrollbars'</span> <span class="o">=></span> <span class="s1">'yes'</span><span class="p">,</span> + <span class="s1">'status'</span><span class="nx"> </span> <span class="nx"> </span><span class="o">=></span> <span class="s1">'yes'</span><span class="p">,</span> + <span class="s1">'resizable'</span><span class="nx"> </span> <span class="nx"> </span><span class="o">=></span> <span class="s1">'yes'</span><span class="p">,</span> + <span class="s1">'screenx'</span> <span class="o">=></span> <span class="mi">0</span><span class="p">,</span> + <span class="s1">'screeny'</span> <span class="o">=></span> <span class="mi">0</span><span class="p">,</span> + <span class="s1">'window_name'</span> <span class="o">=></span> <span class="s1">'_blank'</span> +<span class="p">);</span> + +<span class="k">echo</span> <span class="nx">anchor_popup</span><span class="p">(</span><span class="s1">'news/local/123'</span><span class="p">,</span> <span class="s1">'Click Me!'</span><span class="p">,</span> <span class="nv">$atts</span><span class="p">);</span> +</pre></div> +</div> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">The above attributes are the function defaults so you only need to +set the ones that are different from what you need. If you want the +function to use all of its defaults simply pass an empty array in the +third parameter: +| +| echo anchor_popup(‘news/local/123’, ‘Click Me!’, array());</p> +</div> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">The <strong>window_name</strong> is not really an attribute, but an argument to +the JavaScript <cite>window.open() <http://www.w3schools.com/jsref/met_win_open.asp></cite> +method, which accepts either a window name or a window target.</p> +</div> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">Any other attribute than the listed above will be parsed as an +HTML attribute to the anchor tag.</p> +</div> +</dd></dl> + +<dl class="function"> +<dt id="mailto"> +<code class="descname">mailto</code><span class="sig-paren">(</span><em>$email</em>, <em>$title = ''</em>, <em>$attributes = ''</em><span class="sig-paren">)</span><a class="headerlink" href="#mailto" 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>$email</strong> (<em>string</em>) – E-mail address</li> +<li><strong>$title</strong> (<em>string</em>) – Anchor title</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">A “mail to” hyperlink</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 a standard HTML e-mail link. Usage example:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">echo</span> <span class="nx">mailto</span><span class="p">(</span><span class="s1">'me@my-site.com'</span><span class="p">,</span> <span class="s1">'Click Here to Contact Me'</span><span class="p">);</span> +</pre></div> +</div> +<p>As with the <a class="reference internal" href="#anchor" title="anchor"><code class="xref php php-func docutils literal"><span class="pre">anchor()</span></code></a> tab above, you can set attributes using the +third parameter:</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">'title'</span> <span class="o">=></span> <span class="s1">'Mail me'</span><span class="p">);</span> +<span class="k">echo</span> <span class="nx">mailto</span><span class="p">(</span><span class="s1">'me@my-site.com'</span><span class="p">,</span> <span class="s1">'Contact Me'</span><span class="p">,</span> <span class="nv">$attributes</span><span class="p">);</span> +</pre></div> +</div> +</dd></dl> + +<dl class="function"> +<dt id="safe_mailto"> +<code class="descname">safe_mailto</code><span class="sig-paren">(</span><em>$email</em>, <em>$title = ''</em>, <em>$attributes = ''</em><span class="sig-paren">)</span><a class="headerlink" href="#safe_mailto" 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>$email</strong> (<em>string</em>) – E-mail address</li> +<li><strong>$title</strong> (<em>string</em>) – Anchor title</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">A spam-safe “mail to” hyperlink</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 the <a class="reference internal" href="#mailto" title="mailto"><code class="xref php php-func docutils literal"><span class="pre">mailto()</span></code></a> function except it writes an obfuscated +version of the <em>mailto</em> tag using ordinal numbers written with JavaScript to +help prevent the e-mail address from being harvested by spam bots.</p> +</dd></dl> + +<dl class="function"> +<dt id="auto_link"> +<code class="descname">auto_link</code><span class="sig-paren">(</span><em>$str</em>, <em>$type = 'both'</em>, <em>$popup = FALSE</em><span class="sig-paren">)</span><a class="headerlink" href="#auto_link" 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>) – Input string</li> +<li><strong>$type</strong> (<em>string</em>) – Link type (‘email’, ‘url’ or ‘both’)</li> +<li><strong>$popup</strong> (<em>bool</em>) – Whether to create popup links</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Linkified 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>Automatically turns URLs and e-mail addresses contained in a string into +links. Example:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$string</span> <span class="o">=</span> <span class="nx">auto_link</span><span class="p">(</span><span class="nv">$string</span><span class="p">);</span> +</pre></div> +</div> +<p>The second parameter determines whether URLs and e-mails are converted or +just one or the other. Default behavior is both if the parameter is not +specified. E-mail links are encoded as <a class="reference internal" href="#safe_mailto" title="safe_mailto"><code class="xref php php-func docutils literal"><span class="pre">safe_mailto()</span></code></a> as shown +above.</p> +<p>Converts only URLs:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$string</span> <span class="o">=</span> <span class="nx">auto_link</span><span class="p">(</span><span class="nv">$string</span><span class="p">,</span> <span class="s1">'url'</span><span class="p">);</span> +</pre></div> +</div> +<p>Converts only e-mail addresses:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$string</span> <span class="o">=</span> <span class="nx">auto_link</span><span class="p">(</span><span class="nv">$string</span><span class="p">,</span> <span class="s1">'email'</span><span class="p">);</span> +</pre></div> +</div> +<p>The third parameter determines whether links are shown in a new window. +The value can be TRUE or FALSE (boolean):</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$string</span> <span class="o">=</span> <span class="nx">auto_link</span><span class="p">(</span><span class="nv">$string</span><span class="p">,</span> <span class="s1">'both'</span><span class="p">,</span> <span class="k">TRUE</span><span class="p">);</span> +</pre></div> +</div> +</dd></dl> + +<dl class="function"> +<dt id="url_title"> +<code class="descname">url_title</code><span class="sig-paren">(</span><em>$str</em>, <em>$separator = '-'</em>, <em>$lowercase = FALSE</em><span class="sig-paren">)</span><a class="headerlink" href="#url_title" 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>) – Input string</li> +<li><strong>$separator</strong> (<em>string</em>) – Word separator</li> +<li><strong>$lowercase</strong> (<em>bool</em>) – Whether to transform the output string to lower-case</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">URL-formatted 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>Takes a string as input and creates a human-friendly URL string. This is +useful if, for example, you have a blog in which you’d like to use the +title of your entries in the URL. Example:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$title</span> <span class="o">=</span> <span class="s2">"What's wrong with CSS?"</span><span class="p">;</span> +<span class="nv">$url_title</span> <span class="o">=</span> <span class="nx">url_title</span><span class="p">(</span><span class="nv">$title</span><span class="p">);</span> +<span class="c1">// Produces: Whats-wrong-with-CSS</span> +</pre></div> +</div> +<p>The second parameter determines the word delimiter. By default dashes +are used. Preferred options are: <strong>-</strong> (dash) or <strong>_</strong> (underscore)</p> +<p>Example:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$title</span> <span class="o">=</span> <span class="s2">"What's wrong with CSS?"</span><span class="p">;</span> +<span class="nv">$url_title</span> <span class="o">=</span> <span class="nx">url_title</span><span class="p">(</span><span class="nv">$title</span><span class="p">,</span> <span class="s1">'underscore'</span><span class="p">);</span> +<span class="c1">// Produces: Whats_wrong_with_CSS</span> +</pre></div> +</div> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">Old usage of ‘dash’ and ‘underscore’ as the second parameter +is DEPRECATED.</p> +</div> +<p>The third parameter determines whether or not lowercase characters are +forced. By default they are not. Options are boolean TRUE/FALSE.</p> +<p>Example:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$title</span> <span class="o">=</span> <span class="s2">"What's wrong with CSS?"</span><span class="p">;</span> +<span class="nv">$url_title</span> <span class="o">=</span> <span class="nx">url_title</span><span class="p">(</span><span class="nv">$title</span><span class="p">,</span> <span class="s1">'underscore'</span><span class="p">,</span> <span class="k">TRUE</span><span class="p">);</span> +<span class="c1">// Produces: whats_wrong_with_css</span> +</pre></div> +</div> +</dd></dl> + +<dl class="function"> +<dt id="prep_url"> +<code class="descname">prep_url</code><span class="sig-paren">(</span><em>$str = ''</em><span class="sig-paren">)</span><a class="headerlink" href="#prep_url" 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>) – URL string</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Protocol-prefixed URL 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>This function will add http:// in the event that a protocol prefix +is missing from a URL.</p> +<p>Pass the URL string to the function like this:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$url</span> <span class="o">=</span> <span class="nx">prep_url</span><span class="p">(</span><span class="s1">'example.com'</span><span class="p">);</span> +</pre></div> +</div> +</dd></dl> + +<dl class="function"> +<dt id="redirect"> +<code class="descname">redirect</code><span class="sig-paren">(</span><em>$uri = ''</em>, <em>$method = 'auto'</em>, <em>$code = NULL</em><span class="sig-paren">)</span><a class="headerlink" href="#redirect" 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>$uri</strong> (<em>string</em>) – URI string</li> +<li><strong>$method</strong> (<em>string</em>) – Redirect method (‘auto’, ‘location’ or ‘refresh’)</li> +<li><strong>$code</strong> (<em>string</em>) – HTTP Response code (usually 302 or 303)</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">void</p> +</td> +</tr> +</tbody> +</table> +<p>Does a “header redirect” to the URI specified. If you specify the full +site URL that link will be built, but for local links simply providing +the URI segments to the controller you want to direct to will create the +link. The function will build the URL based on your config file values.</p> +<p>The optional second parameter allows you to force a particular redirection +method. The available methods are <strong>auto</strong>, <strong>location</strong> and <strong>refresh</strong>, +with location being faster but less reliable on IIS servers. +The default is <strong>auto</strong>, which will attempt to intelligently choose the +method based on the server environment.</p> +<p>The optional third parameter allows you to send a specific HTTP Response +Code - this could be used for example to create 301 redirects for search +engine purposes. The default Response Code is 302. The third parameter is +<em>only</em> available with <strong>location</strong> redirects, and not <em>refresh</em>. Examples:</p> +<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">if</span> <span class="p">(</span><span class="nv">$logged_in</span> <span class="o">==</span> <span class="k">FALSE</span><span class="p">)</span> +<span class="p">{</span> + <span class="nx">redirect</span><span class="p">(</span><span class="s1">'/login/form/'</span><span class="p">);</span> +<span class="p">}</span> + +<span class="c1">// with 301 redirect</span> +<span class="nx">redirect</span><span class="p">(</span><span class="s1">'/article/13'</span><span class="p">,</span> <span class="s1">'location'</span><span class="p">,</span> <span class="mi">301</span><span class="p">);</span> +</pre></div> +</div> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">In order for this function to work it must be used before anything +is outputted to the browser since it utilizes server headers.</p> +</div> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">For very fine grained control over headers, you should use the +<a class="reference internal" href="../libraries/output.html"><span class="doc">Output Library</span></a> <code class="docutils literal"><span class="pre">set_header()</span></code> method.</p> +</div> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">To IIS users: if you hide the <cite>Server</cite> HTTP header, the <em>auto</em> +method won’t detect IIS, in that case it is advised you explicitly +use the <strong>refresh</strong> method.</p> +</div> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">When the <strong>location</strong> method is used, an HTTP status code of 303 +will <em>automatically</em> be selected when the page is currently accessed +via POST and HTTP/1.1 is used.</p> +</div> +<div class="admonition important"> +<p class="first admonition-title">Important</p> +<p class="last">This function will terminate script execution.</p> +</div> +</dd></dl> + +</div> +</div> + + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="xml_helper.html" class="btn btn-neutral float-right" title="XML Helper">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="typography_helper.html" class="btn btn-neutral" title="Typography Helper"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2014 - 2018, British Columbia Institute of Technology. + Last updated on Mar 22, 2018. + </p> + </div> + + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + </div> + </div> + + </section> + + </div> + + + + + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT:'../', + VERSION:'3.1.8', + 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 |