Skip to content

docs: improve file upload validation #8876

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kenjis merged 5 commits into from
May 10, 2024
Merged

docs: improve file upload validation #8876

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5cd7ff2
docs: break long lines
kenjis May 9, 2024
251f3aa
chore: change section title
kenjis May 9, 2024
2c5b554
docs: remove unnecessary / in directory paths
kenjis May 9, 2024
28ed8c9
docs: add empty line
kenjis May 9, 2024
312a951
docs: add descriptions
kenjis May 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 28 additions & 12 deletions user_guide_src/source/libraries/uploaded_files.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@
Working with Uploaded Files
###########################

CodeIgniter makes working with files uploaded through a form much simpler and more secure than using PHP's ``$_FILES``
array directly. This extends the :doc:`File class </libraries/files>` and thus gains all of the features of that class.
CodeIgniter makes working with files uploaded through a form much simpler and
more secure than using PHP's ``$_FILES`` array directly. This extends the
:doc:`File class </libraries/files>` and thus gains all of the features of that
class.

.. note:: This is not the same as the File Uploading class in CodeIgniter 3.
This provides a raw interface to the uploaded files with a few small features.
Expand All @@ -12,9 +14,11 @@ array directly. This extends the :doc:`File class </libraries/files>` and thus g
:local:
:depth: 2

***********
The Process
***********
.. _file-upload-form-tutorial:

*************************
File Upload Form Tutorial
*************************

Uploading a file involves the following general process:

Expand All @@ -33,21 +37,23 @@ Creating the Upload Form
========================

Using a text editor, create a form called **upload_form.php**. In it, place
this code and save it to your **app/Views/** directory:
this code and save it to your **app/Views** directory:

.. literalinclude:: uploaded_files/001.php

You'll notice we are using a form helper to create the opening form tag.
File uploads require a multipart form, so the helper creates the proper
syntax for you. You'll also notice we have an ``$errors`` variable. This is
syntax for you.

You'll also notice we have an ``$errors`` variable. This is
so we can show error messages in the event the user does something
wrong.

The Success Page
================

Using a text editor, create a form called **upload_success.php**. In it,
place this code and save it to your **app/Views/** directory::
place this code and save it to your **app/Views** directory::

<!DOCTYPE html>
<html lang="en">
Expand All @@ -73,13 +79,23 @@ The Controller
==============

Using a text editor, create a controller called **Upload.php**. In it, place
this code and save it to your **app/Controllers/** directory:
this code and save it to your **app/Controllers** directory:

.. literalinclude:: uploaded_files/002.php

.. note:: Since the value of a file upload HTML field doesn't exist, and is stored in the ``$_FILES`` global,
only :ref:`rules-for-file-uploads` can be used to validate upload file with :doc:`validation`.
The rule ``required`` also can't be used, so use ``uploaded`` instead.
Since the value of a file upload HTML field doesn't exist, and is stored in the
``$_FILES`` global, only :ref:`rules-for-file-uploads` can be used to validate
upload file with :doc:`validation`.

The rule ``required`` cannot be used either, so if the file is required, use
the rule ``uploaded`` instead.

Note that an empty array (``[]``) is passed as the first argument to
``$this->validateData()``. It is because the file validation rules get the data
for the uploaded file directly from the Request object.

If the form has fields other than file upload, pass the field data as the first
argument.

The Routes
==========
Expand Down
11 changes: 8 additions & 3 deletions user_guide_src/source/libraries/validation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -885,6 +885,8 @@ Available Rules
.. literalinclude:: validation/038.php
:lines: 2-

.. _rules-for-general-use:

Rules for General Use
=====================

Expand Down Expand Up @@ -1044,9 +1046,10 @@ file validation.
files. Therefore, adding any general rules, like ``permit_empty``, to file
validation rules array or string, the file validation will not work correctly.

Since the value of a file upload HTML field doesn't exist, and is stored in the ``$_FILES`` global, the name of the input field will
need to be used twice. Once to specify the field name as you would for any other rule, but again as the first parameter of all
file upload related rules::
Since the value of a file upload HTML field doesn't exist, and is stored in the
``$_FILES`` global, the name of the input field will need to be used twice. Once
to specify the field name as you would for any other rule, but again as the first
parameter of all file upload related rules::

// In the HTML
<input type="file" name="avatar">
Expand All @@ -1056,6 +1059,8 @@ file upload related rules::
'avatar' => 'uploaded[avatar]|max_size[avatar,1024]',
]);

See also :ref:`file-upload-form-tutorial`.

======================= ========== ============================================= ===================================================
Rule Parameter Description Example
======================= ========== ============================================= ===================================================
Expand Down