Gitiles
Code Review Sign In
www.giggi.me / code-igniter-v3-giggi / c576995304fc3609cca0b7b92d1b2cd611ec82f5 / . / user_guide / general / compatibility_functions.html
blob: bd9d5ad9f64ed79f1c353dc6139dd1d9569fd2ec [file] [log] [blame]
Andrey Andreevc5769952019-01-16 17:49:35 +0200[diff] [blame^]1
2
3<!DOCTYPE html>
4<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
5<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
6<head>
7 <meta charset="utf-8">
8 <meta name="viewport" content="width=device-width, initial-scale=1.0">
9
10 <title>Compatibility Functions &mdash; CodeIgniter 3.1.10 documentation</title>
11
12
13
14
15 <link rel="shortcut icon" href="../_static/ci-icon.ico"/>
16
17
18
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
21
22
23
24
25
26
27
28
29 <link rel="stylesheet" href="../_static/css/citheme.css" type="text/css" />
30
31
32
33 <link rel="index" title="Index"
34 href="../genindex.html"/>
35 <link rel="search" title="Search" href="../search.html"/>
36 <link rel="top" title="CodeIgniter 3.1.10 documentation" href="../index.html"/>
37 <link rel="up" title="General Topics" href="index.html"/>
38 <link rel="next" title="URI Routing" href="routing.html"/>
39 <link rel="prev" title="Common Functions" href="common_functions.html"/>
40
41
42 <script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script>
43
44</head>
45
46<body class="wy-body-for-nav" role="document">
47
48 <div id="nav">
49 <div id="nav_inner">
50
51
52
53 <div id="pulldown-menu" class="ciNav">
54 <ul>
55<li class="toctree-l1"><a class="reference internal" href="welcome.html">Welcome to CodeIgniter</a></li>
56</ul>
57<ul>
58<li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installation Instructions</a><ul>
59<li class="toctree-l2"><a class="reference internal" href="../installation/downloads.html">Downloading CodeIgniter</a></li>
60<li class="toctree-l2"><a class="reference internal" href="../installation/index.html">Installation Instructions</a></li>
61<li class="toctree-l2"><a class="reference internal" href="../installation/upgrading.html">Upgrading From a Previous Version</a></li>
62<li class="toctree-l2"><a class="reference internal" href="../installation/troubleshooting.html">Troubleshooting</a></li>
63</ul>
64</li>
65</ul>
66<ul>
67<li class="toctree-l1"><a class="reference internal" href="../overview/index.html">CodeIgniter Overview</a><ul>
68<li class="toctree-l2"><a class="reference internal" href="../overview/getting_started.html">Getting Started</a></li>
69<li class="toctree-l2"><a class="reference internal" href="../overview/at_a_glance.html">CodeIgniter at a Glance</a></li>
70<li class="toctree-l2"><a class="reference internal" href="../overview/features.html">Supported Features</a></li>
71<li class="toctree-l2"><a class="reference internal" href="../overview/appflow.html">Application Flow Chart</a></li>
72<li class="toctree-l2"><a class="reference internal" href="../overview/mvc.html">Model-View-Controller</a></li>
73<li class="toctree-l2"><a class="reference internal" href="../overview/goals.html">Architectural Goals</a></li>
74</ul>
75</li>
76</ul>
77<ul>
78<li class="toctree-l1"><a class="reference internal" href="../tutorial/index.html">Tutorial</a><ul>
79<li class="toctree-l2"><a class="reference internal" href="../tutorial/static_pages.html">Static pages</a></li>
80<li class="toctree-l2"><a class="reference internal" href="../tutorial/news_section.html">News section</a></li>
81<li class="toctree-l2"><a class="reference internal" href="../tutorial/create_news_items.html">Create news items</a></li>
82<li class="toctree-l2"><a class="reference internal" href="../tutorial/conclusion.html">Conclusion</a></li>
83</ul>
84</li>
85</ul>
86<ul>
87<li class="toctree-l1"><a class="reference internal" href="../contributing/index.html">Contributing to CodeIgniter</a><ul>
88<li class="toctree-l2"><a class="reference internal" href="../documentation/index.html">Writing CodeIgniter Documentation</a></li>
89<li class="toctree-l2"><a class="reference internal" href="../DCO.html">Developer’s Certificate of Origin 1.1</a></li>
90</ul>
91</li>
92</ul>
93<ul class="current">
94<li class="toctree-l1 current"><a class="reference internal" href="index.html">General Topics</a><ul class="current">
95<li class="toctree-l2"><a class="reference internal" href="urls.html">CodeIgniter URLs</a></li>
96<li class="toctree-l2"><a class="reference internal" href="controllers.html">Controllers</a></li>
97<li class="toctree-l2"><a class="reference internal" href="reserved_names.html">Reserved Names</a></li>
98<li class="toctree-l2"><a class="reference internal" href="views.html">Views</a></li>
99<li class="toctree-l2"><a class="reference internal" href="models.html">Models</a></li>
100<li class="toctree-l2"><a class="reference internal" href="helpers.html">Helpers</a></li>
101<li class="toctree-l2"><a class="reference internal" href="libraries.html">Using CodeIgniter Libraries</a></li>
102<li class="toctree-l2"><a class="reference internal" href="creating_libraries.html">Creating Libraries</a></li>
103<li class="toctree-l2"><a class="reference internal" href="drivers.html">Using CodeIgniter Drivers</a></li>
104<li class="toctree-l2"><a class="reference internal" href="creating_drivers.html">Creating Drivers</a></li>
105<li class="toctree-l2"><a class="reference internal" href="core_classes.html">Creating Core System Classes</a></li>
106<li class="toctree-l2"><a class="reference internal" href="ancillary_classes.html">Creating Ancillary Classes</a></li>
107<li class="toctree-l2"><a class="reference internal" href="hooks.html">Hooks - Extending the Framework Core</a></li>
108<li class="toctree-l2"><a class="reference internal" href="autoloader.html">Auto-loading Resources</a></li>
109<li class="toctree-l2"><a class="reference internal" href="common_functions.html">Common Functions</a></li>
110<li class="toctree-l2 current"><a class="current reference internal" href="#">Compatibility Functions</a></li>
111<li class="toctree-l2"><a class="reference internal" href="routing.html">URI Routing</a></li>
112<li class="toctree-l2"><a class="reference internal" href="errors.html">Error Handling</a></li>
113<li class="toctree-l2"><a class="reference internal" href="caching.html">Caching</a></li>
114<li class="toctree-l2"><a class="reference internal" href="profiling.html">Profiling Your Application</a></li>
115<li class="toctree-l2"><a class="reference internal" href="cli.html">Running via the CLI</a></li>
116<li class="toctree-l2"><a class="reference internal" href="managing_apps.html">Managing your Applications</a></li>
117<li class="toctree-l2"><a class="reference internal" href="environments.html">Handling Multiple Environments</a></li>
118<li class="toctree-l2"><a class="reference internal" href="alternative_php.html">Alternate PHP Syntax for View Files</a></li>
119<li class="toctree-l2"><a class="reference internal" href="security.html">Security</a></li>
120<li class="toctree-l2"><a class="reference internal" href="styleguide.html">PHP Style Guide</a></li>
121</ul>
122</li>
123</ul>
124<ul>
125<li class="toctree-l1"><a class="reference internal" href="../libraries/index.html">Libraries</a><ul>
126<li class="toctree-l2"><a class="reference internal" href="../libraries/benchmark.html">Benchmarking Class</a></li>
127<li class="toctree-l2"><a class="reference internal" href="../libraries/caching.html">Caching Driver</a></li>
128<li class="toctree-l2"><a class="reference internal" href="../libraries/calendar.html">Calendaring Class</a></li>
129<li class="toctree-l2"><a class="reference internal" href="../libraries/cart.html">Shopping Cart Class</a></li>
130<li class="toctree-l2"><a class="reference internal" href="../libraries/config.html">Config Class</a></li>
131<li class="toctree-l2"><a class="reference internal" href="../libraries/email.html">Email Class</a></li>
132<li class="toctree-l2"><a class="reference internal" href="../libraries/encrypt.html">Encrypt Class</a></li>
133<li class="toctree-l2"><a class="reference internal" href="../libraries/encryption.html">Encryption Library</a></li>
134<li class="toctree-l2"><a class="reference internal" href="../libraries/file_uploading.html">File Uploading Class</a></li>
135<li class="toctree-l2"><a class="reference internal" href="../libraries/form_validation.html">Form Validation</a></li>
136<li class="toctree-l2"><a class="reference internal" href="../libraries/ftp.html">FTP Class</a></li>
137<li class="toctree-l2"><a class="reference internal" href="../libraries/image_lib.html">Image Manipulation Class</a></li>
138<li class="toctree-l2"><a class="reference internal" href="../libraries/input.html">Input Class</a></li>
139<li class="toctree-l2"><a class="reference internal" href="../libraries/javascript.html">Javascript Class</a></li>
140<li class="toctree-l2"><a class="reference internal" href="../libraries/language.html">Language Class</a></li>
141<li class="toctree-l2"><a class="reference internal" href="../libraries/loader.html">Loader Class</a></li>
142<li class="toctree-l2"><a class="reference internal" href="../libraries/migration.html">Migrations Class</a></li>
143<li class="toctree-l2"><a class="reference internal" href="../libraries/output.html">Output Class</a></li>
144<li class="toctree-l2"><a class="reference internal" href="../libraries/pagination.html">Pagination Class</a></li>
145<li class="toctree-l2"><a class="reference internal" href="../libraries/parser.html">Template Parser Class</a></li>
146<li class="toctree-l2"><a class="reference internal" href="../libraries/security.html">Security Class</a></li>
147<li class="toctree-l2"><a class="reference internal" href="../libraries/sessions.html">Session Library</a></li>
148<li class="toctree-l2"><a class="reference internal" href="../libraries/table.html">HTML Table Class</a></li>
149<li class="toctree-l2"><a class="reference internal" href="../libraries/trackback.html">Trackback Class</a></li>
150<li class="toctree-l2"><a class="reference internal" href="../libraries/typography.html">Typography Class</a></li>
151<li class="toctree-l2"><a class="reference internal" href="../libraries/unit_testing.html">Unit Testing Class</a></li>
152<li class="toctree-l2"><a class="reference internal" href="../libraries/uri.html">URI Class</a></li>
153<li class="toctree-l2"><a class="reference internal" href="../libraries/user_agent.html">User Agent Class</a></li>
154<li class="toctree-l2"><a class="reference internal" href="../libraries/xmlrpc.html">XML-RPC and XML-RPC Server Classes</a></li>
155<li class="toctree-l2"><a class="reference internal" href="../libraries/zip.html">Zip Encoding Class</a></li>
156</ul>
157</li>
158</ul>
159<ul>
160<li class="toctree-l1"><a class="reference internal" href="../database/index.html">Database Reference</a><ul>
161<li class="toctree-l2"><a class="reference internal" href="../database/examples.html">Quick Start: Usage Examples</a></li>
162<li class="toctree-l2"><a class="reference internal" href="../database/configuration.html">Database Configuration</a></li>
163<li class="toctree-l2"><a class="reference internal" href="../database/connecting.html">Connecting to a Database</a></li>
164<li class="toctree-l2"><a class="reference internal" href="../database/queries.html">Running Queries</a></li>
165<li class="toctree-l2"><a class="reference internal" href="../database/results.html">Generating Query Results</a></li>
166<li class="toctree-l2"><a class="reference internal" href="../database/helpers.html">Query Helper Functions</a></li>
167<li class="toctree-l2"><a class="reference internal" href="../database/query_builder.html">Query Builder Class</a></li>
168<li class="toctree-l2"><a class="reference internal" href="../database/transactions.html">Transactions</a></li>
169<li class="toctree-l2"><a class="reference internal" href="../database/metadata.html">Getting MetaData</a></li>
170<li class="toctree-l2"><a class="reference internal" href="../database/call_function.html">Custom Function Calls</a></li>
171<li class="toctree-l2"><a class="reference internal" href="../database/caching.html">Query Caching</a></li>
172<li class="toctree-l2"><a class="reference internal" href="../database/forge.html">Database Manipulation with Database Forge</a></li>
173<li class="toctree-l2"><a class="reference internal" href="../database/utilities.html">Database Utilities Class</a></li>
174<li class="toctree-l2"><a class="reference internal" href="../database/db_driver_reference.html">Database Driver Reference</a></li>
175</ul>
176</li>
177</ul>
178<ul>
179<li class="toctree-l1"><a class="reference internal" href="../helpers/index.html">Helpers</a><ul>
180<li class="toctree-l2"><a class="reference internal" href="../helpers/array_helper.html">Array Helper</a></li>
181<li class="toctree-l2"><a class="reference internal" href="../helpers/captcha_helper.html">CAPTCHA Helper</a></li>
182<li class="toctree-l2"><a class="reference internal" href="../helpers/cookie_helper.html">Cookie Helper</a></li>
183<li class="toctree-l2"><a class="reference internal" href="../helpers/date_helper.html">Date Helper</a></li>
184<li class="toctree-l2"><a class="reference internal" href="../helpers/directory_helper.html">Directory Helper</a></li>
185<li class="toctree-l2"><a class="reference internal" href="../helpers/download_helper.html">Download Helper</a></li>
186<li class="toctree-l2"><a class="reference internal" href="../helpers/email_helper.html">Email Helper</a></li>
187<li class="toctree-l2"><a class="reference internal" href="../helpers/file_helper.html">File Helper</a></li>
188<li class="toctree-l2"><a class="reference internal" href="../helpers/form_helper.html">Form Helper</a></li>
189<li class="toctree-l2"><a class="reference internal" href="../helpers/html_helper.html">HTML Helper</a></li>
190<li class="toctree-l2"><a class="reference internal" href="../helpers/inflector_helper.html">Inflector Helper</a></li>
191<li class="toctree-l2"><a class="reference internal" href="../helpers/language_helper.html">Language Helper</a></li>
192<li class="toctree-l2"><a class="reference internal" href="../helpers/number_helper.html">Number Helper</a></li>
193<li class="toctree-l2"><a class="reference internal" href="../helpers/path_helper.html">Path Helper</a></li>
194<li class="toctree-l2"><a class="reference internal" href="../helpers/security_helper.html">Security Helper</a></li>
195<li class="toctree-l2"><a class="reference internal" href="../helpers/smiley_helper.html">Smiley Helper</a></li>
196<li class="toctree-l2"><a class="reference internal" href="../helpers/string_helper.html">String Helper</a></li>
197<li class="toctree-l2"><a class="reference internal" href="../helpers/text_helper.html">Text Helper</a></li>
198<li class="toctree-l2"><a class="reference internal" href="../helpers/typography_helper.html">Typography Helper</a></li>
199<li class="toctree-l2"><a class="reference internal" href="../helpers/url_helper.html">URL Helper</a></li>
200<li class="toctree-l2"><a class="reference internal" href="../helpers/xml_helper.html">XML Helper</a></li>
201</ul>
202</li>
203</ul>
204
205 </div>
206
207
208 </div>
209</div>
210<div id="nav2">
211 <a href="#" id="openToc">
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 </a>
214</div>
215
216 <div class="wy-grid-for-nav">
217
218
219 <nav data-toggle="wy-nav-shift" class="wy-nav-side">
220 <div class="wy-side-nav-search">
221
222 <a href="../index.html" class="fa fa-home"> CodeIgniter</a>
223
224
225<div role="search">
226 <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
227 <input type="text" name="q" placeholder="Search docs" />
228 <input type="hidden" name="check_keywords" value="yes" />
229 <input type="hidden" name="area" value="default" />
230 </form>
231</div>
232 </div>
233
234 <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
235
236
237
238 <ul>
239<li class="toctree-l1"><a class="reference internal" href="welcome.html">Welcome to CodeIgniter</a></li>
240</ul>
241<ul>
242<li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installation Instructions</a><ul>
243<li class="toctree-l2"><a class="reference internal" href="../installation/downloads.html">Downloading CodeIgniter</a></li>
244<li class="toctree-l2"><a class="reference internal" href="../installation/index.html">Installation Instructions</a></li>
245<li class="toctree-l2"><a class="reference internal" href="../installation/upgrading.html">Upgrading From a Previous Version</a></li>
246<li class="toctree-l2"><a class="reference internal" href="../installation/troubleshooting.html">Troubleshooting</a></li>
247</ul>
248</li>
249</ul>
250<ul>
251<li class="toctree-l1"><a class="reference internal" href="../overview/index.html">CodeIgniter Overview</a><ul>
252<li class="toctree-l2"><a class="reference internal" href="../overview/getting_started.html">Getting Started</a></li>
253<li class="toctree-l2"><a class="reference internal" href="../overview/at_a_glance.html">CodeIgniter at a Glance</a></li>
254<li class="toctree-l2"><a class="reference internal" href="../overview/features.html">Supported Features</a></li>
255<li class="toctree-l2"><a class="reference internal" href="../overview/appflow.html">Application Flow Chart</a></li>
256<li class="toctree-l2"><a class="reference internal" href="../overview/mvc.html">Model-View-Controller</a></li>
257<li class="toctree-l2"><a class="reference internal" href="../overview/goals.html">Architectural Goals</a></li>
258</ul>
259</li>
260</ul>
261<ul>
262<li class="toctree-l1"><a class="reference internal" href="../tutorial/index.html">Tutorial</a><ul>
263<li class="toctree-l2"><a class="reference internal" href="../tutorial/static_pages.html">Static pages</a></li>
264<li class="toctree-l2"><a class="reference internal" href="../tutorial/news_section.html">News section</a></li>
265<li class="toctree-l2"><a class="reference internal" href="../tutorial/create_news_items.html">Create news items</a></li>
266<li class="toctree-l2"><a class="reference internal" href="../tutorial/conclusion.html">Conclusion</a></li>
267</ul>
268</li>
269</ul>
270<ul>
271<li class="toctree-l1"><a class="reference internal" href="../contributing/index.html">Contributing to CodeIgniter</a><ul>
272<li class="toctree-l2"><a class="reference internal" href="../documentation/index.html">Writing CodeIgniter Documentation</a></li>
273<li class="toctree-l2"><a class="reference internal" href="../DCO.html">Developer’s Certificate of Origin 1.1</a></li>
274</ul>
275</li>
276</ul>
277<ul class="current">
278<li class="toctree-l1 current"><a class="reference internal" href="index.html">General Topics</a><ul class="current">
279<li class="toctree-l2"><a class="reference internal" href="urls.html">CodeIgniter URLs</a></li>
280<li class="toctree-l2"><a class="reference internal" href="controllers.html">Controllers</a></li>
281<li class="toctree-l2"><a class="reference internal" href="reserved_names.html">Reserved Names</a></li>
282<li class="toctree-l2"><a class="reference internal" href="views.html">Views</a></li>
283<li class="toctree-l2"><a class="reference internal" href="models.html">Models</a></li>
284<li class="toctree-l2"><a class="reference internal" href="helpers.html">Helpers</a></li>
285<li class="toctree-l2"><a class="reference internal" href="libraries.html">Using CodeIgniter Libraries</a></li>
286<li class="toctree-l2"><a class="reference internal" href="creating_libraries.html">Creating Libraries</a></li>
287<li class="toctree-l2"><a class="reference internal" href="drivers.html">Using CodeIgniter Drivers</a></li>
288<li class="toctree-l2"><a class="reference internal" href="creating_drivers.html">Creating Drivers</a></li>
289<li class="toctree-l2"><a class="reference internal" href="core_classes.html">Creating Core System Classes</a></li>
290<li class="toctree-l2"><a class="reference internal" href="ancillary_classes.html">Creating Ancillary Classes</a></li>
291<li class="toctree-l2"><a class="reference internal" href="hooks.html">Hooks - Extending the Framework Core</a></li>
292<li class="toctree-l2"><a class="reference internal" href="autoloader.html">Auto-loading Resources</a></li>
293<li class="toctree-l2"><a class="reference internal" href="common_functions.html">Common Functions</a></li>
294<li class="toctree-l2 current"><a class="current reference internal" href="#">Compatibility Functions</a></li>
295<li class="toctree-l2"><a class="reference internal" href="routing.html">URI Routing</a></li>
296<li class="toctree-l2"><a class="reference internal" href="errors.html">Error Handling</a></li>
297<li class="toctree-l2"><a class="reference internal" href="caching.html">Caching</a></li>
298<li class="toctree-l2"><a class="reference internal" href="profiling.html">Profiling Your Application</a></li>
299<li class="toctree-l2"><a class="reference internal" href="cli.html">Running via the CLI</a></li>
300<li class="toctree-l2"><a class="reference internal" href="managing_apps.html">Managing your Applications</a></li>
301<li class="toctree-l2"><a class="reference internal" href="environments.html">Handling Multiple Environments</a></li>
302<li class="toctree-l2"><a class="reference internal" href="alternative_php.html">Alternate PHP Syntax for View Files</a></li>
303<li class="toctree-l2"><a class="reference internal" href="security.html">Security</a></li>
304<li class="toctree-l2"><a class="reference internal" href="styleguide.html">PHP Style Guide</a></li>
305</ul>
306</li>
307</ul>
308<ul>
309<li class="toctree-l1"><a class="reference internal" href="../libraries/index.html">Libraries</a><ul>
310<li class="toctree-l2"><a class="reference internal" href="../libraries/benchmark.html">Benchmarking Class</a></li>
311<li class="toctree-l2"><a class="reference internal" href="../libraries/caching.html">Caching Driver</a></li>
312<li class="toctree-l2"><a class="reference internal" href="../libraries/calendar.html">Calendaring Class</a></li>
313<li class="toctree-l2"><a class="reference internal" href="../libraries/cart.html">Shopping Cart Class</a></li>
314<li class="toctree-l2"><a class="reference internal" href="../libraries/config.html">Config Class</a></li>
315<li class="toctree-l2"><a class="reference internal" href="../libraries/email.html">Email Class</a></li>
316<li class="toctree-l2"><a class="reference internal" href="../libraries/encrypt.html">Encrypt Class</a></li>
317<li class="toctree-l2"><a class="reference internal" href="../libraries/encryption.html">Encryption Library</a></li>
318<li class="toctree-l2"><a class="reference internal" href="../libraries/file_uploading.html">File Uploading Class</a></li>
319<li class="toctree-l2"><a class="reference internal" href="../libraries/form_validation.html">Form Validation</a></li>
320<li class="toctree-l2"><a class="reference internal" href="../libraries/ftp.html">FTP Class</a></li>
321<li class="toctree-l2"><a class="reference internal" href="../libraries/image_lib.html">Image Manipulation Class</a></li>
322<li class="toctree-l2"><a class="reference internal" href="../libraries/input.html">Input Class</a></li>
323<li class="toctree-l2"><a class="reference internal" href="../libraries/javascript.html">Javascript Class</a></li>
324<li class="toctree-l2"><a class="reference internal" href="../libraries/language.html">Language Class</a></li>
325<li class="toctree-l2"><a class="reference internal" href="../libraries/loader.html">Loader Class</a></li>
326<li class="toctree-l2"><a class="reference internal" href="../libraries/migration.html">Migrations Class</a></li>
327<li class="toctree-l2"><a class="reference internal" href="../libraries/output.html">Output Class</a></li>
328<li class="toctree-l2"><a class="reference internal" href="../libraries/pagination.html">Pagination Class</a></li>
329<li class="toctree-l2"><a class="reference internal" href="../libraries/parser.html">Template Parser Class</a></li>
330<li class="toctree-l2"><a class="reference internal" href="../libraries/security.html">Security Class</a></li>
331<li class="toctree-l2"><a class="reference internal" href="../libraries/sessions.html">Session Library</a></li>
332<li class="toctree-l2"><a class="reference internal" href="../libraries/table.html">HTML Table Class</a></li>
333<li class="toctree-l2"><a class="reference internal" href="../libraries/trackback.html">Trackback Class</a></li>
334<li class="toctree-l2"><a class="reference internal" href="../libraries/typography.html">Typography Class</a></li>
335<li class="toctree-l2"><a class="reference internal" href="../libraries/unit_testing.html">Unit Testing Class</a></li>
336<li class="toctree-l2"><a class="reference internal" href="../libraries/uri.html">URI Class</a></li>
337<li class="toctree-l2"><a class="reference internal" href="../libraries/user_agent.html">User Agent Class</a></li>
338<li class="toctree-l2"><a class="reference internal" href="../libraries/xmlrpc.html">XML-RPC and XML-RPC Server Classes</a></li>
339<li class="toctree-l2"><a class="reference internal" href="../libraries/zip.html">Zip Encoding Class</a></li>
340</ul>
341</li>
342</ul>
343<ul>
344<li class="toctree-l1"><a class="reference internal" href="../database/index.html">Database Reference</a><ul>
345<li class="toctree-l2"><a class="reference internal" href="../database/examples.html">Quick Start: Usage Examples</a></li>
346<li class="toctree-l2"><a class="reference internal" href="../database/configuration.html">Database Configuration</a></li>
347<li class="toctree-l2"><a class="reference internal" href="../database/connecting.html">Connecting to a Database</a></li>
348<li class="toctree-l2"><a class="reference internal" href="../database/queries.html">Running Queries</a></li>
349<li class="toctree-l2"><a class="reference internal" href="../database/results.html">Generating Query Results</a></li>
350<li class="toctree-l2"><a class="reference internal" href="../database/helpers.html">Query Helper Functions</a></li>
351<li class="toctree-l2"><a class="reference internal" href="../database/query_builder.html">Query Builder Class</a></li>
352<li class="toctree-l2"><a class="reference internal" href="../database/transactions.html">Transactions</a></li>
353<li class="toctree-l2"><a class="reference internal" href="../database/metadata.html">Getting MetaData</a></li>
354<li class="toctree-l2"><a class="reference internal" href="../database/call_function.html">Custom Function Calls</a></li>
355<li class="toctree-l2"><a class="reference internal" href="../database/caching.html">Query Caching</a></li>
356<li class="toctree-l2"><a class="reference internal" href="../database/forge.html">Database Manipulation with Database Forge</a></li>
357<li class="toctree-l2"><a class="reference internal" href="../database/utilities.html">Database Utilities Class</a></li>
358<li class="toctree-l2"><a class="reference internal" href="../database/db_driver_reference.html">Database Driver Reference</a></li>
359</ul>
360</li>
361</ul>
362<ul>
363<li class="toctree-l1"><a class="reference internal" href="../helpers/index.html">Helpers</a><ul>
364<li class="toctree-l2"><a class="reference internal" href="../helpers/array_helper.html">Array Helper</a></li>
365<li class="toctree-l2"><a class="reference internal" href="../helpers/captcha_helper.html">CAPTCHA Helper</a></li>
366<li class="toctree-l2"><a class="reference internal" href="../helpers/cookie_helper.html">Cookie Helper</a></li>
367<li class="toctree-l2"><a class="reference internal" href="../helpers/date_helper.html">Date Helper</a></li>
368<li class="toctree-l2"><a class="reference internal" href="../helpers/directory_helper.html">Directory Helper</a></li>
369<li class="toctree-l2"><a class="reference internal" href="../helpers/download_helper.html">Download Helper</a></li>
370<li class="toctree-l2"><a class="reference internal" href="../helpers/email_helper.html">Email Helper</a></li>
371<li class="toctree-l2"><a class="reference internal" href="../helpers/file_helper.html">File Helper</a></li>
372<li class="toctree-l2"><a class="reference internal" href="../helpers/form_helper.html">Form Helper</a></li>
373<li class="toctree-l2"><a class="reference internal" href="../helpers/html_helper.html">HTML Helper</a></li>
374<li class="toctree-l2"><a class="reference internal" href="../helpers/inflector_helper.html">Inflector Helper</a></li>
375<li class="toctree-l2"><a class="reference internal" href="../helpers/language_helper.html">Language Helper</a></li>
376<li class="toctree-l2"><a class="reference internal" href="../helpers/number_helper.html">Number Helper</a></li>
377<li class="toctree-l2"><a class="reference internal" href="../helpers/path_helper.html">Path Helper</a></li>
378<li class="toctree-l2"><a class="reference internal" href="../helpers/security_helper.html">Security Helper</a></li>
379<li class="toctree-l2"><a class="reference internal" href="../helpers/smiley_helper.html">Smiley Helper</a></li>
380<li class="toctree-l2"><a class="reference internal" href="../helpers/string_helper.html">String Helper</a></li>
381<li class="toctree-l2"><a class="reference internal" href="../helpers/text_helper.html">Text Helper</a></li>
382<li class="toctree-l2"><a class="reference internal" href="../helpers/typography_helper.html">Typography Helper</a></li>
383<li class="toctree-l2"><a class="reference internal" href="../helpers/url_helper.html">URL Helper</a></li>
384<li class="toctree-l2"><a class="reference internal" href="../helpers/xml_helper.html">XML Helper</a></li>
385</ul>
386</li>
387</ul>
388
389
390
391 </div>
392 &nbsp;
393 </nav>
394
395 <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
396
397
398 <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
399 <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
400 <a href="../index.html">CodeIgniter</a>
401 </nav>
402
403
404
405 <div class="wy-nav-content">
406 <div class="rst-content">
407 <div role="navigation" aria-label="breadcrumbs navigation">
408 <ul class="wy-breadcrumbs">
409 <li><a href="../index.html">Docs</a> &raquo;</li>
410
411 <li><a href="index.html">General Topics</a> &raquo;</li>
412
413 <li>Compatibility Functions</li>
414 <li class="wy-breadcrumbs-aside">
415
416 </li>
417 <div style="float:right;margin-left:5px;" id="closeMe">
418 <img title="Classic Layout" alt="classic layout" src="data:image/gif;base64,R0lGODlhFAAUAJEAAAAAADMzM////wAAACH5BAUUAAIALAAAAAAUABQAAAImlI+py+0PU5gRBRDM3DxbWoXis42X13USOLauUIqnlsaH/eY6UwAAOw==" />
419 </div>
420 </ul>
421 <hr/>
422</div>
423 <div role="main" class="document">
424
425 <div class="section" id="compatibility-functions">
426<h1>Compatibility Functions<a class="headerlink" href="#compatibility-functions" title="Permalink to this headline"></a></h1>
427<p>CodeIgniter provides a set of compatibility functions that enable
428you to use functions what are otherwise natively available in PHP,
429but only in higher versions or depending on a certain extension.</p>
430<p>Being custom implementations, these functions will also have some
431set of dependencies on their own, but are still useful if your
432PHP setup doesn’t offer them natively.</p>
433<div class="admonition note">
434<p class="first admonition-title">Note</p>
435<p class="last">Much like the <a class="reference internal" href="common_functions.html"><span class="doc">common functions</span></a>, the
436compatibility functions are always available, as long as
437their dependencies are met.</p>
438</div>
439<div class="contents local topic" id="contents">
440<ul class="simple">
441<li><a class="reference internal" href="#password-hashing" id="id7">Password Hashing</a><ul>
442<li><a class="reference internal" href="#dependencies" id="id8">Dependencies</a></li>
443<li><a class="reference internal" href="#constants" id="id9">Constants</a></li>
444<li><a class="reference internal" href="#function-reference" id="id10">Function reference</a></li>
445</ul>
446</li>
447<li><a class="reference internal" href="#hash-message-digest" id="id11">Hash (Message Digest)</a><ul>
448<li><a class="reference internal" href="#id1" id="id12">Dependencies</a></li>
449<li><a class="reference internal" href="#id2" id="id13">Function reference</a></li>
450</ul>
451</li>
452<li><a class="reference internal" href="#multibyte-string" id="id14">Multibyte String</a><ul>
453<li><a class="reference internal" href="#id3" id="id15">Dependencies</a></li>
454<li><a class="reference internal" href="#id4" id="id16">Function reference</a></li>
455</ul>
456</li>
457<li><a class="reference internal" href="#standard-functions" id="id17">Standard Functions</a><ul>
458<li><a class="reference internal" href="#id5" id="id18">Dependencies</a></li>
459<li><a class="reference internal" href="#id6" id="id19">Function reference</a></li>
460</ul>
461</li>
462</ul>
463</div>
464<div class="custom-index container"></div><div class="section" id="password-hashing">
465<h2><a class="toc-backref" href="#id7">Password Hashing</a><a class="headerlink" href="#password-hashing" title="Permalink to this headline"></a></h2>
466<p>This set of compatibility functions offers a “backport” of PHP’s
467standard <a class="reference external" href="http://php.net/password">Password Hashing extension</a>
468that is otherwise available only since PHP 5.5.</p>
469<div class="section" id="dependencies">
470<h3><a class="toc-backref" href="#id8">Dependencies</a><a class="headerlink" href="#dependencies" title="Permalink to this headline"></a></h3>
471<ul class="simple">
472<li>PHP 5.3.7</li>
473<li><code class="docutils literal"><span class="pre">CRYPT_BLOWFISH</span></code> support for <code class="docutils literal"><span class="pre">crypt()</span></code></li>
474</ul>
475</div>
476<div class="section" id="constants">
477<h3><a class="toc-backref" href="#id9">Constants</a><a class="headerlink" href="#constants" title="Permalink to this headline"></a></h3>
478<ul class="simple">
479<li><code class="docutils literal"><span class="pre">PASSWORD_BCRYPT</span></code></li>
480<li><code class="docutils literal"><span class="pre">PASSWORD_DEFAULT</span></code></li>
481</ul>
482</div>
483<div class="section" id="function-reference">
484<h3><a class="toc-backref" href="#id10">Function reference</a><a class="headerlink" href="#function-reference" title="Permalink to this headline"></a></h3>
485<dl class="function">
486<dt id="password_get_info">
487<code class="descname">password_get_info</code><span class="sig-paren">(</span><em>$hash</em><span class="sig-paren">)</span><a class="headerlink" href="#password_get_info" title="Permalink to this definition"></a></dt>
488<dd><table class="docutils field-list" frame="void" rules="none">
489<col class="field-name" />
490<col class="field-body" />
491<tbody valign="top">
492<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
493<li><strong>$hash</strong> (<em>string</em>) – Password hash</li>
494</ul>
495</td>
496</tr>
497<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Information about the hashed password</p>
498</td>
499</tr>
500<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">array</p>
501</td>
502</tr>
503</tbody>
504</table>
505<p>For more information, please refer to the <a class="reference external" href="http://php.net/password_get_info">PHP manual for
506password_get_info()</a>.</p>
507</dd></dl>
508
509<dl class="function">
510<dt id="password_hash">
511<code class="descname">password_hash</code><span class="sig-paren">(</span><em>$password</em>, <em>$algo</em><span class="optional">[</span>, <em>$options = array()</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#password_hash" title="Permalink to this definition"></a></dt>
512<dd><table class="docutils field-list" frame="void" rules="none">
513<col class="field-name" />
514<col class="field-body" />
515<tbody valign="top">
516<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
517<li><strong>$password</strong> (<em>string</em>) – Plain-text password</li>
518<li><strong>$algo</strong> (<em>int</em>) – Hashing algorithm</li>
519<li><strong>$options</strong> (<em>array</em>) – Hashing options</li>
520</ul>
521</td>
522</tr>
523<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Hashed password or FALSE on failure</p>
524</td>
525</tr>
526<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
527</td>
528</tr>
529</tbody>
530</table>
531<p>For more information, please refer to the <a class="reference external" href="http://php.net/password_hash">PHP manual for
532password_hash()</a>.</p>
533<div class="admonition note">
534<p class="first admonition-title">Note</p>
535<p class="last">Unless you provide your own (and valid) salt, this function
536has a further dependency on an available CSPRNG source. Each
537of the following would satisfy that:
538- <code class="docutils literal"><span class="pre">mcrypt_create_iv()</span></code> with <code class="docutils literal"><span class="pre">MCRYPT_DEV_URANDOM</span></code>
539- <code class="docutils literal"><span class="pre">openssl_random_pseudo_bytes()</span></code>
540- /dev/arandom
541- /dev/urandom</p>
542</div>
543</dd></dl>
544
545<dl class="function">
546<dt id="password_needs_rehash">
547<code class="descname">password_needs_rehash</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#password_needs_rehash" title="Permalink to this definition"></a></dt>
548<dd><table class="docutils field-list" frame="void" rules="none">
549<col class="field-name" />
550<col class="field-body" />
551<tbody valign="top">
552<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
553<li><strong>$hash</strong> (<em>string</em>) – Password hash</li>
554<li><strong>$algo</strong> (<em>int</em>) – Hashing algorithm</li>
555<li><strong>$options</strong> (<em>array</em>) – Hashing options</li>
556</ul>
557</td>
558</tr>
559<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">TRUE if the hash should be rehashed to match the given algorithm and options, FALSE otherwise</p>
560</td>
561</tr>
562<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">bool</p>
563</td>
564</tr>
565</tbody>
566</table>
567<p>For more information, please refer to the <a class="reference external" href="http://php.net/password_needs_rehash">PHP manual for
568password_needs_rehash()</a>.</p>
569</dd></dl>
570
571<dl class="function">
572<dt id="password_verify">
573<code class="descname">password_verify</code><span class="sig-paren">(</span><em>$password</em>, <em>$hash</em><span class="sig-paren">)</span><a class="headerlink" href="#password_verify" title="Permalink to this definition"></a></dt>
574<dd><table class="docutils field-list" frame="void" rules="none">
575<col class="field-name" />
576<col class="field-body" />
577<tbody valign="top">
578<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
579<li><strong>$password</strong> (<em>string</em>) – Plain-text password</li>
580<li><strong>$hash</strong> (<em>string</em>) – Password hash</li>
581</ul>
582</td>
583</tr>
584<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">TRUE if the password matches the hash, FALSE if not</p>
585</td>
586</tr>
587<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">bool</p>
588</td>
589</tr>
590</tbody>
591</table>
592<p>For more information, please refer to the <a class="reference external" href="http://php.net/password_verify">PHP manual for
593password_verify()</a>.</p>
594</dd></dl>
595
596</div>
597</div>
598<div class="section" id="hash-message-digest">
599<h2><a class="toc-backref" href="#id11">Hash (Message Digest)</a><a class="headerlink" href="#hash-message-digest" title="Permalink to this headline"></a></h2>
600<p>This compatibility layer contains backports for the <code class="docutils literal"><span class="pre">hash_equals()</span></code>
601and <code class="docutils literal"><span class="pre">hash_pbkdf2()</span></code> functions, which otherwise require PHP 5.6 and/or
602PHP 5.5 respectively.</p>
603<div class="section" id="id1">
604<h3><a class="toc-backref" href="#id12">Dependencies</a><a class="headerlink" href="#id1" title="Permalink to this headline"></a></h3>
605<ul class="simple">
606<li>None</li>
607</ul>
608</div>
609<div class="section" id="id2">
610<h3><a class="toc-backref" href="#id13">Function reference</a><a class="headerlink" href="#id2" title="Permalink to this headline"></a></h3>
611<dl class="function">
612<dt id="hash_equals">
613<code class="descname">hash_equals</code><span class="sig-paren">(</span><em>$known_string</em>, <em>$user_string</em><span class="sig-paren">)</span><a class="headerlink" href="#hash_equals" title="Permalink to this definition"></a></dt>
614<dd><table class="docutils field-list" frame="void" rules="none">
615<col class="field-name" />
616<col class="field-body" />
617<tbody valign="top">
618<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
619<li><strong>$known_string</strong> (<em>string</em>) – Known string</li>
620<li><strong>$user_string</strong> (<em>string</em>) – User-supplied string</li>
621</ul>
622</td>
623</tr>
624<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">TRUE if the strings match, FALSE otherwise</p>
625</td>
626</tr>
627<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
628</td>
629</tr>
630</tbody>
631</table>
632<p>For more information, please refer to the <a class="reference external" href="http://php.net/hash_equals">PHP manual for
633hash_equals()</a>.</p>
634</dd></dl>
635
636<dl class="function">
637<dt id="hash_pbkdf2">
638<code class="descname">hash_pbkdf2</code><span class="sig-paren">(</span><em>$algo</em>, <em>$password</em>, <em>$salt</em>, <em>$iterations</em><span class="optional">[</span>, <em>$length = 0</em><span class="optional">[</span>, <em>$raw_output = FALSE</em><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#hash_pbkdf2" title="Permalink to this definition"></a></dt>
639<dd><table class="docutils field-list" frame="void" rules="none">
640<col class="field-name" />
641<col class="field-body" />
642<tbody valign="top">
643<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
644<li><strong>$algo</strong> (<em>string</em>) – Hashing algorithm</li>
645<li><strong>$password</strong> (<em>string</em>) – Password</li>
646<li><strong>$salt</strong> (<em>string</em>) – Hash salt</li>
647<li><strong>$iterations</strong> (<em>int</em>) – Number of iterations to perform during derivation</li>
648<li><strong>$length</strong> (<em>int</em>) – Output string length</li>
649<li><strong>$raw_output</strong> (<em>bool</em>) – Whether to return raw binary data</li>
650</ul>
651</td>
652</tr>
653<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Password-derived key or FALSE on failure</p>
654</td>
655</tr>
656<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
657</td>
658</tr>
659</tbody>
660</table>
661<p>For more information, please refer to the <a class="reference external" href="http://php.net/hash_pbkdf2">PHP manual for
662hash_pbkdf2()</a>.</p>
663</dd></dl>
664
665</div>
666</div>
667<div class="section" id="multibyte-string">
668<h2><a class="toc-backref" href="#id14">Multibyte String</a><a class="headerlink" href="#multibyte-string" title="Permalink to this headline"></a></h2>
669<p>This set of compatibility functions offers limited support for PHP’s
670<a class="reference external" href="http://php.net/mbstring">Multibyte String extension</a>. Because of
671the limited alternative solutions, only a few functions are available.</p>
672<div class="admonition note">
673<p class="first admonition-title">Note</p>
674<p class="last">When a character set parameter is ommited,
675<code class="docutils literal"><span class="pre">$config['charset']</span></code> will be used.</p>
676</div>
677<div class="section" id="id3">
678<h3><a class="toc-backref" href="#id15">Dependencies</a><a class="headerlink" href="#id3" title="Permalink to this headline"></a></h3>
679<ul class="simple">
680<li><a class="reference external" href="http://php.net/iconv">iconv</a> extension</li>
681</ul>
682<div class="admonition important">
683<p class="first admonition-title">Important</p>
684<p class="last">This dependency is optional and these functions will
685always be declared. If iconv is not available, they WILL
686fall-back to their non-mbstring versions.</p>
687</div>
688<div class="admonition important">
689<p class="first admonition-title">Important</p>
690<p class="last">Where a character set is supplied, it must be
691supported by iconv and in a format that it recognizes.</p>
692</div>
693<div class="admonition note">
694<p class="first admonition-title">Note</p>
695<p class="last">For you own dependency check on the actual mbstring
696extension, use the <code class="docutils literal"><span class="pre">MB_ENABLED</span></code> constant.</p>
697</div>
698</div>
699<div class="section" id="id4">
700<h3><a class="toc-backref" href="#id16">Function reference</a><a class="headerlink" href="#id4" title="Permalink to this headline"></a></h3>
701<dl class="function">
702<dt id="mb_strlen">
703<code class="descname">mb_strlen</code><span class="sig-paren">(</span><em>$str</em><span class="optional">[</span>, <em>$encoding = NULL</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#mb_strlen" title="Permalink to this definition"></a></dt>
704<dd><table class="docutils field-list" frame="void" rules="none">
705<col class="field-name" />
706<col class="field-body" />
707<tbody valign="top">
708<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
709<li><strong>$str</strong> (<em>string</em>) – Input string</li>
710<li><strong>$encoding</strong> (<em>string</em>) – Character set</li>
711</ul>
712</td>
713</tr>
714<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Number of characters in the input string or FALSE on failure</p>
715</td>
716</tr>
717<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
718</td>
719</tr>
720</tbody>
721</table>
722<p>For more information, please refer to the <a class="reference external" href="http://php.net/mb_strlen">PHP manual for
723mb_strlen()</a>.</p>
724</dd></dl>
725
726<dl class="function">
727<dt id="mb_strpos">
728<code class="descname">mb_strpos</code><span class="sig-paren">(</span><em>$haystack</em>, <em>$needle</em><span class="optional">[</span>, <em>$offset = 0</em><span class="optional">[</span>, <em>$encoding = NULL</em><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#mb_strpos" title="Permalink to this definition"></a></dt>
729<dd><table class="docutils field-list" frame="void" rules="none">
730<col class="field-name" />
731<col class="field-body" />
732<tbody valign="top">
733<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
734<li><strong>$haystack</strong> (<em>string</em>) – String to search in</li>
735<li><strong>$needle</strong> (<em>string</em>) – Part of string to search for</li>
736<li><strong>$offset</strong> (<em>int</em>) – Search offset</li>
737<li><strong>$encoding</strong> (<em>string</em>) – Character set</li>
738</ul>
739</td>
740</tr>
741<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Numeric character position of where $needle was found or FALSE if not found</p>
742</td>
743</tr>
744<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">mixed</p>
745</td>
746</tr>
747</tbody>
748</table>
749<p>For more information, please refer to the <a class="reference external" href="http://php.net/mb_strpos">PHP manual for
750mb_strpos()</a>.</p>
751</dd></dl>
752
753<dl class="function">
754<dt id="mb_substr">
755<code class="descname">mb_substr</code><span class="sig-paren">(</span><em>$str</em>, <em>$start</em><span class="optional">[</span>, <em>$length = NULL</em><span class="optional">[</span>, <em>$encoding = NULL</em><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#mb_substr" title="Permalink to this definition"></a></dt>
756<dd><table class="docutils field-list" frame="void" rules="none">
757<col class="field-name" />
758<col class="field-body" />
759<tbody valign="top">
760<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
761<li><strong>$str</strong> (<em>string</em>) – Input string</li>
762<li><strong>$start</strong> (<em>int</em>) – Position of first character</li>
763<li><strong>$length</strong> (<em>int</em>) – Maximum number of characters</li>
764<li><strong>$encoding</strong> (<em>string</em>) – Character set</li>
765</ul>
766</td>
767</tr>
768<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Portion of $str specified by $start and $length or FALSE on failure</p>
769</td>
770</tr>
771<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
772</td>
773</tr>
774</tbody>
775</table>
776<p>For more information, please refer to the <a class="reference external" href="http://php.net/mb_substr">PHP manual for
777mb_substr()</a>.</p>
778</dd></dl>
779
780</div>
781</div>
782<div class="section" id="standard-functions">
783<h2><a class="toc-backref" href="#id17">Standard Functions</a><a class="headerlink" href="#standard-functions" title="Permalink to this headline"></a></h2>
784<p>This set of compatibility functions offers support for a few
785standard functions in PHP that otherwise require a newer PHP version.</p>
786<div class="section" id="id5">
787<h3><a class="toc-backref" href="#id18">Dependencies</a><a class="headerlink" href="#id5" title="Permalink to this headline"></a></h3>
788<ul class="simple">
789<li>None</li>
790</ul>
791</div>
792<div class="section" id="id6">
793<h3><a class="toc-backref" href="#id19">Function reference</a><a class="headerlink" href="#id6" title="Permalink to this headline"></a></h3>
794<dl class="function">
795<dt id="array_column">
796<code class="descname">array_column</code><span class="sig-paren">(</span><em>array $array</em>, <em>$column_key</em><span class="optional">[</span>, <em>$index_key = NULL</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#array_column" title="Permalink to this definition"></a></dt>
797<dd><table class="docutils field-list" frame="void" rules="none">
798<col class="field-name" />
799<col class="field-body" />
800<tbody valign="top">
801<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
802<li><strong>$array</strong> (<em>array</em>) – Array to fetch results from</li>
803<li><strong>$column_key</strong> (<em>mixed</em>) – Key of the column to return values from</li>
804<li><strong>$index_key</strong> (<em>mixed</em>) – Key to use for the returned values</li>
805</ul>
806</td>
807</tr>
808<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">An array of values representing a single column from the input array</p>
809</td>
810</tr>
811<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">array</p>
812</td>
813</tr>
814</tbody>
815</table>
816<p>For more information, please refer to the <a class="reference external" href="http://php.net/array_column">PHP manual for
817array_column()</a>.</p>
818</dd></dl>
819
820<dl class="function">
821<dt id="hex2bin">
822<code class="descname">hex2bin</code><span class="sig-paren">(</span><em>$data</em><span class="sig-paren">)</span><a class="headerlink" href="#hex2bin" title="Permalink to this definition"></a></dt>
823<dd><table class="docutils field-list" frame="void" rules="none">
824<col class="field-name" />
825<col class="field-body" />
826<tbody valign="top">
827<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
828<li><strong>$data</strong> (<em>array</em>) – Hexadecimal representation of data</li>
829</ul>
830</td>
831</tr>
832<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Binary representation of the given data</p>
833</td>
834</tr>
835<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
836</td>
837</tr>
838</tbody>
839</table>
840<p>For more information, please refer to the <a class="reference external" href="http://php.net/hex2bin">PHP manual for hex2bin()</a>.</p>
841</dd></dl>
842
843</div>
844</div>
845</div>
846
847
848 </div>
849 <footer>
850
851 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
852
853 <a href="routing.html" class="btn btn-neutral float-right" title="URI Routing">Next <span class="fa fa-arrow-circle-right"></span></a>
854
855
856 <a href="common_functions.html" class="btn btn-neutral" title="Common Functions"><span class="fa fa-arrow-circle-left"></span> Previous</a>
857
858 </div>
859
860
861 <hr/>
862
863 <div role="contentinfo">
864 <p>
865 &copy; Copyright 2014 - 2019, British Columbia Institute of Technology.
866 Last updated on Jan 16, 2019.
867 </p>
868 </div>
869
870 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>.
871
872</footer>
873 </div>
874 </div>
875
876 </section>
877
878 </div>
879
880
881
882
883
884 <script type="text/javascript">
885 var DOCUMENTATION_OPTIONS = {
886 URL_ROOT:'../',
887 VERSION:'3.1.10',
888 COLLAPSE_INDEX:false,
889 FILE_SUFFIX:'.html',
890 HAS_SOURCE: false
891 };
892 </script>
893 <script type="text/javascript" src="../_static/jquery.js"></script>
894 <script type="text/javascript" src="../_static/underscore.js"></script>
895 <script type="text/javascript" src="../_static/doctools.js"></script>
896
897
898
899
900
901 <script type="text/javascript" src="../_static/js/theme.js"></script>
902
903
904
905
906 <script type="text/javascript">
907 jQuery(function () {
908 SphinxRtdTheme.StickyNav.enable();
909 });
910 </script>
911
912
913</body>
914</html>