mirror of
https://github.com/codeigniter4/CodeIgniter4.git
synced 2025-02-20 11:44:28 +08:00
485 lines
37 KiB
HTML
485 lines
37 KiB
HTML
<!DOCTYPE html>
|
|
<html class="writer-html5" lang="en">
|
|
<head>
|
|
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<title>Working with Files — CodeIgniter 4.6.0 documentation</title>
|
|
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
|
|
<link rel="stylesheet" type="text/css" href="../_static/css/citheme.css" />
|
|
<link rel="stylesheet" type="text/css" href="../_static/css/citheme_dark.css" />
|
|
|
|
|
|
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
|
<!--[if lt IE 9]>
|
|
<script src="../_static/js/html5shiv.min.js"></script>
|
|
<![endif]-->
|
|
|
|
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
|
|
<script src="../_static/jquery.js"></script>
|
|
<script src="../_static/underscore.js"></script>
|
|
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
|
|
<script src="../_static/doctools.js"></script>
|
|
<script src="../_static/sphinx_highlight.js"></script>
|
|
<script src="../_static/js/citheme.js"></script>
|
|
<script src="../_static/js/carbon.js"></script>
|
|
<script src="../_static/js/theme.js"></script>
|
|
<link rel="index" title="Index" href="../genindex.html" />
|
|
<link rel="search" title="Search" href="../search.html" />
|
|
<link rel="next" title="File Collections" href="file_collections.html" />
|
|
<link rel="prev" title="Encryption Service" href="encryption.html" />
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav">
|
|
<div class="wy-grid-for-nav">
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search" >
|
|
|
|
|
|
|
|
<a href="../index.html">
|
|
|
|
<img src="../_static/ci-logo-text.svg" class="logo" alt="Logo"/>
|
|
</a>
|
|
<div role="search">
|
|
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
</div>
|
|
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../intro/index.html">Welcome to CodeIgniter4</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="../intro/index.html">Welcome to CodeIgniter4</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../intro/requirements.html">Server Requirements</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../intro/credits.html">Credits</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../intro/psr.html">PSR Compliance</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../license.html">License Agreement</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installation</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="../installation/installing_composer.html">Composer Installation</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../installation/installing_manual.html">Manual Installation</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../installation/running.html">Running Your App</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../installation/troubleshooting.html">Troubleshooting</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../installation/deployment.html">Deployment</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../changelogs/index.html">Change Logs</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../installation/upgrading.html">Upgrading From a Previous Version</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../installation/repositories.html">CodeIgniter Repositories</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../tutorial/index.html">Build Your First Application</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="../tutorial/static_pages.html">Static Pages</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../tutorial/news_section.html">News Section</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../tutorial/create_news_items.html">Create News Items</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../tutorial/conclusion.html">Conclusion</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../concepts/index.html">CodeIgniter4 Overview</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="../concepts/structure.html">Application Structure</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../concepts/mvc.html">Models, Views, and Controllers</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../concepts/autoloader.html">Autoloading Files</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../concepts/services.html">Services</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../concepts/factories.html">Factories</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../concepts/http.html">Working with HTTP Requests</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../concepts/security.html">Security Guidelines</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../concepts/goals.html">Design and Architectural Goals</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../general/index.html">General Topics</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/configuration.html">Configuration</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/urls.html">CodeIgniter URLs</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/helpers.html">Helper Functions</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/common_functions.html">Global Functions and Constants</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/logging.html">Logging Information</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/errors.html">Error Handling</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/caching.html">Web Page Caching</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/ajax.html">AJAX Requests</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/modules.html">Code Modules</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/managing_apps.html">Managing your Applications</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../general/environments.html">Handling Multiple Environments</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../incoming/index.html">Controllers and Routing</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="../incoming/routing.html">URI Routing</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../incoming/controllers.html">Controllers</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../incoming/filters.html">Controller Filters</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../incoming/auto_routing_improved.html">Auto Routing (Improved)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../incoming/message.html">HTTP Messages</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../incoming/request.html">Request Class</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../incoming/incomingrequest.html">IncomingRequest Class</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../incoming/content_negotiation.html">Content Negotiation</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../incoming/methodspoofing.html">HTTP Method Spoofing</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../incoming/restful.html">RESTful Resource Handling</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../outgoing/index.html">Building Responses</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="../outgoing/views.html">Views</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../outgoing/view_renderer.html">View Renderer</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../outgoing/view_layouts.html">View Layouts</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../outgoing/view_cells.html">View Cells</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../outgoing/view_parser.html">View Parser</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../outgoing/view_decorators.html">View Decorators</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../outgoing/table.html">HTML Table Class</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../outgoing/response.html">HTTP Responses</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../outgoing/api_responses.html">API Response Trait</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../outgoing/csp.html">Content Security Policy</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../outgoing/localization.html">Localization</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../outgoing/alternative_php.html">Alternate PHP Syntax for View Files</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../database/index.html">Working with Databases</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="../database/examples.html">Quick Start: Usage Examples</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../database/configuration.html">Database Configuration</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../database/connecting.html">Connecting to a Database</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../database/queries.html">Running Queries</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../database/results.html">Generating Query Results</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../database/helpers.html">Query Helper Methods</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../database/query_builder.html">Query Builder Class</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../database/transactions.html">Transactions</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../database/metadata.html">Getting Metadata</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../database/call_function.html">Custom Function Calls</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../database/events.html">Database Events</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../database/utilities.html">Database Utilities</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../models/index.html">Modeling Data</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="../models/model.html">Using CodeIgniter's Model</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../models/entities.html">Using Entity Classes</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../dbmgmt/index.html">Managing Databases</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="../dbmgmt/forge.html">Database Forge</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../dbmgmt/migration.html">Database Migrations</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../dbmgmt/seeds.html">Database Seeding</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../dbmgmt/db_commands.html">Database Commands</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="current">
|
|
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Library Reference</a><ul class="current">
|
|
<li class="toctree-l2"><a class="reference internal" href="caching.html">Caching Driver</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cookies.html">Cookies</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cors.html">Cross-Origin Resource Sharing (CORS)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="curlrequest.html">CURLRequest Class</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="email.html">Email Class</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="encryption.html">Encryption Service</a></li>
|
|
<li class="toctree-l2 current"><a class="current reference internal" href="#">Working with Files</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="file_collections.html">File Collections</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="honeypot.html">Honeypot Class</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="images.html">Image Manipulation Class</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="pagination.html">Pagination</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="publisher.html">Publisher</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="security.html">Security</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="sessions.html">Session Library</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="throttler.html">Throttler</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="time.html">Times and Dates</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="typography.html">Typography</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="uploaded_files.html">Working with Uploaded Files</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="uri.html">Working with URIs</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="user_agent.html">User Agent Class</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="validation.html">Validation</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../helpers/index.html">Helpers</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="../helpers/array_helper.html">Array Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../helpers/cookie_helper.html">Cookie Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../helpers/date_helper.html">Date Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../helpers/filesystem_helper.html">Filesystem Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../helpers/form_helper.html">Form Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../helpers/html_helper.html">HTML Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../helpers/inflector_helper.html">Inflector Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../helpers/number_helper.html">Number Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../helpers/security_helper.html">Security Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../helpers/test_helper.html">Test Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../helpers/text_helper.html">Text Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../helpers/url_helper.html">URL Helper</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../helpers/xml_helper.html">XML Helper</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../testing/index.html">Testing</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="../testing/overview.html">Getting Started</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../testing/database.html">Database</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../testing/fabricator.html">Generating Data</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../testing/controllers.html">Controller Testing</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../testing/feature.html">HTTP Testing</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../testing/response.html">Testing Responses</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../testing/cli.html">Testing CLI Commands</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../testing/mocking.html">Mocking</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../testing/benchmark.html">Benchmarking</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../testing/debugging.html">Debugging Your Application</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../cli/index.html">Command Line Usage</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="../cli/cli_overview.html">CLI Overview</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../cli/cli_controllers.html">Running Controllers via CLI</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../cli/spark_commands.html">Spark Commands</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../cli/cli_commands.html">Creating Spark Commands</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../cli/cli_generators.html">CLI Generators</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../cli/cli_library.html">CLI Library</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../cli/cli_request.html">CLIRequest Class</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../extending/index.html">Extending CodeIgniter</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="../extending/core_classes.html">Creating Core System Classes</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../extending/common.html">Replacing Common Functions</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../extending/events.html">Events</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../extending/basecontroller.html">Extending the Controller</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../extending/authentication.html">Authentication</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../extending/composer_packages.html">Creating Composer Packages</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../extending/contributing.html">Contributing to CodeIgniter</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="official_packages.html">Official Packages</a></li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="../index.html">CodeIgniter</a>
|
|
</nav>
|
|
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content">
|
|
<a class="btn btn-neutral float-right" href="https://github.com/codeigniter4/CodeIgniter4/edit/develop/user_guide_src/source/libraries/files.rst">Edit this page</a>
|
|
|
|
<div role="navigation" aria-label="Page navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
|
<li class="breadcrumb-item"><a href="index.html">Library Reference</a></li>
|
|
<li class="breadcrumb-item active">Working with Files</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div itemprop="articleBody">
|
|
|
|
<section id="working-with-files">
|
|
<h1>Working with Files<a class="headerlink" href="#working-with-files" title="Permalink to this heading"></a></h1>
|
|
<p>CodeIgniter provides a File class that wraps the <a class="reference external" href="https://www.php.net/manual/en/class.splfileinfo.php">SplFileInfo</a> class
|
|
and provides some additional convenience methods. This class is the base class for <a class="reference internal" href="uploaded_files.html"><span class="doc">uploaded files</span></a>
|
|
and <a class="reference internal" href="images.html"><span class="doc">images</span></a>.</p>
|
|
<nav class="contents local" id="contents">
|
|
<ul class="simple">
|
|
<li><p><a class="reference internal" href="#getting-a-file-instance" id="id1">Getting a File instance</a></p></li>
|
|
<li><p><a class="reference internal" href="#taking-advantage-of-spl" id="id2">Taking Advantage of Spl</a></p></li>
|
|
<li><p><a class="reference internal" href="#new-features" id="id3">New Features</a></p>
|
|
<ul>
|
|
<li><p><a class="reference internal" href="#getrandomname" id="id4">getRandomName()</a></p></li>
|
|
<li><p><a class="reference internal" href="#getsize" id="id5">getSize()</a></p></li>
|
|
<li><p><a class="reference internal" href="#getsizebyunit" id="id6">getSizeByUnit()</a></p></li>
|
|
<li><p><a class="reference internal" href="#getsizebybinaryunit" id="id7">getSizeByBinaryUnit()</a></p></li>
|
|
<li><p><a class="reference internal" href="#getsizebymetricunit" id="id8">getSizeByMetricUnit()</a></p></li>
|
|
<li><p><a class="reference internal" href="#getmimetype" id="id9">getMimeType()</a></p></li>
|
|
<li><p><a class="reference internal" href="#guessextension" id="id10">guessExtension()</a></p></li>
|
|
<li><p><a class="reference internal" href="#moving-files" id="id11">Moving Files</a></p></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<section id="getting-a-file-instance">
|
|
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Getting a File instance</a><a class="headerlink" href="#getting-a-file-instance" title="Permalink to this heading"></a></h2>
|
|
<p>You create a new File instance by passing in the path to the file in the constructor.</p>
|
|
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="nv">$file</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">\CodeIgniter\Files\File</span><span class="p">(</span><span class="nv">$path</span><span class="p">);</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>By default, the file does not need to exist. However, you can pass an additional argument of <code class="docutils literal notranslate"><span class="pre">true</span></code>
|
|
to check that the file exists and throw <code class="docutils literal notranslate"><span class="pre">FileNotFoundException()</span></code> if it does not.</p>
|
|
</section>
|
|
<section id="taking-advantage-of-spl">
|
|
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Taking Advantage of Spl</a><a class="headerlink" href="#taking-advantage-of-spl" title="Permalink to this heading"></a></h2>
|
|
<p>Once you have an instance, you have the full power of the SplFileInfo class at the ready, including:</p>
|
|
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="c1">// Get the file's basename</span>
|
|
<span class="k">echo</span> <span class="nv">$file</span><span class="o">-></span><span class="na">getBasename</span><span class="p">();</span>
|
|
<span class="c1">// Get last modified time</span>
|
|
<span class="k">echo</span> <span class="nv">$file</span><span class="o">-></span><span class="na">getMTime</span><span class="p">();</span>
|
|
<span class="c1">// Get the true real path</span>
|
|
<span class="k">echo</span> <span class="nv">$file</span><span class="o">-></span><span class="na">getRealPath</span><span class="p">();</span>
|
|
<span class="c1">// Get the file permissions</span>
|
|
<span class="k">echo</span> <span class="nv">$file</span><span class="o">-></span><span class="na">getPerms</span><span class="p">();</span>
|
|
|
|
<span class="c1">// Write CSV rows to it.</span>
|
|
<span class="k">if</span> <span class="p">(</span><span class="nv">$file</span><span class="o">-></span><span class="na">isWritable</span><span class="p">())</span> <span class="p">{</span>
|
|
<span class="nv">$csv</span> <span class="o">=</span> <span class="nv">$file</span><span class="o">-></span><span class="na">openFile</span><span class="p">(</span><span class="s1">'w'</span><span class="p">);</span>
|
|
|
|
<span class="k">foreach</span> <span class="p">(</span><span class="nv">$rows</span> <span class="k">as</span> <span class="nv">$row</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nv">$csv</span><span class="o">-></span><span class="na">fputcsv</span><span class="p">(</span><span class="nv">$row</span><span class="p">);</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
</pre></div>
|
|
</div>
|
|
</section>
|
|
<section id="new-features">
|
|
<h2><a class="toc-backref" href="#id3" role="doc-backlink">New Features</a><a class="headerlink" href="#new-features" title="Permalink to this heading"></a></h2>
|
|
<p>In addition to all of the methods in the SplFileInfo class, you get some new tools.</p>
|
|
<section id="getrandomname">
|
|
<h3><a class="toc-backref" href="#id4" role="doc-backlink">getRandomName()</a><a class="headerlink" href="#getrandomname" title="Permalink to this heading"></a></h3>
|
|
<p>You can generate a cryptographically secure random filename, with the current timestamp prepended, with the <code class="docutils literal notranslate"><span class="pre">getRandomName()</span></code>
|
|
method. This is especially useful to rename files when moving it so that the filename is unguessable:</p>
|
|
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="c1">// Generates something like: 1465965676_385e33f741.jpg</span>
|
|
<span class="nv">$newName</span> <span class="o">=</span> <span class="nv">$file</span><span class="o">-></span><span class="na">getRandomName</span><span class="p">();</span>
|
|
</pre></div>
|
|
</div>
|
|
</section>
|
|
<section id="getsize">
|
|
<h3><a class="toc-backref" href="#id5" role="doc-backlink">getSize()</a><a class="headerlink" href="#getsize" title="Permalink to this heading"></a></h3>
|
|
<p>Returns the size of the file in bytes:</p>
|
|
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="nv">$size</span> <span class="o">=</span> <span class="nv">$file</span><span class="o">-></span><span class="na">getSize</span><span class="p">();</span> <span class="c1">// 256901</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>A <code class="docutils literal notranslate"><span class="pre">RuntimeException</span></code> will be thrown if the file does not exist or an error occurs.</p>
|
|
</section>
|
|
<section id="getsizebyunit">
|
|
<h3><a class="toc-backref" href="#id6" role="doc-backlink">getSizeByUnit()</a><a class="headerlink" href="#getsizebyunit" title="Permalink to this heading"></a></h3>
|
|
<div class="deprecated">
|
|
<p><span class="versionmodified deprecated">Deprecated since version 4.6.0.</span></p>
|
|
</div>
|
|
<p>Returns the size of the file default in bytes. You can pass in either <code class="docutils literal notranslate"><span class="pre">'kb'</span></code> or <code class="docutils literal notranslate"><span class="pre">'mb'</span></code> as the first parameter to get
|
|
the results in kibibytes or mebibytes, respectively:</p>
|
|
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="nv">$bytes</span> <span class="o">=</span> <span class="nv">$file</span><span class="o">-></span><span class="na">getSizeByUnit</span><span class="p">();</span> <span class="c1">// 256901</span>
|
|
<span class="nv">$kilobytes</span> <span class="o">=</span> <span class="nv">$file</span><span class="o">-></span><span class="na">getSizeByUnit</span><span class="p">(</span><span class="s1">'kb'</span><span class="p">);</span> <span class="c1">// 250.880</span>
|
|
<span class="nv">$megabytes</span> <span class="o">=</span> <span class="nv">$file</span><span class="o">-></span><span class="na">getSizeByUnit</span><span class="p">(</span><span class="s1">'mb'</span><span class="p">);</span> <span class="c1">// 0.245</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>A <code class="docutils literal notranslate"><span class="pre">RuntimeException</span></code> will be thrown if the file does not exist or an error occurs.</p>
|
|
</section>
|
|
<section id="getsizebybinaryunit">
|
|
<span id="file-get-size-by-binary-unit"></span><h3><a class="toc-backref" href="#id7" role="doc-backlink">getSizeByBinaryUnit()</a><a class="headerlink" href="#getsizebybinaryunit" title="Permalink to this heading"></a></h3>
|
|
<div class="versionadded">
|
|
<p><span class="versionmodified added">New in version 4.6.0.</span></p>
|
|
</div>
|
|
<p>Returns the size of the file default in bytes. You can pass in different FileSizeUnit values as the first parameter to get
|
|
the results in kibibytes, mebibytes etc. respectively. You can pass in a precision value as the second parameter to define
|
|
the amount of decimal places.</p>
|
|
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="nv">$bytes</span> <span class="o">=</span> <span class="nv">$file</span><span class="o">-></span><span class="na">getSizeByBinaryUnit</span><span class="p">();</span> <span class="c1">// 256901</span>
|
|
<span class="nv">$kibibytes</span> <span class="o">=</span> <span class="nv">$file</span><span class="o">-></span><span class="na">getSizeByBinaryUnit</span><span class="p">(</span><span class="nx">FileSizeUnit</span><span class="o">::</span><span class="na">KB</span><span class="p">);</span> <span class="c1">// 250.880</span>
|
|
<span class="nv">$mebibytes</span> <span class="o">=</span> <span class="nv">$file</span><span class="o">-></span><span class="na">getSizeByBinaryUnit</span><span class="p">(</span><span class="nx">FileSizeUnit</span><span class="o">::</span><span class="na">MB</span><span class="p">);</span> <span class="c1">// 0.245</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>A <code class="docutils literal notranslate"><span class="pre">RuntimeException</span></code> will be thrown if the file does not exist or an error occurs.</p>
|
|
</section>
|
|
<section id="getsizebymetricunit">
|
|
<span id="file-get-size-by-metric-unit"></span><h3><a class="toc-backref" href="#id8" role="doc-backlink">getSizeByMetricUnit()</a><a class="headerlink" href="#getsizebymetricunit" title="Permalink to this heading"></a></h3>
|
|
<div class="versionadded">
|
|
<p><span class="versionmodified added">New in version 4.6.0.</span></p>
|
|
</div>
|
|
<p>Returns the size of the file default in bytes. You can pass in different FileSizeUnit values as the first parameter to get
|
|
the results in kilobytes, megabytes etc. respectively. You can pass in a precision value as the second parameter to define
|
|
the amount of decimal places.</p>
|
|
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="nv">$bytes</span> <span class="o">=</span> <span class="nv">$file</span><span class="o">-></span><span class="na">getSizeByMetricUnit</span><span class="p">();</span> <span class="c1">// 256901</span>
|
|
<span class="nv">$kilobytes</span> <span class="o">=</span> <span class="nv">$file</span><span class="o">-></span><span class="na">getSizeByMetricUnit</span><span class="p">(</span><span class="nx">FileSizeUnit</span><span class="o">::</span><span class="na">KB</span><span class="p">);</span> <span class="c1">// 256.901</span>
|
|
<span class="nv">$megabytes</span> <span class="o">=</span> <span class="nv">$file</span><span class="o">-></span><span class="na">getSizeByMetricUnit</span><span class="p">(</span><span class="nx">FileSizeUnit</span><span class="o">::</span><span class="na">MB</span><span class="p">);</span> <span class="c1">// 0.256</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>A <code class="docutils literal notranslate"><span class="pre">RuntimeException</span></code> will be thrown if the file does not exist or an error occurs.</p>
|
|
</section>
|
|
<section id="getmimetype">
|
|
<h3><a class="toc-backref" href="#id9" role="doc-backlink">getMimeType()</a><a class="headerlink" href="#getmimetype" title="Permalink to this heading"></a></h3>
|
|
<p>Retrieve the media type (mime type) of the file. Uses methods that are considered as secure as possible when determining
|
|
the type of file:</p>
|
|
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="nv">$type</span> <span class="o">=</span> <span class="nv">$file</span><span class="o">-></span><span class="na">getMimeType</span><span class="p">();</span>
|
|
|
|
<span class="k">echo</span> <span class="nv">$type</span><span class="p">;</span> <span class="c1">// image/png</span>
|
|
</pre></div>
|
|
</div>
|
|
</section>
|
|
<section id="guessextension">
|
|
<h3><a class="toc-backref" href="#id10" role="doc-backlink">guessExtension()</a><a class="headerlink" href="#guessextension" title="Permalink to this heading"></a></h3>
|
|
<p>Attempts to determine the file extension based on the trusted <code class="docutils literal notranslate"><span class="pre">getMimeType()</span></code> method. If the mime type is unknown,
|
|
will return null. This is often a more trusted source than simply using the extension provided by the filename. Uses
|
|
the values in <strong>app/Config/Mimes.php</strong> to determine extension:</p>
|
|
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="c1">// Returns 'jpg' (WITHOUT the period)</span>
|
|
<span class="nv">$ext</span> <span class="o">=</span> <span class="nv">$file</span><span class="o">-></span><span class="na">guessExtension</span><span class="p">();</span>
|
|
</pre></div>
|
|
</div>
|
|
</section>
|
|
<section id="moving-files">
|
|
<h3><a class="toc-backref" href="#id11" role="doc-backlink">Moving Files</a><a class="headerlink" href="#moving-files" title="Permalink to this heading"></a></h3>
|
|
<p>Each file can be moved to its new location with the aptly named <code class="docutils literal notranslate"><span class="pre">move()</span></code> method. This takes the directory to move
|
|
the file to as the first parameter:</p>
|
|
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="nv">$file</span><span class="o">-></span><span class="na">move</span><span class="p">(</span><span class="nx">WRITEPATH</span> <span class="o">.</span> <span class="s1">'uploads'</span><span class="p">);</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>By default, the original filename was used. You can specify a new filename by passing it as the second parameter:</p>
|
|
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="nv">$newName</span> <span class="o">=</span> <span class="nv">$file</span><span class="o">-></span><span class="na">getRandomName</span><span class="p">();</span>
|
|
<span class="nv">$file</span><span class="o">-></span><span class="na">move</span><span class="p">(</span><span class="nx">WRITEPATH</span> <span class="o">.</span> <span class="s1">'uploads'</span><span class="p">,</span> <span class="nv">$newName</span><span class="p">);</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">move()</span></code> method returns a new File instance that for the relocated file, so you must capture the result if the
|
|
resulting location is needed:</p>
|
|
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="nv">$file</span> <span class="o">=</span> <span class="nv">$file</span><span class="o">-></span><span class="na">move</span><span class="p">(</span><span class="nx">WRITEPATH</span> <span class="o">.</span> <span class="s1">'uploads'</span><span class="p">);</span>
|
|
</pre></div>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
</section>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
|
<a href="encryption.html" class="btn btn-neutral float-left" title="Encryption Service" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
|
<a href="file_collections.html" class="btn btn-neutral float-right" title="File Collections" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>© Copyright 2019-2025 CodeIgniter Foundation.
|
|
<span class="lastupdated">Last updated on Feb 07, 2025.
|
|
</span></p>
|
|
</div>
|
|
|
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
|
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
|
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
|
|
|
|
</footer>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
<script>
|
|
jQuery(function () {
|
|
SphinxRtdTheme.Navigation.enable(false);
|
|
});
|
|
</script>
|
|
|
|
</body>
|
|
</html> |