Gitiles
Code Review Sign In
www.giggi.me / code-igniter-v3-giggi / 74fc69384aea5f5712e1d2e5c17bee8ef8128bce / . / user_guide / libraries / input.html
blob: 65851f16c2125fd779f41a319527a1b91a570f1f [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>Input Class &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="Libraries" href="index.html"/>
38 <link rel="next" title="Javascript Class" href="javascript.html"/>
39 <link rel="prev" title="Image Manipulation Class" href="image_lib.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="../general/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>
94<li class="toctree-l1"><a class="reference internal" href="../general/index.html">General Topics</a><ul>
95<li class="toctree-l2"><a class="reference internal" href="../general/urls.html">CodeIgniter URLs</a></li>
96<li class="toctree-l2"><a class="reference internal" href="../general/controllers.html">Controllers</a></li>
97<li class="toctree-l2"><a class="reference internal" href="../general/reserved_names.html">Reserved Names</a></li>
98<li class="toctree-l2"><a class="reference internal" href="../general/views.html">Views</a></li>
99<li class="toctree-l2"><a class="reference internal" href="../general/models.html">Models</a></li>
100<li class="toctree-l2"><a class="reference internal" href="../general/helpers.html">Helpers</a></li>
101<li class="toctree-l2"><a class="reference internal" href="../general/libraries.html">Using CodeIgniter Libraries</a></li>
102<li class="toctree-l2"><a class="reference internal" href="../general/creating_libraries.html">Creating Libraries</a></li>
103<li class="toctree-l2"><a class="reference internal" href="../general/drivers.html">Using CodeIgniter Drivers</a></li>
104<li class="toctree-l2"><a class="reference internal" href="../general/creating_drivers.html">Creating Drivers</a></li>
105<li class="toctree-l2"><a class="reference internal" href="../general/core_classes.html">Creating Core System Classes</a></li>
106<li class="toctree-l2"><a class="reference internal" href="../general/ancillary_classes.html">Creating Ancillary Classes</a></li>
107<li class="toctree-l2"><a class="reference internal" href="../general/hooks.html">Hooks - Extending the Framework Core</a></li>
108<li class="toctree-l2"><a class="reference internal" href="../general/autoloader.html">Auto-loading Resources</a></li>
109<li class="toctree-l2"><a class="reference internal" href="../general/common_functions.html">Common Functions</a></li>
110<li class="toctree-l2"><a class="reference internal" href="../general/compatibility_functions.html">Compatibility Functions</a></li>
111<li class="toctree-l2"><a class="reference internal" href="../general/routing.html">URI Routing</a></li>
112<li class="toctree-l2"><a class="reference internal" href="../general/errors.html">Error Handling</a></li>
113<li class="toctree-l2"><a class="reference internal" href="../general/caching.html">Caching</a></li>
114<li class="toctree-l2"><a class="reference internal" href="../general/profiling.html">Profiling Your Application</a></li>
115<li class="toctree-l2"><a class="reference internal" href="../general/cli.html">Running via the CLI</a></li>
116<li class="toctree-l2"><a class="reference internal" href="../general/managing_apps.html">Managing your Applications</a></li>
117<li class="toctree-l2"><a class="reference internal" href="../general/environments.html">Handling Multiple Environments</a></li>
118<li class="toctree-l2"><a class="reference internal" href="../general/alternative_php.html">Alternate PHP Syntax for View Files</a></li>
119<li class="toctree-l2"><a class="reference internal" href="../general/security.html">Security</a></li>
120<li class="toctree-l2"><a class="reference internal" href="../general/styleguide.html">PHP Style Guide</a></li>
121</ul>
122</li>
123</ul>
124<ul class="current">
125<li class="toctree-l1 current"><a class="reference internal" href="index.html">Libraries</a><ul class="current">
126<li class="toctree-l2"><a class="reference internal" href="benchmark.html">Benchmarking Class</a></li>
127<li class="toctree-l2"><a class="reference internal" href="caching.html">Caching Driver</a></li>
128<li class="toctree-l2"><a class="reference internal" href="calendar.html">Calendaring Class</a></li>
129<li class="toctree-l2"><a class="reference internal" href="cart.html">Shopping Cart Class</a></li>
130<li class="toctree-l2"><a class="reference internal" href="config.html">Config Class</a></li>
131<li class="toctree-l2"><a class="reference internal" href="email.html">Email Class</a></li>
132<li class="toctree-l2"><a class="reference internal" href="encrypt.html">Encrypt Class</a></li>
133<li class="toctree-l2"><a class="reference internal" href="encryption.html">Encryption Library</a></li>
134<li class="toctree-l2"><a class="reference internal" href="file_uploading.html">File Uploading Class</a></li>
135<li class="toctree-l2"><a class="reference internal" href="form_validation.html">Form Validation</a></li>
136<li class="toctree-l2"><a class="reference internal" href="ftp.html">FTP Class</a></li>
137<li class="toctree-l2"><a class="reference internal" href="image_lib.html">Image Manipulation Class</a></li>
138<li class="toctree-l2 current"><a class="current reference internal" href="#">Input Class</a></li>
139<li class="toctree-l2"><a class="reference internal" href="javascript.html">Javascript Class</a></li>
140<li class="toctree-l2"><a class="reference internal" href="language.html">Language Class</a></li>
141<li class="toctree-l2"><a class="reference internal" href="loader.html">Loader Class</a></li>
142<li class="toctree-l2"><a class="reference internal" href="migration.html">Migrations Class</a></li>
143<li class="toctree-l2"><a class="reference internal" href="output.html">Output Class</a></li>
144<li class="toctree-l2"><a class="reference internal" href="pagination.html">Pagination Class</a></li>
145<li class="toctree-l2"><a class="reference internal" href="parser.html">Template Parser Class</a></li>
146<li class="toctree-l2"><a class="reference internal" href="security.html">Security Class</a></li>
147<li class="toctree-l2"><a class="reference internal" href="sessions.html">Session Library</a></li>
148<li class="toctree-l2"><a class="reference internal" href="table.html">HTML Table Class</a></li>
149<li class="toctree-l2"><a class="reference internal" href="trackback.html">Trackback Class</a></li>
150<li class="toctree-l2"><a class="reference internal" href="typography.html">Typography Class</a></li>
151<li class="toctree-l2"><a class="reference internal" href="unit_testing.html">Unit Testing Class</a></li>
152<li class="toctree-l2"><a class="reference internal" href="uri.html">URI Class</a></li>
153<li class="toctree-l2"><a class="reference internal" href="user_agent.html">User Agent Class</a></li>
154<li class="toctree-l2"><a class="reference internal" href="xmlrpc.html">XML-RPC and XML-RPC Server Classes</a></li>
155<li class="toctree-l2"><a class="reference internal" href="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="../general/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>
278<li class="toctree-l1"><a class="reference internal" href="../general/index.html">General Topics</a><ul>
279<li class="toctree-l2"><a class="reference internal" href="../general/urls.html">CodeIgniter URLs</a></li>
280<li class="toctree-l2"><a class="reference internal" href="../general/controllers.html">Controllers</a></li>
281<li class="toctree-l2"><a class="reference internal" href="../general/reserved_names.html">Reserved Names</a></li>
282<li class="toctree-l2"><a class="reference internal" href="../general/views.html">Views</a></li>
283<li class="toctree-l2"><a class="reference internal" href="../general/models.html">Models</a></li>
284<li class="toctree-l2"><a class="reference internal" href="../general/helpers.html">Helpers</a></li>
285<li class="toctree-l2"><a class="reference internal" href="../general/libraries.html">Using CodeIgniter Libraries</a></li>
286<li class="toctree-l2"><a class="reference internal" href="../general/creating_libraries.html">Creating Libraries</a></li>
287<li class="toctree-l2"><a class="reference internal" href="../general/drivers.html">Using CodeIgniter Drivers</a></li>
288<li class="toctree-l2"><a class="reference internal" href="../general/creating_drivers.html">Creating Drivers</a></li>
289<li class="toctree-l2"><a class="reference internal" href="../general/core_classes.html">Creating Core System Classes</a></li>
290<li class="toctree-l2"><a class="reference internal" href="../general/ancillary_classes.html">Creating Ancillary Classes</a></li>
291<li class="toctree-l2"><a class="reference internal" href="../general/hooks.html">Hooks - Extending the Framework Core</a></li>
292<li class="toctree-l2"><a class="reference internal" href="../general/autoloader.html">Auto-loading Resources</a></li>
293<li class="toctree-l2"><a class="reference internal" href="../general/common_functions.html">Common Functions</a></li>
294<li class="toctree-l2"><a class="reference internal" href="../general/compatibility_functions.html">Compatibility Functions</a></li>
295<li class="toctree-l2"><a class="reference internal" href="../general/routing.html">URI Routing</a></li>
296<li class="toctree-l2"><a class="reference internal" href="../general/errors.html">Error Handling</a></li>
297<li class="toctree-l2"><a class="reference internal" href="../general/caching.html">Caching</a></li>
298<li class="toctree-l2"><a class="reference internal" href="../general/profiling.html">Profiling Your Application</a></li>
299<li class="toctree-l2"><a class="reference internal" href="../general/cli.html">Running via the CLI</a></li>
300<li class="toctree-l2"><a class="reference internal" href="../general/managing_apps.html">Managing your Applications</a></li>
301<li class="toctree-l2"><a class="reference internal" href="../general/environments.html">Handling Multiple Environments</a></li>
302<li class="toctree-l2"><a class="reference internal" href="../general/alternative_php.html">Alternate PHP Syntax for View Files</a></li>
303<li class="toctree-l2"><a class="reference internal" href="../general/security.html">Security</a></li>
304<li class="toctree-l2"><a class="reference internal" href="../general/styleguide.html">PHP Style Guide</a></li>
305</ul>
306</li>
307</ul>
308<ul class="current">
309<li class="toctree-l1 current"><a class="reference internal" href="index.html">Libraries</a><ul class="current">
310<li class="toctree-l2"><a class="reference internal" href="benchmark.html">Benchmarking Class</a></li>
311<li class="toctree-l2"><a class="reference internal" href="caching.html">Caching Driver</a></li>
312<li class="toctree-l2"><a class="reference internal" href="calendar.html">Calendaring Class</a></li>
313<li class="toctree-l2"><a class="reference internal" href="cart.html">Shopping Cart Class</a></li>
314<li class="toctree-l2"><a class="reference internal" href="config.html">Config Class</a></li>
315<li class="toctree-l2"><a class="reference internal" href="email.html">Email Class</a></li>
316<li class="toctree-l2"><a class="reference internal" href="encrypt.html">Encrypt Class</a></li>
317<li class="toctree-l2"><a class="reference internal" href="encryption.html">Encryption Library</a></li>
318<li class="toctree-l2"><a class="reference internal" href="file_uploading.html">File Uploading Class</a></li>
319<li class="toctree-l2"><a class="reference internal" href="form_validation.html">Form Validation</a></li>
320<li class="toctree-l2"><a class="reference internal" href="ftp.html">FTP Class</a></li>
321<li class="toctree-l2"><a class="reference internal" href="image_lib.html">Image Manipulation Class</a></li>
322<li class="toctree-l2 current"><a class="current reference internal" href="#">Input Class</a></li>
323<li class="toctree-l2"><a class="reference internal" href="javascript.html">Javascript Class</a></li>
324<li class="toctree-l2"><a class="reference internal" href="language.html">Language Class</a></li>
325<li class="toctree-l2"><a class="reference internal" href="loader.html">Loader Class</a></li>
326<li class="toctree-l2"><a class="reference internal" href="migration.html">Migrations Class</a></li>
327<li class="toctree-l2"><a class="reference internal" href="output.html">Output Class</a></li>
328<li class="toctree-l2"><a class="reference internal" href="pagination.html">Pagination Class</a></li>
329<li class="toctree-l2"><a class="reference internal" href="parser.html">Template Parser Class</a></li>
330<li class="toctree-l2"><a class="reference internal" href="security.html">Security Class</a></li>
331<li class="toctree-l2"><a class="reference internal" href="sessions.html">Session Library</a></li>
332<li class="toctree-l2"><a class="reference internal" href="table.html">HTML Table Class</a></li>
333<li class="toctree-l2"><a class="reference internal" href="trackback.html">Trackback Class</a></li>
334<li class="toctree-l2"><a class="reference internal" href="typography.html">Typography Class</a></li>
335<li class="toctree-l2"><a class="reference internal" href="unit_testing.html">Unit Testing Class</a></li>
336<li class="toctree-l2"><a class="reference internal" href="uri.html">URI Class</a></li>
337<li class="toctree-l2"><a class="reference internal" href="user_agent.html">User Agent Class</a></li>
338<li class="toctree-l2"><a class="reference internal" href="xmlrpc.html">XML-RPC and XML-RPC Server Classes</a></li>
339<li class="toctree-l2"><a class="reference internal" href="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">Libraries</a> &raquo;</li>
412
413 <li>Input Class</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="input-class">
426<h1>Input Class<a class="headerlink" href="#input-class" title="Permalink to this headline"></a></h1>
427<p>The Input Class serves two purposes:</p>
428<ol class="arabic simple">
429<li>It pre-processes global input data for security.</li>
430<li>It provides some helper methods for fetching input data and pre-processing it.</li>
431</ol>
432<div class="admonition note">
433<p class="first admonition-title">Note</p>
434<p class="last">This class is initialized automatically by the system so there
435is no need to do it manually.</p>
436</div>
437<div class="contents local topic" id="contents">
438<ul class="simple">
439<li><a class="reference internal" href="#input-filtering" id="id1">Input Filtering</a><ul>
440<li><a class="reference internal" href="#security-filtering" id="id2">Security Filtering</a></li>
441<li><a class="reference internal" href="#xss-filtering" id="id3">XSS Filtering</a></li>
442</ul>
443</li>
444<li><a class="reference internal" href="#accessing-form-data" id="id4">Accessing form data</a><ul>
445<li><a class="reference internal" href="#using-post-get-cookie-or-server-data" id="id5">Using POST, GET, COOKIE, or SERVER Data</a></li>
446<li><a class="reference internal" href="#using-the-php-input-stream" id="id6">Using the php://input stream</a></li>
447</ul>
448</li>
449<li><a class="reference internal" href="#class-reference" id="id7">Class Reference</a></li>
450</ul>
451</div>
452<div class="custom-index container"></div><div class="section" id="input-filtering">
453<h2><a class="toc-backref" href="#id1">Input Filtering</a><a class="headerlink" href="#input-filtering" title="Permalink to this headline"></a></h2>
454<div class="section" id="security-filtering">
455<h3><a class="toc-backref" href="#id2">Security Filtering</a><a class="headerlink" href="#security-filtering" title="Permalink to this headline"></a></h3>
456<p>The security filtering method is called automatically when a new
457<a class="reference internal" href="../general/controllers.html"><span class="doc">controller</span></a> is invoked. It does the
458following:</p>
459<ul class="simple">
460<li>If <code class="docutils literal"><span class="pre">$config['allow_get_array']</span></code> is FALSE (default is TRUE), destroys
461the global GET array.</li>
462<li>Destroys all global variables in the event register_globals is
463turned on.</li>
464<li>Filters the GET/POST/COOKIE array keys, permitting only alpha-numeric
465(and a few other) characters.</li>
466<li>Provides XSS (Cross-site Scripting Hacks) filtering. This can be
467enabled globally, or upon request.</li>
468<li>Standardizes newline characters to <code class="docutils literal"><span class="pre">PHP_EOL</span></code> (\n in UNIX-based OSes,
469\r\n under Windows). This is configurable.</li>
470</ul>
471</div>
472<div class="section" id="xss-filtering">
473<h3><a class="toc-backref" href="#id3">XSS Filtering</a><a class="headerlink" href="#xss-filtering" title="Permalink to this headline"></a></h3>
474<p>The Input class has the ability to filter input automatically to prevent
475cross-site scripting attacks. If you want the filter to run
476automatically every time it encounters POST or COOKIE data you can
477enable it by opening your <em>application/config/config.php</em> file and setting
478this:</p>
479<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$config</span><span class="p">[</span><span class="s1">&#39;global_xss_filtering&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="k">TRUE</span><span class="p">;</span>
480</pre></div>
481</div>
482<p>Please refer to the <a class="reference internal" href="security.html"><span class="doc">Security class</span></a> documentation for
483information on using XSS Filtering in your application.</p>
484<div class="admonition important">
485<p class="first admonition-title">Important</p>
486<p class="last">The ‘global_xss_filtering’ setting is DEPRECATED and kept
487solely for backwards-compatibility purposes. XSS escaping should
488be performed on <em>output</em>, not <em>input</em>!</p>
489</div>
490</div>
491</div>
492<div class="section" id="accessing-form-data">
493<h2><a class="toc-backref" href="#id4">Accessing form data</a><a class="headerlink" href="#accessing-form-data" title="Permalink to this headline"></a></h2>
494<div class="section" id="using-post-get-cookie-or-server-data">
495<h3><a class="toc-backref" href="#id5">Using POST, GET, COOKIE, or SERVER Data</a><a class="headerlink" href="#using-post-get-cookie-or-server-data" title="Permalink to this headline"></a></h3>
496<p>CodeIgniter comes with helper methods that let you fetch POST, GET,
497COOKIE or SERVER items. The main advantage of using the provided
498methods rather than fetching an item directly (<code class="docutils literal"><span class="pre">$_POST['something']</span></code>)
499is that the methods will check to see if the item is set and return
500NULL if not. This lets you conveniently use data without
501having to test whether an item exists first. In other words, normally
502you might do something like this:</p>
503<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$something</span> <span class="o">=</span> <span class="nb">isset</span><span class="p">(</span><span class="nv">$_POST</span><span class="p">[</span><span class="s1">&#39;something&#39;</span><span class="p">])</span> <span class="o">?</span> <span class="nv">$_POST</span><span class="p">[</span><span class="s1">&#39;something&#39;</span><span class="p">]</span> <span class="o">:</span> <span class="k">NULL</span><span class="p">;</span>
504</pre></div>
505</div>
506<p>With CodeIgniter’s built in methods you can simply do this:</p>
507<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$something</span> <span class="o">=</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">input</span><span class="o">-&gt;</span><span class="na">post</span><span class="p">(</span><span class="s1">&#39;something&#39;</span><span class="p">);</span>
508</pre></div>
509</div>
510<p>The main methods are:</p>
511<ul class="simple">
512<li><code class="docutils literal"><span class="pre">$this-&gt;input-&gt;post()</span></code></li>
513<li><code class="docutils literal"><span class="pre">$this-&gt;input-&gt;get()</span></code></li>
514<li><code class="docutils literal"><span class="pre">$this-&gt;input-&gt;cookie()</span></code></li>
515<li><code class="docutils literal"><span class="pre">$this-&gt;input-&gt;server()</span></code></li>
516</ul>
517</div>
518<div class="section" id="using-the-php-input-stream">
519<h3><a class="toc-backref" href="#id6">Using the php://input stream</a><a class="headerlink" href="#using-the-php-input-stream" title="Permalink to this headline"></a></h3>
520<p>If you want to utilize the PUT, DELETE, PATCH or other exotic request
521methods, they can only be accessed via a special input stream, that
522can only be read once. This isn’t as easy as just reading from e.g.
523the <code class="docutils literal"><span class="pre">$_POST</span></code> array, because it will always exist and you can try
524and access multiple variables without caring that you might only have
525one shot at all of the POST data.</p>
526<p>CodeIgniter will take care of that for you, and you can read the data
527from the <strong>php://input</strong> stream at any time, just by using the
528<code class="docutils literal"><span class="pre">$raw_input_stream</span></code> property:</p>
529<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">input</span><span class="o">-&gt;</span><span class="na">raw_input_stream</span><span class="p">;</span>
530</pre></div>
531</div>
532<p>Additionally if the input stream is form-encoded like $_POST you can
533access its values by calling the
534<code class="docutils literal"><span class="pre">input_stream()</span></code> method:</p>
535<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">input</span><span class="o">-&gt;</span><span class="na">input_stream</span><span class="p">(</span><span class="s1">&#39;key&#39;</span><span class="p">);</span>
536</pre></div>
537</div>
538<p>Similar to other methods such as <code class="docutils literal"><span class="pre">get()</span></code> and <code class="docutils literal"><span class="pre">post()</span></code>, if the
539requested data is not found, it will return NULL and you can also
540decide whether to run the data through <code class="docutils literal"><span class="pre">xss_clean()</span></code> by passing
541a boolean value as the second parameter:</p>
542<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">input</span><span class="o">-&gt;</span><span class="na">input_stream</span><span class="p">(</span><span class="s1">&#39;key&#39;</span><span class="p">,</span> <span class="k">TRUE</span><span class="p">);</span> <span class="c1">// XSS Clean</span>
543<span class="nv">$this</span><span class="o">-&gt;</span><span class="na">input</span><span class="o">-&gt;</span><span class="na">input_stream</span><span class="p">(</span><span class="s1">&#39;key&#39;</span><span class="p">,</span> <span class="k">FALSE</span><span class="p">);</span> <span class="c1">// No XSS filter</span>
544</pre></div>
545</div>
546<div class="admonition note">
547<p class="first admonition-title">Note</p>
548<p class="last">You can utilize <code class="docutils literal"><span class="pre">method()</span></code> in order to know if you’re reading
549PUT, DELETE or PATCH data.</p>
550</div>
551</div>
552</div>
553<div class="section" id="class-reference">
554<h2><a class="toc-backref" href="#id7">Class Reference</a><a class="headerlink" href="#class-reference" title="Permalink to this headline"></a></h2>
555<dl class="class">
556<dt id="CI_Input">
557<em class="property">class </em><code class="descname">CI_Input</code><a class="headerlink" href="#CI_Input" title="Permalink to this definition"></a></dt>
558<dd><dl class="attribute">
559<dt>
560<code class="descname">$raw_input_stream</code></dt>
561<dd><p>Read only property that will return php://input data as is.</p>
562<p>The property can be read multiple times.</p>
563</dd></dl>
564
565<dl class="method">
566<dt id="CI_Input::post">
567<code class="descname">post</code><span class="sig-paren">(</span><span class="optional">[</span><em>$index = NULL</em><span class="optional">[</span>, <em>$xss_clean = NULL</em><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_Input::post" title="Permalink to this definition"></a></dt>
568<dd><table class="docutils field-list" frame="void" rules="none">
569<col class="field-name" />
570<col class="field-body" />
571<tbody valign="top">
572<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
573<li><strong>$index</strong> (<em>mixed</em>) – POST parameter name</li>
574<li><strong>$xss_clean</strong> (<em>bool</em>) – Whether to apply XSS filtering</li>
575</ul>
576</td>
577</tr>
578<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">$_POST if no parameters supplied, otherwise the POST value if found or NULL if not</p>
579</td>
580</tr>
581<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">mixed</p>
582</td>
583</tr>
584</tbody>
585</table>
586<p>The first parameter will contain the name of the POST item you are
587looking for:</p>
588<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">input</span><span class="o">-&gt;</span><span class="na">post</span><span class="p">(</span><span class="s1">&#39;some_data&#39;</span><span class="p">);</span>
589</pre></div>
590</div>
591<p>The method returns NULL if the item you are attempting to retrieve
592does not exist.</p>
593<p>The second optional parameter lets you run the data through the XSS
594filter. It’s enabled by setting the second parameter to boolean TRUE
595or by setting your <code class="docutils literal"><span class="pre">$config['global_xss_filtering']</span></code> to TRUE.</p>
596<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">input</span><span class="o">-&gt;</span><span class="na">post</span><span class="p">(</span><span class="s1">&#39;some_data&#39;</span><span class="p">,</span> <span class="k">TRUE</span><span class="p">);</span>
597</pre></div>
598</div>
599<p>To return an array of all POST items call without any parameters.</p>
600<p>To return all POST items and pass them through the XSS filter set the
601first parameter NULL while setting the second parameter to boolean TRUE.</p>
602<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">input</span><span class="o">-&gt;</span><span class="na">post</span><span class="p">(</span><span class="k">NULL</span><span class="p">,</span> <span class="k">TRUE</span><span class="p">);</span> <span class="c1">// returns all POST items with XSS filter</span>
603<span class="nv">$this</span><span class="o">-&gt;</span><span class="na">input</span><span class="o">-&gt;</span><span class="na">post</span><span class="p">(</span><span class="k">NULL</span><span class="p">,</span> <span class="k">FALSE</span><span class="p">);</span> <span class="c1">// returns all POST items without XSS filter</span>
604</pre></div>
605</div>
606<p>To return an array of multiple POST parameters, pass all the required keys
607as an array.</p>
608<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">input</span><span class="o">-&gt;</span><span class="na">post</span><span class="p">(</span><span class="k">array</span><span class="p">(</span><span class="s1">&#39;field1&#39;</span><span class="p">,</span> <span class="s1">&#39;field2&#39;</span><span class="p">));</span>
609</pre></div>
610</div>
611<p>Same rule applied here, to retrieve the parameters with XSS filtering enabled, set the
612second parameter to boolean TRUE.</p>
613<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">input</span><span class="o">-&gt;</span><span class="na">post</span><span class="p">(</span><span class="k">array</span><span class="p">(</span><span class="s1">&#39;field1&#39;</span><span class="p">,</span> <span class="s1">&#39;field2&#39;</span><span class="p">),</span> <span class="k">TRUE</span><span class="p">);</span>
614</pre></div>
615</div>
616</dd></dl>
617
618<dl class="method">
619<dt id="CI_Input::get">
620<code class="descname">get</code><span class="sig-paren">(</span><span class="optional">[</span><em>$index = NULL</em><span class="optional">[</span>, <em>$xss_clean = NULL</em><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_Input::get" title="Permalink to this definition"></a></dt>
621<dd><table class="docutils field-list" frame="void" rules="none">
622<col class="field-name" />
623<col class="field-body" />
624<tbody valign="top">
625<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
626<li><strong>$index</strong> (<em>mixed</em>) – GET parameter name</li>
627<li><strong>$xss_clean</strong> (<em>bool</em>) – Whether to apply XSS filtering</li>
628</ul>
629</td>
630</tr>
631<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">$_GET if no parameters supplied, otherwise the GET value if found or NULL if not</p>
632</td>
633</tr>
634<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">mixed</p>
635</td>
636</tr>
637</tbody>
638</table>
639<p>This method is identical to <code class="docutils literal"><span class="pre">post()</span></code>, only it fetches GET data.</p>
640<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">input</span><span class="o">-&gt;</span><span class="na">get</span><span class="p">(</span><span class="s1">&#39;some_data&#39;</span><span class="p">,</span> <span class="k">TRUE</span><span class="p">);</span>
641</pre></div>
642</div>
643<p>To return an array of all GET items call without any parameters.</p>
644<p>To return all GET items and pass them through the XSS filter set the
645first parameter NULL while setting the second parameter to boolean TRUE.</p>
646<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">input</span><span class="o">-&gt;</span><span class="na">get</span><span class="p">(</span><span class="k">NULL</span><span class="p">,</span> <span class="k">TRUE</span><span class="p">);</span> <span class="c1">// returns all GET items with XSS filter</span>
647<span class="nv">$this</span><span class="o">-&gt;</span><span class="na">input</span><span class="o">-&gt;</span><span class="na">get</span><span class="p">(</span><span class="k">NULL</span><span class="p">,</span> <span class="k">FALSE</span><span class="p">);</span> <span class="c1">// returns all GET items without XSS filtering</span>
648</pre></div>
649</div>
650<p>To return an array of multiple GET parameters, pass all the required keys
651as an array.</p>
652<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">input</span><span class="o">-&gt;</span><span class="na">get</span><span class="p">(</span><span class="k">array</span><span class="p">(</span><span class="s1">&#39;field1&#39;</span><span class="p">,</span> <span class="s1">&#39;field2&#39;</span><span class="p">));</span>
653</pre></div>
654</div>
655<p>Same rule applied here, to retrieve the parameters with XSS filtering enabled, set the
656second parameter to boolean TRUE.</p>
657<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">input</span><span class="o">-&gt;</span><span class="na">get</span><span class="p">(</span><span class="k">array</span><span class="p">(</span><span class="s1">&#39;field1&#39;</span><span class="p">,</span> <span class="s1">&#39;field2&#39;</span><span class="p">),</span> <span class="k">TRUE</span><span class="p">);</span>
658</pre></div>
659</div>
660</dd></dl>
661
662<dl class="method">
663<dt id="CI_Input::post_get">
664<code class="descname">post_get</code><span class="sig-paren">(</span><em>$index</em><span class="optional">[</span>, <em>$xss_clean = NULL</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_Input::post_get" title="Permalink to this definition"></a></dt>
665<dd><table class="docutils field-list" frame="void" rules="none">
666<col class="field-name" />
667<col class="field-body" />
668<tbody valign="top">
669<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
670<li><strong>$index</strong> (<em>string</em>) – POST/GET parameter name</li>
671<li><strong>$xss_clean</strong> (<em>bool</em>) – Whether to apply XSS filtering</li>
672</ul>
673</td>
674</tr>
675<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">POST/GET value if found, NULL if not</p>
676</td>
677</tr>
678<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">mixed</p>
679</td>
680</tr>
681</tbody>
682</table>
683<p>This method works pretty much the same way as <code class="docutils literal"><span class="pre">post()</span></code> and <code class="docutils literal"><span class="pre">get()</span></code>,
684only combined. It will search through both POST and GET streams for data,
685looking in POST first, and then in GET:</p>
686<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">input</span><span class="o">-&gt;</span><span class="na">post_get</span><span class="p">(</span><span class="s1">&#39;some_data&#39;</span><span class="p">,</span> <span class="k">TRUE</span><span class="p">);</span>
687</pre></div>
688</div>
689</dd></dl>
690
691<dl class="method">
692<dt id="CI_Input::get_post">
693<code class="descname">get_post</code><span class="sig-paren">(</span><em>$index</em><span class="optional">[</span>, <em>$xss_clean = NULL</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_Input::get_post" title="Permalink to this definition"></a></dt>
694<dd><table class="docutils field-list" frame="void" rules="none">
695<col class="field-name" />
696<col class="field-body" />
697<tbody valign="top">
698<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
699<li><strong>$index</strong> (<em>string</em>) – GET/POST parameter name</li>
700<li><strong>$xss_clean</strong> (<em>bool</em>) – Whether to apply XSS filtering</li>
701</ul>
702</td>
703</tr>
704<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">GET/POST value if found, NULL if not</p>
705</td>
706</tr>
707<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">mixed</p>
708</td>
709</tr>
710</tbody>
711</table>
712<p>This method works the same way as <code class="docutils literal"><span class="pre">post_get()</span></code> only it looks for GET
713data first.</p>
714<blockquote>
715<div>$this-&gt;input-&gt;get_post(‘some_data’, TRUE);</div></blockquote>
716<div class="admonition note">
717<p class="first admonition-title">Note</p>
718<p class="last">This method used to act EXACTLY like <code class="docutils literal"><span class="pre">post_get()</span></code>, but it’s
719behavior has changed in CodeIgniter 3.0.</p>
720</div>
721</dd></dl>
722
723<dl class="method">
724<dt id="CI_Input::cookie">
725<code class="descname">cookie</code><span class="sig-paren">(</span><span class="optional">[</span><em>$index = NULL</em><span class="optional">[</span>, <em>$xss_clean = NULL</em><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_Input::cookie" title="Permalink to this definition"></a></dt>
726<dd><table class="docutils field-list" frame="void" rules="none">
727<col class="field-name" />
728<col class="field-body" />
729<tbody valign="top">
730<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
731<li><strong>$index</strong> (<em>mixed</em>) – COOKIE name</li>
732<li><strong>$xss_clean</strong> (<em>bool</em>) – Whether to apply XSS filtering</li>
733</ul>
734</td>
735</tr>
736<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">$_COOKIE if no parameters supplied, otherwise the COOKIE value if found or NULL if not</p>
737</td>
738</tr>
739<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">mixed</p>
740</td>
741</tr>
742</tbody>
743</table>
744<p>This method is identical to <code class="docutils literal"><span class="pre">post()</span></code> and <code class="docutils literal"><span class="pre">get()</span></code>, only it fetches cookie
745data:</p>
746<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">input</span><span class="o">-&gt;</span><span class="na">cookie</span><span class="p">(</span><span class="s1">&#39;some_cookie&#39;</span><span class="p">);</span>
747<span class="nv">$this</span><span class="o">-&gt;</span><span class="na">input</span><span class="o">-&gt;</span><span class="na">cookie</span><span class="p">(</span><span class="s1">&#39;some_cookie&#39;</span><span class="p">,</span> <span class="k">TRUE</span><span class="p">);</span> <span class="c1">// with XSS filter</span>
748</pre></div>
749</div>
750<p>To return an array of multiple cookie values, pass all the required keys
751as an array.</p>
752<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">input</span><span class="o">-&gt;</span><span class="na">cookie</span><span class="p">(</span><span class="k">array</span><span class="p">(</span><span class="s1">&#39;some_cookie&#39;</span><span class="p">,</span> <span class="s1">&#39;some_cookie2&#39;</span><span class="p">));</span>
753</pre></div>
754</div>
755<div class="admonition note">
756<p class="first admonition-title">Note</p>
757<p class="last">Unlike the <a class="reference internal" href="../helpers/cookie_helper.html"><span class="doc">Cookie Helper</span></a>
758function <a class="reference internal" href="../helpers/cookie_helper.html#get_cookie" title="get_cookie"><code class="xref php php-func docutils literal"><span class="pre">get_cookie()</span></code></a>, this method does NOT prepend
759your configured <code class="docutils literal"><span class="pre">$config['cookie_prefix']</span></code> value.</p>
760</div>
761</dd></dl>
762
763<dl class="method">
764<dt id="CI_Input::server">
765<code class="descname">server</code><span class="sig-paren">(</span><em>$index</em><span class="optional">[</span>, <em>$xss_clean = NULL</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_Input::server" title="Permalink to this definition"></a></dt>
766<dd><table class="docutils field-list" frame="void" rules="none">
767<col class="field-name" />
768<col class="field-body" />
769<tbody valign="top">
770<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
771<li><strong>$index</strong> (<em>mixed</em>) – Value name</li>
772<li><strong>$xss_clean</strong> (<em>bool</em>) – Whether to apply XSS filtering</li>
773</ul>
774</td>
775</tr>
776<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">$_SERVER item value if found, NULL if not</p>
777</td>
778</tr>
779<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">mixed</p>
780</td>
781</tr>
782</tbody>
783</table>
784<p>This method is identical to the <code class="docutils literal"><span class="pre">post()</span></code>, <code class="docutils literal"><span class="pre">get()</span></code> and <code class="docutils literal"><span class="pre">cookie()</span></code>
785methods, only it fetches server data (<code class="docutils literal"><span class="pre">$_SERVER</span></code>):</p>
786<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">input</span><span class="o">-&gt;</span><span class="na">server</span><span class="p">(</span><span class="s1">&#39;some_data&#39;</span><span class="p">);</span>
787</pre></div>
788</div>
789<p>To return an array of multiple <code class="docutils literal"><span class="pre">$_SERVER</span></code> values, pass all the required keys
790as an array.</p>
791<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">input</span><span class="o">-&gt;</span><span class="na">server</span><span class="p">(</span><span class="k">array</span><span class="p">(</span><span class="s1">&#39;SERVER_PROTOCOL&#39;</span><span class="p">,</span> <span class="s1">&#39;REQUEST_URI&#39;</span><span class="p">));</span>
792</pre></div>
793</div>
794</dd></dl>
795
796<dl class="method">
797<dt id="CI_Input::input_stream">
798<code class="descname">input_stream</code><span class="sig-paren">(</span><span class="optional">[</span><em>$index = NULL</em><span class="optional">[</span>, <em>$xss_clean = NULL</em><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_Input::input_stream" title="Permalink to this definition"></a></dt>
799<dd><table class="docutils field-list" frame="void" rules="none">
800<col class="field-name" />
801<col class="field-body" />
802<tbody valign="top">
803<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
804<li><strong>$index</strong> (<em>mixed</em>) – Key name</li>
805<li><strong>$xss_clean</strong> (<em>bool</em>) – Whether to apply XSS filtering</li>
806</ul>
807</td>
808</tr>
809<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Input stream array if no parameters supplied, otherwise the specified value if found or NULL if not</p>
810</td>
811</tr>
812<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">mixed</p>
813</td>
814</tr>
815</tbody>
816</table>
817<p>This method is identical to <code class="docutils literal"><span class="pre">get()</span></code>, <code class="docutils literal"><span class="pre">post()</span></code> and <code class="docutils literal"><span class="pre">cookie()</span></code>,
818only it fetches the <em>php://input</em> stream data.</p>
819</dd></dl>
820
821<dl class="method">
822<dt id="CI_Input::set_cookie">
823<code class="descname">set_cookie</code><span class="sig-paren">(</span><em>$name = ''</em><span class="optional">[</span>, <em>$value = ''</em><span class="optional">[</span>, <em>$expire = ''</em><span class="optional">[</span>, <em>$domain = ''</em><span class="optional">[</span>, <em>$path = '/'</em><span class="optional">[</span>, <em>$prefix = ''</em><span class="optional">[</span>, <em>$secure = NULL</em><span class="optional">[</span>, <em>$httponly = NULL</em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_Input::set_cookie" title="Permalink to this definition"></a></dt>
824<dd><table class="docutils field-list" frame="void" rules="none">
825<col class="field-name" />
826<col class="field-body" />
827<tbody valign="top">
828<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
829<li><strong>$name</strong> (<em>mixed</em>) – Cookie name or an array of parameters</li>
830<li><strong>$value</strong> (<em>string</em>) – Cookie value</li>
831<li><strong>$expire</strong> (<em>int</em>) – Cookie expiration time in seconds</li>
832<li><strong>$domain</strong> (<em>string</em>) – Cookie domain</li>
833<li><strong>$path</strong> (<em>string</em>) – Cookie path</li>
834<li><strong>$prefix</strong> (<em>string</em>) – Cookie name prefix</li>
835<li><strong>$secure</strong> (<em>bool</em>) – Whether to only transfer the cookie through HTTPS</li>
836<li><strong>$httponly</strong> (<em>bool</em>) – Whether to only make the cookie accessible for HTTP requests (no JavaScript)</li>
837</ul>
838</td>
839</tr>
840<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">void</p>
841</td>
842</tr>
843</tbody>
844</table>
845<p>Sets a cookie containing the values you specify. There are two ways to
846pass information to this method so that a cookie can be set: Array
847Method, and Discrete Parameters:</p>
848<p><strong>Array Method</strong></p>
849<p>Using this method, an associative array is passed to the first
850parameter:</p>
851<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$cookie</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span>
852 <span class="s1">&#39;name&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;The Cookie Name&#39;</span><span class="p">,</span>
853 <span class="s1">&#39;value&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;The Value&#39;</span><span class="p">,</span>
854 <span class="s1">&#39;expire&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;86500&#39;</span><span class="p">,</span>
855 <span class="s1">&#39;domain&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;.some-domain.com&#39;</span><span class="p">,</span>
856 <span class="s1">&#39;path&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;/&#39;</span><span class="p">,</span>
857 <span class="s1">&#39;prefix&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;myprefix_&#39;</span><span class="p">,</span>
858 <span class="s1">&#39;secure&#39;</span> <span class="o">=&gt;</span> <span class="k">TRUE</span>
859<span class="p">);</span>
860
861<span class="nv">$this</span><span class="o">-&gt;</span><span class="na">input</span><span class="o">-&gt;</span><span class="na">set_cookie</span><span class="p">(</span><span class="nv">$cookie</span><span class="p">);</span>
862</pre></div>
863</div>
864<p><strong>Notes</strong></p>
865<p>Only the name and value are required. To delete a cookie set it with the
866expiration blank.</p>
867<p>The expiration is set in <strong>seconds</strong>, which will be added to the current
868time. Do not include the time, but rather only the number of seconds
869from <em>now</em> that you wish the cookie to be valid. If the expiration is
870set to zero the cookie will only last as long as the browser is open.</p>
871<p>For site-wide cookies regardless of how your site is requested, add your
872URL to the <strong>domain</strong> starting with a period, like this:
873.your-domain.com</p>
874<p>The path is usually not needed since the method sets a root path.</p>
875<p>The prefix is only needed if you need to avoid name collisions with
876other identically named cookies for your server.</p>
877<p>The <em>httponly</em> and <em>secure</em> flags, when omitted, will default to your
878<code class="docutils literal"><span class="pre">$config['cookie_httponly']</span></code> and <code class="docutils literal"><span class="pre">$config['cookie_secure']</span></code> settings.</p>
879<p><strong>Discrete Parameters</strong></p>
880<p>If you prefer, you can set the cookie by passing data using individual
881parameters:</p>
882<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">input</span><span class="o">-&gt;</span><span class="na">set_cookie</span><span class="p">(</span><span class="nv">$name</span><span class="p">,</span> <span class="nv">$value</span><span class="p">,</span> <span class="nv">$expire</span><span class="p">,</span> <span class="nv">$domain</span><span class="p">,</span> <span class="nv">$path</span><span class="p">,</span> <span class="nv">$prefix</span><span class="p">,</span> <span class="nv">$secure</span><span class="p">);</span>
883</pre></div>
884</div>
885</dd></dl>
886
887<dl class="method">
888<dt id="CI_Input::ip_address">
889<code class="descname">ip_address</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_Input::ip_address" title="Permalink to this definition"></a></dt>
890<dd><table class="docutils field-list" frame="void" rules="none">
891<col class="field-name" />
892<col class="field-body" />
893<tbody valign="top">
894<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Visitor’s IP address or ‘0.0.0.0’ if not valid</td>
895</tr>
896<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">string</td>
897</tr>
898</tbody>
899</table>
900<p>Returns the IP address for the current user. If the IP address is not
901valid, the method will return ‘0.0.0.0’:</p>
902<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">echo</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">input</span><span class="o">-&gt;</span><span class="na">ip_address</span><span class="p">();</span>
903</pre></div>
904</div>
905<div class="admonition important">
906<p class="first admonition-title">Important</p>
907<p class="last">This method takes into account the <code class="docutils literal"><span class="pre">$config['proxy_ips']</span></code>
908setting and will return the reported HTTP_X_FORWARDED_FOR,
909HTTP_CLIENT_IP, HTTP_X_CLIENT_IP or HTTP_X_CLUSTER_CLIENT_IP
910address for the allowed IP addresses.</p>
911</div>
912</dd></dl>
913
914<dl class="method">
915<dt id="CI_Input::valid_ip">
916<code class="descname">valid_ip</code><span class="sig-paren">(</span><em>$ip</em><span class="optional">[</span>, <em>$which = ''</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_Input::valid_ip" title="Permalink to this definition"></a></dt>
917<dd><table class="docutils field-list" frame="void" rules="none">
918<col class="field-name" />
919<col class="field-body" />
920<tbody valign="top">
921<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
922<li><strong>$ip</strong> (<em>string</em>) – IP address</li>
923<li><strong>$which</strong> (<em>string</em>) – IP protocol (‘ipv4’ or ‘ipv6’)</li>
924</ul>
925</td>
926</tr>
927<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">TRUE if the address is valid, FALSE if not</p>
928</td>
929</tr>
930<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">bool</p>
931</td>
932</tr>
933</tbody>
934</table>
935<p>Takes an IP address as input and returns TRUE or FALSE (boolean) depending
936on whether it is valid or not.</p>
937<div class="admonition note">
938<p class="first admonition-title">Note</p>
939<p class="last">The $this-&gt;input-&gt;ip_address() method above automatically
940validates the IP address.</p>
941</div>
942<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">if</span> <span class="p">(</span> <span class="o">!</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">input</span><span class="o">-&gt;</span><span class="na">valid_ip</span><span class="p">(</span><span class="nv">$ip</span><span class="p">))</span>
943<span class="p">{</span>
944 <span class="k">echo</span> <span class="s1">&#39;Not Valid&#39;</span><span class="p">;</span>
945<span class="p">}</span>
946<span class="k">else</span>
947<span class="p">{</span>
948 <span class="k">echo</span> <span class="s1">&#39;Valid&#39;</span><span class="p">;</span>
949<span class="p">}</span>
950</pre></div>
951</div>
952<p>Accepts an optional second string parameter of ‘ipv4’ or ‘ipv6’ to specify
953an IP format. The default checks for both formats.</p>
954</dd></dl>
955
956<dl class="method">
957<dt id="CI_Input::user_agent">
958<code class="descname">user_agent</code><span class="sig-paren">(</span><span class="optional">[</span><em>$xss_clean = NULL</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_Input::user_agent" title="Permalink to this definition"></a></dt>
959<dd><table class="docutils field-list" frame="void" rules="none">
960<col class="field-name" />
961<col class="field-body" />
962<tbody valign="top">
963<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">User agent string or NULL if not set</p>
964</td>
965</tr>
966<tr class="field-even field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
967<li><strong>$xss_clean</strong> (<em>bool</em>) – Whether to apply XSS filtering</li>
968</ul>
969</td>
970</tr>
971<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">mixed</p>
972</td>
973</tr>
974</tbody>
975</table>
976<p>Returns the user agent string (web browser) being used by the current user,
977or NULL if it’s not available.</p>
978<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">echo</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">input</span><span class="o">-&gt;</span><span class="na">user_agent</span><span class="p">();</span>
979</pre></div>
980</div>
981<p>See the <a class="reference internal" href="user_agent.html"><span class="doc">User Agent Class</span></a> for methods which extract
982information from the user agent string.</p>
983</dd></dl>
984
985<dl class="method">
986<dt id="CI_Input::request_headers">
987<code class="descname">request_headers</code><span class="sig-paren">(</span><span class="optional">[</span><em>$xss_clean = FALSE</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_Input::request_headers" title="Permalink to this definition"></a></dt>
988<dd><table class="docutils field-list" frame="void" rules="none">
989<col class="field-name" />
990<col class="field-body" />
991<tbody valign="top">
992<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
993<li><strong>$xss_clean</strong> (<em>bool</em>) – Whether to apply XSS filtering</li>
994</ul>
995</td>
996</tr>
997<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">An array of HTTP request headers</p>
998</td>
999</tr>
1000<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">array</p>
1001</td>
1002</tr>
1003</tbody>
1004</table>
1005<p>Returns an array of HTTP request headers.
1006Useful if running in a non-Apache environment where
1007<a class="reference external" href="http://php.net/apache_request_headers">apache_request_headers()</a>
1008will not be supported.</p>
1009<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$headers</span> <span class="o">=</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">input</span><span class="o">-&gt;</span><span class="na">request_headers</span><span class="p">();</span>
1010</pre></div>
1011</div>
1012</dd></dl>
1013
1014<dl class="method">
1015<dt id="CI_Input::get_request_header">
1016<code class="descname">get_request_header</code><span class="sig-paren">(</span><em>$index</em><span class="optional">[</span>, <em>$xss_clean = FALSE</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_Input::get_request_header" title="Permalink to this definition"></a></dt>
1017<dd><table class="docutils field-list" frame="void" rules="none">
1018<col class="field-name" />
1019<col class="field-body" />
1020<tbody valign="top">
1021<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
1022<li><strong>$index</strong> (<em>string</em>) – HTTP request header name</li>
1023<li><strong>$xss_clean</strong> (<em>bool</em>) – Whether to apply XSS filtering</li>
1024</ul>
1025</td>
1026</tr>
1027<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">An HTTP request header or NULL if not found</p>
1028</td>
1029</tr>
1030<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
1031</td>
1032</tr>
1033</tbody>
1034</table>
1035<p>Returns a single member of the request headers array or NULL
1036if the searched header is not found.</p>
1037<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">input</span><span class="o">-&gt;</span><span class="na">get_request_header</span><span class="p">(</span><span class="s1">&#39;some-header&#39;</span><span class="p">,</span> <span class="k">TRUE</span><span class="p">);</span>
1038</pre></div>
1039</div>
1040</dd></dl>
1041
1042<dl class="method">
1043<dt id="CI_Input::is_ajax_request">
1044<code class="descname">is_ajax_request</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_Input::is_ajax_request" title="Permalink to this definition"></a></dt>
1045<dd><table class="docutils field-list" frame="void" rules="none">
1046<col class="field-name" />
1047<col class="field-body" />
1048<tbody valign="top">
1049<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">TRUE if it is an Ajax request, FALSE if not</td>
1050</tr>
1051<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
1052</tr>
1053</tbody>
1054</table>
1055<p>Checks to see if the HTTP_X_REQUESTED_WITH server header has been
1056set, and returns boolean TRUE if it is or FALSE if not.</p>
1057</dd></dl>
1058
1059<dl class="method">
1060<dt id="CI_Input::is_cli_request">
1061<code class="descname">is_cli_request</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_Input::is_cli_request" title="Permalink to this definition"></a></dt>
1062<dd><table class="docutils field-list" frame="void" rules="none">
1063<col class="field-name" />
1064<col class="field-body" />
1065<tbody valign="top">
1066<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">TRUE if it is a CLI request, FALSE if not</td>
1067</tr>
1068<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
1069</tr>
1070</tbody>
1071</table>
1072<p>Checks to see if the application was run from the command-line
1073interface.</p>
1074<div class="admonition note">
1075<p class="first admonition-title">Note</p>
1076<p class="last">This method checks both the PHP SAPI name currently in use
1077and if the <code class="docutils literal"><span class="pre">STDIN</span></code> constant is defined, which is usually a
1078failsafe way to see if PHP is being run via the command line.</p>
1079</div>
1080<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">input</span><span class="o">-&gt;</span><span class="na">is_cli_request</span><span class="p">()</span>
1081</pre></div>
1082</div>
1083<div class="admonition note">
1084<p class="first admonition-title">Note</p>
1085<p class="last">This method is DEPRECATED and is now just an alias for the
1086<code class="xref py py-func docutils literal"><span class="pre">is_cli()</span></code> function.</p>
1087</div>
1088</dd></dl>
1089
1090<dl class="method">
1091<dt id="CI_Input::method">
1092<code class="descname">method</code><span class="sig-paren">(</span><span class="optional">[</span><em>$upper = FALSE</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_Input::method" title="Permalink to this definition"></a></dt>
1093<dd><table class="docutils field-list" frame="void" rules="none">
1094<col class="field-name" />
1095<col class="field-body" />
1096<tbody valign="top">
1097<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
1098<li><strong>$upper</strong> (<em>bool</em>) – Whether to return the request method name in upper or lower case</li>
1099</ul>
1100</td>
1101</tr>
1102<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">HTTP request method</p>
1103</td>
1104</tr>
1105<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
1106</td>
1107</tr>
1108</tbody>
1109</table>
1110<p>Returns the <code class="docutils literal"><span class="pre">$_SERVER['REQUEST_METHOD']</span></code>, with the option to set it
1111in uppercase or lowercase.</p>
1112<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">echo</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">input</span><span class="o">-&gt;</span><span class="na">method</span><span class="p">(</span><span class="k">TRUE</span><span class="p">);</span> <span class="c1">// Outputs: POST</span>
1113<span class="k">echo</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">input</span><span class="o">-&gt;</span><span class="na">method</span><span class="p">(</span><span class="k">FALSE</span><span class="p">);</span> <span class="c1">// Outputs: post</span>
1114<span class="k">echo</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">input</span><span class="o">-&gt;</span><span class="na">method</span><span class="p">();</span> <span class="c1">// Outputs: post</span>
1115</pre></div>
1116</div>
1117</dd></dl>
1118
1119</dd></dl>
1120
1121</div>
1122</div>
1123
1124
1125 </div>
1126 <footer>
1127
1128 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
1129
1130 <a href="javascript.html" class="btn btn-neutral float-right" title="Javascript Class">Next <span class="fa fa-arrow-circle-right"></span></a>
1131
1132
1133 <a href="image_lib.html" class="btn btn-neutral" title="Image Manipulation Class"><span class="fa fa-arrow-circle-left"></span> Previous</a>
1134
1135 </div>
1136
1137
1138 <hr/>
1139
1140 <div role="contentinfo">
1141 <p>
1142 &copy; Copyright 2014 - 2019, British Columbia Institute of Technology.
1143 Last updated on Jan 16, 2019.
1144 </p>
1145 </div>
1146
1147 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>.
1148
1149</footer>
1150 </div>
1151 </div>
1152
1153 </section>
1154
1155 </div>
1156
1157
1158
1159
1160
1161 <script type="text/javascript">
1162 var DOCUMENTATION_OPTIONS = {
1163 URL_ROOT:'../',
1164 VERSION:'3.1.10',
1165 COLLAPSE_INDEX:false,
1166 FILE_SUFFIX:'.html',
1167 HAS_SOURCE: false
1168 };
1169 </script>
1170 <script type="text/javascript" src="../_static/jquery.js"></script>
1171 <script type="text/javascript" src="../_static/underscore.js"></script>
1172 <script type="text/javascript" src="../_static/doctools.js"></script>
1173
1174
1175
1176
1177
1178 <script type="text/javascript" src="../_static/js/theme.js"></script>
1179
1180
1181
1182
1183 <script type="text/javascript">
1184 jQuery(function () {
1185 SphinxRtdTheme.StickyNav.enable();
1186 });
1187 </script>
1188
1189
1190</body>
1191</html>