Главная Обзор Помощь
Вход
wangsaitao
/
guotianyun-sp-yh
1
0
Ответвить 0
Файлы Задачи 0 Запросы на слияние 0 Вики
Ветка: master
Ветки Метки
guotianyun-s...
/
user_guide
/
libraries
/
input.html

input.html 80 KB
Постоянная ссылка История Исходник

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191 
  1. 

  2. 

  3. <!DOCTYPE html>
    4. 

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

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

  6. <head>
    7. 

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

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

  9.   
    10. 

  10.   <title>Input Class &mdash; CodeIgniter 3.1.11 documentation</title>
    11. 

  11.   
    12. 

  12. 

  13.   
    14. 

  14.   
    15. 

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

  16.   
    17. 

  17. 

  18.   
    19. 

  19.   <link href='https://fonts.googleapis.com/css?family=Lato:400,700,400italic,700italic|Roboto+Slab:400,700|Inconsolata:400,700&subset=latin,cyrillic' rel='stylesheet' type='text/css'>
    20. 

  20. 

  21.   
    22. 

  22.   
    23. 

  23.     
    24. 

  24. 

  25.   
    26. 

  26. 

  27.   
    28. 

  28.   
    29. 

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

  30.   
    31. 

  31. 

  32.   
    33. 

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

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

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

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

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

  38.         <link rel="next" title="Javascript Class" href="javascript.html"/>
    39. 

  39.         <link rel="prev" title="Image Manipulation Class" href="image_lib.html"/> 
    40. 

  40. 

  41.   
    42. 

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

  43. 

  44. </head>
    45. 

  45. 

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

  47. 

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

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

  50.     
    51. 

  51.     
    52. 

  52.     
    53. 

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

  54.         <ul>
    55. 

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

  56. </ul>
    57. 

  57. <ul>
    58. 

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

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

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

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

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

  63. </ul>
    64. 

  64. </li>
    65. 

  65. </ul>
    66. 

  66. <ul>
    67. 

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

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

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

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

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

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

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

  74. </ul>
    75. 

  75. </li>
    76. 

  76. </ul>
    77. 

  77. <ul>
    78. 

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

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

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

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

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

  83. </ul>
    84. 

  84. </li>
    85. 

  85. </ul>
    86. 

  86. <ul>
    87. 

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

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

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

  90. </ul>
    91. 

  91. </li>
    92. 

  92. </ul>
    93. 

  93. <ul>
    94. 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  121. </ul>
    122. 

  122. </li>
    123. 

  123. </ul>
    124. 

  124. <ul class="current">
    125. 

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

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

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

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

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

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

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

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

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

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

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

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

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

  138. <li class="toctree-l2 current"><a class="current reference internal" href="#">Input Class</a></li>
    139. 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  156. </ul>
    157. 

  157. </li>
    158. 

  158. </ul>
    159. 

  159. <ul>
    160. 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  175. </ul>
    176. 

  176. </li>
    177. 

  177. </ul>
    178. 

  178. <ul>
    179. 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  197. <li class="toctree-l2"><a class="reference internal" href="../helpers/text_helper.html">Text Helper</a></li>
    198. 

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

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

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

  201. </ul>
    202. 

  202. </li>
    203. 

  203. </ul>
    204. 

  204. 

  205.       </div>
    206. 

  206.     
    207. 

  207.       
    208. 

  208.   </div>
    209. 

  209. </div>
    210. 

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

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

  212.     <img src="data:image/jpeg;base64,/9j/4AAQSkZJRgABAgAAZABkAAD/7AARRHVja3kAAQAEAAAARgAA/+4ADkFkb2JlAGTAAAAAAf/bAIQABAMDAwMDBAMDBAYEAwQGBwUEBAUHCAYGBwYGCAoICQkJCQgKCgwMDAwMCgwMDQ0MDBERERERFBQUFBQUFBQUFAEEBQUIBwgPCgoPFA4ODhQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQU/8AAEQgAKwCaAwERAAIRAQMRAf/EAHsAAQAABwEBAAAAAAAAAAAAAAABAwQFBgcIAgkBAQAAAAAAAAAAAAAAAAAAAAAQAAEDAwICBwYEAgsAAAAAAAIBAwQAEQUSBiEHkROTVNQWGDFBUVIUCHEiMtOUFWGBobHRQlMkZIRVEQEAAAAAAAAAAAAAAAAAAAAA/9oADAMBAAIRAxEAPwDSC+ygkOOaUoKigUCgUCgUCgUCgUCgUCgUCgkuGguIP9FBMFb0Hqg7We+3jlmIqqYFf4ub+/QYlnOR/LqIBKGFUbf8qWv971BytQXXE7Y3Lnm3HsFhp2TaZJAdchRXpIgSpdEJWxJEW3xoKV7F5OMy7JkQn2o7D6w33XGjEAkoiqrJEqIiOIiKuhePCgqp22dyYyS3CyWHnQ5joG61HkRnmnTbaFSMhExRVQRRVJU9iUHjE7ez+fJ0MFipmUNhBV8YUd2SoIV9KkjQla9ltegttBdPLW4/qocL+UTfrMiHW4+P9M71shuyrqaHTcxsl7jegpsji8nh5ZwMvDfgTm0RTjSmjYdFCS6KoOIipdFunCgmNYTMv457MMY6U7iI6oMieDDhRm1VbIhuoOkbqtuK0Hpzb+eZcYZexUxt6UyUqK2cd0SdjtgrhOgijcgERUlJOCIl6CpgbP3blRI8XgMjNARAyKNDfeRBdFDBVUAXgQrqH4pxoJTu2NysY97LP4ac1io5q1InHFeGO24LnVKJuKOkSQ/yKir+rh7aCLG1dzypZQI2FnvTgccYOM3FeN0XWERXAUEFVQgQkUktdLpegm+Td3/Xli/L+S/mYNJIOF9G/wBeLKrZHFb0akG6W1WtQWSg3Dyg5e7V3fipE3O4/wCrktyzYA+ufas2LbZIlmnAT2kvuoN1wft95augilglX/tzP3qCu9O3LL/wV/i5v79BvmTADq14UGu91467Z6U9y0HzH/ncj/U/sT/CgynZG7I2NezpZGUjIycJkYkZSG+uQ81pbBNKLxJfjwoMqZ3/ALYHl35AJ7/cuwHcu5k7r1Q5pHetBjquqVVJWGxj9Zrtcl/Ggy3dHMvauR3HFZj5nHNxSyW5JISYDMoIwx8tFIGHZhPNaykGapr6rUAiicEoMG21lMRj8buPAz8xhJrr7uOeiPTCyAwXUaGR1mgozbTusOsFLEiJ7fbQa/h7gcjy2H3V6xppwDNtUSxCJIqp7valBuWVzJ22xuCROXNNZiJkMtms0DbjUkAZjzoDrTMd9dDRI44ZC2YsrYdKWP2WDT2S3N9dNdlRYrGMYc06IURXSYb0igrpWS485xVNS6nF4rwslkoMwnbpgZLB7bmt5uMweAhDEl4B5uSLzzqTnnyVpW2jaJHRMSIjdDiiotvy3DOE5rYTEbkl5yFn28k7JyG4c7AU2HtLH1uKfaiMPI40CdYbpNtmLdwTSn5rewLNld+7TLdeal4WarWBkbVKBjgdElMJJwAAY5fl4kB3b1fp4XvagsGS3FjJfLzDNtS8aeXx7LzT7TyzByQE5PccRGRC0ZRUDRV6y62vbjagzLmJzS2vuPK43JY6aP1TW6Jz+RIWyFtyC06y3EkiiinAo7YCqfq1AqqnGgsOH3lhZO8d1pmcpB8j5XIm9OYlBJSQ/FSS4427DKO0RC8AlcEMhFdViRR1WDWR5t3WXVuL1d106kG9vdeye2g60+1FDyW0shIcXVpyroXt8I8dfd+NB1vioAdWnD3UF1+gD4UFc6CEKpagxXN43rwJLUHz7yX2c8zokt9uHlsPIhA4aRnnHJTLptIS6CNsY7iASpxUUMkReGpfbQW0vtN5pitvrsN28rwtBD0nc0+/Yft5XhaB6TuaXfsP28rwtA9J3NPv2H7eV4Wgek7mn37D9vK8LQPSdzT79h+3leFoHpO5pd+w/byvC0D0nc0u/Yft5XhaB6TuaXfsP28rwtA9J3NLv2H7eV4Wgek7ml37D9vK8LQPSdzS79h+3leFoHpO5p9+w/byvC0E9r7Reazy2HIYVPxkS/CUHVn26cosxyv2g7h89LYmZSXOenvLEQ1YaQ222RATcQCP8rSGqqA8S02W2pQ6FhMoAIlqCtsnwoCpdKClejI4i3Sgtb+GBxVuNBSFt1pV/RQefLjPyUDy4z8lA8uM/JQPLjPyUDy4z8lA8uM/JQPLjPyUDy4z8lA8uM/JQPLjPyUDy4z8lA8utJ/koJ7WCbBU/LQXOPAFq1koK8B0pag90CggtBBf6qB0UDooHRQOigdFA6KB0UDooHRQOigdFA6KB0UDooI0EaBQf//Z" title="Toggle Table of Contents" alt="Toggle Table of Contents" />
    213. 

  213.   </a>
    214. 

  214. </div>
    215. 

  215. 

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

  217. 

  218.     
    219. 

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

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

  221.         
    222. 

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

  223.         
    224. 

  224.         
    225. 

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

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

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

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

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

  230.   </form>
    231. 

  231. </div>
    232. 

  232.       </div>
    233. 

  233. 

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

  235.         
    236. 

  236.           
    237. 

  237.           
    238. 

  238.               <ul>
    239. 

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

  240. </ul>
    241. 

  241. <ul>
    242. 

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

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

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

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

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

  247. </ul>
    248. 

  248. </li>
    249. 

  249. </ul>
    250. 

  250. <ul>
    251. 

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

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

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

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

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

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

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

  258. </ul>
    259. 

  259. </li>
    260. 

  260. </ul>
    261. 

  261. <ul>
    262. 

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

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

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

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

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

  267. </ul>
    268. 

  268. </li>
    269. 

  269. </ul>
    270. 

  270. <ul>
    271. 

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

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

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

  274. </ul>
    275. 

  275. </li>
    276. 

  276. </ul>
    277. 

  277. <ul>
    278. 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  305. </ul>
    306. 

  306. </li>
    307. 

  307. </ul>
    308. 

  308. <ul class="current">
    309. 

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

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

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

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

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

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

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

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

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

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

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

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

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

  322. <li class="toctree-l2 current"><a class="current reference internal" href="#">Input Class</a></li>
    323. 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  340. </ul>
    341. 

  341. </li>
    342. 

  342. </ul>
    343. 

  343. <ul>
    344. 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  359. </ul>
    360. 

  360. </li>
    361. 

  361. </ul>
    362. 

  362. <ul>
    363. 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  381. <li class="toctree-l2"><a class="reference internal" href="../helpers/text_helper.html">Text Helper</a></li>
    382. 

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

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

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

  385. </ul>
    386. 

  386. </li>
    387. 

  387. </ul>
    388. 

  388. 

  389.           
    390. 

  390.         
    391. 

  391.       </div>
    392. 

  392.       &nbsp;
    393. 

  393.     </nav>
    394. 

  394. 

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

  396. 

  397.       
    398. 

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

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

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

  401.       </nav>
    402. 

  402. 

  403. 

  404.       
    405. 

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

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

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

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

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

  410.       
    411. 

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

  412.       
    413. 

  413.     <li>Input Class</li>
    414. 

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

  415.       
    416. 

  416.     </li>
    417. 

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

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

  419.     </div>
    420. 

  420.   </ul>
    421. 

  421.   <hr/>
    422. 

  422. </div>
    423. 

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

  424.             
    425. 

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

  426. <h1>Input Class<a class="headerlink" href="#input-class" title="Permalink to this headline">¶</a></h1>
    427. 

  427. <p>The Input Class serves two purposes:</p>
    428. 

  428. <ol class="arabic simple">
    429. 

  429. <li>It pre-processes global input data for security.</li>
    430. 

  430. <li>It provides some helper methods for fetching input data and pre-processing it.</li>
    431. 

  431. </ol>
    432. 

  432. <div class="admonition note">
    433. 

  433. <p class="first admonition-title">Note</p>
    434. 

  434. <p class="last">This class is initialized automatically by the system so there
    435. 

  435. is no need to do it manually.</p>
    436. 

  436. </div>
    437. 

  437. <div class="contents local topic" id="contents">
    438. 

  438. <ul class="simple">
    439. 

  439. <li><a class="reference internal" href="#input-filtering" id="id1">Input Filtering</a><ul>
    440. 

  440. <li><a class="reference internal" href="#security-filtering" id="id2">Security Filtering</a></li>
    441. 

  441. <li><a class="reference internal" href="#xss-filtering" id="id3">XSS Filtering</a></li>
    442. 

  442. </ul>
    443. 

  443. </li>
    444. 

  444. <li><a class="reference internal" href="#accessing-form-data" id="id4">Accessing form data</a><ul>
    445. 

  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. 

  446. <li><a class="reference internal" href="#using-the-php-input-stream" id="id6">Using the php://input stream</a></li>
    447. 

  447. </ul>
    448. 

  448. </li>
    449. 

  449. <li><a class="reference internal" href="#class-reference" id="id7">Class Reference</a></li>
    450. 

  450. </ul>
    451. 

  451. </div>
    452. 

  452. <div class="custom-index container"></div><div class="section" id="input-filtering">
    453. 

  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. 

  454. <div class="section" id="security-filtering">
    455. 

  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. 

  456. <p>The security filtering method is called automatically when a new
    457. 

  457. <a class="reference internal" href="../general/controllers.html"><span class="doc">controller</span></a> is invoked. It does the
    458. 

  458. following:</p>
    459. 

  459. <ul class="simple">
    460. 

  460. <li>If <code class="docutils literal"><span class="pre">$config['allow_get_array']</span></code> is FALSE (default is TRUE), destroys
    461. 

  461. the global GET array.</li>
    462. 

  462. <li>Destroys all global variables in the event register_globals is
    463. 

  463. turned on.</li>
    464. 

  464. <li>Filters the GET/POST/COOKIE array keys, permitting only alpha-numeric
    465. 

  465. (and a few other) characters.</li>
    466. 

  466. <li>Provides XSS (Cross-site Scripting Hacks) filtering. This can be
    467. 

  467. enabled globally, or upon request.</li>
    468. 

  468. <li>Standardizes newline characters to <code class="docutils literal"><span class="pre">PHP_EOL</span></code> (\n in UNIX-based OSes,
    469. 

  469. \r\n under Windows). This is configurable.</li>
    470. 

  470. </ul>
    471. 

  471. </div>
    472. 

  472. <div class="section" id="xss-filtering">
    473. 

  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. 

  474. <p>The Input class has the ability to filter input automatically to prevent
    475. 

  475. cross-site scripting attacks. If you want the filter to run
    476. 

  476. automatically every time it encounters POST or COOKIE data you can
    477. 

  477. enable it by opening your <em>application/config/config.php</em> file and setting
    478. 

  478. this:</p>
    479. 

  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. 

  480. </pre></div>
    481. 

  481. </div>
    482. 

  482. <p>Please refer to the <a class="reference internal" href="security.html"><span class="doc">Security class</span></a> documentation for
    483. 

  483. information on using XSS Filtering in your application.</p>
    484. 

  484. <div class="admonition important">
    485. 

  485. <p class="first admonition-title">Important</p>
    486. 

  486. <p class="last">The ‘global_xss_filtering’ setting is DEPRECATED and kept
    487. 

  487. solely for backwards-compatibility purposes. XSS escaping should
    488. 

  488. be performed on <em>output</em>, not <em>input</em>!</p>
    489. 

  489. </div>
    490. 

  490. </div>
    491. 

  491. </div>
    492. 

  492. <div class="section" id="accessing-form-data">
    493. 

  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. 

  494. <div class="section" id="using-post-get-cookie-or-server-data">
    495. 

  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. 

  496. <p>CodeIgniter comes with helper methods that let you fetch POST, GET,
    497. 

  497. COOKIE or SERVER items. The main advantage of using the provided
    498. 

  498. methods rather than fetching an item directly (<code class="docutils literal"><span class="pre">$_POST['something']</span></code>)
    499. 

  499. is that the methods will check to see if the item is set and return
    500. 

  500. NULL if not. This lets you conveniently use data without
    501. 

  501. having to test whether an item exists first. In other words, normally
    502. 

  502. you might do something like this:</p>
    503. 

  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. 

  504. </pre></div>
    505. 

  505. </div>
    506. 

  506. <p>With CodeIgniter’s built in methods you can simply do this:</p>
    507. 

  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. 

  508. </pre></div>
    509. 

  509. </div>
    510. 

  510. <p>The main methods are:</p>
    511. 

  511. <ul class="simple">
    512. 

  512. <li><code class="docutils literal"><span class="pre">$this-&gt;input-&gt;post()</span></code></li>
    513. 

  513. <li><code class="docutils literal"><span class="pre">$this-&gt;input-&gt;get()</span></code></li>
    514. 

  514. <li><code class="docutils literal"><span class="pre">$this-&gt;input-&gt;cookie()</span></code></li>
    515. 

  515. <li><code class="docutils literal"><span class="pre">$this-&gt;input-&gt;server()</span></code></li>
    516. 

  516. </ul>
    517. 

  517. </div>
    518. 

  518. <div class="section" id="using-the-php-input-stream">
    519. 

  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. 

  520. <p>If you want to utilize the PUT, DELETE, PATCH or other exotic request
    521. 

  521. methods, they can only be accessed via a special input stream, that
    522. 

  522. can only be read once. This isn’t as easy as just reading from e.g.
    523. 

  523. the <code class="docutils literal"><span class="pre">$_POST</span></code> array, because it will always exist and you can try
    524. 

  524. and access multiple variables without caring that you might only have
    525. 

  525. one shot at all of the POST data.</p>
    526. 

  526. <p>CodeIgniter will take care of that for you, and you can read the data
    527. 

  527. from the <strong>php://input</strong> stream at any time, just by using the
    528. 

  528. <code class="docutils literal"><span class="pre">$raw_input_stream</span></code> property:</p>
    529. 

  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. 

  530. </pre></div>
    531. 

  531. </div>
    532. 

  532. <p>Additionally if the input stream is form-encoded like $_POST you can
    533. 

  533. access its values by calling the
    534. 

  534. <code class="docutils literal"><span class="pre">input_stream()</span></code> method:</p>
    535. 

  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. 

  536. </pre></div>
    537. 

  537. </div>
    538. 

  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
    539. 

  539. requested data is not found, it will return NULL and you can also
    540. 

  540. decide whether to run the data through <code class="docutils literal"><span class="pre">xss_clean()</span></code> by passing
    541. 

  541. a boolean value as the second parameter:</p>
    542. 

  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. 

  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. 

  544. </pre></div>
    545. 

  545. </div>
    546. 

  546. <div class="admonition note">
    547. 

  547. <p class="first admonition-title">Note</p>
    548. 

  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
    549. 

  549. PUT, DELETE or PATCH data.</p>
    550. 

  550. </div>
    551. 

  551. </div>
    552. 

  552. </div>
    553. 

  553. <div class="section" id="class-reference">
    554. 

  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. 

  555. <dl class="class">
    556. 

  556. <dt id="CI_Input">
    557. 

  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. 

  558. <dd><dl class="attribute">
    559. 

  559. <dt>
    560. 

  560. <code class="descname">$raw_input_stream</code></dt>
    561. 

  561. <dd><p>Read only property that will return php://input data as is.</p>
    562. 

  562. <p>The property can be read multiple times.</p>
    563. 

  563. </dd></dl>
    564. 

  564. 

  565. <dl class="method">
    566. 

  566. <dt id="CI_Input::post">
    567. 

  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. 

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

  569. <col class="field-name" />
    570. 

  570. <col class="field-body" />
    571. 

  571. <tbody valign="top">
    572. 

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

  573. <li><strong>$index</strong> (<em>mixed</em>) – POST parameter name</li>
    574. 

  574. <li><strong>$xss_clean</strong> (<em>bool</em>) – Whether to apply XSS filtering</li>
    575. 

  575. </ul>
    576. 

  576. </td>
    577. 

  577. </tr>
    578. 

  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. 

  579. </td>
    580. 

  580. </tr>
    581. 

  581. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">mixed</p>
    582. 

  582. </td>
    583. 

  583. </tr>
    584. 

  584. </tbody>
    585. 

  585. </table>
    586. 

  586. <p>The first parameter will contain the name of the POST item you are
    587. 

  587. looking for:</p>
    588. 

  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. 

  589. </pre></div>
    590. 

  590. </div>
    591. 

  591. <p>The method returns NULL if the item you are attempting to retrieve
    592. 

  592. does not exist.</p>
    593. 

  593. <p>The second optional parameter lets you run the data through the XSS
    594. 

  594. filter. It’s enabled by setting the second parameter to boolean TRUE
    595. 

  595. or by setting your <code class="docutils literal"><span class="pre">$config['global_xss_filtering']</span></code> to TRUE.</p>
    596. 

  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. 

  597. </pre></div>
    598. 

  598. </div>
    599. 

  599. <p>To return an array of all POST items call without any parameters.</p>
    600. 

  600. <p>To return all POST items and pass them through the XSS filter set the
    601. 

  601. first parameter NULL while setting the second parameter to boolean TRUE.</p>
    602. 

  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. 

  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. 

  604. </pre></div>
    605. 

  605. </div>
    606. 

  606. <p>To return an array of multiple POST parameters, pass all the required keys
    607. 

  607. as an array.</p>
    608. 

  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. 

  609. </pre></div>
    610. 

  610. </div>
    611. 

  611. <p>Same rule applied here, to retrieve the parameters with XSS filtering enabled, set the
    612. 

  612. second parameter to boolean TRUE.</p>
    613. 

  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. 

  614. </pre></div>
    615. 

  615. </div>
    616. 

  616. </dd></dl>
    617. 

  617. 

  618. <dl class="method">
    619. 

  619. <dt id="CI_Input::get">
    620. 

  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. 

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

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

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

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

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

  626. <li><strong>$index</strong> (<em>mixed</em>) – GET parameter name</li>
    627. 

  627. <li><strong>$xss_clean</strong> (<em>bool</em>) – Whether to apply XSS filtering</li>
    628. 

  628. </ul>
    629. 

  629. </td>
    630. 

  630. </tr>
    631. 

  631. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">$_GET if no parameters supplied, otherwise the GET value if found or NULL if not</p>
    632. 

  632. </td>
    633. 

  633. </tr>
    634. 

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

  635. </td>
    636. 

  636. </tr>
    637. 

  637. </tbody>
    638. 

  638. </table>
    639. 

  639. <p>This method is identical to <code class="docutils literal"><span class="pre">post()</span></code>, only it fetches GET data.</p>
    640. 

  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. 

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

  642. </div>
    643. 

  643. <p>To return an array of all GET items call without any parameters.</p>
    644. 

  644. <p>To return all GET items and pass them through the XSS filter set the
    645. 

  645. first parameter NULL while setting the second parameter to boolean TRUE.</p>
    646. 

  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. 

  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. 

  648. </pre></div>
    649. 

  649. </div>
    650. 

  650. <p>To return an array of multiple GET parameters, pass all the required keys
    651. 

  651. as an array.</p>
    652. 

  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. 

  653. </pre></div>
    654. 

  654. </div>
    655. 

  655. <p>Same rule applied here, to retrieve the parameters with XSS filtering enabled, set the
    656. 

  656. second parameter to boolean TRUE.</p>
    657. 

  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. 

  658. </pre></div>
    659. 

  659. </div>
    660. 

  660. </dd></dl>
    661. 

  661. 

  662. <dl class="method">
    663. 

  663. <dt id="CI_Input::post_get">
    664. 

  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. 

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

  666. <col class="field-name" />
    667. 

  667. <col class="field-body" />
    668. 

  668. <tbody valign="top">
    669. 

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

  670. <li><strong>$index</strong> (<em>string</em>) – POST/GET parameter name</li>
    671. 

  671. <li><strong>$xss_clean</strong> (<em>bool</em>) – Whether to apply XSS filtering</li>
    672. 

  672. </ul>
    673. 

  673. </td>
    674. 

  674. </tr>
    675. 

  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. 

  676. </td>
    677. 

  677. </tr>
    678. 

  678. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">mixed</p>
    679. 

  679. </td>
    680. 

  680. </tr>
    681. 

  681. </tbody>
    682. 

  682. </table>
    683. 

  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>,
    684. 

  684. only combined. It will search through both POST and GET streams for data,
    685. 

  685. looking in POST first, and then in GET:</p>
    686. 

  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. 

  687. </pre></div>
    688. 

  688. </div>
    689. 

  689. </dd></dl>
    690. 

  690. 

  691. <dl class="method">
    692. 

  692. <dt id="CI_Input::get_post">
    693. 

  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. 

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

  695. <col class="field-name" />
    696. 

  696. <col class="field-body" />
    697. 

  697. <tbody valign="top">
    698. 

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

  699. <li><strong>$index</strong> (<em>string</em>) – GET/POST parameter name</li>
    700. 

  700. <li><strong>$xss_clean</strong> (<em>bool</em>) – Whether to apply XSS filtering</li>
    701. 

  701. </ul>
    702. 

  702. </td>
    703. 

  703. </tr>
    704. 

  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. 

  705. </td>
    706. 

  706. </tr>
    707. 

  707. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">mixed</p>
    708. 

  708. </td>
    709. 

  709. </tr>
    710. 

  710. </tbody>
    711. 

  711. </table>
    712. 

  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
    713. 

  713. data first.</p>
    714. 

  714. <blockquote>
    715. 

  715. <div>$this-&gt;input-&gt;get_post(‘some_data’, TRUE);</div></blockquote>
    716. 

  716. <div class="admonition note">
    717. 

  717. <p class="first admonition-title">Note</p>
    718. 

  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
    719. 

  719. behavior has changed in CodeIgniter 3.0.</p>
    720. 

  720. </div>
    721. 

  721. </dd></dl>
    722. 

  722. 

  723. <dl class="method">
    724. 

  724. <dt id="CI_Input::cookie">
    725. 

  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. 

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

  727. <col class="field-name" />
    728. 

  728. <col class="field-body" />
    729. 

  729. <tbody valign="top">
    730. 

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

  731. <li><strong>$index</strong> (<em>mixed</em>) – COOKIE name</li>
    732. 

  732. <li><strong>$xss_clean</strong> (<em>bool</em>) – Whether to apply XSS filtering</li>
    733. 

  733. </ul>
    734. 

  734. </td>
    735. 

  735. </tr>
    736. 

  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. 

  737. </td>
    738. 

  738. </tr>
    739. 

  739. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">mixed</p>
    740. 

  740. </td>
    741. 

  741. </tr>
    742. 

  742. </tbody>
    743. 

  743. </table>
    744. 

  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
    745. 

  745. data:</p>
    746. 

  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. 

  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. 

  748. </pre></div>
    749. 

  749. </div>
    750. 

  750. <p>To return an array of multiple cookie values, pass all the required keys
    751. 

  751. as an array.</p>
    752. 

  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. 

  753. </pre></div>
    754. 

  754. </div>
    755. 

  755. <div class="admonition note">
    756. 

  756. <p class="first admonition-title">Note</p>
    757. 

  757. <p class="last">Unlike the <a class="reference internal" href="../helpers/cookie_helper.html"><span class="doc">Cookie Helper</span></a>
    758. 

  758. function <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
    759. 

  759. your configured <code class="docutils literal"><span class="pre">$config['cookie_prefix']</span></code> value.</p>
    760. 

  760. </div>
    761. 

  761. </dd></dl>
    762. 

  762. 

  763. <dl class="method">
    764. 

  764. <dt id="CI_Input::server">
    765. 

  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. 

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

  767. <col class="field-name" />
    768. 

  768. <col class="field-body" />
    769. 

  769. <tbody valign="top">
    770. 

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

  771. <li><strong>$index</strong> (<em>mixed</em>) – Value name</li>
    772. 

  772. <li><strong>$xss_clean</strong> (<em>bool</em>) – Whether to apply XSS filtering</li>
    773. 

  773. </ul>
    774. 

  774. </td>
    775. 

  775. </tr>
    776. 

  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. 

  777. </td>
    778. 

  778. </tr>
    779. 

  779. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">mixed</p>
    780. 

  780. </td>
    781. 

  781. </tr>
    782. 

  782. </tbody>
    783. 

  783. </table>
    784. 

  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>
    785. 

  785. methods, only it fetches server data (<code class="docutils literal"><span class="pre">$_SERVER</span></code>):</p>
    786. 

  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. 

  787. </pre></div>
    788. 

  788. </div>
    789. 

  789. <p>To return an array of multiple <code class="docutils literal"><span class="pre">$_SERVER</span></code> values, pass all the required keys
    790. 

  790. as an array.</p>
    791. 

  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. 

  792. </pre></div>
    793. 

  793. </div>
    794. 

  794. </dd></dl>
    795. 

  795. 

  796. <dl class="method">
    797. 

  797. <dt id="CI_Input::input_stream">
    798. 

  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. 

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

  800. <col class="field-name" />
    801. 

  801. <col class="field-body" />
    802. 

  802. <tbody valign="top">
    803. 

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

  804. <li><strong>$index</strong> (<em>mixed</em>) – Key name</li>
    805. 

  805. <li><strong>$xss_clean</strong> (<em>bool</em>) – Whether to apply XSS filtering</li>
    806. 

  806. </ul>
    807. 

  807. </td>
    808. 

  808. </tr>
    809. 

  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. 

  810. </td>
    811. 

  811. </tr>
    812. 

  812. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">mixed</p>
    813. 

  813. </td>
    814. 

  814. </tr>
    815. 

  815. </tbody>
    816. 

  816. </table>
    817. 

  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>,
    818. 

  818. only it fetches the <em>php://input</em> stream data.</p>
    819. 

  819. </dd></dl>
    820. 

  820. 

  821. <dl class="method">
    822. 

  822. <dt id="CI_Input::set_cookie">
    823. 

  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. 

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

  825. <col class="field-name" />
    826. 

  826. <col class="field-body" />
    827. 

  827. <tbody valign="top">
    828. 

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

  829. <li><strong>$name</strong> (<em>mixed</em>) – Cookie name or an array of parameters</li>
    830. 

  830. <li><strong>$value</strong> (<em>string</em>) – Cookie value</li>
    831. 

  831. <li><strong>$expire</strong> (<em>int</em>) – Cookie expiration time in seconds</li>
    832. 

  832. <li><strong>$domain</strong> (<em>string</em>) – Cookie domain</li>
    833. 

  833. <li><strong>$path</strong> (<em>string</em>) – Cookie path</li>
    834. 

  834. <li><strong>$prefix</strong> (<em>string</em>) – Cookie name prefix</li>
    835. 

  835. <li><strong>$secure</strong> (<em>bool</em>) – Whether to only transfer the cookie through HTTPS</li>
    836. 

  836. <li><strong>$httponly</strong> (<em>bool</em>) – Whether to only make the cookie accessible for HTTP requests (no JavaScript)</li>
    837. 

  837. </ul>
    838. 

  838. </td>
    839. 

  839. </tr>
    840. 

  840. <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">void</p>
    841. 

  841. </td>
    842. 

  842. </tr>
    843. 

  843. </tbody>
    844. 

  844. </table>
    845. 

  845. <p>Sets a cookie containing the values you specify. There are two ways to
    846. 

  846. pass information to this method so that a cookie can be set: Array
    847. 

  847. Method, and Discrete Parameters:</p>
    848. 

  848. <p><strong>Array Method</strong></p>
    849. 

  849. <p>Using this method, an associative array is passed to the first
    850. 

  850. parameter:</p>
    851. 

  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. 

  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. 

  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. 

  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. 

  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. 

  856.         <span class="s1">&#39;path&#39;</span>   <span class="o">=&gt;</span> <span class="s1">&#39;/&#39;</span><span class="p">,</span>
    857. 

  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. 

  858.         <span class="s1">&#39;secure&#39;</span> <span class="o">=&gt;</span> <span class="k">TRUE</span>
    859. 

  859. <span class="p">);</span>
    860. 

  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. 

  862. </pre></div>
    863. 

  863. </div>
    864. 

  864. <p><strong>Notes</strong></p>
    865. 

  865. <p>Only the name and value are required. To delete a cookie set it with the
    866. 

  866. expiration blank.</p>
    867. 

  867. <p>The expiration is set in <strong>seconds</strong>, which will be added to the current
    868. 

  868. time. Do not include the time, but rather only the number of seconds
    869. 

  869. from <em>now</em> that you wish the cookie to be valid. If the expiration is
    870. 

  870. set to zero the cookie will only last as long as the browser is open.</p>
    871. 

  871. <p>For site-wide cookies regardless of how your site is requested, add your
    872. 

  872. URL to the <strong>domain</strong> starting with a period, like this:
    873. 

  873. .your-domain.com</p>
    874. 

  874. <p>The path is usually not needed since the method sets a root path.</p>
    875. 

  875. <p>The prefix is only needed if you need to avoid name collisions with
    876. 

  876. other identically named cookies for your server.</p>
    877. 

  877. <p>The <em>httponly</em> and <em>secure</em> flags, when omitted, will default to your
    878. 

  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. 

  879. <p><strong>Discrete Parameters</strong></p>
    880. 

  880. <p>If you prefer, you can set the cookie by passing data using individual
    881. 

  881. parameters:</p>
    882. 

  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. 

  883. </pre></div>
    884. 

  884. </div>
    885. 

  885. </dd></dl>
    886. 

  886. 

  887. <dl class="method">
    888. 

  888. <dt id="CI_Input::ip_address">
    889. 

  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. 

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

  891. <col class="field-name" />
    892. 

  892. <col class="field-body" />
    893. 

  893. <tbody valign="top">
    894. 

  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. 

  895. </tr>
    896. 

  896. <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">string</td>
    897. 

  897. </tr>
    898. 

  898. </tbody>
    899. 

  899. </table>
    900. 

  900. <p>Returns the IP address for the current user. If the IP address is not
    901. 

  901. valid, the method will return ‘0.0.0.0’:</p>
    902. 

  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. 

  903. </pre></div>
    904. 

  904. </div>
    905. 

  905. <div class="admonition important">
    906. 

  906. <p class="first admonition-title">Important</p>
    907. 

  907. <p class="last">This method takes into account the <code class="docutils literal"><span class="pre">$config['proxy_ips']</span></code>
    908. 

  908. setting and will return the reported HTTP_X_FORWARDED_FOR,
    909. 

  909. HTTP_CLIENT_IP, HTTP_X_CLIENT_IP or HTTP_X_CLUSTER_CLIENT_IP
    910. 

  910. address for the allowed IP addresses.</p>
    911. 

  911. </div>
    912. 

  912. </dd></dl>
    913. 

  913. 

  914. <dl class="method">
    915. 

  915. <dt id="CI_Input::valid_ip">
    916. 

  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. 

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

  918. <col class="field-name" />
    919. 

  919. <col class="field-body" />
    920. 

  920. <tbody valign="top">
    921. 

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

  922. <li><strong>$ip</strong> (<em>string</em>) – IP address</li>
    923. 

  923. <li><strong>$which</strong> (<em>string</em>) – IP protocol (‘ipv4’ or ‘ipv6’)</li>
    924. 

  924. </ul>
    925. 

  925. </td>
    926. 

  926. </tr>
    927. 

  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. 

  928. </td>
    929. 

  929. </tr>
    930. 

  930. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">bool</p>
    931. 

  931. </td>
    932. 

  932. </tr>
    933. 

  933. </tbody>
    934. 

  934. </table>
    935. 

  935. <p>Takes an IP address as input and returns TRUE or FALSE (boolean) depending
    936. 

  936. on whether it is valid or not.</p>
    937. 

  937. <div class="admonition note">
    938. 

  938. <p class="first admonition-title">Note</p>
    939. 

  939. <p class="last">The $this-&gt;input-&gt;ip_address() method above automatically
    940. 

  940. validates the IP address.</p>
    941. 

  941. </div>
    942. 

  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. 

  943. <span class="p">{</span>
    944. 

  944.         <span class="k">echo</span> <span class="s1">&#39;Not Valid&#39;</span><span class="p">;</span>
    945. 

  945. <span class="p">}</span>
    946. 

  946. <span class="k">else</span>
    947. 

  947. <span class="p">{</span>
    948. 

  948.         <span class="k">echo</span> <span class="s1">&#39;Valid&#39;</span><span class="p">;</span>
    949. 

  949. <span class="p">}</span>
    950. 

  950. </pre></div>
    951. 

  951. </div>
    952. 

  952. <p>Accepts an optional second string parameter of ‘ipv4’ or ‘ipv6’ to specify
    953. 

  953. an IP format. The default checks for both formats.</p>
    954. 

  954. </dd></dl>
    955. 

  955. 

  956. <dl class="method">
    957. 

  957. <dt id="CI_Input::user_agent">
    958. 

  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. 

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

  960. <col class="field-name" />
    961. 

  961. <col class="field-body" />
    962. 

  962. <tbody valign="top">
    963. 

  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. 

  964. </td>
    965. 

  965. </tr>
    966. 

  966. <tr class="field-even field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    967. 

  967. <li><strong>$xss_clean</strong> (<em>bool</em>) – Whether to apply XSS filtering</li>
    968. 

  968. </ul>
    969. 

  969. </td>
    970. 

  970. </tr>
    971. 

  971. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">mixed</p>
    972. 

  972. </td>
    973. 

  973. </tr>
    974. 

  974. </tbody>
    975. 

  975. </table>
    976. 

  976. <p>Returns the user agent string (web browser) being used by the current user,
    977. 

  977. or NULL if it’s not available.</p>
    978. 

  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. 

  979. </pre></div>
    980. 

  980. </div>
    981. 

  981. <p>See the <a class="reference internal" href="user_agent.html"><span class="doc">User Agent Class</span></a> for methods which extract
    982. 

  982. information from the user agent string.</p>
    983. 

  983. </dd></dl>
    984. 

  984. 

  985. <dl class="method">
    986. 

  986. <dt id="CI_Input::request_headers">
    987. 

  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. 

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

  989. <col class="field-name" />
    990. 

  990. <col class="field-body" />
    991. 

  991. <tbody valign="top">
    992. 

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

  993. <li><strong>$xss_clean</strong> (<em>bool</em>) – Whether to apply XSS filtering</li>
    994. 

  994. </ul>
    995. 

  995. </td>
    996. 

  996. </tr>
    997. 

  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. 

  998. </td>
    999. 

  999. </tr>
    1000. 

  1000. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">array</p>
    1001. 

  1001. </td>
    1002. 

  1002. </tr>
    1003. 

  1003. </tbody>
    1004. 

  1004. </table>
    1005. 

  1005. <p>Returns an array of HTTP request headers.
    1006. 

  1006. Useful if running in a non-Apache environment where
    1007. 

  1007. <a class="reference external" href="http://php.net/apache_request_headers">apache_request_headers()</a>
    1008. 

  1008. will not be supported.</p>
    1009. 

  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. 

  1010. </pre></div>
    1011. 

  1011. </div>
    1012. 

  1012. </dd></dl>
    1013. 

  1013. 

  1014. <dl class="method">
    1015. 

  1015. <dt id="CI_Input::get_request_header">
    1016. 

  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. 

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

  1018. <col class="field-name" />
    1019. 

  1019. <col class="field-body" />
    1020. 

  1020. <tbody valign="top">
    1021. 

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

  1022. <li><strong>$index</strong> (<em>string</em>) – HTTP request header name</li>
    1023. 

  1023. <li><strong>$xss_clean</strong> (<em>bool</em>) – Whether to apply XSS filtering</li>
    1024. 

  1024. </ul>
    1025. 

  1025. </td>
    1026. 

  1026. </tr>
    1027. 

  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. 

  1028. </td>
    1029. 

  1029. </tr>
    1030. 

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

  1031. </td>
    1032. 

  1032. </tr>
    1033. 

  1033. </tbody>
    1034. 

  1034. </table>
    1035. 

  1035. <p>Returns a single member of the request headers array or NULL
    1036. 

  1036. if the searched header is not found.</p>
    1037. 

  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. 

  1038. </pre></div>
    1039. 

  1039. </div>
    1040. 

  1040. </dd></dl>
    1041. 

  1041. 

  1042. <dl class="method">
    1043. 

  1043. <dt id="CI_Input::is_ajax_request">
    1044. 

  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. 

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

  1046. <col class="field-name" />
    1047. 

  1047. <col class="field-body" />
    1048. 

  1048. <tbody valign="top">
    1049. 

  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. 

  1050. </tr>
    1051. 

  1051. <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
    1052. 

  1052. </tr>
    1053. 

  1053. </tbody>
    1054. 

  1054. </table>
    1055. 

  1055. <p>Checks to see if the HTTP_X_REQUESTED_WITH server header has been
    1056. 

  1056. set, and returns boolean TRUE if it is or FALSE if not.</p>
    1057. 

  1057. </dd></dl>
    1058. 

  1058. 

  1059. <dl class="method">
    1060. 

  1060. <dt id="CI_Input::is_cli_request">
    1061. 

  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. 

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

  1063. <col class="field-name" />
    1064. 

  1064. <col class="field-body" />
    1065. 

  1065. <tbody valign="top">
    1066. 

  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. 

  1067. </tr>
    1068. 

  1068. <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
    1069. 

  1069. </tr>
    1070. 

  1070. </tbody>
    1071. 

  1071. </table>
    1072. 

  1072. <p>Checks to see if the application was run from the command-line
    1073. 

  1073. interface.</p>
    1074. 

  1074. <div class="admonition note">
    1075. 

  1075. <p class="first admonition-title">Note</p>
    1076. 

  1076. <p class="last">This method checks both the PHP SAPI name currently in use
    1077. 

  1077. and if the <code class="docutils literal"><span class="pre">STDIN</span></code> constant is defined, which is usually a
    1078. 

  1078. failsafe way to see if PHP is being run via the command line.</p>
    1079. 

  1079. </div>
    1080. 

  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. 

  1081. </pre></div>
    1082. 

  1082. </div>
    1083. 

  1083. <div class="admonition note">
    1084. 

  1084. <p class="first admonition-title">Note</p>
    1085. 

  1085. <p class="last">This method is DEPRECATED and is now just an alias for the
    1086. 

  1086. <code class="xref py py-func docutils literal"><span class="pre">is_cli()</span></code> function.</p>
    1087. 

  1087. </div>
    1088. 

  1088. </dd></dl>
    1089. 

  1089. 

  1090. <dl class="method">
    1091. 

  1091. <dt id="CI_Input::method">
    1092. 

  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. 

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

  1094. <col class="field-name" />
    1095. 

  1095. <col class="field-body" />
    1096. 

  1096. <tbody valign="top">
    1097. 

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

  1098. <li><strong>$upper</strong> (<em>bool</em>) – Whether to return the request method name in upper or lower case</li>
    1099. 

  1099. </ul>
    1100. 

  1100. </td>
    1101. 

  1101. </tr>
    1102. 

  1102. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">HTTP request method</p>
    1103. 

  1103. </td>
    1104. 

  1104. </tr>
    1105. 

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

  1106. </td>
    1107. 

  1107. </tr>
    1108. 

  1108. </tbody>
    1109. 

  1109. </table>
    1110. 

  1110. <p>Returns the <code class="docutils literal"><span class="pre">$_SERVER['REQUEST_METHOD']</span></code>, with the option to set it
    1111. 

  1111. in uppercase or lowercase.</p>
    1112. 

  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. 

  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. 

  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. 

  1115. </pre></div>
    1116. 

  1116. </div>
    1117. 

  1117. </dd></dl>
    1118. 

  1118. 

  1119. </dd></dl>
    1120. 

  1120. 

  1121. </div>
    1122. 

  1122. </div>
    1123. 

  1123. 

  1124. 

  1125.           </div>
    1126. 

  1126.           <footer>
    1127. 

  1127.   
    1128. 

  1128.     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
    1129. 

  1129.       
    1130. 

  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. 

  1131.       
    1132. 

  1132.       
    1133. 

  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. 

  1134.       
    1135. 

  1135.     </div>
    1136. 

  1136.   
    1137. 

  1137. 

  1138.   <hr/>
    1139. 

  1139. 

  1140.   <div role="contentinfo">
    1141. 

  1141.     <p>
    1142. 

  1142.         &copy; Copyright 2014 - 2019, British Columbia Institute of Technology.
    1143. 

  1143.       Last updated on Sep 19, 2019.
    1144. 

  1144.     </p>
    1145. 

  1145.   </div>
    1146. 

  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. 

  1148.   
    1149. 

  1149. </footer>
    1150. 

  1150.         </div>
    1151. 

  1151.       </div>
    1152. 

  1152. 

  1153.     </section>
    1154. 

  1154. 

  1155.   </div>
    1156. 

  1156.   
    1157. 

  1157. 

  1158. 

  1159.   
    1160. 

  1160. 

  1161.     <script type="text/javascript">
    1162. 

  1162.         var DOCUMENTATION_OPTIONS = {
    1163. 

  1163.             URL_ROOT:'../',
    1164. 

  1164.             VERSION:'3.1.11',
    1165. 

  1165.             COLLAPSE_INDEX:false,
    1166. 

  1166.             FILE_SUFFIX:'.html',
    1167. 

  1167.             HAS_SOURCE:  false
    1168. 

  1168.         };
    1169. 

  1169.     </script>
    1170. 

  1170.       <script type="text/javascript" src="../_static/jquery.js"></script>
    1171. 

  1171.       <script type="text/javascript" src="../_static/underscore.js"></script>
    1172. 

  1172.       <script type="text/javascript" src="../_static/doctools.js"></script>
    1173. 

  1173. 

  1174.   
    1175. 

  1175. 

  1176.   
    1177. 

  1177.   
    1178. 

  1178.     <script type="text/javascript" src="../_static/js/theme.js"></script>
    1179. 

  1179.   
    1180. 

  1180. 

  1181.   
    1182. 

  1182.   
    1183. 

  1183.   <script type="text/javascript">
    1184. 

  1184.       jQuery(function () {
    1185. 

  1185.           SphinxRtdTheme.StickyNav.enable();
    1186. 

  1186.       });
    1187. 

  1187.   </script>
    1188. 

  1188.    
    1189. 

  1189. 

  1190. </body>
    1191. 

  1191. </html>
    1192.