WARNING: You are browsing the documentation for Symfony 2.0 which is not maintained anymore. Consider upgrading your projects to Symfony 4.1.

file Field Type

file Field Type

The file type represents a file input in your form.

Rendered as input file field
Inherited options
Parent type form
Class FileType

Basic Usage

Say you have this form definition:

1
$builder->add('attachment', 'file');

Caution

Don't forget to add the enctype attribute in the form tag: <form action="#" method="post" {{ form_enctype(form) }}>.

When the form is submitted, the attachment field will be an instance of UploadedFile. It can be used to move the attachment file to a permanent location:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
use Symfony\Component\HttpFoundation\File\UploadedFile;

public function uploadAction()
{
    // ...

    if ($form->isValid()) {
        $someNewFilename = ...

        $form['attachment']->getData()->move($dir, $someNewFilename);

        // ...
    }

    // ...
}

The move() method takes a directory and a file name as its arguments. You might calculate the filename in one of the following ways:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
// use the original file name
$file->move($dir, $file->getClientOriginalName());

// compute a random name and try to guess the extension (more secure)
$extension = $file->guessExtension();
if (!$extension) {
    // extension cannot be guessed
    $extension = 'bin';
}
$file->move($dir, rand(1, 99999).'.'.$extension);

Using the original name via getClientOriginalName() is not safe as it could have been manipulated by the end-user. Moreover, it can contain characters that are not allowed in file names. You should sanitize the name before using it directly.

Read the cookbook for an example of how to manage a file upload associated with a Doctrine entity.

Inherited options

These options inherit from the field type:

required

type: Boolean default: true

If true, an HTML5 required attribute will be rendered. The corresponding label will also render with a required class.

This is superficial and independent from validation. At best, if you let Symfony guess your field type, then the value of this option will be guessed from your validation information.

label

type: string default: The label is "guessed" from the field name

Sets the label that will be used when rendering the field. The label can also be directly set inside the template:

1
{{ form_label(form.name, 'Your name') }}

read_only

type: Boolean default: false

If this option is true, the field will be rendered with the disabled attribute so that the field is not editable.

error_bubbling

type: Boolean default: false

If true, any errors for this field will be passed to the parent field or form. For example, if set to true on a normal field, any errors for that field will be attached to the main form, not to the specific field.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.