|
|
|
|
|
|
|
|
<!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>String Helper — CodeIgniter 3.1.4 documentation</title>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="shortcut icon" href="../_static/ci-icon.ico"/>
|
|
|
|
|
|
|
|
|
|
|
|
<link href='https://fonts.googleapis.com/css?family=Lato:400,700,400italic,700italic|Roboto+Slab:400,700|Inconsolata:400,700&subset=latin,cyrillic' rel='stylesheet' type='text/css'>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../_static/css/citheme.css" type="text/css" />
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="top" title="CodeIgniter 3.1.4 documentation" href="../index.html"/>
|
|
|
<link rel="up" title="Helpers" href="index.html"/>
|
|
|
<link rel="next" title="Text Helper" href="text_helper.html"/>
|
|
|
<link rel="prev" title="Smiley Helper" href="smiley_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"><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 current"><a class="current reference internal" href="">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"><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 current"><a class="current reference internal" href="">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>String 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="string-helper">
|
|
|
<h1>String Helper<a class="headerlink" href="#string-helper" title="Permalink to this headline">¶</a></h1>
|
|
|
<p>The String Helper file contains functions that assist in working with
|
|
|
strings.</p>
|
|
|
<div class="admonition important">
|
|
|
<p class="first admonition-title">Important</p>
|
|
|
<p class="last">Please note that these functions are NOT intended, nor
|
|
|
suitable to be used for any kind of security-related logic.</p>
|
|
|
</div>
|
|
|
<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">'string'</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="random_string">
|
|
|
<tt class="descname">random_string</tt><big>(</big><span class="optional">[</span><em>$type = 'alnum'</em><span class="optional">[</span>, <em>$len = 8</em><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#random_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">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
|
<li><strong>$type</strong> (<em>string</em>) – Randomization type</li>
|
|
|
<li><strong>$len</strong> (<em>int</em>) – Output string length</li>
|
|
|
</ul>
|
|
|
</td>
|
|
|
</tr>
|
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">A random 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>Generates a random string based on the type and length you specify.
|
|
|
Useful for creating passwords or generating random hashes.</p>
|
|
|
<p>The first parameter specifies the type of string, the second parameter
|
|
|
specifies the length. The following choices are available:</p>
|
|
|
<ul class="simple">
|
|
|
<li><strong>alpha</strong>: A string with lower and uppercase letters only.</li>
|
|
|
<li><strong>alnum</strong>: Alpha-numeric string with lower and uppercase characters.</li>
|
|
|
<li><strong>basic</strong>: A random number based on <tt class="docutils literal"><span class="pre">mt_rand()</span></tt>.</li>
|
|
|
<li><strong>numeric</strong>: Numeric string.</li>
|
|
|
<li><strong>nozero</strong>: Numeric string with no zeros.</li>
|
|
|
<li><strong>md5</strong>: An encrypted random number based on <tt class="docutils literal"><span class="pre">md5()</span></tt> (fixed length of 32).</li>
|
|
|
<li><strong>sha1</strong>: An encrypted random number based on <tt class="docutils literal"><span class="pre">sha1()</span></tt> (fixed length of 40).</li>
|
|
|
</ul>
|
|
|
<p>Usage example:</p>
|
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">echo</span> <span class="nx">random_string</span><span class="p">(</span><span class="s1">'alnum'</span><span class="p">,</span> <span class="mi">16</span><span class="p">);</span>
|
|
|
</pre></div>
|
|
|
</div>
|
|
|
<div class="admonition note">
|
|
|
<p class="first admonition-title">Note</p>
|
|
|
<p class="last">Usage of the <em>unique</em> and <em>encrypt</em> types is DEPRECATED. They
|
|
|
are just aliases for <em>md5</em> and <em>sha1</em> respectively.</p>
|
|
|
</div>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="function">
|
|
|
<dt id="increment_string">
|
|
|
<tt class="descname">increment_string</tt><big>(</big><em>$str</em><span class="optional">[</span>, <em>$separator = '_'</em><span class="optional">[</span>, <em>$first = 1</em><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#increment_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">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>) – Separator to append a duplicate number with</li>
|
|
|
<li><strong>$first</strong> (<em>int</em>) – Starting number</li>
|
|
|
</ul>
|
|
|
</td>
|
|
|
</tr>
|
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">An incremented 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>Increments a string by appending a number to it or increasing the
|
|
|
number. Useful for creating “copies” or a file or duplicating database
|
|
|
content which has unique titles or slugs.</p>
|
|
|
<p>Usage example:</p>
|
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">echo</span> <span class="nx">increment_string</span><span class="p">(</span><span class="s1">'file'</span><span class="p">,</span> <span class="s1">'_'</span><span class="p">);</span> <span class="c1">// "file_1"</span>
|
|
|
<span class="k">echo</span> <span class="nx">increment_string</span><span class="p">(</span><span class="s1">'file'</span><span class="p">,</span> <span class="s1">'-'</span><span class="p">,</span> <span class="mi">2</span><span class="p">);</span> <span class="c1">// "file-2"</span>
|
|
|
<span class="k">echo</span> <span class="nx">increment_string</span><span class="p">(</span><span class="s1">'file_4'</span><span class="p">);</span> <span class="c1">// "file_5"</span>
|
|
|
</pre></div>
|
|
|
</div>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="function">
|
|
|
<dt id="alternator">
|
|
|
<tt class="descname">alternator</tt><big>(</big><em>$args</em><big>)</big><a class="headerlink" href="#alternator" 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>$args</strong> (<em>mixed</em>) – A variable number of arguments</li>
|
|
|
</ul>
|
|
|
</td>
|
|
|
</tr>
|
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Alternated string(s)</p>
|
|
|
</td>
|
|
|
</tr>
|
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">mixed</p>
|
|
|
</td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<p>Allows two or more items to be alternated between, when cycling through
|
|
|
a loop. Example:</p>
|
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">for</span> <span class="p">(</span><span class="nv">$i</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span> <span class="nv">$i</span> <span class="o"><</span> <span class="mi">10</span><span class="p">;</span> <span class="nv">$i</span><span class="o">++</span><span class="p">)</span>
|
|
|
<span class="p">{</span>
|
|
|
<span class="k">echo</span> <span class="nx">alternator</span><span class="p">(</span><span class="s1">'string one'</span><span class="p">,</span> <span class="s1">'string two'</span><span class="p">);</span>
|
|
|
<span class="p">}</span>
|
|
|
</pre></div>
|
|
|
</div>
|
|
|
<p>You can add as many parameters as you want, and with each iteration of
|
|
|
your loop the next item will be returned.</p>
|
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">for</span> <span class="p">(</span><span class="nv">$i</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span> <span class="nv">$i</span> <span class="o"><</span> <span class="mi">10</span><span class="p">;</span> <span class="nv">$i</span><span class="o">++</span><span class="p">)</span>
|
|
|
<span class="p">{</span>
|
|
|
<span class="k">echo</span> <span class="nx">alternator</span><span class="p">(</span><span class="s1">'one'</span><span class="p">,</span> <span class="s1">'two'</span><span class="p">,</span> <span class="s1">'three'</span><span class="p">,</span> <span class="s1">'four'</span><span class="p">,</span> <span class="s1">'five'</span><span class="p">);</span>
|
|
|
<span class="p">}</span>
|
|
|
</pre></div>
|
|
|
</div>
|
|
|
<div class="admonition note">
|
|
|
<p class="first admonition-title">Note</p>
|
|
|
<p class="last">To use multiple separate calls to this function simply call the
|
|
|
function with no arguments to re-initialize.</p>
|
|
|
</div>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="function">
|
|
|
<dt id="repeater">
|
|
|
<tt class="descname">repeater</tt><big>(</big><em>$data</em><span class="optional">[</span>, <em>$num = 1</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#repeater" 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>) – Input</li>
|
|
|
<li><strong>$num</strong> (<em>int</em>) – Number of times to repeat</li>
|
|
|
</ul>
|
|
|
</td>
|
|
|
</tr>
|
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Repeated 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>Generates repeating copies of the data you submit. Example:</p>
|
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$string</span> <span class="o">=</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">;</span>
|
|
|
<span class="k">echo</span> <span class="nx">repeater</span><span class="p">(</span><span class="nv">$string</span><span class="p">,</span> <span class="mi">30</span><span class="p">);</span>
|
|
|
</pre></div>
|
|
|
</div>
|
|
|
<p>The above would generate 30 newlines.</p>
|
|
|
<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>
|
|
|
instead.</p>
|
|
|
</div>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="function">
|
|
|
<dt id="reduce_double_slashes">
|
|
|
<tt class="descname">reduce_double_slashes</tt><big>(</big><em>$str</em><big>)</big><a class="headerlink" href="#reduce_double_slashes" 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>
|
|
|
</ul>
|
|
|
</td>
|
|
|
</tr>
|
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">A string with normalized slashes</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>Converts double slashes in a string to a single slash, except those
|
|
|
found in URL protocol prefixes (e.g. http&#58;//).</p>
|
|
|
<p>Example:</p>
|
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$string</span> <span class="o">=</span> <span class="s2">"http://example.com//index.php"</span><span class="p">;</span>
|
|
|
<span class="k">echo</span> <span class="nx">reduce_double_slashes</span><span class="p">(</span><span class="nv">$string</span><span class="p">);</span> <span class="c1">// results in "http://example.com/index.php"</span>
|
|
|
</pre></div>
|
|
|
</div>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="function">
|
|
|
<dt id="strip_slashes">
|
|
|
<tt class="descname">strip_slashes</tt><big>(</big><em>$data</em><big>)</big><a class="headerlink" href="#strip_slashes" 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>mixed</em>) – Input string or an array of strings</li>
|
|
|
</ul>
|
|
|
</td>
|
|
|
</tr>
|
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">String(s) with stripped slashes</p>
|
|
|
</td>
|
|
|
</tr>
|
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">mixed</p>
|
|
|
</td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<p>Removes any slashes from an array of strings.</p>
|
|
|
<p>Example:</p>
|
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$str</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span>
|
|
|
<span class="s1">'question'</span><span class="nx"> </span><span class="o">=></span> <span class="s1">'Is your name O\'reilly?'</span><span class="p">,</span>
|
|
|
<span class="s1">'answer'</span> <span class="o">=></span> <span class="s1">'No, my name is O\'connor.'</span>
|
|
|
<span class="p">);</span>
|
|
|
|
|
|
<span class="nv">$str</span> <span class="o">=</span> <span class="nx">strip_slashes</span><span class="p">(</span><span class="nv">$str</span><span class="p">);</span>
|
|
|
</pre></div>
|
|
|
</div>
|
|
|
<p>The above will return the following array:</p>
|
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">array</span><span class="p">(</span>
|
|
|
<span class="s1">'question'</span><span class="nx"> </span><span class="o">=></span> <span class="s2">"Is your name O'reilly?"</span><span class="p">,</span>
|
|
|
<span class="s1">'answer'</span> <span class="o">=></span> <span class="s2">"No, my name is O'connor."</span>
|
|
|
<span class="p">);</span>
|
|
|
</pre></div>
|
|
|
</div>
|
|
|
<div class="admonition note">
|
|
|
<p class="first admonition-title">Note</p>
|
|
|
<p class="last">For historical reasons, this function will also accept
|
|
|
and handle string inputs. This however makes it just an
|
|
|
alias for <tt class="docutils literal"><span class="pre">stripslashes()</span></tt>.</p>
|
|
|
</div>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="function">
|
|
|
<dt id="trim_slashes">
|
|
|
<tt class="descname">trim_slashes</tt><big>(</big><em>$str</em><big>)</big><a class="headerlink" href="#trim_slashes" 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>
|
|
|
</ul>
|
|
|
</td>
|
|
|
</tr>
|
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Slash-trimmed 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>Removes any leading/trailing slashes from a string. Example:</p>
|
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$string</span> <span class="o">=</span> <span class="s2">"/this/that/theother/"</span><span class="p">;</span>
|
|
|
<span class="k">echo</span> <span class="nx">trim_slashes</span><span class="p">(</span><span class="nv">$string</span><span class="p">);</span> <span class="c1">// results in this/that/theother</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">trim()</span></tt> instead:
|
|
|
|
|
|
|
| trim($str, ‘/’);</p>
|
|
|
</div>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="function">
|
|
|
<dt id="reduce_multiples">
|
|
|
<tt class="descname">reduce_multiples</tt><big>(</big><em>$str</em><span class="optional">[</span>, <em>$character = ''</em><span class="optional">[</span>, <em>$trim = FALSE</em><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#reduce_multiples" 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>) – Text to search in</li>
|
|
|
<li><strong>$character</strong> (<em>string</em>) – Character to reduce</li>
|
|
|
<li><strong>$trim</strong> (<em>bool</em>) – Whether to also trim the specified character</li>
|
|
|
</ul>
|
|
|
</td>
|
|
|
</tr>
|
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Reduced 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>Reduces multiple instances of a particular character occurring directly
|
|
|
after each other. Example:</p>
|
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$string</span> <span class="o">=</span> <span class="s2">"Fred, Bill,, Joe, Jimmy"</span><span class="p">;</span>
|
|
|
<span class="nv">$string</span> <span class="o">=</span> <span class="nx">reduce_multiples</span><span class="p">(</span><span class="nv">$string</span><span class="p">,</span><span class="s2">","</span><span class="p">);</span> <span class="c1">//results in "Fred, Bill, Joe, Jimmy"</span>
|
|
|
</pre></div>
|
|
|
</div>
|
|
|
<p>If the third parameter is set to TRUE it will remove occurrences of the
|
|
|
character at the beginning and the end of the string. Example:</p>
|
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$string</span> <span class="o">=</span> <span class="s2">",Fred, Bill,, Joe, Jimmy,"</span><span class="p">;</span>
|
|
|
<span class="nv">$string</span> <span class="o">=</span> <span class="nx">reduce_multiples</span><span class="p">(</span><span class="nv">$string</span><span class="p">,</span> <span class="s2">", "</span><span class="p">,</span> <span class="k">TRUE</span><span class="p">);</span> <span class="c1">//results in "Fred, Bill, Joe, Jimmy"</span>
|
|
|
</pre></div>
|
|
|
</div>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="function">
|
|
|
<dt id="quotes_to_entities">
|
|
|
<tt class="descname">quotes_to_entities</tt><big>(</big><em>$str</em><big>)</big><a class="headerlink" href="#quotes_to_entities" 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>
|
|
|
</ul>
|
|
|
</td>
|
|
|
</tr>
|
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">String with quotes converted to 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>Converts single and double quotes in a string to the corresponding HTML
|
|
|
entities. Example:</p>
|
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$string</span> <span class="o">=</span> <span class="s2">"Joe's </span><span class="se">\"</span><span class="s2">dinner</span><span class="se">\"</span><span class="s2">"</span><span class="p">;</span>
|
|
|
<span class="nv">$string</span> <span class="o">=</span> <span class="nx">quotes_to_entities</span><span class="p">(</span><span class="nv">$string</span><span class="p">);</span> <span class="c1">//results in "Joe&#39;s &quot;dinner&quot;"</span>
|
|
|
</pre></div>
|
|
|
</div>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="function">
|
|
|
<dt id="strip_quotes">
|
|
|
<tt class="descname">strip_quotes</tt><big>(</big><em>$str</em><big>)</big><a class="headerlink" href="#strip_quotes" 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>
|
|
|
</ul>
|
|
|
</td>
|
|
|
</tr>
|
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">String with quotes stripped</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>Removes single and double quotes from a string. Example:</p>
|
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$string</span> <span class="o">=</span> <span class="s2">"Joe's </span><span class="se">\"</span><span class="s2">dinner</span><span class="se">\"</span><span class="s2">"</span><span class="p">;</span>
|
|
|
<span class="nv">$string</span> <span class="o">=</span> <span class="nx">strip_quotes</span><span class="p">(</span><span class="nv">$string</span><span class="p">);</span> <span class="c1">//results in "Joes dinner"</span>
|
|
|
</pre></div>
|
|
|
</div>
|
|
|
</dd></dl>
|
|
|
|
|
|
</div>
|
|
|
</div>
|
|
|
|
|
|
|
|
|
</div>
|
|
|
<footer>
|
|
|
|
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|
|
|
|
|
<a href="text_helper.html" class="btn btn-neutral float-right" title="Text Helper">Next <span class="fa fa-arrow-circle-right"></span></a>
|
|
|
|
|
|
|
|
|
<a href="smiley_helper.html" class="btn btn-neutral" title="Smiley Helper"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
<hr/>
|
|
|
|
|
|
<div role="contentinfo">
|
|
|
<p>
|
|
|
© Copyright 2014 - 2017, British Columbia Institute of Technology.
|
|
|
Last updated on Mar 20, 2017.
|
|
|
</p>
|
|
|
</div>
|
|
|
|
|
|
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
|
|
|
|
</footer>
|
|
|
</div>
|
|
|
</div>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript">
|
|
|
var DOCUMENTATION_OPTIONS = {
|
|
|
URL_ROOT:'../',
|
|
|
VERSION:'3.1.4',
|
|
|
COLLAPSE_INDEX:false,
|
|
|
FILE_SUFFIX:'.html',
|
|
|
HAS_SOURCE: false
|
|
|
};
|
|
|
</script>
|
|
|
<script type="text/javascript" src="../_static/jquery.js"></script>
|
|
|
<script type="text/javascript" src="../_static/underscore.js"></script>
|
|
|
<script type="text/javascript" src="../_static/doctools.js"></script>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript" src="../_static/js/theme.js"></script>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript">
|
|
|
jQuery(function () {
|
|
|
SphinxRtdTheme.StickyNav.enable();
|
|
|
});
|
|
|
</script>
|
|
|
|
|
|
|
|
|
</body>
|
|
|
</html> |
