PageRenderTime 46ms CodeModel.GetById 6ms RepoModel.GetById 1ms app.codeStats 0ms

/user_guide/helpers/text_helper.html

https://bitbucket.org/bo_hmb/bo_hmb
HTML | 847 lines | 750 code | 96 blank | 1 comment | 0 complexity | 424953b7f08eb94fcbe84e3da28b3dc9 MD5 | raw file
Possible License(s): Apache-2.0, MIT, LGPL-2.1, MPL-2.0-no-copyleft-exception, GPL-2.0 
    

  1. 

  2. 

  3. <!DOCTYPE html>
    4. 

  4. <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
    5. 

  5. <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
    6. 

  6. <head>
    7. 

  7.   <meta charset="utf-8">
    8. 

  8.   <meta name="viewport" content="width=device-width, initial-scale=1.0">
    9. 

  9.   
    10. 

  10.   <title>Text Helper &mdash; CodeIgniter 3.1.8 documentation</title>
    11. 

  11.   
    12. 

  12. 

  13.   
    14. 

  14.   
    15. 

  15.     <link rel="shortcut icon" href="../_static/ci-icon.ico"/>
    16. 

  16.   
    17. 

  17. 

  18.   
    19. 

  19.   <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'>
    20. 

  20. 

  21.   
    22. 

  22.   
    23. 

  23.     
    24. 

  24. 

  25.   
    26. 

  26. 

  27.   
    28. 

  28.   
    29. 

  29.     <link rel="stylesheet" href="../_static/css/citheme.css" type="text/css" />
    30. 

  30.   
    31. 

  31. 

  32.   
    33. 

  33.         <link rel="index" title="Index"
    34. 

  34.               href="../genindex.html"/>
    35. 

  35.         <link rel="search" title="Search" href="../search.html"/>
    36. 

  36.     <link rel="top" title="CodeIgniter 3.1.8 documentation" href="../index.html"/>
    37. 

  37.         <link rel="up" title="Helpers" href="index.html"/>
    38. 

  38.         <link rel="next" title="Typography Helper" href="typography_helper.html"/>
    39. 

  39.         <link rel="prev" title="String Helper" href="string_helper.html"/> 
    40. 

  40. 

  41.   
    42. 

  42.   <script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script>
    43. 

  43. 

  44. </head>
    45. 

  45. 

  46. <body class="wy-body-for-nav" role="document">
    47. 

  47. 

  48.   <div id="nav">
    49. 

  49.   <div id="nav_inner">
    50. 

  50.     
    51. 

  51.     
    52. 

  52.     
    53. 

  53.       <div id="pulldown-menu" class="ciNav">
    54. 

  54.         <ul>
    55. 

  55. <li class="toctree-l1"><a class="reference internal" href="../general/welcome.html">Welcome to CodeIgniter</a></li>
    56. 

  56. </ul>
    57. 

  57. <ul>
    58. 

  58. <li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installation Instructions</a><ul>
    59. 

  59. <li class="toctree-l2"><a class="reference internal" href="../installation/downloads.html">Downloading CodeIgniter</a></li>
    60. 

  60. <li class="toctree-l2"><a class="reference internal" href="../installation/index.html">Installation Instructions</a></li>
    61. 

  61. <li class="toctree-l2"><a class="reference internal" href="../installation/upgrading.html">Upgrading From a Previous Version</a></li>
    62. 

  62. <li class="toctree-l2"><a class="reference internal" href="../installation/troubleshooting.html">Troubleshooting</a></li>
    63. 

  63. </ul>
    64. 

  64. </li>
    65. 

  65. </ul>
    66. 

  66. <ul>
    67. 

  67. <li class="toctree-l1"><a class="reference internal" href="../overview/index.html">CodeIgniter Overview</a><ul>
    68. 

  68. <li class="toctree-l2"><a class="reference internal" href="../overview/getting_started.html">Getting Started</a></li>
    69. 

  69. <li class="toctree-l2"><a class="reference internal" href="../overview/at_a_glance.html">CodeIgniter at a Glance</a></li>
    70. 

  70. <li class="toctree-l2"><a class="reference internal" href="../overview/features.html">Supported Features</a></li>
    71. 

  71. <li class="toctree-l2"><a class="reference internal" href="../overview/appflow.html">Application Flow Chart</a></li>
    72. 

  72. <li class="toctree-l2"><a class="reference internal" href="../overview/mvc.html">Model-View-Controller</a></li>
    73. 

  73. <li class="toctree-l2"><a class="reference internal" href="../overview/goals.html">Architectural Goals</a></li>
    74. 

  74. </ul>
    75. 

  75. </li>
    76. 

  76. </ul>
    77. 

  77. <ul>
    78. 

  78. <li class="toctree-l1"><a class="reference internal" href="../tutorial/index.html">Tutorial</a><ul>
    79. 

  79. <li class="toctree-l2"><a class="reference internal" href="../tutorial/static_pages.html">Static pages</a></li>
    80. 

  80. <li class="toctree-l2"><a class="reference internal" href="../tutorial/news_section.html">News section</a></li>
    81. 

  81. <li class="toctree-l2"><a class="reference internal" href="../tutorial/create_news_items.html">Create news items</a></li>
    82. 

  82. <li class="toctree-l2"><a class="reference internal" href="../tutorial/conclusion.html">Conclusion</a></li>
    83. 

  83. </ul>
    84. 

  84. </li>
    85. 

  85. </ul>
    86. 

  86. <ul>
    87. 

  87. <li class="toctree-l1"><a class="reference internal" href="../contributing/index.html">Contributing to CodeIgniter</a><ul>
    88. 

  88. <li class="toctree-l2"><a class="reference internal" href="../documentation/index.html">Writing CodeIgniter Documentation</a></li>
    89. 

  89. <li class="toctree-l2"><a class="reference internal" href="../DCO.html">Developer’s Certificate of Origin 1.1</a></li>
    90. 

  90. </ul>
    91. 

  91. </li>
    92. 

  92. </ul>
    93. 

  93. <ul>
    94. 

  94. <li class="toctree-l1"><a class="reference internal" href="../general/index.html">General Topics</a><ul>
    95. 

  95. <li class="toctree-l2"><a class="reference internal" href="../general/urls.html">CodeIgniter URLs</a></li>
    96. 

  96. <li class="toctree-l2"><a class="reference internal" href="../general/controllers.html">Controllers</a></li>
    97. 

  97. <li class="toctree-l2"><a class="reference internal" href="../general/reserved_names.html">Reserved Names</a></li>
    98. 

  98. <li class="toctree-l2"><a class="reference internal" href="../general/views.html">Views</a></li>
    99. 

  99. <li class="toctree-l2"><a class="reference internal" href="../general/models.html">Models</a></li>
    100. 

  100. <li class="toctree-l2"><a class="reference internal" href="../general/helpers.html">Helpers</a></li>
    101. 

  101. <li class="toctree-l2"><a class="reference internal" href="../general/libraries.html">Using CodeIgniter Libraries</a></li>
    102. 

  102. <li class="toctree-l2"><a class="reference internal" href="../general/creating_libraries.html">Creating Libraries</a></li>
    103. 

  103. <li class="toctree-l2"><a class="reference internal" href="../general/drivers.html">Using CodeIgniter Drivers</a></li>
    104. 

  104. <li class="toctree-l2"><a class="reference internal" href="../general/creating_drivers.html">Creating Drivers</a></li>
    105. 

  105. <li class="toctree-l2"><a class="reference internal" href="../general/core_classes.html">Creating Core System Classes</a></li>
    106. 

  106. <li class="toctree-l2"><a class="reference internal" href="../general/ancillary_classes.html">Creating Ancillary Classes</a></li>
    107. 

  107. <li class="toctree-l2"><a class="reference internal" href="../general/hooks.html">Hooks - Extending the Framework Core</a></li>
    108. 

  108. <li class="toctree-l2"><a class="reference internal" href="../general/autoloader.html">Auto-loading Resources</a></li>
    109. 

  109. <li class="toctree-l2"><a class="reference internal" href="../general/common_functions.html">Common Functions</a></li>
    110. 

  110. <li class="toctree-l2"><a class="reference internal" href="../general/compatibility_functions.html">Compatibility Functions</a></li>
    111. 

  111. <li class="toctree-l2"><a class="reference internal" href="../general/routing.html">URI Routing</a></li>
    112. 

  112. <li class="toctree-l2"><a class="reference internal" href="../general/errors.html">Error Handling</a></li>
    113. 

  113. <li class="toctree-l2"><a class="reference internal" href="../general/caching.html">Caching</a></li>
    114. 

  114. <li class="toctree-l2"><a class="reference internal" href="../general/profiling.html">Profiling Your Application</a></li>
    115. 

  115. <li class="toctree-l2"><a class="reference internal" href="../general/cli.html">Running via the CLI</a></li>
    116. 

  116. <li class="toctree-l2"><a class="reference internal" href="../general/managing_apps.html">Managing your Applications</a></li>
    117. 

  117. <li class="toctree-l2"><a class="reference internal" href="../general/environments.html">Handling Multiple Environments</a></li>
    118. 

  118. <li class="toctree-l2"><a class="reference internal" href="../general/alternative_php.html">Alternate PHP Syntax for View Files</a></li>
    119. 

  119. <li class="toctree-l2"><a class="reference internal" href="../general/security.html">Security</a></li>
    120. 

  120. <li class="toctree-l2"><a class="reference internal" href="../general/styleguide.html">PHP Style Guide</a></li>
    121. 

  121. </ul>
    122. 

  122. </li>
    123. 

  123. </ul>
    124. 

  124. <ul>
    125. 

  125. <li class="toctree-l1"><a class="reference internal" href="../libraries/index.html">Libraries</a><ul>
    126. 

  126. <li class="toctree-l2"><a class="reference internal" href="../libraries/benchmark.html">Benchmarking Class</a></li>
    127. 

  127. <li class="toctree-l2"><a class="reference internal" href="../libraries/caching.html">Caching Driver</a></li>
    128. 

  128. <li class="toctree-l2"><a class="reference internal" href="../libraries/calendar.html">Calendaring Class</a></li>
    129. 

  129. <li class="toctree-l2"><a class="reference internal" href="../libraries/cart.html">Shopping Cart Class</a></li>
    130. 

  130. <li class="toctree-l2"><a class="reference internal" href="../libraries/config.html">Config Class</a></li>
    131. 

  131. <li class="toctree-l2"><a class="reference internal" href="../libraries/email.html">Email Class</a></li>
    132. 

  132. <li class="toctree-l2"><a class="reference internal" href="../libraries/encrypt.html">Encrypt Class</a></li>
    133. 

  133. <li class="toctree-l2"><a class="reference internal" href="../libraries/encryption.html">Encryption Library</a></li>
    134. 

  134. <li class="toctree-l2"><a class="reference internal" href="../libraries/file_uploading.html">File Uploading Class</a></li>
    135. 

  135. <li class="toctree-l2"><a class="reference internal" href="../libraries/form_validation.html">Form Validation</a></li>
    136. 

  136. <li class="toctree-l2"><a class="reference internal" href="../libraries/ftp.html">FTP Class</a></li>
    137. 

  137. <li class="toctree-l2"><a class="reference internal" href="../libraries/image_lib.html">Image Manipulation Class</a></li>
    138. 

  138. <li class="toctree-l2"><a class="reference internal" href="../libraries/input.html">Input Class</a></li>
    139. 

  139. <li class="toctree-l2"><a class="reference internal" href="../libraries/javascript.html">Javascript Class</a></li>
    140. 

  140. <li class="toctree-l2"><a class="reference internal" href="../libraries/language.html">Language Class</a></li>
    141. 

  141. <li class="toctree-l2"><a class="reference internal" href="../libraries/loader.html">Loader Class</a></li>
    142. 

  142. <li class="toctree-l2"><a class="reference internal" href="../libraries/migration.html">Migrations Class</a></li>
    143. 

  143. <li class="toctree-l2"><a class="reference internal" href="../libraries/output.html">Output Class</a></li>
    144. 

  144. <li class="toctree-l2"><a class="reference internal" href="../libraries/pagination.html">Pagination Class</a></li>
    145. 

  145. <li class="toctree-l2"><a class="reference internal" href="../libraries/parser.html">Template Parser Class</a></li>
    146. 

  146. <li class="toctree-l2"><a class="reference internal" href="../libraries/security.html">Security Class</a></li>
    147. 

  147. <li class="toctree-l2"><a class="reference internal" href="../libraries/sessions.html">Session Library</a></li>
    148. 

  148. <li class="toctree-l2"><a class="reference internal" href="../libraries/table.html">HTML Table Class</a></li>
    149. 

  149. <li class="toctree-l2"><a class="reference internal" href="../libraries/trackback.html">Trackback Class</a></li>
    150. 

  150. <li class="toctree-l2"><a class="reference internal" href="../libraries/typography.html">Typography Class</a></li>
    151. 

  151. <li class="toctree-l2"><a class="reference internal" href="../libraries/unit_testing.html">Unit Testing Class</a></li>
    152. 

  152. <li class="toctree-l2"><a class="reference internal" href="../libraries/uri.html">URI Class</a></li>
    153. 

  153. <li class="toctree-l2"><a class="reference internal" href="../libraries/user_agent.html">User Agent Class</a></li>
    154. 

  154. <li class="toctree-l2"><a class="reference internal" href="../libraries/xmlrpc.html">XML-RPC and XML-RPC Server Classes</a></li>
    155. 

  155. <li class="toctree-l2"><a class="reference internal" href="../libraries/zip.html">Zip Encoding Class</a></li>
    156. 

  156. </ul>
    157. 

  157. </li>
    158. 

  158. </ul>
    159. 

  159. <ul>
    160. 

  160. <li class="toctree-l1"><a class="reference internal" href="../database/index.html">Database Reference</a><ul>
    161. 

  161. <li class="toctree-l2"><a class="reference internal" href="../database/examples.html">Quick Start: Usage Examples</a></li>
    162. 

  162. <li class="toctree-l2"><a class="reference internal" href="../database/configuration.html">Database Configuration</a></li>
    163. 

  163. <li class="toctree-l2"><a class="reference internal" href="../database/connecting.html">Connecting to a Database</a></li>
    164. 

  164. <li class="toctree-l2"><a class="reference internal" href="../database/queries.html">Running Queries</a></li>
    165. 

  165. <li class="toctree-l2"><a class="reference internal" href="../database/results.html">Generating Query Results</a></li>
    166. 

  166. <li class="toctree-l2"><a class="reference internal" href="../database/helpers.html">Query Helper Functions</a></li>
    167. 

  167. <li class="toctree-l2"><a class="reference internal" href="../database/query_builder.html">Query Builder Class</a></li>
    168. 

  168. <li class="toctree-l2"><a class="reference internal" href="../database/transactions.html">Transactions</a></li>
    169. 

  169. <li class="toctree-l2"><a class="reference internal" href="../database/metadata.html">Getting MetaData</a></li>
    170. 

  170. <li class="toctree-l2"><a class="reference internal" href="../database/call_function.html">Custom Function Calls</a></li>
    171. 

  171. <li class="toctree-l2"><a class="reference internal" href="../database/caching.html">Query Caching</a></li>
    172. 

  172. <li class="toctree-l2"><a class="reference internal" href="../database/forge.html">Database Manipulation with Database Forge</a></li>
    173. 

  173. <li class="toctree-l2"><a class="reference internal" href="../database/utilities.html">Database Utilities Class</a></li>
    174. 

  174. <li class="toctree-l2"><a class="reference internal" href="../database/db_driver_reference.html">Database Driver Reference</a></li>
    175. 

  175. </ul>
    176. 

  176. </li>
    177. 

  177. </ul>
    178. 

  178. <ul class="current">
    179. 

  179. <li class="toctree-l1 current"><a class="reference internal" href="index.html">Helpers</a><ul class="current">
    180. 

  180. <li class="toctree-l2"><a class="reference internal" href="array_helper.html">Array Helper</a></li>
    181. 

  181. <li class="toctree-l2"><a class="reference internal" href="captcha_helper.html">CAPTCHA Helper</a></li>
    182. 

  182. <li class="toctree-l2"><a class="reference internal" href="cookie_helper.html">Cookie Helper</a></li>
    183. 

  183. <li class="toctree-l2"><a class="reference internal" href="date_helper.html">Date Helper</a></li>
    184. 

  184. <li class="toctree-l2"><a class="reference internal" href="directory_helper.html">Directory Helper</a></li>
    185. 

  185. <li class="toctree-l2"><a class="reference internal" href="download_helper.html">Download Helper</a></li>
    186. 

  186. <li class="toctree-l2"><a class="reference internal" href="email_helper.html">Email Helper</a></li>
    187. 

  187. <li class="toctree-l2"><a class="reference internal" href="file_helper.html">File Helper</a></li>
    188. 

  188. <li class="toctree-l2"><a class="reference internal" href="form_helper.html">Form Helper</a></li>
    189. 

  189. <li class="toctree-l2"><a class="reference internal" href="html_helper.html">HTML Helper</a></li>
    190. 

  190. <li class="toctree-l2"><a class="reference internal" href="inflector_helper.html">Inflector Helper</a></li>
    191. 

  191. <li class="toctree-l2"><a class="reference internal" href="language_helper.html">Language Helper</a></li>
    192. 

  192. <li class="toctree-l2"><a class="reference internal" href="number_helper.html">Number Helper</a></li>
    193. 

  193. <li class="toctree-l2"><a class="reference internal" href="path_helper.html">Path Helper</a></li>
    194. 

  194. <li class="toctree-l2"><a class="reference internal" href="security_helper.html">Security Helper</a></li>
    195. 

  195. <li class="toctree-l2"><a class="reference internal" href="smiley_helper.html">Smiley Helper</a></li>
    196. 

  196. <li class="toctree-l2"><a class="reference internal" href="string_helper.html">String Helper</a></li>
    197. 

  197. <li class="toctree-l2 current"><a class="current reference internal" href="#">Text Helper</a></li>
    198. 

  198. <li class="toctree-l2"><a class="reference internal" href="typography_helper.html">Typography Helper</a></li>
    199. 

  199. <li class="toctree-l2"><a class="reference internal" href="url_helper.html">URL Helper</a></li>
    200. 

  200. <li class="toctree-l2"><a class="reference internal" href="xml_helper.html">XML Helper</a></li>
    201. 

  201. </ul>
    202. 

  202. </li>
    203. 

  203. </ul>
    204. 

  204. 

  205.       </div>
    206. 

  206.     
    207. 

  207.       
    208. 

  208.   </div>
    209. 

  209. </div>
    210. 

  210. <div id="nav2">
    211. 

  211.   <a href="#" id="openToc">
    212. 

  212.     <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" />
    213. 

  213.   </a>
    214. 

  214. </div>
    215. 

  215. 

  216.   <div class="wy-grid-for-nav">
    217. 

  217. 

  218.     
    219. 

  219.     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
    220. 

  220.       <div class="wy-side-nav-search">
    221. 

  221.         
    222. 

  222.           <a href="../index.html" class="fa fa-home"> CodeIgniter</a>
    223. 

  223.         
    224. 

  224.         
    225. 

  225. <div role="search">
    226. 

  226.   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
    227. 

  227.     <input type="text" name="q" placeholder="Search docs" />
    228. 

  228.     <input type="hidden" name="check_keywords" value="yes" />
    229. 

  229.     <input type="hidden" name="area" value="default" />
    230. 

  230.   </form>
    231. 

  231. </div>
    232. 

  232.       </div>
    233. 

  233. 

  234.       <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
    235. 

  235.         
    236. 

  236.           
    237. 

  237.           
    238. 

  238.               <ul>
    239. 

  239. <li class="toctree-l1"><a class="reference internal" href="../general/welcome.html">Welcome to CodeIgniter</a></li>
    240. 

  240. </ul>
    241. 

  241. <ul>
    242. 

  242. <li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installation Instructions</a><ul>
    243. 

  243. <li class="toctree-l2"><a class="reference internal" href="../installation/downloads.html">Downloading CodeIgniter</a></li>
    244. 

  244. <li class="toctree-l2"><a class="reference internal" href="../installation/index.html">Installation Instructions</a></li>
    245. 

  245. <li class="toctree-l2"><a class="reference internal" href="../installation/upgrading.html">Upgrading From a Previous Version</a></li>
    246. 

  246. <li class="toctree-l2"><a class="reference internal" href="../installation/troubleshooting.html">Troubleshooting</a></li>
    247. 

  247. </ul>
    248. 

  248. </li>
    249. 

  249. </ul>
    250. 

  250. <ul>
    251. 

  251. <li class="toctree-l1"><a class="reference internal" href="../overview/index.html">CodeIgniter Overview</a><ul>
    252. 

  252. <li class="toctree-l2"><a class="reference internal" href="../overview/getting_started.html">Getting Started</a></li>
    253. 

  253. <li class="toctree-l2"><a class="reference internal" href="../overview/at_a_glance.html">CodeIgniter at a Glance</a></li>
    254. 

  254. <li class="toctree-l2"><a class="reference internal" href="../overview/features.html">Supported Features</a></li>
    255. 

  255. <li class="toctree-l2"><a class="reference internal" href="../overview/appflow.html">Application Flow Chart</a></li>
    256. 

  256. <li class="toctree-l2"><a class="reference internal" href="../overview/mvc.html">Model-View-Controller</a></li>
    257. 

  257. <li class="toctree-l2"><a class="reference internal" href="../overview/goals.html">Architectural Goals</a></li>
    258. 

  258. </ul>
    259. 

  259. </li>
    260. 

  260. </ul>
    261. 

  261. <ul>
    262. 

  262. <li class="toctree-l1"><a class="reference internal" href="../tutorial/index.html">Tutorial</a><ul>
    263. 

  263. <li class="toctree-l2"><a class="reference internal" href="../tutorial/static_pages.html">Static pages</a></li>
    264. 

  264. <li class="toctree-l2"><a class="reference internal" href="../tutorial/news_section.html">News section</a></li>
    265. 

  265. <li class="toctree-l2"><a class="reference internal" href="../tutorial/create_news_items.html">Create news items</a></li>
    266. 

  266. <li class="toctree-l2"><a class="reference internal" href="../tutorial/conclusion.html">Conclusion</a></li>
    267. 

  267. </ul>
    268. 

  268. </li>
    269. 

  269. </ul>
    270. 

  270. <ul>
    271. 

  271. <li class="toctree-l1"><a class="reference internal" href="../contributing/index.html">Contributing to CodeIgniter</a><ul>
    272. 

  272. <li class="toctree-l2"><a class="reference internal" href="../documentation/index.html">Writing CodeIgniter Documentation</a></li>
    273. 

  273. <li class="toctree-l2"><a class="reference internal" href="../DCO.html">Developer’s Certificate of Origin 1.1</a></li>
    274. 

  274. </ul>
    275. 

  275. </li>
    276. 

  276. </ul>
    277. 

  277. <ul>
    278. 

  278. <li class="toctree-l1"><a class="reference internal" href="../general/index.html">General Topics</a><ul>
    279. 

  279. <li class="toctree-l2"><a class="reference internal" href="../general/urls.html">CodeIgniter URLs</a></li>
    280. 

  280. <li class="toctree-l2"><a class="reference internal" href="../general/controllers.html">Controllers</a></li>
    281. 

  281. <li class="toctree-l2"><a class="reference internal" href="../general/reserved_names.html">Reserved Names</a></li>
    282. 

  282. <li class="toctree-l2"><a class="reference internal" href="../general/views.html">Views</a></li>
    283. 

  283. <li class="toctree-l2"><a class="reference internal" href="../general/models.html">Models</a></li>
    284. 

  284. <li class="toctree-l2"><a class="reference internal" href="../general/helpers.html">Helpers</a></li>
    285. 

  285. <li class="toctree-l2"><a class="reference internal" href="../general/libraries.html">Using CodeIgniter Libraries</a></li>
    286. 

  286. <li class="toctree-l2"><a class="reference internal" href="../general/creating_libraries.html">Creating Libraries</a></li>
    287. 

  287. <li class="toctree-l2"><a class="reference internal" href="../general/drivers.html">Using CodeIgniter Drivers</a></li>
    288. 

  288. <li class="toctree-l2"><a class="reference internal" href="../general/creating_drivers.html">Creating Drivers</a></li>
    289. 

  289. <li class="toctree-l2"><a class="reference internal" href="../general/core_classes.html">Creating Core System Classes</a></li>
    290. 

  290. <li class="toctree-l2"><a class="reference internal" href="../general/ancillary_classes.html">Creating Ancillary Classes</a></li>
    291. 

  291. <li class="toctree-l2"><a class="reference internal" href="../general/hooks.html">Hooks - Extending the Framework Core</a></li>
    292. 

  292. <li class="toctree-l2"><a class="reference internal" href="../general/autoloader.html">Auto-loading Resources</a></li>
    293. 

  293. <li class="toctree-l2"><a class="reference internal" href="../general/common_functions.html">Common Functions</a></li>
    294. 

  294. <li class="toctree-l2"><a class="reference internal" href="../general/compatibility_functions.html">Compatibility Functions</a></li>
    295. 

  295. <li class="toctree-l2"><a class="reference internal" href="../general/routing.html">URI Routing</a></li>
    296. 

  296. <li class="toctree-l2"><a class="reference internal" href="../general/errors.html">Error Handling</a></li>
    297. 

  297. <li class="toctree-l2"><a class="reference internal" href="../general/caching.html">Caching</a></li>
    298. 

  298. <li class="toctree-l2"><a class="reference internal" href="../general/profiling.html">Profiling Your Application</a></li>
    299. 

  299. <li class="toctree-l2"><a class="reference internal" href="../general/cli.html">Running via the CLI</a></li>
    300. 

  300. <li class="toctree-l2"><a class="reference internal" href="../general/managing_apps.html">Managing your Applications</a></li>
    301. 

  301. <li class="toctree-l2"><a class="reference internal" href="../general/environments.html">Handling Multiple Environments</a></li>
    302. 

  302. <li class="toctree-l2"><a class="reference internal" href="../general/alternative_php.html">Alternate PHP Syntax for View Files</a></li>
    303. 

  303. <li class="toctree-l2"><a class="reference internal" href="../general/security.html">Security</a></li>
    304. 

  304. <li class="toctree-l2"><a class="reference internal" href="../general/styleguide.html">PHP Style Guide</a></li>
    305. 

  305. </ul>
    306. 

  306. </li>
    307. 

  307. </ul>
    308. 

  308. <ul>
    309. 

  309. <li class="toctree-l1"><a class="reference internal" href="../libraries/index.html">Libraries</a><ul>
    310. 

  310. <li class="toctree-l2"><a class="reference internal" href="../libraries/benchmark.html">Benchmarking Class</a></li>
    311. 

  311. <li class="toctree-l2"><a class="reference internal" href="../libraries/caching.html">Caching Driver</a></li>
    312. 

  312. <li class="toctree-l2"><a class="reference internal" href="../libraries/calendar.html">Calendaring Class</a></li>
    313. 

  313. <li class="toctree-l2"><a class="reference internal" href="../libraries/cart.html">Shopping Cart Class</a></li>
    314. 

  314. <li class="toctree-l2"><a class="reference internal" href="../libraries/config.html">Config Class</a></li>
    315. 

  315. <li class="toctree-l2"><a class="reference internal" href="../libraries/email.html">Email Class</a></li>
    316. 

  316. <li class="toctree-l2"><a class="reference internal" href="../libraries/encrypt.html">Encrypt Class</a></li>
    317. 

  317. <li class="toctree-l2"><a class="reference internal" href="../libraries/encryption.html">Encryption Library</a></li>
    318. 

  318. <li class="toctree-l2"><a class="reference internal" href="../libraries/file_uploading.html">File Uploading Class</a></li>
    319. 

  319. <li class="toctree-l2"><a class="reference internal" href="../libraries/form_validation.html">Form Validation</a></li>
    320. 

  320. <li class="toctree-l2"><a class="reference internal" href="../libraries/ftp.html">FTP Class</a></li>
    321. 

  321. <li class="toctree-l2"><a class="reference internal" href="../libraries/image_lib.html">Image Manipulation Class</a></li>
    322. 

  322. <li class="toctree-l2"><a class="reference internal" href="../libraries/input.html">Input Class</a></li>
    323. 

  323. <li class="toctree-l2"><a class="reference internal" href="../libraries/javascript.html">Javascript Class</a></li>
    324. 

  324. <li class="toctree-l2"><a class="reference internal" href="../libraries/language.html">Language Class</a></li>
    325. 

  325. <li class="toctree-l2"><a class="reference internal" href="../libraries/loader.html">Loader Class</a></li>
    326. 

  326. <li class="toctree-l2"><a class="reference internal" href="../libraries/migration.html">Migrations Class</a></li>
    327. 

  327. <li class="toctree-l2"><a class="reference internal" href="../libraries/output.html">Output Class</a></li>
    328. 

  328. <li class="toctree-l2"><a class="reference internal" href="../libraries/pagination.html">Pagination Class</a></li>
    329. 

  329. <li class="toctree-l2"><a class="reference internal" href="../libraries/parser.html">Template Parser Class</a></li>
    330. 

  330. <li class="toctree-l2"><a class="reference internal" href="../libraries/security.html">Security Class</a></li>
    331. 

  331. <li class="toctree-l2"><a class="reference internal" href="../libraries/sessions.html">Session Library</a></li>
    332. 

  332. <li class="toctree-l2"><a class="reference internal" href="../libraries/table.html">HTML Table Class</a></li>
    333. 

  333. <li class="toctree-l2"><a class="reference internal" href="../libraries/trackback.html">Trackback Class</a></li>
    334. 

  334. <li class="toctree-l2"><a class="reference internal" href="../libraries/typography.html">Typography Class</a></li>
    335. 

  335. <li class="toctree-l2"><a class="reference internal" href="../libraries/unit_testing.html">Unit Testing Class</a></li>
    336. 

  336. <li class="toctree-l2"><a class="reference internal" href="../libraries/uri.html">URI Class</a></li>
    337. 

  337. <li class="toctree-l2"><a class="reference internal" href="../libraries/user_agent.html">User Agent Class</a></li>
    338. 

  338. <li class="toctree-l2"><a class="reference internal" href="../libraries/xmlrpc.html">XML-RPC and XML-RPC Server Classes</a></li>
    339. 

  339. <li class="toctree-l2"><a class="reference internal" href="../libraries/zip.html">Zip Encoding Class</a></li>
    340. 

  340. </ul>
    341. 

  341. </li>
    342. 

  342. </ul>
    343. 

  343. <ul>
    344. 

  344. <li class="toctree-l1"><a class="reference internal" href="../database/index.html">Database Reference</a><ul>
    345. 

  345. <li class="toctree-l2"><a class="reference internal" href="../database/examples.html">Quick Start: Usage Examples</a></li>
    346. 

  346. <li class="toctree-l2"><a class="reference internal" href="../database/configuration.html">Database Configuration</a></li>
    347. 

  347. <li class="toctree-l2"><a class="reference internal" href="../database/connecting.html">Connecting to a Database</a></li>
    348. 

  348. <li class="toctree-l2"><a class="reference internal" href="../database/queries.html">Running Queries</a></li>
    349. 

  349. <li class="toctree-l2"><a class="reference internal" href="../database/results.html">Generating Query Results</a></li>
    350. 

  350. <li class="toctree-l2"><a class="reference internal" href="../database/helpers.html">Query Helper Functions</a></li>
    351. 

  351. <li class="toctree-l2"><a class="reference internal" href="../database/query_builder.html">Query Builder Class</a></li>
    352. 

  352. <li class="toctree-l2"><a class="reference internal" href="../database/transactions.html">Transactions</a></li>
    353. 

  353. <li class="toctree-l2"><a class="reference internal" href="../database/metadata.html">Getting MetaData</a></li>
    354. 

  354. <li class="toctree-l2"><a class="reference internal" href="../database/call_function.html">Custom Function Calls</a></li>
    355. 

  355. <li class="toctree-l2"><a class="reference internal" href="../database/caching.html">Query Caching</a></li>
    356. 

  356. <li class="toctree-l2"><a class="reference internal" href="../database/forge.html">Database Manipulation with Database Forge</a></li>
    357. 

  357. <li class="toctree-l2"><a class="reference internal" href="../database/utilities.html">Database Utilities Class</a></li>
    358. 

  358. <li class="toctree-l2"><a class="reference internal" href="../database/db_driver_reference.html">Database Driver Reference</a></li>
    359. 

  359. </ul>
    360. 

  360. </li>
    361. 

  361. </ul>
    362. 

  362. <ul class="current">
    363. 

  363. <li class="toctree-l1 current"><a class="reference internal" href="index.html">Helpers</a><ul class="current">
    364. 

  364. <li class="toctree-l2"><a class="reference internal" href="array_helper.html">Array Helper</a></li>
    365. 

  365. <li class="toctree-l2"><a class="reference internal" href="captcha_helper.html">CAPTCHA Helper</a></li>
    366. 

  366. <li class="toctree-l2"><a class="reference internal" href="cookie_helper.html">Cookie Helper</a></li>
    367. 

  367. <li class="toctree-l2"><a class="reference internal" href="date_helper.html">Date Helper</a></li>
    368. 

  368. <li class="toctree-l2"><a class="reference internal" href="directory_helper.html">Directory Helper</a></li>
    369. 

  369. <li class="toctree-l2"><a class="reference internal" href="download_helper.html">Download Helper</a></li>
    370. 

  370. <li class="toctree-l2"><a class="reference internal" href="email_helper.html">Email Helper</a></li>
    371. 

  371. <li class="toctree-l2"><a class="reference internal" href="file_helper.html">File Helper</a></li>
    372. 

  372. <li class="toctree-l2"><a class="reference internal" href="form_helper.html">Form Helper</a></li>
    373. 

  373. <li class="toctree-l2"><a class="reference internal" href="html_helper.html">HTML Helper</a></li>
    374. 

  374. <li class="toctree-l2"><a class="reference internal" href="inflector_helper.html">Inflector Helper</a></li>
    375. 

  375. <li class="toctree-l2"><a class="reference internal" href="language_helper.html">Language Helper</a></li>
    376. 

  376. <li class="toctree-l2"><a class="reference internal" href="number_helper.html">Number Helper</a></li>
    377. 

  377. <li class="toctree-l2"><a class="reference internal" href="path_helper.html">Path Helper</a></li>
    378. 

  378. <li class="toctree-l2"><a class="reference internal" href="security_helper.html">Security Helper</a></li>
    379. 

  379. <li class="toctree-l2"><a class="reference internal" href="smiley_helper.html">Smiley Helper</a></li>
    380. 

  380. <li class="toctree-l2"><a class="reference internal" href="string_helper.html">String Helper</a></li>
    381. 

  381. <li class="toctree-l2 current"><a class="current reference internal" href="#">Text Helper</a></li>
    382. 

  382. <li class="toctree-l2"><a class="reference internal" href="typography_helper.html">Typography Helper</a></li>
    383. 

  383. <li class="toctree-l2"><a class="reference internal" href="url_helper.html">URL Helper</a></li>
    384. 

  384. <li class="toctree-l2"><a class="reference internal" href="xml_helper.html">XML Helper</a></li>
    385. 

  385. </ul>
    386. 

  386. </li>
    387. 

  387. </ul>
    388. 

  388. 

  389.           
    390. 

  390.         
    391. 

  391.       </div>
    392. 

  392.       &nbsp;
    393. 

  393.     </nav>
    394. 

  394. 

  395.     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
    396. 

  396. 

  397.       
    398. 

  398.       <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
    399. 

  399.         <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
    400. 

  400.         <a href="../index.html">CodeIgniter</a>
    401. 

  401.       </nav>
    402. 

  402. 

  403. 

  404.       
    405. 

  405.       <div class="wy-nav-content">
    406. 

  406.         <div class="rst-content">
    407. 

  407.           <div role="navigation" aria-label="breadcrumbs navigation">
    408. 

  408.   <ul class="wy-breadcrumbs">
    409. 

  409.     <li><a href="../index.html">Docs</a> &raquo;</li>
    410. 

  410.       
    411. 

  411.         <li><a href="index.html">Helpers</a> &raquo;</li>
    412. 

  412.       
    413. 

  413.     <li>Text Helper</li>
    414. 

  414.     <li class="wy-breadcrumbs-aside">
    415. 

  415.       
    416. 

  416.     </li>
    417. 

  417.     <div style="float:right;margin-left:5px;" id="closeMe">
    418. 

  418.       <img title="Classic Layout" alt="classic layout" src="data:image/gif;base64,R0lGODlhFAAUAJEAAAAAADMzM////wAAACH5BAUUAAIALAAAAAAUABQAAAImlI+py+0PU5gRBRDM3DxbWoXis42X13USOLauUIqnlsaH/eY6UwAAOw==" />
    419. 

  419.     </div>
    420. 

  420.   </ul>
    421. 

  421.   <hr/>
    422. 

  422. </div>
    423. 

  423.           <div role="main" class="document">
    424. 

  424.             
    425. 

  425.   <div class="section" id="text-helper">
    426. 

  426. <h1>Text Helper<a class="headerlink" href="#text-helper" title="Permalink to this headline"></a></h1>
    427. 

  427. <p>The Text Helper file contains functions that assist in working with
    428. 

  428. text.</p>
    429. 

  429. <div class="contents local topic" id="contents">
    430. 

  430. <ul class="simple">
    431. 

  431. <li><a class="reference internal" href="#loading-this-helper" id="id1">Loading this Helper</a></li>
    432. 

  432. <li><a class="reference internal" href="#available-functions" id="id2">Available Functions</a></li>
    433. 

  433. </ul>
    434. 

  434. </div>
    435. 

  435. <div class="custom-index container"></div><div class="section" id="loading-this-helper">
    436. 

  436. <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>
    437. 

  437. <p>This helper is loaded using the following code:</p>
    438. 

  438. <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">load</span><span class="o">-&gt;</span><span class="na">helper</span><span class="p">(</span><span class="s1">&#39;text&#39;</span><span class="p">);</span>
    439. 

  439. </pre></div>
    440. 

  440. </div>
    441. 

  441. </div>
    442. 

  442. <div class="section" id="available-functions">
    443. 

  443. <h2><a class="toc-backref" href="#id2">Available Functions</a><a class="headerlink" href="#available-functions" title="Permalink to this headline"></a></h2>
    444. 

  444. <p>The following functions are available:</p>
    445. 

  445. <dl class="function">
    446. 

  446. <dt id="word_limiter">
    447. 

  447. <code class="descname">word_limiter</code><span class="sig-paren">(</span><em>$str</em><span class="optional">[</span>, <em>$limit = 100</em><span class="optional">[</span>, <em>$end_char = '&amp;#8230;'</em><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#word_limiter" title="Permalink to this definition"></a></dt>
    448. 

  448. <dd><table class="docutils field-list" frame="void" rules="none">
    449. 

  449. <col class="field-name" />
    450. 

  450. <col class="field-body" />
    451. 

  451. <tbody valign="top">
    452. 

  452. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    453. 

  453. <li><strong>$str</strong> (<em>string</em>) – Input string</li>
    454. 

  454. <li><strong>$limit</strong> (<em>int</em>) – Limit</li>
    455. 

  455. <li><strong>$end_char</strong> (<em>string</em>) – End character (usually an ellipsis)</li>
    456. 

  456. </ul>
    457. 

  457. </td>
    458. 

  458. </tr>
    459. 

  459. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Word-limited string</p>
    460. 

  460. </td>
    461. 

  461. </tr>
    462. 

  462. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
    463. 

  463. </td>
    464. 

  464. </tr>
    465. 

  465. </tbody>
    466. 

  466. </table>
    467. 

  467. <p>Truncates a string to the number of <em>words</em> specified. Example:</p>
    468. 

  468. <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$string</span> <span class="o">=</span> <span class="s2">&quot;Here is a nice text string consisting of eleven words.&quot;</span><span class="p">;</span>
    469. 

  469. <span class="nv">$string</span> <span class="o">=</span> <span class="nx">word_limiter</span><span class="p">(</span><span class="nv">$string</span><span class="p">,</span> <span class="mi">4</span><span class="p">);</span>
    470. 

  470. <span class="c1">// Returns:  Here is a nice</span>
    471. 

  471. </pre></div>
    472. 

  472. </div>
    473. 

  473. <p>The third parameter is an optional suffix added to the string. By
    474. 

  474. default it adds an ellipsis.</p>
    475. 

  475. </dd></dl>
    476. 

  476. 

  477. <dl class="function">
    478. 

  478. <dt id="character_limiter">
    479. 

  479. <code class="descname">character_limiter</code><span class="sig-paren">(</span><em>$str</em><span class="optional">[</span>, <em>$n = 500</em><span class="optional">[</span>, <em>$end_char = '&amp;#8230;'</em><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#character_limiter" title="Permalink to this definition"></a></dt>
    480. 

  480. <dd><table class="docutils field-list" frame="void" rules="none">
    481. 

  481. <col class="field-name" />
    482. 

  482. <col class="field-body" />
    483. 

  483. <tbody valign="top">
    484. 

  484. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    485. 

  485. <li><strong>$str</strong> (<em>string</em>) – Input string</li>
    486. 

  486. <li><strong>$n</strong> (<em>int</em>) – Number of characters</li>
    487. 

  487. <li><strong>$end_char</strong> (<em>string</em>) – End character (usually an ellipsis)</li>
    488. 

  488. </ul>
    489. 

  489. </td>
    490. 

  490. </tr>
    491. 

  491. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Character-limited string</p>
    492. 

  492. </td>
    493. 

  493. </tr>
    494. 

  494. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
    495. 

  495. </td>
    496. 

  496. </tr>
    497. 

  497. </tbody>
    498. 

  498. </table>
    499. 

  499. <p>Truncates a string to the number of <em>characters</em> specified. It
    500. 

  500. maintains the integrity of words so the character count may be slightly
    501. 

  501. more or less than what you specify.</p>
    502. 

  502. <p>Example:</p>
    503. 

  503. <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$string</span> <span class="o">=</span> <span class="s2">&quot;Here is a nice text string consisting of eleven words.&quot;</span><span class="p">;</span>
    504. 

  504. <span class="nv">$string</span> <span class="o">=</span> <span class="nx">character_limiter</span><span class="p">(</span><span class="nv">$string</span><span class="p">,</span> <span class="mi">20</span><span class="p">);</span>
    505. 

  505. <span class="c1">// Returns:  Here is a nice text string</span>
    506. 

  506. </pre></div>
    507. 

  507. </div>
    508. 

  508. <p>The third parameter is an optional suffix added to the string, if
    509. 

  509. undeclared this helper uses an ellipsis.</p>
    510. 

  510. <div class="admonition note">
    511. 

  511. <p class="first admonition-title">Note</p>
    512. 

  512. <p class="last">If you need to truncate to an exact number of characters please
    513. 

  513. see the <a class="reference internal" href="#ellipsize" title="ellipsize"><code class="xref php php-func docutils literal"><span class="pre">ellipsize()</span></code></a> function below.</p>
    514. 

  514. </div>
    515. 

  515. </dd></dl>
    516. 

  516. 

  517. <dl class="function">
    518. 

  518. <dt id="ascii_to_entities">
    519. 

  519. <code class="descname">ascii_to_entities</code><span class="sig-paren">(</span><em>$str</em><span class="sig-paren">)</span><a class="headerlink" href="#ascii_to_entities" title="Permalink to this definition"></a></dt>
    520. 

  520. <dd><table class="docutils field-list" frame="void" rules="none">
    521. 

  521. <col class="field-name" />
    522. 

  522. <col class="field-body" />
    523. 

  523. <tbody valign="top">
    524. 

  524. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    525. 

  525. <li><strong>$str</strong> (<em>string</em>) – Input string</li>
    526. 

  526. </ul>
    527. 

  527. </td>
    528. 

  528. </tr>
    529. 

  529. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">A string with ASCII values converted to entities</p>
    530. 

  530. </td>
    531. 

  531. </tr>
    532. 

  532. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
    533. 

  533. </td>
    534. 

  534. </tr>
    535. 

  535. </tbody>
    536. 

  536. </table>
    537. 

  537. <p>Converts ASCII values to character entities, including high ASCII and MS
    538. 

  538. Word characters that can cause problems when used in a web page, so that
    539. 

  539. they can be shown consistently regardless of browser settings or stored
    540. 

  540. reliably in a database. There is some dependence on your server’s
    541. 

  541. supported character sets, so it may not be 100% reliable in all cases,
    542. 

  542. but for the most part it should correctly identify characters outside
    543. 

  543. the normal range (like accented characters).</p>
    544. 

  544. <p>Example:</p>
    545. 

  545. <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$string</span> <span class="o">=</span> <span class="nx">ascii_to_entities</span><span class="p">(</span><span class="nv">$string</span><span class="p">);</span>
    546. 

  546. </pre></div>
    547. 

  547. </div>
    548. 

  548. </dd></dl>
    549. 

  549. 

  550. <dl class="function">
    551. 

  551. <dt id="convert_accented_characters">
    552. 

  552. <code class="descname">convert_accented_characters</code><span class="sig-paren">(</span><em>$str</em><span class="sig-paren">)</span><a class="headerlink" href="#convert_accented_characters" title="Permalink to this definition"></a></dt>
    553. 

  553. <dd><table class="docutils field-list" frame="void" rules="none">
    554. 

  554. <col class="field-name" />
    555. 

  555. <col class="field-body" />
    556. 

  556. <tbody valign="top">
    557. 

  557. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    558. 

  558. <li><strong>$str</strong> (<em>string</em>) – Input string</li>
    559. 

  559. </ul>
    560. 

  560. </td>
    561. 

  561. </tr>
    562. 

  562. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">A string with accented characters converted</p>
    563. 

  563. </td>
    564. 

  564. </tr>
    565. 

  565. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
    566. 

  566. </td>
    567. 

  567. </tr>
    568. 

  568. </tbody>
    569. 

  569. </table>
    570. 

  570. <p>Transliterates high ASCII characters to low ASCII equivalents. Useful
    571. 

  571. when non-English characters need to be used where only standard ASCII
    572. 

  572. characters are safely used, for instance, in URLs.</p>
    573. 

  573. <p>Example:</p>
    574. 

  574. <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$string</span> <span class="o">=</span> <span class="nx">convert_accented_characters</span><span class="p">(</span><span class="nv">$string</span><span class="p">);</span>
    575. 

  575. </pre></div>
    576. 

  576. </div>
    577. 

  577. <div class="admonition note">
    578. 

  578. <p class="first admonition-title">Note</p>
    579. 

  579. <p class="last">This function uses a companion config file
    580. 

  580. <cite>application/config/foreign_chars.php</cite> to define the to and
    581. 

  581. from array for transliteration.</p>
    582. 

  582. </div>
    583. 

  583. </dd></dl>
    584. 

  584. 

  585. <dl class="function">
    586. 

  586. <dt id="word_censor">
    587. 

  587. <code class="descname">word_censor</code><span class="sig-paren">(</span><em>$str</em>, <em>$censored</em><span class="optional">[</span>, <em>$replacement = ''</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#word_censor" title="Permalink to this definition"></a></dt>
    588. 

  588. <dd><table class="docutils field-list" frame="void" rules="none">
    589. 

  589. <col class="field-name" />
    590. 

  590. <col class="field-body" />
    591. 

  591. <tbody valign="top">
    592. 

  592. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    593. 

  593. <li><strong>$str</strong> (<em>string</em>) – Input string</li>
    594. 

  594. <li><strong>$censored</strong> (<em>array</em>) – List of bad words to censor</li>
    595. 

  595. <li><strong>$replacement</strong> (<em>string</em>) – What to replace bad words with</li>
    596. 

  596. </ul>
    597. 

  597. </td>
    598. 

  598. </tr>
    599. 

  599. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Censored string</p>
    600. 

  600. </td>
    601. 

  601. </tr>
    602. 

  602. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
    603. 

  603. </td>
    604. 

  604. </tr>
    605. 

  605. </tbody>
    606. 

  606. </table>
    607. 

  607. <p>Enables you to censor words within a text string. The first parameter
    608. 

  608. will contain the original string. The second will contain an array of
    609. 

  609. words which you disallow. The third (optional) parameter can contain
    610. 

  610. a replacement value for the words. If not specified they are replaced
    611. 

  611. with pound signs: ####.</p>
    612. 

  612. <p>Example:</p>
    613. 

  613. <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$disallowed</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span><span class="s1">&#39;darn&#39;</span><span class="p">,</span> <span class="s1">&#39;shucks&#39;</span><span class="p">,</span> <span class="s1">&#39;golly&#39;</span><span class="p">,</span> <span class="s1">&#39;phooey&#39;</span><span class="p">);</span>
    614. 

  614. <span class="nv">$string</span> <span class="o">=</span> <span class="nx">word_censor</span><span class="p">(</span><span class="nv">$string</span><span class="p">,</span> <span class="nv">$disallowed</span><span class="p">,</span> <span class="s1">&#39;Beep!&#39;</span><span class="p">);</span>
    615. 

  615. </pre></div>
    616. 

  616. </div>
    617. 

  617. </dd></dl>
    618. 

  618. 

  619. <dl class="function">
    620. 

  620. <dt id="highlight_code">
    621. 

  621. <code class="descname">highlight_code</code><span class="sig-paren">(</span><em>$str</em><span class="sig-paren">)</span><a class="headerlink" href="#highlight_code" title="Permalink to this definition"></a></dt>
    622. 

  622. <dd><table class="docutils field-list" frame="void" rules="none">
    623. 

  623. <col class="field-name" />
    624. 

  624. <col class="field-body" />
    625. 

  625. <tbody valign="top">
    626. 

  626. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    627. 

  627. <li><strong>$str</strong> (<em>string</em>) – Input string</li>
    628. 

  628. </ul>
    629. 

  629. </td>
    630. 

  630. </tr>
    631. 

  631. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">String with code highlighted via HTML</p>
    632. 

  632. </td>
    633. 

  633. </tr>
    634. 

  634. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
    635. 

  635. </td>
    636. 

  636. </tr>
    637. 

  637. </tbody>
    638. 

  638. </table>
    639. 

  639. <p>Colorizes a string of code (PHP, HTML, etc.). Example:</p>
    640. 

  640. <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$string</span> <span class="o">=</span> <span class="nx">highlight_code</span><span class="p">(</span><span class="nv">$string</span><span class="p">);</span>
    641. 

  641. </pre></div>
    642. 

  642. </div>
    643. 

  643. <p>The function uses PHP’s <code class="docutils literal"><span class="pre">highlight_string()</span></code> function, so the
    644. 

  644. colors used are the ones specified in your php.ini file.</p>
    645. 

  645. </dd></dl>
    646. 

  646. 

  647. <dl class="function">
    648. 

  648. <dt id="highlight_phrase">
    649. 

  649. <code class="descname">highlight_phrase</code><span class="sig-paren">(</span><em>$str</em>, <em>$phrase</em><span class="optional">[</span>, <em>$tag_open = '&lt;mark&gt;'</em><span class="optional">[</span>, <em>$tag_close = '&lt;/mark&gt;'</em><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#highlight_phrase" title="Permalink to this definition"></a></dt>
    650. 

  650. <dd><table class="docutils field-list" frame="void" rules="none">
    651. 

  651. <col class="field-name" />
    652. 

  652. <col class="field-body" />
    653. 

  653. <tbody valign="top">
    654. 

  654. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    655. 

  655. <li><strong>$str</strong> (<em>string</em>) – Input string</li>
    656. 

  656. <li><strong>$phrase</strong> (<em>string</em>) – Phrase to highlight</li>
    657. 

  657. <li><strong>$tag_open</strong> (<em>string</em>) – Opening tag used for the highlight</li>
    658. 

  658. <li><strong>$tag_close</strong> (<em>string</em>) – Closing tag for the highlight</li>
    659. 

  659. </ul>
    660. 

  660. </td>
    661. 

  661. </tr>
    662. 

  662. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">String with a phrase highlighted via HTML</p>
    663. 

  663. </td>
    664. 

  664. </tr>
    665. 

  665. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
    666. 

  666. </td>
    667. 

  667. </tr>
    668. 

  668. </tbody>
    669. 

  669. </table>
    670. 

  670. <p>Will highlight a phrase within a text string. The first parameter will
    671. 

  671. contain the original string, the second will contain the phrase you wish
    672. 

  672. to highlight. The third and fourth parameters will contain the
    673. 

  673. opening/closing HTML tags you would like the phrase wrapped in.</p>
    674. 

  674. <p>Example:</p>
    675. 

  675. <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$string</span> <span class="o">=</span> <span class="s2">&quot;Here is a nice text string about nothing in particular.&quot;</span><span class="p">;</span>
    676. 

  676. <span class="k">echo</span> <span class="nx">highlight_phrase</span><span class="p">(</span><span class="nv">$string</span><span class="p">,</span> <span class="s2">&quot;nice text&quot;</span><span class="p">,</span> <span class="s1">&#39;&lt;span style=&quot;color:#990000;&quot;&gt;&#39;</span><span class="p">,</span> <span class="s1">&#39;&lt;/span&gt;&#39;</span><span class="p">);</span>
    677. 

  677. </pre></div>
    678. 

  678. </div>
    679. 

  679. <p>The above code prints:</p>
    680. 

  680. <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nx">Here</span> <span class="nx">is</span> <span class="nx">a</span> <span class="o">&lt;</span><span class="nx">span</span> <span class="nx">style</span><span class="o">=</span><span class="s2">&quot;color:#990000;&quot;</span><span class="o">&gt;</span><span class="nx">nice</span> <span class="nx">text</span><span class="o">&lt;/</span><span class="nx">span</span><span class="o">&gt;</span> <span class="nx">string</span> <span class="nx">about</span> <span class="nx">nothing</span> <span class="nx">in</span> <span class="nx">particular</span><span class="o">.</span>
    681. 

  681. </pre></div>
    682. 

  682. </div>
    683. 

  683. <div class="admonition note">
    684. 

  684. <p class="first admonition-title">Note</p>
    685. 

  685. <p>This function used to use the <code class="docutils literal"><span class="pre">&lt;strong&gt;</span></code> tag by default. Older browsers
    686. 

  686. might not support the new HTML5 mark tag, so it is recommended that you
    687. 

  687. insert the following CSS code into your stylesheet if you need to support
    688. 

  688. such browsers:</p>
    689. 

  689. <div class="last highlight-ci"><div class="highlight"><pre><span></span><span class="nx">mark</span> <span class="p">{</span>
    690. 

  690.         <span class="nx">background</span><span class="o">:</span> <span class="c1">#ff0;</span>
    691. 

  691.         <span class="nx">color</span><span class="o">:</span> <span class="c1">#000;</span>
    692. 

  692. <span class="p">};</span>
    693. 

  693. </pre></div>
    694. 

  694. </div>
    695. 

  695. </div>
    696. 

  696. </dd></dl>
    697. 

  697. 

  698. <dl class="function">
    699. 

  699. <dt id="word_wrap">
    700. 

  700. <code class="descname">word_wrap</code><span class="sig-paren">(</span><em>$str</em><span class="optional">[</span>, <em>$charlim = 76</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#word_wrap" title="Permalink to this definition"></a></dt>
    701. 

  701. <dd><table class="docutils field-list" frame="void" rules="none">
    702. 

  702. <col class="field-name" />
    703. 

  703. <col class="field-body" />
    704. 

  704. <tbody valign="top">
    705. 

  705. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    706. 

  706. <li><strong>$str</strong> (<em>string</em>) – Input string</li>
    707. 

  707. <li><strong>$charlim</strong> (<em>int</em>) – Character limit</li>
    708. 

  708. </ul>
    709. 

  709. </td>
    710. 

  710. </tr>
    711. 

  711. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Word-wrapped string</p>
    712. 

  712. </td>
    713. 

  713. </tr>
    714. 

  714. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
    715. 

  715. </td>
    716. 

  716. </tr>
    717. 

  717. </tbody>
    718. 

  718. </table>
    719. 

  719. <p>Wraps text at the specified <em>character</em> count while maintaining
    720. 

  720. complete words.</p>
    721. 

  721. <p>Example:</p>
    722. 

  722. <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$string</span> <span class="o">=</span> <span class="s2">&quot;Here is a simple string of text that will help us demonstrate this function.&quot;</span><span class="p">;</span>
    723. 

  723. <span class="k">echo</span> <span class="nx">word_wrap</span><span class="p">(</span><span class="nv">$string</span><span class="p">,</span> <span class="mi">25</span><span class="p">);</span>
    724. 

  724. 

  725. <span class="c1">// Would produce:</span>
    726. 

  726. <span class="c1">// Here is a simple string</span>
    727. 

  727. <span class="c1">// of text that will help us</span>
    728. 

  728. <span class="c1">// demonstrate this</span>
    729. 

  729. <span class="c1">// function.</span>
    730. 

  730. </pre></div>
    731. 

  731. </div>
    732. 

  732. </dd></dl>
    733. 

  733. 

  734. <dl class="function">
    735. 

  735. <dt id="ellipsize">
    736. 

  736. <code class="descname">ellipsize</code><span class="sig-paren">(</span><em>$str</em>, <em>$max_length</em><span class="optional">[</span>, <em>$position = 1</em><span class="optional">[</span>, <em>$ellipsis = '&amp;hellip;'</em><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#ellipsize" title="Permalink to this definition"></a></dt>
    737. 

  737. <dd><table class="docutils field-list" frame="void" rules="none">
    738. 

  738. <col class="field-name" />
    739. 

  739. <col class="field-body" />
    740. 

  740. <tbody valign="top">
    741. 

  741. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    742. 

  742. <li><strong>$str</strong> (<em>string</em>) – Input string</li>
    743. 

  743. <li><strong>$max_length</strong> (<em>int</em>) – String length limit</li>
    744. 

  744. <li><strong>$position</strong> (<em>mixed</em>) – Position to split at (int or float)</li>
    745. 

  745. <li><strong>$ellipsis</strong> (<em>string</em>) – What to use as the ellipsis character</li>
    746. 

  746. </ul>
    747. 

  747. </td>
    748. 

  748. </tr>
    749. 

  749. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Ellipsized string</p>
    750. 

  750. </td>
    751. 

  751. </tr>
    752. 

  752. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
    753. 

  753. </td>
    754. 

  754. </tr>
    755. 

  755. </tbody>
    756. 

  756. </table>
    757. 

  757. <p>This function will strip tags from a string, split it at a defined
    758. 

  758. maximum length, and insert an ellipsis.</p>
    759. 

  759. <p>The first parameter is the string to ellipsize, the second is the number
    760. 

  760. of characters in the final string. The third parameter is where in the
    761. 

  761. string the ellipsis should appear from 0 - 1, left to right. For
    762. 

  762. example. a value of 1 will place the ellipsis at the right of the
    763. 

  763. string, .5 in the middle, and 0 at the left.</p>
    764. 

  764. <p>An optional forth parameter is the kind of ellipsis. By default,
    765. 

  765. &amp;hellip; will be inserted.</p>
    766. 

  766. <p>Example:</p>
    767. 

  767. <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$str</span> <span class="o">=</span> <span class="s1">&#39;this_string_is_entirely_too_long_and_might_break_my_design.jpg&#39;</span><span class="p">;</span>
    768. 

  768. <span class="k">echo</span> <span class="nx">ellipsize</span><span class="p">(</span><span class="nv">$str</span><span class="p">,</span> <span class="mi">32</span><span class="p">,</span> <span class="o">.</span><span class="mi">5</span><span class="p">);</span>
    769. 

  769. </pre></div>
    770. 

  770. </div>
    771. 

  771. <p>Produces:</p>
    772. 

  772. <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nx">this_string_is_e</span><span class="o">&amp;</span><span class="nx">hellip</span><span class="p">;</span><span class="nx">ak_my_design</span><span class="o">.</span><span class="nx">jpg</span>
    773. 

  773. </pre></div>
    774. 

  774. </div>
    775. 

  775. </dd></dl>
    776. 

  776. 

  777. </div>
    778. 

  778. </div>
    779. 

  779. 

  780. 

  781.           </div>
    782. 

  782.           <footer>
    783. 

  783.   
    784. 

  784.     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
    785. 

  785.       
    786. 

  786.         <a href="typography_helper.html" class="btn btn-neutral float-right" title="Typography Helper">Next <span class="fa fa-arrow-circle-right"></span></a>
    787. 

  787.       
    788. 

  788.       
    789. 

  789.         <a href="string_helper.html" class="btn btn-neutral" title="String Helper"><span class="fa fa-arrow-circle-left"></span> Previous</a>
    790. 

  790.       
    791. 

  791.     </div>
    792. 

  792.   
    793. 

  793. 

  794.   <hr/>
    795. 

  795. 

  796.   <div role="contentinfo">
    797. 

  797.     <p>
    798. 

  798.         &copy; Copyright 2014 - 2018, British Columbia Institute of Technology.
    799. 

  799.       Last updated on Mar 22, 2018.
    800. 

  800.     </p>
    801. 

  801.   </div>
    802. 

  802. 

  803.   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>.
    804. 

  804.   
    805. 

  805. </footer>
    806. 

  806.         </div>
    807. 

  807.       </div>
    808. 

  808. 

  809.     </section>
    810. 

  810. 

  811.   </div>
    812. 

  812.   
    813. 

  813. 

  814. 

  815.   
    816. 

  816. 

  817.     <script type="text/javascript">
    818. 

  818.         var DOCUMENTATION_OPTIONS = {
    819. 

  819.             URL_ROOT:'../',
    820. 

  820.             VERSION:'3.1.8',
    821. 

  821.             COLLAPSE_INDEX:false,
    822. 

  822.             FILE_SUFFIX:'.html',
    823. 

  823.             HAS_SOURCE:  false
    824. 

  824.         };
    825. 

  825.     </script>
    826. 

  826.       <script type="text/javascript" src="../_static/jquery.js"></script>
    827. 

  827.       <script type="text/javascript" src="../_static/underscore.js"></script>
    828. 

  828.       <script type="text/javascript" src="../_static/doctools.js"></script>
    829. 

  829. 

  830.   
    831. 

  831. 

  832.   
    833. 

  833.   
    834. 

  834.     <script type="text/javascript" src="../_static/js/theme.js"></script>
    835. 

  835.   
    836. 

  836. 

  837.   
    838. 

  838.   
    839. 

  839.   <script type="text/javascript">
    840. 

  840.       jQuery(function () {
    841. 

  841.           SphinxRtdTheme.StickyNav.enable();
    842. 

  842.       });
    843. 

  843.   </script>
    844. 

  844.    
    845. 

  845. 

  846. </body>
    847. 

  847. </html>
    848.