MeioUpload Behavior - An improved File Upload Behavior for CakePHP

MeioUpload Behavior – An improved File Upload Behavior for CakePHP

MeioUpload Behavior is an improved File Upload Behavior for the CakePHP framework. It’s based on the Digital Spaghetti’s Upload Behavior.

Juan Basso created a project hosted at github. I am unable to keep working on this behavior an he is making some updates to the code. I think github is a great tool because you can simply fork the project and make your own changes. Go check his work: http://github.com/jrbasso/MeioUpload/tree/master

Download

MeioUploadBehavior version 1.0.1

Features

Can be used for any kind of files;
Accepts custom directory for files to be uploaded;
Validates the file extension and mime-type due to the behavior configuration;
Validates the max file size;
Allow custom validation rules;
Allow as many thumbnails formats as you want;
Allow more then one field to be uploadable, with custom options per field;
Stores the directory, filesize, and mime-type in the database if the table has these fields. Also allows to customize these fields names;
Allow the use of default files and deleting files without deleting the entire record;
Delete files when the record is deleted or updated with a new file;
Also works in the $model->saveAll method.

Usage

Place the meio_upload.php file in your app/models/behaviors folder;
If you want to use thumbnails, download Nate’s phpThumb Component and place it in your app/controllers/components folder;

Insert in your model table a character varying field:

CREATE TABLE `products` (
`id` int(8) unsigned NOT NULL auto_increment,
`name` varchar(255) default NULL,
`description` text default NULL,
`price` double default NULL,
`picture` varchar(255) default NULL,
`dir` varchar(255) default NULL,
`mimetype` varchar(255) NULL,
`filesize` int(11) unsigned default NULL,
`created` datetime default NULL,
`modified` datetime default NULL,
PRIMARY KEY  (`id`) ) ENGINE=MyISAM  DEFAULT CHARSET=utf8;

Add the MeioUpload in the $actsAs of your model:

var $actsAs = array(
    'MeioUpload' => array(
        'picture' => array(
            'dir' => 'img{DS}{model}{DS}{field}',
            'create_directory' => true,
            'allowed_mime' => array('image/jpeg', 'image/pjpeg', 'image/png'),
            'allowed_ext' => array('.jpg', '.jpeg', '.png'),
            'thumbsizes' => array(
                'normal' => array('width'=>200, 'height'=>200),
            ),
            'default' => 'default.jpg',
        )
    )
);

Use a form file input to the field:

echo $form->input('picture', array('type' => 'file'));

Make sure your form has multipart/form-data enctype:

echo $form->create('Product',array('type' => 'file'));

Make sure the PHP has permission to write in the folder yous specified and the php.ini allow the MAX_FILE_SIZE you specified.

Options

When you apply the MeioUpload Behavior to a Model, you pass an array with your options. Here are the options you can change and it’s defaults.

dir
The folder where the uploaded files will be saved. It must be inside the app/webroot directory and defaults to an empty string, what means that it will be the app/webroot itself. If you specify some path, then it will be app/webroot/the_path_you/specified. In this option you may use the {DS} pattern, what will be converted to ‘/’ in UNIX systems and to ‘\’ in Windows systems.
allowed_mime
This option specifies the allowed mime-types for the files. It defaults to an empty array. What means that every mime-type will be accepted. But if you specify an array with the mime-types allowed, only files of these mime-types will be accepted.
```
var $actsAs = array(
    'picture' => array(
        'allowed_mime' => array('image/jpeg', 'image/pjpeg', 'image/png')
    )
);
```
The code above says that the picture field will be a file uploaded, and it allows ‘image/jpeg’, ‘image/pjpeg’ and ‘image/png’ mime-types.
allowed_ext
This option specifies the allowed file extensions. It defaults to an empty array. What means that every extension will be accepted. But if you specify an array with the extensions allowed, only files with these extensions will be accepted.
```
var $actsAs = array(
    'picture' => array(
        'allowed_ext' => array('.jpg', '.jpeg', '.png')
    )
);
```
The code above says that the picture field will be a file uploaded, and it allows ‘.jpg’, ‘.jpeg’ and ‘.png’ extensions.
create_directory
If you want to create the directory specified in the dir option if it don’t exists, then set this option to true. It already defaults to true, but you can set it to false.
max_size
The max file size allowed in the upload. Be sure it’s lower then the php.ini configuration. You can set a numeric value of bytes, or set it in other unit like ‘8 Kb’, only ‘kb’, ‘mb’, ‘gb’ and ‘tb’ units are allowed and it’s not case-sensitive. It defaults to 2 Mb.
```
var $actsAs = array(
    'picture' => array(
        'max_size' => '4 Mb'
    )
);
```
default
If you have a file that you want to use if the field is left blank, like a default picture for users who don’t have one, set this option to the name of this file. Make sure it is inside the folder specified in the ‘dir’ option.
```
var $actsAs = array(
    'picture' => array(
        'default' => 'default.jpg'
    )
);
```
fields
With this option you can customize the field inside your model table, where the data will be saved. The filename is the key of the options array, and you can setup fields to store the filesize, mime-type and directory. It defaults to ‘filesize’, ‘mimetype’ and ‘dir’ respectively, but you can customize with an array:
```
var $actsAs = array(
    'picture' => array(
        'fields' => array(
            'filesize' => 'picture_filesize',
            'mimetype' => '{field}_mimetype',
            'dir' => 'pictures_folder'
        )
    )
);
```
The code above says that your filesize, mimetype and dir fields will be ‘picture_filesize’, ‘picture_mimetype’ and ‘picture_folder’ respectively. And the filename field will be pictures. You may notice that in mimetype case, i used the constant {field} that will be replaced with the field name(picture in this case).

Validations

The behavior automatically include some validations to your field. Here they are:

FieldName Checks if the field has been setup to be and uploadable.
Dir Checks if the directory exists or if it can be created. This validation depends on the option ‘create_directory’.
Empty Checks if the filename is not empty. It defaults to be used only on create.
UploadError Checks if ocurred erros in the upload.
MaxSize Checks if the file isn’t bigger then the max file size option.
InvalidMime Checks if the file is of an allowed mime-type.
InvalidExt Checks if the file has an allowed extension.

You can overwrite any of the parameters of these default validation rules. Directly in the model $validate var:

var $validate = array(
    'picture' => array(
        'Empty' => array(
            'check' => false
        ),
        'InvalidExt => array(
            'message' => 'This file extension isn't allowed.'
        )
    )
);

In the code above, i changed the message for the ‘InvalidExt’ default validation. You can also disable any of the default validations by setting the ‘check’ atribute fo false as is shown in the example above for the ‘Empty’ default validation. You can change any of the other parameters of the built-in cake validation:

var $validate = array(
    'picture' => array(
        'Empty' => array(
            'rule' => array('YourDefaultValidation'),
            'on' => 'update',
            'required' => true
        ),
    )
);

You can also change the validation rule for one you have created. But use this functionality carefully.

Setting up file removing

If you send a form data with as field named data[Model][field][remove] not empty, then the behavior will automatically delete the file associated with the record and set it’s value to the default, if it is set, or to empty. To achieve this you can add a checkbox to your form:

echo $form->input('Product.picture.remove', array('type' => 'checkbox'));

138 Responses to “MeioUpload Behavior – An improved File Upload Behavior for CakePHP”

Pages: « 1 2 3 [4] 5 6 7 8 9 10 11 … 14 » Show All

31
Russ (rgreenphotodesign) Says:
December 11th, 2008 at 13:21
The site I listed is not the one I’m using this for. But I do have a question. Hope it’s not a stupid one

I have a model called Miscfile and the database contains the basic elements in your example with a couple of custom fields.

var $actsAs = array( ‘MeioUpload’ => array( ‘audiofile’ => array( ‘dir’ => ‘userfiles{DS}audio’, ‘create_directory’ => true, ‘allowed_mime’ => array(‘audio/wav’), ‘allowed_ext’ => array(‘.wav’), ),
```
   )
);
```
I can’t seem to get any data to store in the table, the file uploads fine, but nothing in the database.

here is my action in controller. function add() { $this->Miscfile->saveAll($this->data); $this->set(‘message’, ‘Your file has been uploaded’); $this->render(‘audio’); }

View:

create(‘Miscfile’, array(‘type’ => ‘file’)); ?> input(‘audiofile’, array(‘type’ => ‘file’)); ?> input(‘title’); ?> end(‘Upload File’); ?>

Again the file uploads fine, but no DB. Feels like I’m missing something super simple or obvious!
32
faemino Says:
December 12th, 2008 at 13:36
Hi Vinicius, First thanks for this useful behavior.

When I try to update a model from a form with a “remove” checkbox (set true), the recordset be updated but the file isn’t deleted.

Dive in your code in the beforeSave method the next code block:

//if the record is already saved in the database, set the existing file to be removed after the save is sucessfull if(!empty($model->data[$model->name][$model->primaryKey])){ $this->setFileToRemove($fieldName); }

don’t delete the file in edit action.

For now I’ve put these ugly else:

} else {
$this->setFileToRemove($fieldName); }

And edit and file deletion works fine. Another actions like add works too. For now, I can’t look better your code and learn about it to see if I’m wrong or to propose a better solution than a else.

Sorry for my poor english. Cheers and thanks faemino
33
gabriel Says:
December 13th, 2008 at 13:12
Hi Luke,

I found the problem for the following message :

Notice (8): Undefined index: {Model} … in 550 meiouploadbehavior::fixname() – [internal], line ??

I left caracters after “?>” tag in my class or files configuration. Now it’s ok.

However I have still this problem : If I load 2 times the same file, the older version is replaced with the new one (the new one isn’t renamed).

See you

Gabriel
34
gabriel Says:
December 13th, 2008 at 14:02
Hello,

What’s happen if I download the same file 2 times (2 rows in the db for one file in the same directoy) and I delete one row in the DB ?

See you !
35
Tickão Says:
December 17th, 2008 at 17:37
Olá, sou iniciante no Cake.

Fiz e refiz os passos e não consegui fazer o upload.

O sistema está em desenvolvimento no windows, tentei varias vezes mas simplesmente não faz o upload, não grava o campo file no BD e não dá nenhum erro.

Será que vc poderia me ajudar? Fora os procedimentos acima precisa mais algum outro no controller por exemplo?
36
Gabriel Says:
December 18th, 2008 at 22:51
I notice you should set variable debug on 0.

If debbug > 0 you’ll have the following error :

Notice (8): Undefined index: {Model} … in 550 meiouploadbehavior::fixname() – [internal], line ??
37
berger Says:
December 19th, 2008 at 15:07
Hi, everything works almost fine with me. Except the redirect after add and delete. For some reasons it gets redirected to the same page (add to add, delete to delete). In the case of delete this results in an infinite loop… any suggestions?

greetz berger
38
Sparkybarkalot Says:
December 21st, 2008 at 22:58
I’m having problems getting this to work and I’m wondering if you have a solution. When I hit the submit button for the form, I get this notice and error: “Notice (8): Array to string conversion [CORE\cake\libs\model\datasources\dbo_source.php, line 571]” and “Warning (512): SQL Error: 1054: Unknown column ‘Array’ in ‘field list’ [CORE\cake\libs\model\datasources\dbo_source.php, line 514]” I found two recommended solutions elsewhere online, but neither solved my problem. This is in my model: var $actsAs = array( ‘MeioUpload’ => array( ‘picture’ => array( ‘dir’ => ‘files{DS}pictures’, ‘allowed_mime’ => array(‘image/jpeg’, ‘image/pjpeg’, ‘image/png’), ‘allowed_ext’ => array(‘.jpg’, ‘.jpeg’, ‘.png’), ‘default’ => ‘default.jpg’ ) ) );

This is in my view: create(‘Painting’, array(‘type’ => ‘file’)); ?>
```
input('title');
    echo $form-&gt;input('location_id');
    echo $form-&gt;input('size');
    echo $form-&gt;input('date_moved');
    echo $form-&gt;input('picture', array('type' =&gt; 'file'));
?&gt;
```
end(‘Submit’);?>

Any suggestions?
39
Mohammad Nuaimat Says:
December 22nd, 2008 at 13:53
Dear

how can i specify ‘dir’ config such that it creates a folder for current model and a subfolder for current model record id then place the file inside this subfolder.

ex: Model: Profile Id: 12 Fname: test.jpg

this should be found in /webroot/files/Profile/12/test.jpg

anyway ??
40
John Says:
December 23rd, 2008 at 08:12
Hi. First of all I just want to say thanks for making such a useful bit of code available to everyone. I’ve got the behaviour working in a basic way with no problems at all.

Apologies in advance as this is probably a really obvious question. I wanted to save the field(s) using a habtm relationship.

Product HABTM Image

My Models are as follows:

array(‘className’ => ‘Image’, ‘joinTable’ => ‘images_products’, ‘foreignKey’ => ‘product_id’, ‘associationForeignKey’ => ‘image_id’, ‘unique’ => true, ‘conditions’ => ”, ‘fields’ => ”, ‘order’ => ”, ‘limit’ => ”, ‘offset’ => ”, ‘finderQuery’ => ”, ‘deleteQuery’ => ”, ‘insertQuery’ => ” ) );

} ?>

array(‘className’ => ‘Product’, ‘joinTable’ => ‘images_products’, ‘foreignKey’ => ‘image_id’, ‘associationForeignKey’ => ‘product_id’, ‘unique’ => true, ‘conditions’ => ”, ‘fields’ => ”, ‘order’ => ”, ‘limit’ => ”, ‘offset’ => ”, ‘finderQuery’ => ”, ‘deleteQuery’ => ”, ‘insertQuery’ => ” ) );
```
/* use the upload compaonent */
var $actsAs = array(
    'MeioUpload' =&gt; array(
        'filename' =&gt; array(
            'dir' =&gt; 'img{DS}{model}{DS}{field}',
            'create_directory' =&gt; true,
            'allowed_mime' =&gt; array('image/jpeg', 'image/pjpeg', 'image/png'),
            'allowed_ext' =&gt; array('.jpg', '.jpeg', '.png'),
            'thumbsizes' =&gt; array(
                'small'  =&gt; array('width'=&gt;100, 'height'=&gt;100),
                'medium' =&gt; array('width'=&gt;220, 'height'=&gt;220),
                'large'  =&gt; array('width'=&gt;800, 'height'=&gt;600)
            )
            /*'default' =&gt; 'default.jpg',*/
        )
    )
);
```
} ?>

And my view is really simple:
```
create('Product', array('type' =&gt; 'file'));?&gt;


    input('name');
    echo $form-&gt;input('live');
    echo $form-&gt;input('deleted');
    //echo $form-&gt;input('Image.filename', array('type' =&gt; 'file'));  

?&gt;

    Filename





end();?&gt;
```
and my view

data)) {
```
        //pr($this-&gt;data);

        $this-&gt;Product-&gt;create();
        if ($this-&gt;Product-&gt;save($this-&gt;data)) {
            $this-&gt;Session-&gt;setFlash(__('The Product has been saved', true));
            $this-&gt;redirect(array('action'=&gt;'index'));
        } else {
            $this-&gt;Session-&gt;setFlash(__('The Product could not be saved. Please, try again.', true));
        }
    }
    $images = $this-&gt;Product-&gt;Image-&gt;find('list');
    $this-&gt;set(compact('images'));
}
```
I don’t get any error messages, it is just that the image isn’t uploaded and no data is saved to the images table.

Any help would be greatly appreciated. Thanks.

Thanks