#Stapler

Stapler can be used to generate file upload attachments for use with the wonderfully fabulous Laravel PHP Framework, authored by Taylor Otwell. If you have used ruby on rails' paperclip plugin then you will be familiar with its syntax. This bundle is inspired entirely from the work done by the guys at thoughtbot for the Rails Paperclip bundle: https://github.com/thoughtbot/paperclip. While not an exact duplicate, if you've used Paperclip before then you should be somewhat familiar with how this bundle works.

Stapler was created by Travis Bennett and Kelt Dockins, with thanks to Matthew Machuga for help and support.

##Requirements

Stapler currently requires php >= 5.4 (Stapler is implemented via the use of traits) as well as the Resizer bundle by Maikel Daloo.

Installing the Bundle

Stapler is distributed as a bundle, which is how it should be used in your app.

Install the bundle using Artisan:

artisan bundle:install stapler

Update your application/bundles.php file with:

'stapler' => array( 'auto' => true ),

Quickstart

In the document root of your application (most likely the public folder), create a folder named system and grant your application write permissions to it.

In your model:

class User extends Eloquent {
	use Stapler\stapler;

    public function __construct($attributes = array(), $exists = false){
        parent::__construct($attributes, $exists);

        $this->has_attached_file('avatar', [
            'styles' => [
            	'medium' => '300x300',
                'thumb' => '100x100'
            ]
        ]);
    }
}

From the command line, use the migration generator:

php artisan stapler::fasten users avatar
php artisan migrate

In your new view:

<?= Form::open_for_files('/users', 'POST') ?>
	<?= Form::file('avatar') ?>
<?= Form::close() ?>

In your controller:

public function post_create()
{
	$user = User::create(['avatar' => Input::file('avatar')]);	
}

In your show view:

<?= HTML::image($user->avatar_url() ?>
<?= HTML::image($user->avatar_url('medium') ?>
<?= HTML::image($user->avatar_url('thumb') ?>

To detach a file, simply set the attribute to null:

$user->avatar = null;
$user->save();

Configuration

Stapler works by attaching file uploads to records stored within a database table (model). Configuration is (currently) available on a per model basis only. Each model can have multiple attachments defined (avatar, photo, some_random_attachment, etc) and in turn each attachment can have multiple sizes (styles) defined. When an image or file is uploaded, Stapler will handle all the file processing (moving, resizing, etc) and provide helper methods for retreiving the uploaded assets. To accomplish this, four fields (named after the attachemnt) are created (via stapler:fasten) in the corresponding table for any model containing a file attachment. For example, an attachment named 'avatar' the following fields would be created:

• avatar_file_name
• avatar_file_size
• avatar_content_type
• avatar_uploaded_at

Stapler can be configured to store files in a variety of ways. This is done by defining a url string which points to the uploaded file asset. This is done via string interpolations. Currently, the following interpolations are available for use:

• :attachment - The name of the file attachment as declared in the has_attached_file function, e.g 'avatar'.
• :class - The classname of the model contaning the file attachment, e.g User. Stapler can handle namespacing of classes.
• :extension - The file extension type of the uploaded file, e.g '.jpg'
• :filename - The name of the uploaded file, e.g 'some_file.jpg'
• :id - The id of the corresponding database record for the uploaded file.
• :id_partition - The partitioned id of the corresponding database record for the uploaded file, e.g an id = 1 is interpolated as 000/000/001. This is the default and recommended setting for Stapler. Partioned id's help overcome the 32k subfolder problem that occurs in nix-based systems using the EXT3 file system.
• :laravel_root - The path to the root of the laravel project.
• :style - The resizing style of the file (images only), e.g 'thumbnail' or 'orginal'.

These interpolation can then be used to define a url and default_url for the location of your uploaded files. In a minimal configuration, the following settings are enabled by default:

• url: '/system/:class/:attachment/:id_partition/:style/:filename',

• default_url: '/:attachment/:style/missing.png',

• default_style: 'original',

• styles: [],

• keep_old_files: false

• url: The file system path to the file upload, relative to the public folder (document root) of the project.

• default_url: The default file returned when no file upload is present for a record.

• default_style: The default style returned from the Stapler file location helper methods. An unaltered version of uploaded file is always stored within the 'original' style, however the default_style can be set to point to any of the defined syles within the styles array.

• styles: An array of image sizes defined for the file attachment. Stapler will attempt to use the Resizer bundle to format the file upload into the defined style. To enable image cropping, insert a # symbol after the resizing options. For example:

'styles' => [
    'thumbnail' => '100x100#'
]

will create a copy of the file upload, resized and cropped to 100x100.

Examples

Create an attachment named 'picture', with both thumbnail (100x100) and large (300x300) styles, using custom url and default_url configurations.

public function __construct($attributes = array(), $exists = false){
    parent::__construct($attributes, $exists);

    $this->has_attached_file('picture', [
        'styles' => [
            'thumbnail' => '100x100',
            'thumbnail' => '300x300'
        ],
        'url' => '/system/:attachment/:id_partition/:style/:filename',
        'default_url' => '/:attachment/:style/missing.jpg'
    ]);
}

Create an attachment named 'picture', with both thumbnail (100x100) and large (300x300) styles, using custom url and default_url configurations, with the keep_old_files flag set to true (so that older file uploads aren't deleted from the file system) and image cropping turned on.

public function __construct($attributes = array(), $exists = false){
    parent::__construct($attributes, $exists);

    $this->has_attached_file('picture', [
        'styles' => [
            'thumbnail' => '100x100#',
            'thumbnail' => '300x300#'
        ],
        'url' => '/system/:attachment/:id_partition/:style/:filename',
        'default_url' => '/:attachment/:style/missing.jpg',
        'keep_old_files' => true
    ]);
}

Stapler makes it easy to manage multiple file uploads as well. A custom static method 'arrange_files' is provided in order to arrange the $_FILES array into a more convient form for handling multiple files. Here's an example of how this might work:

In models/user.php:

// A user has many photos.
public function photos(){
    return $this->has_many('Photo');
}

In models/photo.php:

public function __construct($attributes = array(), $exists = false){
        parent::__construct($attributes, $exists);

        $this->has_attached_file('photo', [
            'styles' => [
                'thumbnail' => '100x100#'
            ]
        ]);
    }

// A photo belongs to a user.
public function user(){
    return $this->belongs_to('User');
}

In the user new view:

<?= Form::open_for_files('/users', 'POST') ?>
    <?= Form::file('photos[]') ?>
    <?= Form::file('photos[]') ?>
    <?= Form::file('photos[]') ?>
<?= Form::close() ?>

In controllers/user.php

public function post_create()
{
    $user = new User();

    // Re-arrange the $_FILES array
    $files = User::arrange_files(Input::file('photos'));
    
    // Attach each photo to the user and save it.
    foreach($files as $file){
        $photo = new Photo();
        $photo->photo = $file;
        $user->photos()->insert($photo);
    }
}

Displaying uploaded files is also easy. Stapler provides convenience methods for retrieving url and path locations to uploaded files. As an example, for an attachment named 'photo', the static methods photo_path() and photo_url() would be available on the model to which the file was attached. Assuming an attachment named photo that's attached to a User model, consider the following:

Display a resized thumbnail style image belonging to a user record:

<?= HTML::image($user->photo_url('thumbnail')) ?>

Display the original image style (unmodified image):

<?= HTML::image($user->photo_url('original')) ?>

This also displays the unmodified original image (unless the :default_url interpolation has been set to a different style):

<?= HTML::image($user->photo_url()) ?>

We can also retrieve the file path of an uploaded file. This returns the physical file system path to the thumbnail style image:

$user->photo_path('thumbnail');