Attach Plugin

Attach Plugin, is easy upload in CakePHP 2. For several projects I have used the MeioUpload plugin and he was really good for me, but for some new projects I`d like to use polymorphic model for mine attachments, and the new and good Imagine library for generate thumbs, and manipulate images. So I decided to start one plugin, that is called Attach. To use it’s really simple:

Installation

Usage

In a model that needs uploading, replace the class declaration with something similar to the following:

It’s important to remember that your model class can have your own fields, and it will have a extra relation with Attachment model with the fields that are upload.

App::uses('AppModel', 'Model');

class Media extends AppModel {

    public $validate = array(
        'image' => array(
            'extension' => array(
                'rule' => array(
                    'extension', array(
                        'jpg',
                        'jpeg',
                        'bmp',
                        'gif',
                        'png',
                        'jpg'
                    )
                ),
                'message' => 'File extension is not supported',
                'on' => 'create'
            ),
            'mime' => array(
                'rule' => array('mime', array(
                    'image/jpeg',
                    'image/pjpeg',
                    'image/bmp',
                    'image/x-ms-bmp',
                    'image/gif',
                    'image/png'
                )),
                'on' => 'create'
            ),
            'size' => array(
                'rule' => array('size', 2097152),
                'on' => 'create'
            )
        ),
        'swf' => array(
            'extension' => array(
                'rule' => array(
                    'extension', array(
                        'swf',
                    )
                ),
                'message' => 'File extension is not supported',
                'on' => 'create'
            ),
            'mime' => array(
                'rule' => array('mime', array(
                    'application/x-shockwave-flash',
                )),
                'on' => 'create'
            ),
            'size' => array(
                'rule' => array('size', 53687091200),
                'on' => 'create'
            )
        ),
        'zip' => array(
            'extension' => array(
                'rule' => array(
                    'extension', array(
                        'zip',
                    )
                ),
                'message' => 'File extension is not supported',
                'on' => 'create'
            ),
            'mime' => array(
                'rule' => array('mime', array(
                    'application/zip',
                    'multipart/x-zip'
                )),
                'on' => 'create'
            ),
            'size' => array(
                'rule' => array('size', 53687091200),
                'on' => 'create'
            )
        ),
    );

    public $actsAs = array(
        'Attach.Upload' => array(
            'swf' => array(
                'dir' => 'webroot{DS}uploads{DS}media{DS}swf'
            ),
            'image' => array(
                'dir' => 'webroot{DS}uploads{DS}media{DS}image',
                'thumbs' => array(
                    'thumb' => array(
                        'w' => 190,
                        'h' => 158,
                        'crop' => true,
                    ),
                ),
            ),
            'zip' => array(
                'dir' => 'webroot{DS}uploads{DS}media{DS}zip'
            ),
        ),
    );

You also need to specify the fields in your database like so

CREATE TABLE  `attachments` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `filename` varchar(150) NOT NULL,
  `model` varchar(150) NOT NULL,
  `foreign_key` int(11) NOT NULL,
  `type` varchar(100) NOT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

Create your upload view, make sure it’s a multipart/form-data form, and the filename field is of type ‘file’:

echo $this->Form->create('Media', array('type' => 'file'));
echo $this->Form->input('name');
echo $this->Form->input('image', array('type' => 'file'));
echo $this->Form->input('swf', array('type' => 'file'));
echo $this->Form->input('zip', array('type' => 'file'));
echo $this->Form->input('status');
echo $this->Form->end(__('Submit'));

Attach creates automatic for you the relationship with the model Attachment, for each type that you define:

var_dump($this->Media->AttachmentImage);
var_dump($this->Media->AttachmentSwf);
var_dump($this->Media->AttachmentZip);

It will be always “Attachment” plus the type! So that’s it the Attach plugin will handle your files, you can keep uptodate with the changes at the plugin at github: https://github.com/krolow/Attach