Andrey Andreev | c576995 | 2019-01-16 17:49:35 +0200 | [diff] [blame] | 1 | |
| 2 | |
| 3 | <!DOCTYPE html> |
| 4 | <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> |
| 5 | <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> |
| 6 | <head> |
| 7 | <meta charset="utf-8"> |
| 8 | <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| 9 | |
| 10 | <title>File Uploading Class — CodeIgniter 3.1.10 documentation</title> |
| 11 | |
| 12 | |
| 13 | |
| 14 | |
| 15 | <link rel="shortcut icon" href="../_static/ci-icon.ico"/> |
| 16 | |
| 17 | |
| 18 | |
| 19 | <link href='https://fonts.googleapis.com/css?family=Lato:400,700,400italic,700italic|Roboto+Slab:400,700|Inconsolata:400,700&subset=latin,cyrillic' rel='stylesheet' type='text/css'> |
| 20 | |
| 21 | |
| 22 | |
| 23 | |
| 24 | |
| 25 | |
| 26 | |
| 27 | |
| 28 | |
| 29 | <link rel="stylesheet" href="../_static/css/citheme.css" type="text/css" /> |
| 30 | |
| 31 | |
| 32 | |
| 33 | <link rel="index" title="Index" |
| 34 | href="../genindex.html"/> |
| 35 | <link rel="search" title="Search" href="../search.html"/> |
| 36 | <link rel="top" title="CodeIgniter 3.1.10 documentation" href="../index.html"/> |
| 37 | <link rel="up" title="Libraries" href="index.html"/> |
| 38 | <link rel="next" title="Form Validation" href="form_validation.html"/> |
| 39 | <link rel="prev" title="Encryption Library" href="encryption.html"/> |
| 40 | |
| 41 | |
| 42 | <script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script> |
| 43 | |
| 44 | </head> |
| 45 | |
| 46 | <body class="wy-body-for-nav" role="document"> |
| 47 | |
| 48 | <div id="nav"> |
| 49 | <div id="nav_inner"> |
| 50 | |
| 51 | |
| 52 | |
| 53 | <div id="pulldown-menu" class="ciNav"> |
| 54 | <ul> |
| 55 | <li class="toctree-l1"><a class="reference internal" href="../general/welcome.html">Welcome to CodeIgniter</a></li> |
| 56 | </ul> |
| 57 | <ul> |
| 58 | <li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installation Instructions</a><ul> |
| 59 | <li class="toctree-l2"><a class="reference internal" href="../installation/downloads.html">Downloading CodeIgniter</a></li> |
| 60 | <li class="toctree-l2"><a class="reference internal" href="../installation/index.html">Installation Instructions</a></li> |
| 61 | <li class="toctree-l2"><a class="reference internal" href="../installation/upgrading.html">Upgrading From a Previous Version</a></li> |
| 62 | <li class="toctree-l2"><a class="reference internal" href="../installation/troubleshooting.html">Troubleshooting</a></li> |
| 63 | </ul> |
| 64 | </li> |
| 65 | </ul> |
| 66 | <ul> |
| 67 | <li class="toctree-l1"><a class="reference internal" href="../overview/index.html">CodeIgniter Overview</a><ul> |
| 68 | <li class="toctree-l2"><a class="reference internal" href="../overview/getting_started.html">Getting Started</a></li> |
| 69 | <li class="toctree-l2"><a class="reference internal" href="../overview/at_a_glance.html">CodeIgniter at a Glance</a></li> |
| 70 | <li class="toctree-l2"><a class="reference internal" href="../overview/features.html">Supported Features</a></li> |
| 71 | <li class="toctree-l2"><a class="reference internal" href="../overview/appflow.html">Application Flow Chart</a></li> |
| 72 | <li class="toctree-l2"><a class="reference internal" href="../overview/mvc.html">Model-View-Controller</a></li> |
| 73 | <li class="toctree-l2"><a class="reference internal" href="../overview/goals.html">Architectural Goals</a></li> |
| 74 | </ul> |
| 75 | </li> |
| 76 | </ul> |
| 77 | <ul> |
| 78 | <li class="toctree-l1"><a class="reference internal" href="../tutorial/index.html">Tutorial</a><ul> |
| 79 | <li class="toctree-l2"><a class="reference internal" href="../tutorial/static_pages.html">Static pages</a></li> |
| 80 | <li class="toctree-l2"><a class="reference internal" href="../tutorial/news_section.html">News section</a></li> |
| 81 | <li class="toctree-l2"><a class="reference internal" href="../tutorial/create_news_items.html">Create news items</a></li> |
| 82 | <li class="toctree-l2"><a class="reference internal" href="../tutorial/conclusion.html">Conclusion</a></li> |
| 83 | </ul> |
| 84 | </li> |
| 85 | </ul> |
| 86 | <ul> |
| 87 | <li class="toctree-l1"><a class="reference internal" href="../contributing/index.html">Contributing to CodeIgniter</a><ul> |
| 88 | <li class="toctree-l2"><a class="reference internal" href="../documentation/index.html">Writing CodeIgniter Documentation</a></li> |
| 89 | <li class="toctree-l2"><a class="reference internal" href="../DCO.html">Developer’s Certificate of Origin 1.1</a></li> |
| 90 | </ul> |
| 91 | </li> |
| 92 | </ul> |
| 93 | <ul> |
| 94 | <li class="toctree-l1"><a class="reference internal" href="../general/index.html">General Topics</a><ul> |
| 95 | <li class="toctree-l2"><a class="reference internal" href="../general/urls.html">CodeIgniter URLs</a></li> |
| 96 | <li class="toctree-l2"><a class="reference internal" href="../general/controllers.html">Controllers</a></li> |
| 97 | <li class="toctree-l2"><a class="reference internal" href="../general/reserved_names.html">Reserved Names</a></li> |
| 98 | <li class="toctree-l2"><a class="reference internal" href="../general/views.html">Views</a></li> |
| 99 | <li class="toctree-l2"><a class="reference internal" href="../general/models.html">Models</a></li> |
| 100 | <li class="toctree-l2"><a class="reference internal" href="../general/helpers.html">Helpers</a></li> |
| 101 | <li class="toctree-l2"><a class="reference internal" href="../general/libraries.html">Using CodeIgniter Libraries</a></li> |
| 102 | <li class="toctree-l2"><a class="reference internal" href="../general/creating_libraries.html">Creating Libraries</a></li> |
| 103 | <li class="toctree-l2"><a class="reference internal" href="../general/drivers.html">Using CodeIgniter Drivers</a></li> |
| 104 | <li class="toctree-l2"><a class="reference internal" href="../general/creating_drivers.html">Creating Drivers</a></li> |
| 105 | <li class="toctree-l2"><a class="reference internal" href="../general/core_classes.html">Creating Core System Classes</a></li> |
| 106 | <li class="toctree-l2"><a class="reference internal" href="../general/ancillary_classes.html">Creating Ancillary Classes</a></li> |
| 107 | <li class="toctree-l2"><a class="reference internal" href="../general/hooks.html">Hooks - Extending the Framework Core</a></li> |
| 108 | <li class="toctree-l2"><a class="reference internal" href="../general/autoloader.html">Auto-loading Resources</a></li> |
| 109 | <li class="toctree-l2"><a class="reference internal" href="../general/common_functions.html">Common Functions</a></li> |
| 110 | <li class="toctree-l2"><a class="reference internal" href="../general/compatibility_functions.html">Compatibility Functions</a></li> |
| 111 | <li class="toctree-l2"><a class="reference internal" href="../general/routing.html">URI Routing</a></li> |
| 112 | <li class="toctree-l2"><a class="reference internal" href="../general/errors.html">Error Handling</a></li> |
| 113 | <li class="toctree-l2"><a class="reference internal" href="../general/caching.html">Caching</a></li> |
| 114 | <li class="toctree-l2"><a class="reference internal" href="../general/profiling.html">Profiling Your Application</a></li> |
| 115 | <li class="toctree-l2"><a class="reference internal" href="../general/cli.html">Running via the CLI</a></li> |
| 116 | <li class="toctree-l2"><a class="reference internal" href="../general/managing_apps.html">Managing your Applications</a></li> |
| 117 | <li class="toctree-l2"><a class="reference internal" href="../general/environments.html">Handling Multiple Environments</a></li> |
| 118 | <li class="toctree-l2"><a class="reference internal" href="../general/alternative_php.html">Alternate PHP Syntax for View Files</a></li> |
| 119 | <li class="toctree-l2"><a class="reference internal" href="../general/security.html">Security</a></li> |
| 120 | <li class="toctree-l2"><a class="reference internal" href="../general/styleguide.html">PHP Style Guide</a></li> |
| 121 | </ul> |
| 122 | </li> |
| 123 | </ul> |
| 124 | <ul class="current"> |
| 125 | <li class="toctree-l1 current"><a class="reference internal" href="index.html">Libraries</a><ul class="current"> |
| 126 | <li class="toctree-l2"><a class="reference internal" href="benchmark.html">Benchmarking Class</a></li> |
| 127 | <li class="toctree-l2"><a class="reference internal" href="caching.html">Caching Driver</a></li> |
| 128 | <li class="toctree-l2"><a class="reference internal" href="calendar.html">Calendaring Class</a></li> |
| 129 | <li class="toctree-l2"><a class="reference internal" href="cart.html">Shopping Cart Class</a></li> |
| 130 | <li class="toctree-l2"><a class="reference internal" href="config.html">Config Class</a></li> |
| 131 | <li class="toctree-l2"><a class="reference internal" href="email.html">Email Class</a></li> |
| 132 | <li class="toctree-l2"><a class="reference internal" href="encrypt.html">Encrypt Class</a></li> |
| 133 | <li class="toctree-l2"><a class="reference internal" href="encryption.html">Encryption Library</a></li> |
| 134 | <li class="toctree-l2 current"><a class="current reference internal" href="#">File Uploading Class</a></li> |
| 135 | <li class="toctree-l2"><a class="reference internal" href="form_validation.html">Form Validation</a></li> |
| 136 | <li class="toctree-l2"><a class="reference internal" href="ftp.html">FTP Class</a></li> |
| 137 | <li class="toctree-l2"><a class="reference internal" href="image_lib.html">Image Manipulation Class</a></li> |
| 138 | <li class="toctree-l2"><a class="reference internal" href="input.html">Input Class</a></li> |
| 139 | <li class="toctree-l2"><a class="reference internal" href="javascript.html">Javascript Class</a></li> |
| 140 | <li class="toctree-l2"><a class="reference internal" href="language.html">Language Class</a></li> |
| 141 | <li class="toctree-l2"><a class="reference internal" href="loader.html">Loader Class</a></li> |
| 142 | <li class="toctree-l2"><a class="reference internal" href="migration.html">Migrations Class</a></li> |
| 143 | <li class="toctree-l2"><a class="reference internal" href="output.html">Output Class</a></li> |
| 144 | <li class="toctree-l2"><a class="reference internal" href="pagination.html">Pagination Class</a></li> |
| 145 | <li class="toctree-l2"><a class="reference internal" href="parser.html">Template Parser Class</a></li> |
| 146 | <li class="toctree-l2"><a class="reference internal" href="security.html">Security Class</a></li> |
| 147 | <li class="toctree-l2"><a class="reference internal" href="sessions.html">Session Library</a></li> |
| 148 | <li class="toctree-l2"><a class="reference internal" href="table.html">HTML Table Class</a></li> |
| 149 | <li class="toctree-l2"><a class="reference internal" href="trackback.html">Trackback Class</a></li> |
| 150 | <li class="toctree-l2"><a class="reference internal" href="typography.html">Typography Class</a></li> |
| 151 | <li class="toctree-l2"><a class="reference internal" href="unit_testing.html">Unit Testing Class</a></li> |
| 152 | <li class="toctree-l2"><a class="reference internal" href="uri.html">URI Class</a></li> |
| 153 | <li class="toctree-l2"><a class="reference internal" href="user_agent.html">User Agent Class</a></li> |
| 154 | <li class="toctree-l2"><a class="reference internal" href="xmlrpc.html">XML-RPC and XML-RPC Server Classes</a></li> |
| 155 | <li class="toctree-l2"><a class="reference internal" href="zip.html">Zip Encoding Class</a></li> |
| 156 | </ul> |
| 157 | </li> |
| 158 | </ul> |
| 159 | <ul> |
| 160 | <li class="toctree-l1"><a class="reference internal" href="../database/index.html">Database Reference</a><ul> |
| 161 | <li class="toctree-l2"><a class="reference internal" href="../database/examples.html">Quick Start: Usage Examples</a></li> |
| 162 | <li class="toctree-l2"><a class="reference internal" href="../database/configuration.html">Database Configuration</a></li> |
| 163 | <li class="toctree-l2"><a class="reference internal" href="../database/connecting.html">Connecting to a Database</a></li> |
| 164 | <li class="toctree-l2"><a class="reference internal" href="../database/queries.html">Running Queries</a></li> |
| 165 | <li class="toctree-l2"><a class="reference internal" href="../database/results.html">Generating Query Results</a></li> |
| 166 | <li class="toctree-l2"><a class="reference internal" href="../database/helpers.html">Query Helper Functions</a></li> |
| 167 | <li class="toctree-l2"><a class="reference internal" href="../database/query_builder.html">Query Builder Class</a></li> |
| 168 | <li class="toctree-l2"><a class="reference internal" href="../database/transactions.html">Transactions</a></li> |
| 169 | <li class="toctree-l2"><a class="reference internal" href="../database/metadata.html">Getting MetaData</a></li> |
| 170 | <li class="toctree-l2"><a class="reference internal" href="../database/call_function.html">Custom Function Calls</a></li> |
| 171 | <li class="toctree-l2"><a class="reference internal" href="../database/caching.html">Query Caching</a></li> |
| 172 | <li class="toctree-l2"><a class="reference internal" href="../database/forge.html">Database Manipulation with Database Forge</a></li> |
| 173 | <li class="toctree-l2"><a class="reference internal" href="../database/utilities.html">Database Utilities Class</a></li> |
| 174 | <li class="toctree-l2"><a class="reference internal" href="../database/db_driver_reference.html">Database Driver Reference</a></li> |
| 175 | </ul> |
| 176 | </li> |
| 177 | </ul> |
| 178 | <ul> |
| 179 | <li class="toctree-l1"><a class="reference internal" href="../helpers/index.html">Helpers</a><ul> |
| 180 | <li class="toctree-l2"><a class="reference internal" href="../helpers/array_helper.html">Array Helper</a></li> |
| 181 | <li class="toctree-l2"><a class="reference internal" href="../helpers/captcha_helper.html">CAPTCHA Helper</a></li> |
| 182 | <li class="toctree-l2"><a class="reference internal" href="../helpers/cookie_helper.html">Cookie Helper</a></li> |
| 183 | <li class="toctree-l2"><a class="reference internal" href="../helpers/date_helper.html">Date Helper</a></li> |
| 184 | <li class="toctree-l2"><a class="reference internal" href="../helpers/directory_helper.html">Directory Helper</a></li> |
| 185 | <li class="toctree-l2"><a class="reference internal" href="../helpers/download_helper.html">Download Helper</a></li> |
| 186 | <li class="toctree-l2"><a class="reference internal" href="../helpers/email_helper.html">Email Helper</a></li> |
| 187 | <li class="toctree-l2"><a class="reference internal" href="../helpers/file_helper.html">File Helper</a></li> |
| 188 | <li class="toctree-l2"><a class="reference internal" href="../helpers/form_helper.html">Form Helper</a></li> |
| 189 | <li class="toctree-l2"><a class="reference internal" href="../helpers/html_helper.html">HTML Helper</a></li> |
| 190 | <li class="toctree-l2"><a class="reference internal" href="../helpers/inflector_helper.html">Inflector Helper</a></li> |
| 191 | <li class="toctree-l2"><a class="reference internal" href="../helpers/language_helper.html">Language Helper</a></li> |
| 192 | <li class="toctree-l2"><a class="reference internal" href="../helpers/number_helper.html">Number Helper</a></li> |
| 193 | <li class="toctree-l2"><a class="reference internal" href="../helpers/path_helper.html">Path Helper</a></li> |
| 194 | <li class="toctree-l2"><a class="reference internal" href="../helpers/security_helper.html">Security Helper</a></li> |
| 195 | <li class="toctree-l2"><a class="reference internal" href="../helpers/smiley_helper.html">Smiley Helper</a></li> |
| 196 | <li class="toctree-l2"><a class="reference internal" href="../helpers/string_helper.html">String Helper</a></li> |
| 197 | <li class="toctree-l2"><a class="reference internal" href="../helpers/text_helper.html">Text Helper</a></li> |
| 198 | <li class="toctree-l2"><a class="reference internal" href="../helpers/typography_helper.html">Typography Helper</a></li> |
| 199 | <li class="toctree-l2"><a class="reference internal" href="../helpers/url_helper.html">URL Helper</a></li> |
| 200 | <li class="toctree-l2"><a class="reference internal" href="../helpers/xml_helper.html">XML Helper</a></li> |
| 201 | </ul> |
| 202 | </li> |
| 203 | </ul> |
| 204 | |
| 205 | </div> |
| 206 | |
| 207 | |
| 208 | </div> |
| 209 | </div> |
| 210 | <div id="nav2"> |
| 211 | <a href="#" id="openToc"> |
| 212 | <img src="data:image/jpeg;base64,/9j/4AAQSkZJRgABAgAAZABkAAD/7AARRHVja3kAAQAEAAAARgAA/+4ADkFkb2JlAGTAAAAAAf/bAIQABAMDAwMDBAMDBAYEAwQGBwUEBAUHCAYGBwYGCAoICQkJCQgKCgwMDAwMCgwMDQ0MDBERERERFBQUFBQUFBQUFAEEBQUIBwgPCgoPFA4ODhQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQU/8AAEQgAKwCaAwERAAIRAQMRAf/EAHsAAQAABwEBAAAAAAAAAAAAAAABAwQFBgcIAgkBAQAAAAAAAAAAAAAAAAAAAAAQAAEDAwICBwYEAgsAAAAAAAIBAwQAEQUSBiEHkROTVNQWGDFBUVIUCHEiMtOUFWGBobHRQlMkZIRVEQEAAAAAAAAAAAAAAAAAAAAA/9oADAMBAAIRAxEAPwDSC+ygkOOaUoKigUCgUCgUCgUCgUCgUCgUCgkuGguIP9FBMFb0Hqg7We+3jlmIqqYFf4ub+/QYlnOR/LqIBKGFUbf8qWv971BytQXXE7Y3Lnm3HsFhp2TaZJAdchRXpIgSpdEJWxJEW3xoKV7F5OMy7JkQn2o7D6w33XGjEAkoiqrJEqIiOIiKuhePCgqp22dyYyS3CyWHnQ5joG61HkRnmnTbaFSMhExRVQRRVJU9iUHjE7ez+fJ0MFipmUNhBV8YUd2SoIV9KkjQla9ltegttBdPLW4/qocL+UTfrMiHW4+P9M71shuyrqaHTcxsl7jegpsji8nh5ZwMvDfgTm0RTjSmjYdFCS6KoOIipdFunCgmNYTMv457MMY6U7iI6oMieDDhRm1VbIhuoOkbqtuK0Hpzb+eZcYZexUxt6UyUqK2cd0SdjtgrhOgijcgERUlJOCIl6CpgbP3blRI8XgMjNARAyKNDfeRBdFDBVUAXgQrqH4pxoJTu2NysY97LP4ac1io5q1InHFeGO24LnVKJuKOkSQ/yKir+rh7aCLG1dzypZQI2FnvTgccYOM3FeN0XWERXAUEFVQgQkUktdLpegm+Td3/Xli/L+S/mYNJIOF9G/wBeLKrZHFb0akG6W1WtQWSg3Dyg5e7V3fipE3O4/wCrktyzYA+ufas2LbZIlmnAT2kvuoN1wft95augilglX/tzP3qCu9O3LL/wV/i5v79BvmTADq14UGu91467Z6U9y0HzH/ncj/U/sT/CgynZG7I2NezpZGUjIycJkYkZSG+uQ81pbBNKLxJfjwoMqZ3/ALYHl35AJ7/cuwHcu5k7r1Q5pHetBjquqVVJWGxj9Zrtcl/Ggy3dHMvauR3HFZj5nHNxSyW5JISYDMoIwx8tFIGHZhPNaykGapr6rUAiicEoMG21lMRj8buPAz8xhJrr7uOeiPTCyAwXUaGR1mgozbTusOsFLEiJ7fbQa/h7gcjy2H3V6xppwDNtUSxCJIqp7valBuWVzJ22xuCROXNNZiJkMtms0DbjUkAZjzoDrTMd9dDRI44ZC2YsrYdKWP2WDT2S3N9dNdlRYrGMYc06IURXSYb0igrpWS485xVNS6nF4rwslkoMwnbpgZLB7bmt5uMweAhDEl4B5uSLzzqTnnyVpW2jaJHRMSIjdDiiotvy3DOE5rYTEbkl5yFn28k7JyG4c7AU2HtLH1uKfaiMPI40CdYbpNtmLdwTSn5rewLNld+7TLdeal4WarWBkbVKBjgdElMJJwAAY5fl4kB3b1fp4XvagsGS3FjJfLzDNtS8aeXx7LzT7TyzByQE5PccRGRC0ZRUDRV6y62vbjagzLmJzS2vuPK43JY6aP1TW6Jz+RIWyFtyC06y3EkiiinAo7YCqfq1AqqnGgsOH3lhZO8d1pmcpB8j5XIm9OYlBJSQ/FSS4427DKO0RC8AlcEMhFdViRR1WDWR5t3WXVuL1d106kG9vdeye2g60+1FDyW0shIcXVpyroXt8I8dfd+NB1vioAdWnD3UF1+gD4UFc6CEKpagxXN43rwJLUHz7yX2c8zokt9uHlsPIhA4aRnnHJTLptIS6CNsY7iASpxUUMkReGpfbQW0vtN5pitvrsN28rwtBD0nc0+/Yft5XhaB6TuaXfsP28rwtA9J3NPv2H7eV4Wgek7mn37D9vK8LQPSdzT79h+3leFoHpO5pd+w/byvC0D0nc0u/Yft5XhaB6TuaXfsP28rwtA9J3NLv2H7eV4Wgek7ml37D9vK8LQPSdzS79h+3leFoHpO5p9+w/byvC0E9r7Reazy2HIYVPxkS/CUHVn26cosxyv2g7h89LYmZSXOenvLEQ1YaQ222RATcQCP8rSGqqA8S02W2pQ6FhMoAIlqCtsnwoCpdKClejI4i3Sgtb+GBxVuNBSFt1pV/RQefLjPyUDy4z8lA8uM/JQPLjPyUDy4z8lA8uM/JQPLjPyUDy4z8lA8uM/JQPLjPyUDy4z8lA8utJ/koJ7WCbBU/LQXOPAFq1koK8B0pag90CggtBBf6qB0UDooHRQOigdFA6KB0UDooHRQOigdFA6KB0UDooI0EaBQf//Z" title="Toggle Table of Contents" alt="Toggle Table of Contents" /> |
| 213 | </a> |
| 214 | </div> |
| 215 | |
| 216 | <div class="wy-grid-for-nav"> |
| 217 | |
| 218 | |
| 219 | <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| 220 | <div class="wy-side-nav-search"> |
| 221 | |
| 222 | <a href="../index.html" class="fa fa-home"> CodeIgniter</a> |
| 223 | |
| 224 | |
| 225 | <div role="search"> |
| 226 | <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> |
| 227 | <input type="text" name="q" placeholder="Search docs" /> |
| 228 | <input type="hidden" name="check_keywords" value="yes" /> |
| 229 | <input type="hidden" name="area" value="default" /> |
| 230 | </form> |
| 231 | </div> |
| 232 | </div> |
| 233 | |
| 234 | <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
| 235 | |
| 236 | |
| 237 | |
| 238 | <ul> |
| 239 | <li class="toctree-l1"><a class="reference internal" href="../general/welcome.html">Welcome to CodeIgniter</a></li> |
| 240 | </ul> |
| 241 | <ul> |
| 242 | <li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installation Instructions</a><ul> |
| 243 | <li class="toctree-l2"><a class="reference internal" href="../installation/downloads.html">Downloading CodeIgniter</a></li> |
| 244 | <li class="toctree-l2"><a class="reference internal" href="../installation/index.html">Installation Instructions</a></li> |
| 245 | <li class="toctree-l2"><a class="reference internal" href="../installation/upgrading.html">Upgrading From a Previous Version</a></li> |
| 246 | <li class="toctree-l2"><a class="reference internal" href="../installation/troubleshooting.html">Troubleshooting</a></li> |
| 247 | </ul> |
| 248 | </li> |
| 249 | </ul> |
| 250 | <ul> |
| 251 | <li class="toctree-l1"><a class="reference internal" href="../overview/index.html">CodeIgniter Overview</a><ul> |
| 252 | <li class="toctree-l2"><a class="reference internal" href="../overview/getting_started.html">Getting Started</a></li> |
| 253 | <li class="toctree-l2"><a class="reference internal" href="../overview/at_a_glance.html">CodeIgniter at a Glance</a></li> |
| 254 | <li class="toctree-l2"><a class="reference internal" href="../overview/features.html">Supported Features</a></li> |
| 255 | <li class="toctree-l2"><a class="reference internal" href="../overview/appflow.html">Application Flow Chart</a></li> |
| 256 | <li class="toctree-l2"><a class="reference internal" href="../overview/mvc.html">Model-View-Controller</a></li> |
| 257 | <li class="toctree-l2"><a class="reference internal" href="../overview/goals.html">Architectural Goals</a></li> |
| 258 | </ul> |
| 259 | </li> |
| 260 | </ul> |
| 261 | <ul> |
| 262 | <li class="toctree-l1"><a class="reference internal" href="../tutorial/index.html">Tutorial</a><ul> |
| 263 | <li class="toctree-l2"><a class="reference internal" href="../tutorial/static_pages.html">Static pages</a></li> |
| 264 | <li class="toctree-l2"><a class="reference internal" href="../tutorial/news_section.html">News section</a></li> |
| 265 | <li class="toctree-l2"><a class="reference internal" href="../tutorial/create_news_items.html">Create news items</a></li> |
| 266 | <li class="toctree-l2"><a class="reference internal" href="../tutorial/conclusion.html">Conclusion</a></li> |
| 267 | </ul> |
| 268 | </li> |
| 269 | </ul> |
| 270 | <ul> |
| 271 | <li class="toctree-l1"><a class="reference internal" href="../contributing/index.html">Contributing to CodeIgniter</a><ul> |
| 272 | <li class="toctree-l2"><a class="reference internal" href="../documentation/index.html">Writing CodeIgniter Documentation</a></li> |
| 273 | <li class="toctree-l2"><a class="reference internal" href="../DCO.html">Developer’s Certificate of Origin 1.1</a></li> |
| 274 | </ul> |
| 275 | </li> |
| 276 | </ul> |
| 277 | <ul> |
| 278 | <li class="toctree-l1"><a class="reference internal" href="../general/index.html">General Topics</a><ul> |
| 279 | <li class="toctree-l2"><a class="reference internal" href="../general/urls.html">CodeIgniter URLs</a></li> |
| 280 | <li class="toctree-l2"><a class="reference internal" href="../general/controllers.html">Controllers</a></li> |
| 281 | <li class="toctree-l2"><a class="reference internal" href="../general/reserved_names.html">Reserved Names</a></li> |
| 282 | <li class="toctree-l2"><a class="reference internal" href="../general/views.html">Views</a></li> |
| 283 | <li class="toctree-l2"><a class="reference internal" href="../general/models.html">Models</a></li> |
| 284 | <li class="toctree-l2"><a class="reference internal" href="../general/helpers.html">Helpers</a></li> |
| 285 | <li class="toctree-l2"><a class="reference internal" href="../general/libraries.html">Using CodeIgniter Libraries</a></li> |
| 286 | <li class="toctree-l2"><a class="reference internal" href="../general/creating_libraries.html">Creating Libraries</a></li> |
| 287 | <li class="toctree-l2"><a class="reference internal" href="../general/drivers.html">Using CodeIgniter Drivers</a></li> |
| 288 | <li class="toctree-l2"><a class="reference internal" href="../general/creating_drivers.html">Creating Drivers</a></li> |
| 289 | <li class="toctree-l2"><a class="reference internal" href="../general/core_classes.html">Creating Core System Classes</a></li> |
| 290 | <li class="toctree-l2"><a class="reference internal" href="../general/ancillary_classes.html">Creating Ancillary Classes</a></li> |
| 291 | <li class="toctree-l2"><a class="reference internal" href="../general/hooks.html">Hooks - Extending the Framework Core</a></li> |
| 292 | <li class="toctree-l2"><a class="reference internal" href="../general/autoloader.html">Auto-loading Resources</a></li> |
| 293 | <li class="toctree-l2"><a class="reference internal" href="../general/common_functions.html">Common Functions</a></li> |
| 294 | <li class="toctree-l2"><a class="reference internal" href="../general/compatibility_functions.html">Compatibility Functions</a></li> |
| 295 | <li class="toctree-l2"><a class="reference internal" href="../general/routing.html">URI Routing</a></li> |
| 296 | <li class="toctree-l2"><a class="reference internal" href="../general/errors.html">Error Handling</a></li> |
| 297 | <li class="toctree-l2"><a class="reference internal" href="../general/caching.html">Caching</a></li> |
| 298 | <li class="toctree-l2"><a class="reference internal" href="../general/profiling.html">Profiling Your Application</a></li> |
| 299 | <li class="toctree-l2"><a class="reference internal" href="../general/cli.html">Running via the CLI</a></li> |
| 300 | <li class="toctree-l2"><a class="reference internal" href="../general/managing_apps.html">Managing your Applications</a></li> |
| 301 | <li class="toctree-l2"><a class="reference internal" href="../general/environments.html">Handling Multiple Environments</a></li> |
| 302 | <li class="toctree-l2"><a class="reference internal" href="../general/alternative_php.html">Alternate PHP Syntax for View Files</a></li> |
| 303 | <li class="toctree-l2"><a class="reference internal" href="../general/security.html">Security</a></li> |
| 304 | <li class="toctree-l2"><a class="reference internal" href="../general/styleguide.html">PHP Style Guide</a></li> |
| 305 | </ul> |
| 306 | </li> |
| 307 | </ul> |
| 308 | <ul class="current"> |
| 309 | <li class="toctree-l1 current"><a class="reference internal" href="index.html">Libraries</a><ul class="current"> |
| 310 | <li class="toctree-l2"><a class="reference internal" href="benchmark.html">Benchmarking Class</a></li> |
| 311 | <li class="toctree-l2"><a class="reference internal" href="caching.html">Caching Driver</a></li> |
| 312 | <li class="toctree-l2"><a class="reference internal" href="calendar.html">Calendaring Class</a></li> |
| 313 | <li class="toctree-l2"><a class="reference internal" href="cart.html">Shopping Cart Class</a></li> |
| 314 | <li class="toctree-l2"><a class="reference internal" href="config.html">Config Class</a></li> |
| 315 | <li class="toctree-l2"><a class="reference internal" href="email.html">Email Class</a></li> |
| 316 | <li class="toctree-l2"><a class="reference internal" href="encrypt.html">Encrypt Class</a></li> |
| 317 | <li class="toctree-l2"><a class="reference internal" href="encryption.html">Encryption Library</a></li> |
| 318 | <li class="toctree-l2 current"><a class="current reference internal" href="#">File Uploading Class</a></li> |
| 319 | <li class="toctree-l2"><a class="reference internal" href="form_validation.html">Form Validation</a></li> |
| 320 | <li class="toctree-l2"><a class="reference internal" href="ftp.html">FTP Class</a></li> |
| 321 | <li class="toctree-l2"><a class="reference internal" href="image_lib.html">Image Manipulation Class</a></li> |
| 322 | <li class="toctree-l2"><a class="reference internal" href="input.html">Input Class</a></li> |
| 323 | <li class="toctree-l2"><a class="reference internal" href="javascript.html">Javascript Class</a></li> |
| 324 | <li class="toctree-l2"><a class="reference internal" href="language.html">Language Class</a></li> |
| 325 | <li class="toctree-l2"><a class="reference internal" href="loader.html">Loader Class</a></li> |
| 326 | <li class="toctree-l2"><a class="reference internal" href="migration.html">Migrations Class</a></li> |
| 327 | <li class="toctree-l2"><a class="reference internal" href="output.html">Output Class</a></li> |
| 328 | <li class="toctree-l2"><a class="reference internal" href="pagination.html">Pagination Class</a></li> |
| 329 | <li class="toctree-l2"><a class="reference internal" href="parser.html">Template Parser Class</a></li> |
| 330 | <li class="toctree-l2"><a class="reference internal" href="security.html">Security Class</a></li> |
| 331 | <li class="toctree-l2"><a class="reference internal" href="sessions.html">Session Library</a></li> |
| 332 | <li class="toctree-l2"><a class="reference internal" href="table.html">HTML Table Class</a></li> |
| 333 | <li class="toctree-l2"><a class="reference internal" href="trackback.html">Trackback Class</a></li> |
| 334 | <li class="toctree-l2"><a class="reference internal" href="typography.html">Typography Class</a></li> |
| 335 | <li class="toctree-l2"><a class="reference internal" href="unit_testing.html">Unit Testing Class</a></li> |
| 336 | <li class="toctree-l2"><a class="reference internal" href="uri.html">URI Class</a></li> |
| 337 | <li class="toctree-l2"><a class="reference internal" href="user_agent.html">User Agent Class</a></li> |
| 338 | <li class="toctree-l2"><a class="reference internal" href="xmlrpc.html">XML-RPC and XML-RPC Server Classes</a></li> |
| 339 | <li class="toctree-l2"><a class="reference internal" href="zip.html">Zip Encoding Class</a></li> |
| 340 | </ul> |
| 341 | </li> |
| 342 | </ul> |
| 343 | <ul> |
| 344 | <li class="toctree-l1"><a class="reference internal" href="../database/index.html">Database Reference</a><ul> |
| 345 | <li class="toctree-l2"><a class="reference internal" href="../database/examples.html">Quick Start: Usage Examples</a></li> |
| 346 | <li class="toctree-l2"><a class="reference internal" href="../database/configuration.html">Database Configuration</a></li> |
| 347 | <li class="toctree-l2"><a class="reference internal" href="../database/connecting.html">Connecting to a Database</a></li> |
| 348 | <li class="toctree-l2"><a class="reference internal" href="../database/queries.html">Running Queries</a></li> |
| 349 | <li class="toctree-l2"><a class="reference internal" href="../database/results.html">Generating Query Results</a></li> |
| 350 | <li class="toctree-l2"><a class="reference internal" href="../database/helpers.html">Query Helper Functions</a></li> |
| 351 | <li class="toctree-l2"><a class="reference internal" href="../database/query_builder.html">Query Builder Class</a></li> |
| 352 | <li class="toctree-l2"><a class="reference internal" href="../database/transactions.html">Transactions</a></li> |
| 353 | <li class="toctree-l2"><a class="reference internal" href="../database/metadata.html">Getting MetaData</a></li> |
| 354 | <li class="toctree-l2"><a class="reference internal" href="../database/call_function.html">Custom Function Calls</a></li> |
| 355 | <li class="toctree-l2"><a class="reference internal" href="../database/caching.html">Query Caching</a></li> |
| 356 | <li class="toctree-l2"><a class="reference internal" href="../database/forge.html">Database Manipulation with Database Forge</a></li> |
| 357 | <li class="toctree-l2"><a class="reference internal" href="../database/utilities.html">Database Utilities Class</a></li> |
| 358 | <li class="toctree-l2"><a class="reference internal" href="../database/db_driver_reference.html">Database Driver Reference</a></li> |
| 359 | </ul> |
| 360 | </li> |
| 361 | </ul> |
| 362 | <ul> |
| 363 | <li class="toctree-l1"><a class="reference internal" href="../helpers/index.html">Helpers</a><ul> |
| 364 | <li class="toctree-l2"><a class="reference internal" href="../helpers/array_helper.html">Array Helper</a></li> |
| 365 | <li class="toctree-l2"><a class="reference internal" href="../helpers/captcha_helper.html">CAPTCHA Helper</a></li> |
| 366 | <li class="toctree-l2"><a class="reference internal" href="../helpers/cookie_helper.html">Cookie Helper</a></li> |
| 367 | <li class="toctree-l2"><a class="reference internal" href="../helpers/date_helper.html">Date Helper</a></li> |
| 368 | <li class="toctree-l2"><a class="reference internal" href="../helpers/directory_helper.html">Directory Helper</a></li> |
| 369 | <li class="toctree-l2"><a class="reference internal" href="../helpers/download_helper.html">Download Helper</a></li> |
| 370 | <li class="toctree-l2"><a class="reference internal" href="../helpers/email_helper.html">Email Helper</a></li> |
| 371 | <li class="toctree-l2"><a class="reference internal" href="../helpers/file_helper.html">File Helper</a></li> |
| 372 | <li class="toctree-l2"><a class="reference internal" href="../helpers/form_helper.html">Form Helper</a></li> |
| 373 | <li class="toctree-l2"><a class="reference internal" href="../helpers/html_helper.html">HTML Helper</a></li> |
| 374 | <li class="toctree-l2"><a class="reference internal" href="../helpers/inflector_helper.html">Inflector Helper</a></li> |
| 375 | <li class="toctree-l2"><a class="reference internal" href="../helpers/language_helper.html">Language Helper</a></li> |
| 376 | <li class="toctree-l2"><a class="reference internal" href="../helpers/number_helper.html">Number Helper</a></li> |
| 377 | <li class="toctree-l2"><a class="reference internal" href="../helpers/path_helper.html">Path Helper</a></li> |
| 378 | <li class="toctree-l2"><a class="reference internal" href="../helpers/security_helper.html">Security Helper</a></li> |
| 379 | <li class="toctree-l2"><a class="reference internal" href="../helpers/smiley_helper.html">Smiley Helper</a></li> |
| 380 | <li class="toctree-l2"><a class="reference internal" href="../helpers/string_helper.html">String Helper</a></li> |
| 381 | <li class="toctree-l2"><a class="reference internal" href="../helpers/text_helper.html">Text Helper</a></li> |
| 382 | <li class="toctree-l2"><a class="reference internal" href="../helpers/typography_helper.html">Typography Helper</a></li> |
| 383 | <li class="toctree-l2"><a class="reference internal" href="../helpers/url_helper.html">URL Helper</a></li> |
| 384 | <li class="toctree-l2"><a class="reference internal" href="../helpers/xml_helper.html">XML Helper</a></li> |
| 385 | </ul> |
| 386 | </li> |
| 387 | </ul> |
| 388 | |
| 389 | |
| 390 | |
| 391 | </div> |
| 392 | |
| 393 | </nav> |
| 394 | |
| 395 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| 396 | |
| 397 | |
| 398 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> |
| 399 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| 400 | <a href="../index.html">CodeIgniter</a> |
| 401 | </nav> |
| 402 | |
| 403 | |
| 404 | |
| 405 | <div class="wy-nav-content"> |
| 406 | <div class="rst-content"> |
| 407 | <div role="navigation" aria-label="breadcrumbs navigation"> |
| 408 | <ul class="wy-breadcrumbs"> |
| 409 | <li><a href="../index.html">Docs</a> »</li> |
| 410 | |
| 411 | <li><a href="index.html">Libraries</a> »</li> |
| 412 | |
| 413 | <li>File Uploading Class</li> |
| 414 | <li class="wy-breadcrumbs-aside"> |
| 415 | |
| 416 | </li> |
| 417 | <div style="float:right;margin-left:5px;" id="closeMe"> |
| 418 | <img title="Classic Layout" alt="classic layout" src="data:image/gif;base64,R0lGODlhFAAUAJEAAAAAADMzM////wAAACH5BAUUAAIALAAAAAAUABQAAAImlI+py+0PU5gRBRDM3DxbWoXis42X13USOLauUIqnlsaH/eY6UwAAOw==" /> |
| 419 | </div> |
| 420 | </ul> |
| 421 | <hr/> |
| 422 | </div> |
| 423 | <div role="main" class="document"> |
| 424 | |
| 425 | <div class="section" id="file-uploading-class"> |
| 426 | <h1>File Uploading Class<a class="headerlink" href="#file-uploading-class" title="Permalink to this headline">¶</a></h1> |
| 427 | <p>CodeIgniter’s File Uploading Class permits files to be uploaded. You can |
| 428 | set various preferences, restricting the type and size of the files.</p> |
| 429 | <div class="contents local topic" id="contents"> |
| 430 | <ul class="simple"> |
| 431 | <li><a class="reference internal" href="#the-process" id="id1">The Process</a><ul> |
| 432 | <li><a class="reference internal" href="#creating-the-upload-form" id="id2">Creating the Upload Form</a></li> |
| 433 | <li><a class="reference internal" href="#the-success-page" id="id3">The Success Page</a></li> |
| 434 | <li><a class="reference internal" href="#the-controller" id="id4">The Controller</a></li> |
| 435 | <li><a class="reference internal" href="#the-upload-directory" id="id5">The Upload Directory</a></li> |
| 436 | <li><a class="reference internal" href="#try-it" id="id6">Try it!</a></li> |
| 437 | </ul> |
| 438 | </li> |
| 439 | <li><a class="reference internal" href="#reference-guide" id="id7">Reference Guide</a><ul> |
| 440 | <li><a class="reference internal" href="#initializing-the-upload-class" id="id8">Initializing the Upload Class</a></li> |
| 441 | <li><a class="reference internal" href="#setting-preferences" id="id9">Setting Preferences</a></li> |
| 442 | <li><a class="reference internal" href="#preferences" id="id10">Preferences</a></li> |
| 443 | <li><a class="reference internal" href="#setting-preferences-in-a-config-file" id="id11">Setting preferences in a config file</a></li> |
| 444 | </ul> |
| 445 | </li> |
| 446 | <li><a class="reference internal" href="#class-reference" id="id12">Class Reference</a></li> |
| 447 | </ul> |
| 448 | </div> |
| 449 | <div class="custom-index container"></div><div class="section" id="the-process"> |
| 450 | <h2><a class="toc-backref" href="#id1">The Process</a><a class="headerlink" href="#the-process" title="Permalink to this headline">¶</a></h2> |
| 451 | <p>Uploading a file involves the following general process:</p> |
| 452 | <ul class="simple"> |
| 453 | <li>An upload form is displayed, allowing a user to select a file and |
| 454 | upload it.</li> |
| 455 | <li>When the form is submitted, the file is uploaded to the destination |
| 456 | you specify.</li> |
| 457 | <li>Along the way, the file is validated to make sure it is allowed to be |
| 458 | uploaded based on the preferences you set.</li> |
| 459 | <li>Once uploaded, the user will be shown a success message.</li> |
| 460 | </ul> |
| 461 | <p>To demonstrate this process here is brief tutorial. Afterward you’ll |
| 462 | find reference information.</p> |
| 463 | <div class="section" id="creating-the-upload-form"> |
| 464 | <h3><a class="toc-backref" href="#id2">Creating the Upload Form</a><a class="headerlink" href="#creating-the-upload-form" title="Permalink to this headline">¶</a></h3> |
| 465 | <p>Using a text editor, create a form called upload_form.php. In it, place |
| 466 | this code and save it to your <strong>application/views/</strong> directory:</p> |
| 467 | <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="o"><</span><span class="nx">html</span><span class="o">></span> |
| 468 | <span class="o"><</span><span class="nx">head</span><span class="o">></span> |
| 469 | <span class="o"><</span><span class="nx">title</span><span class="o">></span><span class="nx">Upload</span> <span class="nx">Form</span><span class="o"></</span><span class="nx">title</span><span class="o">></span> |
| 470 | <span class="o"></</span><span class="nx">head</span><span class="o">></span> |
| 471 | <span class="o"><</span><span class="nx">body</span><span class="o">></span> |
| 472 | |
| 473 | <span class="o"><?</span><span class="nx">php</span> <span class="k">echo</span> <span class="nv">$error</span><span class="p">;</span><span class="cp">?></span> |
| 474 | |
| 475 | <span class="cp"><?php</span> <span class="k">echo</span> <span class="nx">form_open_multipart</span><span class="p">(</span><span class="s1">'upload/do_upload'</span><span class="p">);</span><span class="cp">?></span> |
| 476 | |
| 477 | <span class="p"><</span><span class="nt">input</span> <span class="na">type</span><span class="o">=</span><span class="s">"file"</span> <span class="na">name</span><span class="o">=</span><span class="s">"userfile"</span> <span class="na">size</span><span class="o">=</span><span class="s">"20"</span> <span class="p">/></span> |
| 478 | |
| 479 | <span class="p"><</span><span class="nt">br</span> <span class="p">/><</span><span class="nt">br</span> <span class="p">/></span> |
| 480 | |
| 481 | <span class="p"><</span><span class="nt">input</span> <span class="na">type</span><span class="o">=</span><span class="s">"submit"</span> <span class="na">value</span><span class="o">=</span><span class="s">"upload"</span> <span class="p">/></span> |
| 482 | |
| 483 | <span class="p"></</span><span class="nt">form</span><span class="p">></span> |
| 484 | |
| 485 | <span class="p"></</span><span class="nt">body</span><span class="p">></span> |
| 486 | <span class="p"></</span><span class="nt">html</span><span class="p">></span> |
| 487 | </pre></div> |
| 488 | </div> |
| 489 | <p>You’ll notice we are using a form helper to create the opening form tag. |
| 490 | File uploads require a multipart form, so the helper creates the proper |
| 491 | syntax for you. You’ll also notice we have an $error variable. This is |
| 492 | so we can show error messages in the event the user does something |
| 493 | wrong.</p> |
| 494 | </div> |
| 495 | <div class="section" id="the-success-page"> |
| 496 | <h3><a class="toc-backref" href="#id3">The Success Page</a><a class="headerlink" href="#the-success-page" title="Permalink to this headline">¶</a></h3> |
| 497 | <p>Using a text editor, create a form called upload_success.php. In it, |
| 498 | place this code and save it to your <strong>application/views/</strong> directory:</p> |
| 499 | <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="o"><</span><span class="nx">html</span><span class="o">></span> |
| 500 | <span class="o"><</span><span class="nx">head</span><span class="o">></span> |
| 501 | <span class="o"><</span><span class="nx">title</span><span class="o">></span><span class="nx">Upload</span> <span class="nx">Form</span><span class="o"></</span><span class="nx">title</span><span class="o">></span> |
| 502 | <span class="o"></</span><span class="nx">head</span><span class="o">></span> |
| 503 | <span class="o"><</span><span class="nx">body</span><span class="o">></span> |
| 504 | |
| 505 | <span class="o"><</span><span class="nx">h3</span><span class="o">></span><span class="nx">Your</span> <span class="nb">file</span> <span class="nx">was</span> <span class="nx">successfully</span> <span class="nx">uploaded</span><span class="o">!</</span><span class="nx">h3</span><span class="o">></span> |
| 506 | |
| 507 | <span class="o"><</span><span class="nx">ul</span><span class="o">></span> |
| 508 | <span class="o"><?</span><span class="nx">php</span> <span class="k">foreach</span> <span class="p">(</span><span class="nv">$upload_data</span> <span class="k">as</span> <span class="nv">$item</span> <span class="o">=></span> <span class="nv">$value</span><span class="p">)</span><span class="o">:</span><span class="cp">?></span> |
| 509 | <span class="p"><</span><span class="nt">li</span><span class="p">></span><span class="cp"><?php</span> <span class="k">echo</span> <span class="nv">$item</span><span class="p">;</span><span class="cp">?></span>: <span class="cp"><?php</span> <span class="k">echo</span> <span class="nv">$value</span><span class="p">;</span><span class="cp">?></span><span class="p"></</span><span class="nt">li</span><span class="p">></span> |
| 510 | <span class="cp"><?php</span> <span class="k">endforeach</span><span class="p">;</span> <span class="cp">?></span> |
| 511 | <span class="p"></</span><span class="nt">ul</span><span class="p">></span> |
| 512 | |
| 513 | <span class="p"><</span><span class="nt">p</span><span class="p">></span><span class="cp"><?php</span> <span class="k">echo</span> <span class="nx">anchor</span><span class="p">(</span><span class="s1">'upload'</span><span class="p">,</span> <span class="s1">'Upload Another File!'</span><span class="p">);</span> <span class="cp">?></span><span class="p"></</span><span class="nt">p</span><span class="p">></span> |
| 514 | |
| 515 | <span class="p"></</span><span class="nt">body</span><span class="p">></span> |
| 516 | <span class="p"></</span><span class="nt">html</span><span class="p">></span> |
| 517 | </pre></div> |
| 518 | </div> |
| 519 | </div> |
| 520 | <div class="section" id="the-controller"> |
| 521 | <h3><a class="toc-backref" href="#id4">The Controller</a><a class="headerlink" href="#the-controller" title="Permalink to this headline">¶</a></h3> |
| 522 | <p>Using a text editor, create a controller called Upload.php. In it, place |
| 523 | this code and save it to your <strong>application/controllers/</strong> directory:</p> |
| 524 | <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="o"><?</span><span class="nx">php</span> |
| 525 | |
| 526 | <span class="k">class</span> <span class="nc">Upload</span> <span class="k">extends</span> <span class="nx">CI_Controller</span> <span class="p">{</span> |
| 527 | |
| 528 | <span class="k">public</span> <span class="k">function</span> <span class="nf">__construct</span><span class="p">()</span> |
| 529 | <span class="p">{</span> |
| 530 | <span class="k">parent</span><span class="o">::</span><span class="na">__construct</span><span class="p">();</span> |
| 531 | <span class="nv">$this</span><span class="o">-></span><span class="na">load</span><span class="o">-></span><span class="na">helper</span><span class="p">(</span><span class="k">array</span><span class="p">(</span><span class="s1">'form'</span><span class="p">,</span> <span class="s1">'url'</span><span class="p">));</span> |
| 532 | <span class="p">}</span> |
| 533 | |
| 534 | <span class="k">public</span> <span class="k">function</span> <span class="nf">index</span><span class="p">()</span> |
| 535 | <span class="p">{</span> |
| 536 | <span class="nv">$this</span><span class="o">-></span><span class="na">load</span><span class="o">-></span><span class="na">view</span><span class="p">(</span><span class="s1">'upload_form'</span><span class="p">,</span> <span class="k">array</span><span class="p">(</span><span class="s1">'error'</span> <span class="o">=></span> <span class="s1">' '</span> <span class="p">));</span> |
| 537 | <span class="p">}</span> |
| 538 | |
| 539 | <span class="k">public</span> <span class="k">function</span> <span class="nf">do_upload</span><span class="p">()</span> |
| 540 | <span class="p">{</span> |
| 541 | <span class="nv">$config</span><span class="p">[</span><span class="s1">'upload_path'</span><span class="p">]</span> <span class="o">=</span> <span class="s1">'./uploads/'</span><span class="p">;</span> |
| 542 | <span class="nv">$config</span><span class="p">[</span><span class="s1">'allowed_types'</span><span class="p">]</span> <span class="o">=</span> <span class="s1">'gif|jpg|png'</span><span class="p">;</span> |
| 543 | <span class="nv">$config</span><span class="p">[</span><span class="s1">'max_size'</span><span class="p">]</span> <span class="o">=</span> <span class="mi">100</span><span class="p">;</span> |
| 544 | <span class="nv">$config</span><span class="p">[</span><span class="s1">'max_width'</span><span class="p">]</span> <span class="o">=</span> <span class="mi">1024</span><span class="p">;</span> |
| 545 | <span class="nv">$config</span><span class="p">[</span><span class="s1">'max_height'</span><span class="p">]</span> <span class="o">=</span> <span class="mi">768</span><span class="p">;</span> |
| 546 | |
| 547 | <span class="nv">$this</span><span class="o">-></span><span class="na">load</span><span class="o">-></span><span class="na">library</span><span class="p">(</span><span class="s1">'upload'</span><span class="p">,</span> <span class="nv">$config</span><span class="p">);</span> |
| 548 | |
| 549 | <span class="k">if</span> <span class="p">(</span> <span class="o">!</span> <span class="nv">$this</span><span class="o">-></span><span class="na">upload</span><span class="o">-></span><span class="na">do_upload</span><span class="p">(</span><span class="s1">'userfile'</span><span class="p">))</span> |
| 550 | <span class="p">{</span> |
| 551 | <span class="nv">$error</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span><span class="s1">'error'</span> <span class="o">=></span> <span class="nv">$this</span><span class="o">-></span><span class="na">upload</span><span class="o">-></span><span class="na">display_errors</span><span class="p">());</span> |
| 552 | |
| 553 | <span class="nv">$this</span><span class="o">-></span><span class="na">load</span><span class="o">-></span><span class="na">view</span><span class="p">(</span><span class="s1">'upload_form'</span><span class="p">,</span> <span class="nv">$error</span><span class="p">);</span> |
| 554 | <span class="p">}</span> |
| 555 | <span class="k">else</span> |
| 556 | <span class="p">{</span> |
| 557 | <span class="nv">$data</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span><span class="s1">'upload_data'</span> <span class="o">=></span> <span class="nv">$this</span><span class="o">-></span><span class="na">upload</span><span class="o">-></span><span class="na">data</span><span class="p">());</span> |
| 558 | |
| 559 | <span class="nv">$this</span><span class="o">-></span><span class="na">load</span><span class="o">-></span><span class="na">view</span><span class="p">(</span><span class="s1">'upload_success'</span><span class="p">,</span> <span class="nv">$data</span><span class="p">);</span> |
| 560 | <span class="p">}</span> |
| 561 | <span class="p">}</span> |
| 562 | <span class="p">}</span> |
| 563 | <span class="cp">?></span> |
| 564 | </pre></div> |
| 565 | </div> |
| 566 | </div> |
| 567 | <div class="section" id="the-upload-directory"> |
| 568 | <h3><a class="toc-backref" href="#id5">The Upload Directory</a><a class="headerlink" href="#the-upload-directory" title="Permalink to this headline">¶</a></h3> |
| 569 | <p>You’ll need a destination directory for your uploaded images. Create a |
| 570 | directory at the root of your CodeIgniter installation called uploads |
| 571 | and set its file permissions to 777.</p> |
| 572 | </div> |
| 573 | <div class="section" id="try-it"> |
| 574 | <h3><a class="toc-backref" href="#id6">Try it!</a><a class="headerlink" href="#try-it" title="Permalink to this headline">¶</a></h3> |
| 575 | <p>To try your form, visit your site using a URL similar to this one:</p> |
| 576 | <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nx">example</span><span class="o">.</span><span class="nx">com</span><span class="o">/</span><span class="nx">index</span><span class="o">.</span><span class="nx">php</span><span class="o">/</span><span class="nx">upload</span><span class="o">/</span> |
| 577 | </pre></div> |
| 578 | </div> |
| 579 | <p>You should see an upload form. Try uploading an image file (either a |
| 580 | jpg, gif, or png). If the path in your controller is correct it should |
| 581 | work.</p> |
| 582 | </div> |
| 583 | </div> |
| 584 | <div class="section" id="reference-guide"> |
| 585 | <h2><a class="toc-backref" href="#id7">Reference Guide</a><a class="headerlink" href="#reference-guide" title="Permalink to this headline">¶</a></h2> |
| 586 | <div class="section" id="initializing-the-upload-class"> |
| 587 | <h3><a class="toc-backref" href="#id8">Initializing the Upload Class</a><a class="headerlink" href="#initializing-the-upload-class" title="Permalink to this headline">¶</a></h3> |
| 588 | <p>Like most other classes in CodeIgniter, the Upload class is initialized |
| 589 | in your controller using the <code class="docutils literal"><span class="pre">$this->load->library()</span></code> method:</p> |
| 590 | <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$this</span><span class="o">-></span><span class="na">load</span><span class="o">-></span><span class="na">library</span><span class="p">(</span><span class="s1">'upload'</span><span class="p">);</span> |
| 591 | </pre></div> |
| 592 | </div> |
| 593 | <p>Once the Upload class is loaded, the object will be available using: |
| 594 | $this->upload</p> |
| 595 | </div> |
| 596 | <div class="section" id="setting-preferences"> |
| 597 | <h3><a class="toc-backref" href="#id9">Setting Preferences</a><a class="headerlink" href="#setting-preferences" title="Permalink to this headline">¶</a></h3> |
| 598 | <p>Similar to other libraries, you’ll control what is allowed to be upload |
| 599 | based on your preferences. In the controller you built above you set the |
| 600 | following preferences:</p> |
| 601 | <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$config</span><span class="p">[</span><span class="s1">'upload_path'</span><span class="p">]</span> <span class="o">=</span> <span class="s1">'./uploads/'</span><span class="p">;</span> |
| 602 | <span class="nv">$config</span><span class="p">[</span><span class="s1">'allowed_types'</span><span class="p">]</span> <span class="o">=</span> <span class="s1">'gif|jpg|png'</span><span class="p">;</span> |
| 603 | <span class="nv">$config</span><span class="p">[</span><span class="s1">'max_size'</span><span class="p">]</span> <span class="o">=</span> <span class="s1">'100'</span><span class="p">;</span> |
| 604 | <span class="nv">$config</span><span class="p">[</span><span class="s1">'max_width'</span><span class="p">]</span> <span class="o">=</span> <span class="s1">'1024'</span><span class="p">;</span> |
| 605 | <span class="nv">$config</span><span class="p">[</span><span class="s1">'max_height'</span><span class="p">]</span> <span class="o">=</span> <span class="s1">'768'</span><span class="p">;</span> |
| 606 | |
| 607 | <span class="nv">$this</span><span class="o">-></span><span class="na">load</span><span class="o">-></span><span class="na">library</span><span class="p">(</span><span class="s1">'upload'</span><span class="p">,</span> <span class="nv">$config</span><span class="p">);</span> |
| 608 | |
| 609 | <span class="c1">// Alternately you can set preferences by calling the ``initialize()`` method. Useful if you auto-load the class:</span> |
| 610 | <span class="nv">$this</span><span class="o">-></span><span class="na">upload</span><span class="o">-></span><span class="na">initialize</span><span class="p">(</span><span class="nv">$config</span><span class="p">);</span> |
| 611 | </pre></div> |
| 612 | </div> |
| 613 | <p>The above preferences should be fairly self-explanatory. Below is a |
| 614 | table describing all available preferences.</p> |
| 615 | </div> |
| 616 | <div class="section" id="preferences"> |
| 617 | <h3><a class="toc-backref" href="#id10">Preferences</a><a class="headerlink" href="#preferences" title="Permalink to this headline">¶</a></h3> |
| 618 | <p>The following preferences are available. The default value indicates |
| 619 | what will be used if you do not specify that preference.</p> |
| 620 | <table border="1" class="docutils"> |
| 621 | <colgroup> |
| 622 | <col width="20%" /> |
| 623 | <col width="12%" /> |
| 624 | <col width="16%" /> |
| 625 | <col width="51%" /> |
| 626 | </colgroup> |
| 627 | <thead valign="bottom"> |
| 628 | <tr class="row-odd"><th class="head">Preference</th> |
| 629 | <th class="head">Default Value</th> |
| 630 | <th class="head">Options</th> |
| 631 | <th class="head">Description</th> |
| 632 | </tr> |
| 633 | </thead> |
| 634 | <tbody valign="top"> |
| 635 | <tr class="row-even"><td><strong>upload_path</strong></td> |
| 636 | <td>None</td> |
| 637 | <td>None</td> |
| 638 | <td>The path to the directory where the upload should be placed. The |
| 639 | directory must be writable and the path can be absolute or relative.</td> |
| 640 | </tr> |
| 641 | <tr class="row-odd"><td><strong>allowed_types</strong></td> |
| 642 | <td>None</td> |
| 643 | <td>None</td> |
| 644 | <td>The mime types corresponding to the types of files you allow to be |
| 645 | uploaded. Usually the file extension can be used as the mime type. |
| 646 | Can be either an array or a pipe-separated string.</td> |
| 647 | </tr> |
| 648 | <tr class="row-even"><td><strong>file_name</strong></td> |
| 649 | <td>None</td> |
| 650 | <td>Desired file name</td> |
| 651 | <td>If set CodeIgniter will rename the uploaded file to this name. The |
| 652 | extension provided in the file name must also be an allowed file type. |
| 653 | If no extension is provided in the original file_name will be used.</td> |
| 654 | </tr> |
| 655 | <tr class="row-odd"><td><strong>file_ext_tolower</strong></td> |
| 656 | <td>FALSE</td> |
| 657 | <td>TRUE/FALSE (boolean)</td> |
| 658 | <td>If set to TRUE, the file extension will be forced to lower case</td> |
| 659 | </tr> |
| 660 | <tr class="row-even"><td><strong>overwrite</strong></td> |
| 661 | <td>FALSE</td> |
| 662 | <td>TRUE/FALSE (boolean)</td> |
| 663 | <td>If set to true, if a file with the same name as the one you are |
| 664 | uploading exists, it will be overwritten. If set to false, a number will |
| 665 | be appended to the filename if another with the same name exists.</td> |
| 666 | </tr> |
| 667 | <tr class="row-odd"><td><strong>max_size</strong></td> |
| 668 | <td>0</td> |
| 669 | <td>None</td> |
| 670 | <td>The maximum size (in kilobytes) that the file can be. Set to zero for no |
| 671 | limit. Note: Most PHP installations have their own limit, as specified |
| 672 | in the php.ini file. Usually 2 MB (or 2048 KB) by default.</td> |
| 673 | </tr> |
| 674 | <tr class="row-even"><td><strong>max_width</strong></td> |
| 675 | <td>0</td> |
| 676 | <td>None</td> |
| 677 | <td>The maximum width (in pixels) that the image can be. Set to zero for no |
| 678 | limit.</td> |
| 679 | </tr> |
| 680 | <tr class="row-odd"><td><strong>max_height</strong></td> |
| 681 | <td>0</td> |
| 682 | <td>None</td> |
| 683 | <td>The maximum height (in pixels) that the image can be. Set to zero for no |
| 684 | limit.</td> |
| 685 | </tr> |
| 686 | <tr class="row-even"><td><strong>min_width</strong></td> |
| 687 | <td>0</td> |
| 688 | <td>None</td> |
| 689 | <td>The minimum width (in pixels) that the image can be. Set to zero for no |
| 690 | limit.</td> |
| 691 | </tr> |
| 692 | <tr class="row-odd"><td><strong>min_height</strong></td> |
| 693 | <td>0</td> |
| 694 | <td>None</td> |
| 695 | <td>The minimum height (in pixels) that the image can be. Set to zero for no |
| 696 | limit.</td> |
| 697 | </tr> |
| 698 | <tr class="row-even"><td><strong>max_filename</strong></td> |
| 699 | <td>0</td> |
| 700 | <td>None</td> |
| 701 | <td>The maximum length that a file name can be. Set to zero for no limit.</td> |
| 702 | </tr> |
| 703 | <tr class="row-odd"><td><strong>max_filename_increment</strong></td> |
| 704 | <td>100</td> |
| 705 | <td>None</td> |
| 706 | <td>When overwrite is set to FALSE, use this to set the maximum filename |
| 707 | increment for CodeIgniter to append to the filename.</td> |
| 708 | </tr> |
| 709 | <tr class="row-even"><td><strong>encrypt_name</strong></td> |
| 710 | <td>FALSE</td> |
| 711 | <td>TRUE/FALSE (boolean)</td> |
| 712 | <td>If set to TRUE the file name will be converted to a random encrypted |
| 713 | string. This can be useful if you would like the file saved with a name |
| 714 | that can not be discerned by the person uploading it.</td> |
| 715 | </tr> |
| 716 | <tr class="row-odd"><td><strong>remove_spaces</strong></td> |
| 717 | <td>TRUE</td> |
| 718 | <td>TRUE/FALSE (boolean)</td> |
| 719 | <td>If set to TRUE, any spaces in the file name will be converted to |
| 720 | underscores. This is recommended.</td> |
| 721 | </tr> |
| 722 | <tr class="row-even"><td><strong>detect_mime</strong></td> |
| 723 | <td>TRUE</td> |
| 724 | <td>TRUE/FALSE (boolean)</td> |
| 725 | <td>If set to TRUE, a server side detection of the file type will be |
| 726 | performed to avoid code injection attacks. DO NOT disable this option |
| 727 | unless you have no other option as that would cause a security risk.</td> |
| 728 | </tr> |
| 729 | <tr class="row-odd"><td><strong>mod_mime_fix</strong></td> |
| 730 | <td>TRUE</td> |
| 731 | <td>TRUE/FALSE (boolean)</td> |
| 732 | <td>If set to TRUE, multiple filename extensions will be suffixed with an |
| 733 | underscore in order to avoid triggering <a class="reference external" href="http://httpd.apache.org/docs/2.0/mod/mod_mime.html#multipleext">Apache mod_mime</a>. |
| 734 | DO NOT turn off this option if your upload directory is public, as this |
| 735 | is a security risk.</td> |
| 736 | </tr> |
| 737 | </tbody> |
| 738 | </table> |
| 739 | </div> |
| 740 | <div class="section" id="setting-preferences-in-a-config-file"> |
| 741 | <h3><a class="toc-backref" href="#id11">Setting preferences in a config file</a><a class="headerlink" href="#setting-preferences-in-a-config-file" title="Permalink to this headline">¶</a></h3> |
| 742 | <p>If you prefer not to set preferences using the above method, you can |
| 743 | instead put them into a config file. Simply create a new file called the |
| 744 | upload.php, add the $config array in that file. Then save the file in: |
| 745 | <strong>config/upload.php</strong> and it will be used automatically. You will NOT |
| 746 | need to use the <code class="docutils literal"><span class="pre">$this->upload->initialize()</span></code> method if you save your |
| 747 | preferences in a config file.</p> |
| 748 | </div> |
| 749 | </div> |
| 750 | <div class="section" id="class-reference"> |
| 751 | <h2><a class="toc-backref" href="#id12">Class Reference</a><a class="headerlink" href="#class-reference" title="Permalink to this headline">¶</a></h2> |
| 752 | <dl class="class"> |
| 753 | <dt id="CI_Upload"> |
| 754 | <em class="property">class </em><code class="descname">CI_Upload</code><a class="headerlink" href="#CI_Upload" title="Permalink to this definition">¶</a></dt> |
| 755 | <dd><dl class="method"> |
| 756 | <dt id="CI_Upload::initialize"> |
| 757 | <code class="descname">initialize</code><span class="sig-paren">(</span><span class="optional">[</span><em>array $config = array()</em><span class="optional">[</span>, <em>$reset = TRUE</em><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_Upload::initialize" title="Permalink to this definition">¶</a></dt> |
| 758 | <dd><table class="docutils field-list" frame="void" rules="none"> |
| 759 | <col class="field-name" /> |
| 760 | <col class="field-body" /> |
| 761 | <tbody valign="top"> |
| 762 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| 763 | <li><strong>$config</strong> (<em>array</em>) – Preferences</li> |
| 764 | <li><strong>$reset</strong> (<em>bool</em>) – Whether to reset preferences (that are not provided in $config) to their defaults</li> |
| 765 | </ul> |
| 766 | </td> |
| 767 | </tr> |
| 768 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">CI_Upload instance (method chaining)</p> |
| 769 | </td> |
| 770 | </tr> |
| 771 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">CI_Upload</p> |
| 772 | </td> |
| 773 | </tr> |
| 774 | </tbody> |
| 775 | </table> |
| 776 | </dd></dl> |
| 777 | |
| 778 | <dl class="method"> |
| 779 | <dt id="CI_Upload::do_upload"> |
| 780 | <code class="descname">do_upload</code><span class="sig-paren">(</span><span class="optional">[</span><em>$field = 'userfile'</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_Upload::do_upload" title="Permalink to this definition">¶</a></dt> |
| 781 | <dd><table class="docutils field-list" frame="void" rules="none"> |
| 782 | <col class="field-name" /> |
| 783 | <col class="field-body" /> |
| 784 | <tbody valign="top"> |
| 785 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| 786 | <li><strong>$field</strong> (<em>string</em>) – Name of the form field</li> |
| 787 | </ul> |
| 788 | </td> |
| 789 | </tr> |
| 790 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">TRUE on success, FALSE on failure</p> |
| 791 | </td> |
| 792 | </tr> |
| 793 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">bool</p> |
| 794 | </td> |
| 795 | </tr> |
| 796 | </tbody> |
| 797 | </table> |
| 798 | <p>Performs the upload based on the preferences you’ve set.</p> |
| 799 | <div class="admonition note"> |
| 800 | <p class="first admonition-title">Note</p> |
| 801 | <p class="last">By default the upload routine expects the file to come from |
| 802 | a form field called userfile, and the form must be of type |
| 803 | “multipart”.</p> |
| 804 | </div> |
| 805 | <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="o"><</span><span class="nx">form</span> <span class="nx">method</span><span class="o">=</span><span class="s2">"post"</span> <span class="nx">action</span><span class="o">=</span><span class="s2">"some_action"</span> <span class="nx">enctype</span><span class="o">=</span><span class="s2">"multipart/form-data"</span> <span class="o">/></span> |
| 806 | </pre></div> |
| 807 | </div> |
| 808 | <p>If you would like to set your own field name simply pass its value to |
| 809 | the <code class="docutils literal"><span class="pre">do_upload()</span></code> method:</p> |
| 810 | <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$field_name</span> <span class="o">=</span> <span class="s2">"some_field_name"</span><span class="p">;</span> |
| 811 | <span class="nv">$this</span><span class="o">-></span><span class="na">upload</span><span class="o">-></span><span class="na">do_upload</span><span class="p">(</span><span class="nv">$field_name</span><span class="p">);</span> |
| 812 | </pre></div> |
| 813 | </div> |
| 814 | </dd></dl> |
| 815 | |
| 816 | <dl class="method"> |
| 817 | <dt id="CI_Upload::display_errors"> |
| 818 | <code class="descname">display_errors</code><span class="sig-paren">(</span><span class="optional">[</span><em>$open = '<p>'</em><span class="optional">[</span>, <em>$close = '</p>'</em><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_Upload::display_errors" title="Permalink to this definition">¶</a></dt> |
| 819 | <dd><table class="docutils field-list" frame="void" rules="none"> |
| 820 | <col class="field-name" /> |
| 821 | <col class="field-body" /> |
| 822 | <tbody valign="top"> |
| 823 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| 824 | <li><strong>$open</strong> (<em>string</em>) – Opening markup</li> |
| 825 | <li><strong>$close</strong> (<em>string</em>) – Closing markup</li> |
| 826 | </ul> |
| 827 | </td> |
| 828 | </tr> |
| 829 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Formatted error message(s)</p> |
| 830 | </td> |
| 831 | </tr> |
| 832 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p> |
| 833 | </td> |
| 834 | </tr> |
| 835 | </tbody> |
| 836 | </table> |
| 837 | <p>Retrieves any error messages if the <code class="docutils literal"><span class="pre">do_upload()</span></code> method returned |
| 838 | false. The method does not echo automatically, it returns the data so |
| 839 | you can assign it however you need.</p> |
| 840 | <p><strong>Formatting Errors</strong></p> |
| 841 | <blockquote> |
| 842 | <div><p>By default the above method wraps any errors within <p> tags. You can |
| 843 | set your own delimiters like this:</p> |
| 844 | <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$this</span><span class="o">-></span><span class="na">upload</span><span class="o">-></span><span class="na">display_errors</span><span class="p">(</span><span class="s1">'<p>'</span><span class="p">,</span> <span class="s1">'</p>'</span><span class="p">);</span> |
| 845 | </pre></div> |
| 846 | </div> |
| 847 | </div></blockquote> |
| 848 | </dd></dl> |
| 849 | |
| 850 | <dl class="method"> |
| 851 | <dt id="CI_Upload::data"> |
| 852 | <code class="descname">data</code><span class="sig-paren">(</span><span class="optional">[</span><em>$index = NULL</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_Upload::data" title="Permalink to this definition">¶</a></dt> |
| 853 | <dd><table class="docutils field-list" frame="void" rules="none"> |
| 854 | <col class="field-name" /> |
| 855 | <col class="field-body" /> |
| 856 | <tbody valign="top"> |
| 857 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| 858 | <li><strong>$data</strong> (<em>string</em>) – Element to return instead of the full array</li> |
| 859 | </ul> |
| 860 | </td> |
| 861 | </tr> |
| 862 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Information about the uploaded file</p> |
| 863 | </td> |
| 864 | </tr> |
| 865 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">mixed</p> |
| 866 | </td> |
| 867 | </tr> |
| 868 | </tbody> |
| 869 | </table> |
| 870 | <p>This is a helper method that returns an array containing all of the |
| 871 | data related to the file you uploaded. Here is the array prototype:</p> |
| 872 | <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">Array</span> |
| 873 | <span class="p">(</span> |
| 874 | <span class="p">[</span><span class="nx">file_name</span><span class="p">]</span> <span class="o">=></span> <span class="nx">mypic</span><span class="o">.</span><span class="nx">jpg</span> |
| 875 | <span class="p">[</span><span class="nx">file_type</span><span class="p">]</span> <span class="o">=></span> <span class="nx">image</span><span class="o">/</span><span class="nx">jpeg</span> |
| 876 | <span class="p">[</span><span class="nx">file_path</span><span class="p">]</span> <span class="o">=></span> <span class="o">/</span><span class="nx">path</span><span class="o">/</span><span class="nx">to</span><span class="o">/</span><span class="nx">your</span><span class="o">/</span><span class="nx">upload</span><span class="o">/</span> |
| 877 | <span class="p">[</span><span class="nx">full_path</span><span class="p">]</span> <span class="o">=></span> <span class="o">/</span><span class="nx">path</span><span class="o">/</span><span class="nx">to</span><span class="o">/</span><span class="nx">your</span><span class="o">/</span><span class="nx">upload</span><span class="o">/</span><span class="nx">jpg</span><span class="o">.</span><span class="nx">jpg</span> |
| 878 | <span class="p">[</span><span class="nx">raw_name</span><span class="p">]</span> <span class="o">=></span> <span class="nx">mypic</span> |
| 879 | <span class="p">[</span><span class="nx">orig_name</span><span class="p">]</span> <span class="o">=></span> <span class="nx">mypic</span><span class="o">.</span><span class="nx">jpg</span> |
| 880 | <span class="p">[</span><span class="nx">client_name</span><span class="p">]</span> <span class="o">=></span> <span class="nx">mypic</span><span class="o">.</span><span class="nx">jpg</span> |
| 881 | <span class="p">[</span><span class="nx">file_ext</span><span class="p">]</span> <span class="o">=></span> <span class="o">.</span><span class="nx">jpg</span> |
| 882 | <span class="p">[</span><span class="nx">file_size</span><span class="p">]</span> <span class="o">=></span> <span class="mf">22.2</span> |
| 883 | <span class="p">[</span><span class="nx">is_image</span><span class="p">]</span> <span class="o">=></span> <span class="mi">1</span> |
| 884 | <span class="p">[</span><span class="nx">image_width</span><span class="p">]</span> <span class="o">=></span> <span class="mi">800</span> |
| 885 | <span class="p">[</span><span class="nx">image_height</span><span class="p">]</span> <span class="o">=></span> <span class="mi">600</span> |
| 886 | <span class="p">[</span><span class="nx">image_type</span><span class="p">]</span> <span class="o">=></span> <span class="nx">jpeg</span> |
| 887 | <span class="p">[</span><span class="nx">image_size_str</span><span class="p">]</span> <span class="o">=></span> <span class="nx">width</span><span class="o">=</span><span class="s2">"800"</span> <span class="nx">height</span><span class="o">=</span><span class="s2">"200"</span> |
| 888 | <span class="p">)</span> |
| 889 | </pre></div> |
| 890 | </div> |
| 891 | <p>To return one element from the array:</p> |
| 892 | <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$this</span><span class="o">-></span><span class="na">upload</span><span class="o">-></span><span class="na">data</span><span class="p">(</span><span class="s1">'file_name'</span><span class="p">);</span> <span class="c1">// Returns: mypic.jpg</span> |
| 893 | </pre></div> |
| 894 | </div> |
| 895 | <p>Here’s a table explaining the above-displayed array items:</p> |
| 896 | <table border="1" class="docutils"> |
| 897 | <colgroup> |
| 898 | <col width="14%" /> |
| 899 | <col width="86%" /> |
| 900 | </colgroup> |
| 901 | <thead valign="bottom"> |
| 902 | <tr class="row-odd"><th class="head">Item</th> |
| 903 | <th class="head">Description</th> |
| 904 | </tr> |
| 905 | </thead> |
| 906 | <tbody valign="top"> |
| 907 | <tr class="row-even"><td>file_name</td> |
| 908 | <td>Name of the file that was uploaded, including the filename extension</td> |
| 909 | </tr> |
| 910 | <tr class="row-odd"><td>file_type</td> |
| 911 | <td>File MIME type identifier</td> |
| 912 | </tr> |
| 913 | <tr class="row-even"><td>file_path</td> |
| 914 | <td>Absolute server path to the file</td> |
| 915 | </tr> |
| 916 | <tr class="row-odd"><td>full_path</td> |
| 917 | <td>Absolute server path, including the file name</td> |
| 918 | </tr> |
| 919 | <tr class="row-even"><td>raw_name</td> |
| 920 | <td>File name, without the extension</td> |
| 921 | </tr> |
| 922 | <tr class="row-odd"><td>orig_name</td> |
| 923 | <td>Original file name. This is only useful if you use the encrypted name option.</td> |
| 924 | </tr> |
| 925 | <tr class="row-even"><td>client_name</td> |
| 926 | <td>File name supplied by the client user agent, but possibly sanitized</td> |
| 927 | </tr> |
| 928 | <tr class="row-odd"><td>file_ext</td> |
| 929 | <td>Filename extension, period included</td> |
| 930 | </tr> |
| 931 | <tr class="row-even"><td>file_size</td> |
| 932 | <td>File size in kilobytes</td> |
| 933 | </tr> |
| 934 | <tr class="row-odd"><td>is_image</td> |
| 935 | <td>Whether the file is an image or not. 1 = image. 0 = not.</td> |
| 936 | </tr> |
| 937 | <tr class="row-even"><td>image_width</td> |
| 938 | <td>Image width</td> |
| 939 | </tr> |
| 940 | <tr class="row-odd"><td>image_height</td> |
| 941 | <td>Image height</td> |
| 942 | </tr> |
| 943 | <tr class="row-even"><td>image_type</td> |
| 944 | <td>Image type (usually the file name extension without the period)</td> |
| 945 | </tr> |
| 946 | <tr class="row-odd"><td>image_size_str</td> |
| 947 | <td>A string containing the width and height (useful to put into an image tag)</td> |
| 948 | </tr> |
| 949 | </tbody> |
| 950 | </table> |
| 951 | </dd></dl> |
| 952 | |
| 953 | </dd></dl> |
| 954 | |
| 955 | </div> |
| 956 | </div> |
| 957 | |
| 958 | |
| 959 | </div> |
| 960 | <footer> |
| 961 | |
| 962 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| 963 | |
| 964 | <a href="form_validation.html" class="btn btn-neutral float-right" title="Form Validation">Next <span class="fa fa-arrow-circle-right"></span></a> |
| 965 | |
| 966 | |
| 967 | <a href="encryption.html" class="btn btn-neutral" title="Encryption Library"><span class="fa fa-arrow-circle-left"></span> Previous</a> |
| 968 | |
| 969 | </div> |
| 970 | |
| 971 | |
| 972 | <hr/> |
| 973 | |
| 974 | <div role="contentinfo"> |
| 975 | <p> |
| 976 | © Copyright 2014 - 2019, British Columbia Institute of Technology. |
| 977 | Last updated on Jan 16, 2019. |
| 978 | </p> |
| 979 | </div> |
| 980 | |
| 981 | 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>. |
| 982 | |
| 983 | </footer> |
| 984 | </div> |
| 985 | </div> |
| 986 | |
| 987 | </section> |
| 988 | |
| 989 | </div> |
| 990 | |
| 991 | |
| 992 | |
| 993 | |
| 994 | |
| 995 | <script type="text/javascript"> |
| 996 | var DOCUMENTATION_OPTIONS = { |
| 997 | URL_ROOT:'../', |
| 998 | VERSION:'3.1.10', |
| 999 | COLLAPSE_INDEX:false, |
| 1000 | FILE_SUFFIX:'.html', |
| 1001 | HAS_SOURCE: false |
| 1002 | }; |
| 1003 | </script> |
| 1004 | <script type="text/javascript" src="../_static/jquery.js"></script> |
| 1005 | <script type="text/javascript" src="../_static/underscore.js"></script> |
| 1006 | <script type="text/javascript" src="../_static/doctools.js"></script> |
| 1007 | |
| 1008 | |
| 1009 | |
| 1010 | |
| 1011 | |
| 1012 | <script type="text/javascript" src="../_static/js/theme.js"></script> |
| 1013 | |
| 1014 | |
| 1015 | |
| 1016 | |
| 1017 | <script type="text/javascript"> |
| 1018 | jQuery(function () { |
| 1019 | SphinxRtdTheme.StickyNav.enable(); |
| 1020 | }); |
| 1021 | </script> |
| 1022 | |
| 1023 | |
| 1024 | </body> |
| 1025 | </html> |