Начало Каталог Помощ
Вход
wangsaitao
/
guotianyun-sp-yh
1
0
Разклонения 0
Файлове Задачи 0 Заявки за сливане 0 Уики
Клон: master
Клонове Маркери
guotianyun-s...
/
user_guide
/
helpers
/
file_helper.html

file_helper.html 52 KB
Постоянна връзка История Директен файл

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829 
  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>File Helper &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="Helpers" href="index.html"/>
    38. 

  38.         <link rel="next" title="Form Helper" href="form_helper.html"/>
    39. 

  39.         <link rel="prev" title="Email Helper" href="email_helper.html"/> 
    40. 

  40. 

  41.   
    42. 

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

  43. 

  44. </head>
    45. 

  45. 

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

  47. 

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

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

  50.     
    51. 

  51.     
    52. 

  52.     
    53. 

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

  54.         <ul>
    55. 

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

  56. </ul>
    57. 

  57. <ul>
    58. 

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

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

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

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

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

  63. </ul>
    64. 

  64. </li>
    65. 

  65. </ul>
    66. 

  66. <ul>
    67. 

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

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

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

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

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

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

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

  74. </ul>
    75. 

  75. </li>
    76. 

  76. </ul>
    77. 

  77. <ul>
    78. 

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

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

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

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

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

  83. </ul>
    84. 

  84. </li>
    85. 

  85. </ul>
    86. 

  86. <ul>
    87. 

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

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

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

  90. </ul>
    91. 

  91. </li>
    92. 

  92. </ul>
    93. 

  93. <ul>
    94. 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  121. </ul>
    122. 

  122. </li>
    123. 

  123. </ul>
    124. 

  124. <ul>
    125. 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  156. </ul>
    157. 

  157. </li>
    158. 

  158. </ul>
    159. 

  159. <ul>
    160. 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  175. </ul>
    176. 

  176. </li>
    177. 

  177. </ul>
    178. 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  201. </ul>
    202. 

  202. </li>
    203. 

  203. </ul>
    204. 

  204. 

  205.       </div>
    206. 

  206.     
    207. 

  207.       
    208. 

  208.   </div>
    209. 

  209. </div>
    210. 

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

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

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

  213.   </a>
    214. 

  214. </div>
    215. 

  215. 

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

  217. 

  218.     
    219. 

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

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

  221.         
    222. 

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

  223.         
    224. 

  224.         
    225. 

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

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

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

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

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

  230.   </form>
    231. 

  231. </div>
    232. 

  232.       </div>
    233. 

  233. 

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

  235.         
    236. 

  236.           
    237. 

  237.           
    238. 

  238.               <ul>
    239. 

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

  240. </ul>
    241. 

  241. <ul>
    242. 

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

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

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

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

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

  247. </ul>
    248. 

  248. </li>
    249. 

  249. </ul>
    250. 

  250. <ul>
    251. 

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

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

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

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

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

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

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

  258. </ul>
    259. 

  259. </li>
    260. 

  260. </ul>
    261. 

  261. <ul>
    262. 

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

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

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

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

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

  267. </ul>
    268. 

  268. </li>
    269. 

  269. </ul>
    270. 

  270. <ul>
    271. 

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

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

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

  274. </ul>
    275. 

  275. </li>
    276. 

  276. </ul>
    277. 

  277. <ul>
    278. 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  305. </ul>
    306. 

  306. </li>
    307. 

  307. </ul>
    308. 

  308. <ul>
    309. 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  340. </ul>
    341. 

  341. </li>
    342. 

  342. </ul>
    343. 

  343. <ul>
    344. 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  359. </ul>
    360. 

  360. </li>
    361. 

  361. </ul>
    362. 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  385. </ul>
    386. 

  386. </li>
    387. 

  387. </ul>
    388. 

  388. 

  389.           
    390. 

  390.         
    391. 

  391.       </div>
    392. 

  392.       &nbsp;
    393. 

  393.     </nav>
    394. 

  394. 

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

  396. 

  397.       
    398. 

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

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

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

  401.       </nav>
    402. 

  402. 

  403. 

  404.       
    405. 

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

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

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

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

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

  410.       
    411. 

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

  412.       
    413. 

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

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

  415.       
    416. 

  416.     </li>
    417. 

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

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

  419.     </div>
    420. 

  420.   </ul>
    421. 

  421.   <hr/>
    422. 

  422. </div>
    423. 

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

  424.             
    425. 

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

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

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

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

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

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

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

  432. </ul>
    433. 

  433. </div>
    434. 

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

  435. <h2><a class="toc-backref" href="#id1">Loading this Helper</a><a class="headerlink" href="#loading-this-helper" title="Permalink to this headline">¶</a></h2>
    436. 

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

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

  438. </pre></div>
    439. 

  439. </div>
    440. 

  440. </div>
    441. 

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

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

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

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

  445. <dt id="read_file">
    446. 

  446. <code class="descname">read_file</code><span class="sig-paren">(</span><em>$file</em><span class="sig-paren">)</span><a class="headerlink" href="#read_file" title="Permalink to this definition">¶</a></dt>
    447. 

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

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

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

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

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

  452. <li><strong>$file</strong> (<em>string</em>) – File path</li>
    453. 

  453. </ul>
    454. 

  454. </td>
    455. 

  455. </tr>
    456. 

  456. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">File contents or FALSE on failure</p>
    457. 

  457. </td>
    458. 

  458. </tr>
    459. 

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

  460. </td>
    461. 

  461. </tr>
    462. 

  462. </tbody>
    463. 

  463. </table>
    464. 

  464. <p>Returns the data contained in the file specified in the path.</p>
    465. 

  465. <p>Example:</p>
    466. 

  466. <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$string</span> <span class="o">=</span> <span class="nx">read_file</span><span class="p">(</span><span class="s1">&#39;./path/to/file.php&#39;</span><span class="p">);</span>
    467. 

  467. </pre></div>
    468. 

  468. </div>
    469. 

  469. <p>The path can be a relative or full server path. Returns FALSE (boolean) on failure.</p>
    470. 

  470. <div class="admonition note">
    471. 

  471. <p class="first admonition-title">Note</p>
    472. 

  472. <p class="last">The path is relative to your main site index.php file, NOT your
    473. 

  473. controller or view files. CodeIgniter uses a front controller so paths
    474. 

  474. are always relative to the main site index.</p>
    475. 

  475. </div>
    476. 

  476. <div class="admonition note">
    477. 

  477. <p class="first admonition-title">Note</p>
    478. 

  478. <p class="last">This function is DEPRECATED. Use the native <code class="docutils literal"><span class="pre">file_get_contents()</span></code>
    479. 

  479. instead.</p>
    480. 

  480. </div>
    481. 

  481. <div class="admonition important">
    482. 

  482. <p class="first admonition-title">Important</p>
    483. 

  483. <p class="last">If your server is running an <strong>open_basedir</strong> restriction this
    484. 

  484. function might not work if you are trying to access a file above the
    485. 

  485. calling script.</p>
    486. 

  486. </div>
    487. 

  487. </dd></dl>
    488. 

  488. 

  489. <dl class="function">
    490. 

  490. <dt id="write_file">
    491. 

  491. <code class="descname">write_file</code><span class="sig-paren">(</span><em>$path</em>, <em>$data</em><span class="optional">[</span>, <em>$mode = 'wb'</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#write_file" title="Permalink to this definition">¶</a></dt>
    492. 

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

  493. <col class="field-name" />
    494. 

  494. <col class="field-body" />
    495. 

  495. <tbody valign="top">
    496. 

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

  497. <li><strong>$path</strong> (<em>string</em>) – File path</li>
    498. 

  498. <li><strong>$data</strong> (<em>string</em>) – Data to write to file</li>
    499. 

  499. <li><strong>$mode</strong> (<em>string</em>) – <code class="docutils literal"><span class="pre">fopen()</span></code> mode</li>
    500. 

  500. </ul>
    501. 

  501. </td>
    502. 

  502. </tr>
    503. 

  503. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">TRUE if the write was successful, FALSE in case of an error</p>
    504. 

  504. </td>
    505. 

  505. </tr>
    506. 

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

  507. </td>
    508. 

  508. </tr>
    509. 

  509. </tbody>
    510. 

  510. </table>
    511. 

  511. <p>Writes data to the file specified in the path. If the file does not exist then the
    512. 

  512. function will create it.</p>
    513. 

  513. <p>Example:</p>
    514. 

  514. <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$data</span> <span class="o">=</span> <span class="s1">&#39;Some file data&#39;</span><span class="p">;</span>
    515. 

  515. <span class="k">if</span> <span class="p">(</span> <span class="o">!</span> <span class="nx">write_file</span><span class="p">(</span><span class="s1">&#39;./path/to/file.php&#39;</span><span class="p">,</span> <span class="nv">$data</span><span class="p">))</span>
    516. 

  516. <span class="p">{</span>
    517. 

  517.         <span class="k">echo</span> <span class="s1">&#39;Unable to write the file&#39;</span><span class="p">;</span>
    518. 

  518. <span class="p">}</span>
    519. 

  519. <span class="k">else</span>
    520. 

  520. <span class="p">{</span>
    521. 

  521.         <span class="k">echo</span> <span class="s1">&#39;File written!&#39;</span><span class="p">;</span>
    522. 

  522. <span class="p">}</span>
    523. 

  523. </pre></div>
    524. 

  524. </div>
    525. 

  525. <p>You can optionally set the write mode via the third parameter:</p>
    526. 

  526. <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nx">write_file</span><span class="p">(</span><span class="s1">&#39;./path/to/file.php&#39;</span><span class="p">,</span> <span class="nv">$data</span><span class="p">,</span> <span class="s1">&#39;r+&#39;</span><span class="p">);</span>
    527. 

  527. </pre></div>
    528. 

  528. </div>
    529. 

  529. <p>The default mode is ‘wb’. Please see the <a class="reference external" href="http://php.net/manual/en/function.fopen.php">PHP user guide</a>
    530. 

  530. for mode options.</p>
    531. 

  531. <div class="admonition note">
    532. 

  532. <p class="first admonition-title">Note</p>
    533. 

  533. <p class="last">The path is relative to your main site index.php file, NOT your
    534. 

  534. controller or view files. CodeIgniter uses a front controller so paths
    535. 

  535. are always relative to the main site index.</p>
    536. 

  536. </div>
    537. 

  537. <div class="admonition note">
    538. 

  538. <p class="first admonition-title">Note</p>
    539. 

  539. <p class="last">This function acquires an exclusive lock on the file while writing to it.</p>
    540. 

  540. </div>
    541. 

  541. </dd></dl>
    542. 

  542. 

  543. <dl class="function">
    544. 

  544. <dt id="delete_files">
    545. 

  545. <code class="descname">delete_files</code><span class="sig-paren">(</span><em>$path</em><span class="optional">[</span>, <em>$del_dir = FALSE</em><span class="optional">[</span>, <em>$htdocs = FALSE</em><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#delete_files" title="Permalink to this definition">¶</a></dt>
    546. 

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

  547. <col class="field-name" />
    548. 

  548. <col class="field-body" />
    549. 

  549. <tbody valign="top">
    550. 

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

  551. <li><strong>$path</strong> (<em>string</em>) – Directory path</li>
    552. 

  552. <li><strong>$del_dir</strong> (<em>bool</em>) – Whether to also delete directories</li>
    553. 

  553. <li><strong>$htdocs</strong> (<em>bool</em>) – Whether to skip deleting .htaccess and index page files</li>
    554. 

  554. </ul>
    555. 

  555. </td>
    556. 

  556. </tr>
    557. 

  557. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">TRUE on success, FALSE in case of an error</p>
    558. 

  558. </td>
    559. 

  559. </tr>
    560. 

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

  561. </td>
    562. 

  562. </tr>
    563. 

  563. </tbody>
    564. 

  564. </table>
    565. 

  565. <p>Deletes ALL files contained in the supplied path.</p>
    566. 

  566. <p>Example:</p>
    567. 

  567. <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nx">delete_files</span><span class="p">(</span><span class="s1">&#39;./path/to/directory/&#39;</span><span class="p">);</span>
    568. 

  568. </pre></div>
    569. 

  569. </div>
    570. 

  570. <p>If the second parameter is set to TRUE, any directories contained within the supplied
    571. 

  571. root path will be deleted as well.</p>
    572. 

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

  573. <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nx">delete_files</span><span class="p">(</span><span class="s1">&#39;./path/to/directory/&#39;</span><span class="p">,</span> <span class="k">TRUE</span><span class="p">);</span>
    574. 

  574. </pre></div>
    575. 

  575. </div>
    576. 

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

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

  578. <p class="last">The files must be writable or owned by the system in order to be deleted.</p>
    579. 

  579. </div>
    580. 

  580. </dd></dl>
    581. 

  581. 

  582. <dl class="function">
    583. 

  583. <dt id="get_filenames">
    584. 

  584. <code class="descname">get_filenames</code><span class="sig-paren">(</span><em>$source_dir</em><span class="optional">[</span>, <em>$include_path = FALSE</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#get_filenames" title="Permalink to this definition">¶</a></dt>
    585. 

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

  586. <col class="field-name" />
    587. 

  587. <col class="field-body" />
    588. 

  588. <tbody valign="top">
    589. 

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

  590. <li><strong>$source_dir</strong> (<em>string</em>) – Directory path</li>
    591. 

  591. <li><strong>$include_path</strong> (<em>bool</em>) – Whether to include the path as part of the filenames</li>
    592. 

  592. </ul>
    593. 

  593. </td>
    594. 

  594. </tr>
    595. 

  595. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">An array of file names</p>
    596. 

  596. </td>
    597. 

  597. </tr>
    598. 

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

  599. </td>
    600. 

  600. </tr>
    601. 

  601. </tbody>
    602. 

  602. </table>
    603. 

  603. <p>Takes a server path as input and returns an array containing the names of all files
    604. 

  604. contained within it. The file path can optionally be added to the file names by setting
    605. 

  605. the second parameter to TRUE.</p>
    606. 

  606. <p>Example:</p>
    607. 

  607. <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$controllers</span> <span class="o">=</span> <span class="nx">get_filenames</span><span class="p">(</span><span class="nx">APPPATH</span><span class="o">.</span><span class="s1">&#39;controllers/&#39;</span><span class="p">);</span>
    608. 

  608. </pre></div>
    609. 

  609. </div>
    610. 

  610. </dd></dl>
    611. 

  611. 

  612. <dl class="function">
    613. 

  613. <dt id="get_dir_file_info">
    614. 

  614. <code class="descname">get_dir_file_info</code><span class="sig-paren">(</span><em>$source_dir</em>, <em>$top_level_only</em><span class="sig-paren">)</span><a class="headerlink" href="#get_dir_file_info" title="Permalink to this definition">¶</a></dt>
    615. 

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

  616. <col class="field-name" />
    617. 

  617. <col class="field-body" />
    618. 

  618. <tbody valign="top">
    619. 

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

  620. <li><strong>$source_dir</strong> (<em>string</em>) – Directory path</li>
    621. 

  621. <li><strong>$top_level_only</strong> (<em>bool</em>) – Whether to look only at the specified directory (excluding sub-directories)</li>
    622. 

  622. </ul>
    623. 

  623. </td>
    624. 

  624. </tr>
    625. 

  625. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">An array containing info on the supplied directory’s contents</p>
    626. 

  626. </td>
    627. 

  627. </tr>
    628. 

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

  629. </td>
    630. 

  630. </tr>
    631. 

  631. </tbody>
    632. 

  632. </table>
    633. 

  633. <p>Reads the specified directory and builds an array containing the filenames, filesize,
    634. 

  634. dates, and permissions. Sub-folders contained within the specified path are only read
    635. 

  635. if forced by sending the second parameter to FALSE, as this can be an intensive
    636. 

  636. operation.</p>
    637. 

  637. <p>Example:</p>
    638. 

  638. <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$models_info</span> <span class="o">=</span> <span class="nx">get_dir_file_info</span><span class="p">(</span><span class="nx">APPPATH</span><span class="o">.</span><span class="s1">&#39;models/&#39;</span><span class="p">);</span>
    639. 

  639. </pre></div>
    640. 

  640. </div>
    641. 

  641. </dd></dl>
    642. 

  642. 

  643. <dl class="function">
    644. 

  644. <dt id="get_file_info">
    645. 

  645. <code class="descname">get_file_info</code><span class="sig-paren">(</span><em>$file</em><span class="optional">[</span>, <em>$returned_values = array('name'</em>, <em>'server_path'</em>, <em>'size'</em>, <em>'date')</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#get_file_info" title="Permalink to this definition">¶</a></dt>
    646. 

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

  647. <col class="field-name" />
    648. 

  648. <col class="field-body" />
    649. 

  649. <tbody valign="top">
    650. 

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

  651. <li><strong>$file</strong> (<em>string</em>) – File path</li>
    652. 

  652. <li><strong>$returned_values</strong> (<em>array</em>) – What type of info to return</li>
    653. 

  653. </ul>
    654. 

  654. </td>
    655. 

  655. </tr>
    656. 

  656. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">An array containing info on the specified file or FALSE on failure</p>
    657. 

  657. </td>
    658. 

  658. </tr>
    659. 

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

  660. </td>
    661. 

  661. </tr>
    662. 

  662. </tbody>
    663. 

  663. </table>
    664. 

  664. <p>Given a file and path, returns (optionally) the <em>name</em>, <em>path</em>, <em>size</em> and <em>date modified</em>
    665. 

  665. information attributes for a file. Second parameter allows you to explicitly declare what
    666. 

  666. information you want returned.</p>
    667. 

  667. <p>Valid <code class="docutils literal"><span class="pre">$returned_values</span></code> options are: <cite>name</cite>, <cite>size</cite>, <cite>date</cite>, <cite>readable</cite>, <cite>writeable</cite>,
    668. 

  668. <cite>executable</cite> and <cite>fileperms</cite>.</p>
    669. 

  669. </dd></dl>
    670. 

  670. 

  671. <dl class="function">
    672. 

  672. <dt id="get_mime_by_extension">
    673. 

  673. <code class="descname">get_mime_by_extension</code><span class="sig-paren">(</span><em>$filename</em><span class="sig-paren">)</span><a class="headerlink" href="#get_mime_by_extension" title="Permalink to this definition">¶</a></dt>
    674. 

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

  675. <col class="field-name" />
    676. 

  676. <col class="field-body" />
    677. 

  677. <tbody valign="top">
    678. 

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

  679. <li><strong>$filename</strong> (<em>string</em>) – File name</li>
    680. 

  680. </ul>
    681. 

  681. </td>
    682. 

  682. </tr>
    683. 

  683. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">MIME type string or FALSE on failure</p>
    684. 

  684. </td>
    685. 

  685. </tr>
    686. 

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

  687. </td>
    688. 

  688. </tr>
    689. 

  689. </tbody>
    690. 

  690. </table>
    691. 

  691. <p>Translates a filename extension into a MIME type based on <em>config/mimes.php</em>.
    692. 

  692. Returns FALSE if it can’t determine the type, or read the MIME config file.</p>
    693. 

  693. <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$file</span> <span class="o">=</span> <span class="s1">&#39;somefile.png&#39;</span><span class="p">;</span>
    694. 

  694. <span class="k">echo</span> <span class="nv">$file</span><span class="o">.</span><span class="s1">&#39; is has a mime type of &#39;</span><span class="o">.</span><span class="nx">get_mime_by_extension</span><span class="p">(</span><span class="nv">$file</span><span class="p">);</span>
    695. 

  695. </pre></div>
    696. 

  696. </div>
    697. 

  697. <div class="admonition note">
    698. 

  698. <p class="first admonition-title">Note</p>
    699. 

  699. <p class="last">This is not an accurate way of determining file MIME types, and
    700. 

  700. is here strictly for convenience. It should not be used for security
    701. 

  701. purposes.</p>
    702. 

  702. </div>
    703. 

  703. </dd></dl>
    704. 

  704. 

  705. <dl class="function">
    706. 

  706. <dt id="symbolic_permissions">
    707. 

  707. <code class="descname">symbolic_permissions</code><span class="sig-paren">(</span><em>$perms</em><span class="sig-paren">)</span><a class="headerlink" href="#symbolic_permissions" title="Permalink to this definition">¶</a></dt>
    708. 

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

  709. <col class="field-name" />
    710. 

  710. <col class="field-body" />
    711. 

  711. <tbody valign="top">
    712. 

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

  713. <li><strong>$perms</strong> (<em>int</em>) – Permissions</li>
    714. 

  714. </ul>
    715. 

  715. </td>
    716. 

  716. </tr>
    717. 

  717. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Symbolic permissions string</p>
    718. 

  718. </td>
    719. 

  719. </tr>
    720. 

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

  721. </td>
    722. 

  722. </tr>
    723. 

  723. </tbody>
    724. 

  724. </table>
    725. 

  725. <p>Takes numeric permissions (such as is returned by <code class="docutils literal"><span class="pre">fileperms()</span></code>) and returns
    726. 

  726. standard symbolic notation of file permissions.</p>
    727. 

  727. <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">echo</span> <span class="nx">symbolic_permissions</span><span class="p">(</span><span class="nb">fileperms</span><span class="p">(</span><span class="s1">&#39;./index.php&#39;</span><span class="p">));</span>  <span class="c1">// -rw-r--r--</span>
    728. 

  728. </pre></div>
    729. 

  729. </div>
    730. 

  730. </dd></dl>
    731. 

  731. 

  732. <dl class="function">
    733. 

  733. <dt id="octal_permissions">
    734. 

  734. <code class="descname">octal_permissions</code><span class="sig-paren">(</span><em>$perms</em><span class="sig-paren">)</span><a class="headerlink" href="#octal_permissions" title="Permalink to this definition">¶</a></dt>
    735. 

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

  736. <col class="field-name" />
    737. 

  737. <col class="field-body" />
    738. 

  738. <tbody valign="top">
    739. 

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

  740. <li><strong>$perms</strong> (<em>int</em>) – Permissions</li>
    741. 

  741. </ul>
    742. 

  742. </td>
    743. 

  743. </tr>
    744. 

  744. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Octal permissions string</p>
    745. 

  745. </td>
    746. 

  746. </tr>
    747. 

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

  748. </td>
    749. 

  749. </tr>
    750. 

  750. </tbody>
    751. 

  751. </table>
    752. 

  752. <p>Takes numeric permissions (such as is returned by <code class="docutils literal"><span class="pre">fileperms()</span></code>) and returns
    753. 

  753. a three character octal notation of file permissions.</p>
    754. 

  754. <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">echo</span> <span class="nx">octal_permissions</span><span class="p">(</span><span class="nb">fileperms</span><span class="p">(</span><span class="s1">&#39;./index.php&#39;</span><span class="p">));</span> <span class="c1">// 644</span>
    755. 

  755. </pre></div>
    756. 

  756. </div>
    757. 

  757. </dd></dl>
    758. 

  758. 

  759. </div>
    760. 

  760. </div>
    761. 

  761. 

  762. 

  763.           </div>
    764. 

  764.           <footer>
    765. 

  765.   
    766. 

  766.     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
    767. 

  767.       
    768. 

  768.         <a href="form_helper.html" class="btn btn-neutral float-right" title="Form Helper">Next <span class="fa fa-arrow-circle-right"></span></a>
    769. 

  769.       
    770. 

  770.       
    771. 

  771.         <a href="email_helper.html" class="btn btn-neutral" title="Email Helper"><span class="fa fa-arrow-circle-left"></span> Previous</a>
    772. 

  772.       
    773. 

  773.     </div>
    774. 

  774.   
    775. 

  775. 

  776.   <hr/>
    777. 

  777. 

  778.   <div role="contentinfo">
    779. 

  779.     <p>
    780. 

  780.         &copy; Copyright 2014 - 2019, British Columbia Institute of Technology.
    781. 

  781.       Last updated on Sep 19, 2019.
    782. 

  782.     </p>
    783. 

  783.   </div>
    784. 

  784. 

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

  786.   
    787. 

  787. </footer>
    788. 

  788.         </div>
    789. 

  789.       </div>
    790. 

  790. 

  791.     </section>
    792. 

  792. 

  793.   </div>
    794. 

  794.   
    795. 

  795. 

  796. 

  797.   
    798. 

  798. 

  799.     <script type="text/javascript">
    800. 

  800.         var DOCUMENTATION_OPTIONS = {
    801. 

  801.             URL_ROOT:'../',
    802. 

  802.             VERSION:'3.1.11',
    803. 

  803.             COLLAPSE_INDEX:false,
    804. 

  804.             FILE_SUFFIX:'.html',
    805. 

  805.             HAS_SOURCE:  false
    806. 

  806.         };
    807. 

  807.     </script>
    808. 

  808.       <script type="text/javascript" src="../_static/jquery.js"></script>
    809. 

  809.       <script type="text/javascript" src="../_static/underscore.js"></script>
    810. 

  810.       <script type="text/javascript" src="../_static/doctools.js"></script>
    811. 

  811. 

  812.   
    813. 

  813. 

  814.   
    815. 

  815.   
    816. 

  816.     <script type="text/javascript" src="../_static/js/theme.js"></script>
    817. 

  817.   
    818. 

  818. 

  819.   
    820. 

  820.   
    821. 

  821.   <script type="text/javascript">
    822. 

  822.       jQuery(function () {
    823. 

  823.           SphinxRtdTheme.StickyNav.enable();
    824. 

  824.       });
    825. 

  825.   </script>
    826. 

  826.    
    827. 

  827. 

  828. </body>
    829. 

  829. </html>
    830.