bnbwebexpertise / laravel-attachments
Attach files to your models, retrievable by key, group name or using the Eloquent relationship.
Installs: 186 814
Dependents: 2
Suggesters: 0
Security: 0
Stars: 87
Watchers: 12
Forks: 29
Open Issues: 3
Type:package
Requires
- php: >=7.0
- bnbwebexpertise/php-uuid: >=0.0.2
- doctrine/dbal: ~2.5|^3.0
- illuminate/console: >=5.5
- illuminate/database: >=5.5
- illuminate/encryption: >=5.5
- illuminate/routing: >=5.5
- illuminate/support: >=5.5
- nesbot/carbon: ^1.20 || ^2.0 || ^3
Requires (Dev)
- laravel/framework: >=5.5
- dev-master / 1.x-dev
- 1.0.27
- 1.0.26
- 1.0.25
- 1.0.24
- 1.0.23
- 1.0.22
- 1.0.21
- 1.0.20
- 1.0.19
- 1.0.18
- 1.0.16
- 1.0.15
- 1.0.14
- 1.0.13
- 1.0.12
- 1.0.11
- 1.0.10
- 1.0.9
- 1.0.8
- 1.0.7
- 1.0.6
- 1.0.5
- 1.0.4
- 1.0.3
- 1.0.2
- 1.0.1
- 1.0.0
- 0.0.16
- 0.0.15
- 0.0.14
- 0.0.13
- 0.0.12
- 0.0.11
- 0.0.10
- 0.0.9
- 0.0.8
- 0.0.7
- 0.0.6
- 0.0.5
- 0.0.4
- 0.0.3
- 0.0.2
- 0.0.1
- dev-Mortred974-patch-1
- dev-L5.1
- dev-L5.4
This package is auto-updated.
Last update: 2024-12-13 09:39:18 UTC
README
This package allows to quickly attach files to your models, retrievable by key, group name or using the Eloquent relationship.
Can also be installed on Laravel 5.4, see below
Installation
You can install this package via composer. Laravel 5.5+ auto discovers the service provider.
composer require bnbwebexpertise/laravel-attachments
Older Laravel 5.4 install
For 5.4 support install version 0.0.16 :
composer require bnbwebexpertise/laravel-attachments:0.0.16
Then add the service provider to your configuration :
'providers' => [ // ... Bnb\Laravel\Attachments\AttachmentsServiceProvider::class, // ... ],
Configuration
You can customize this package behavior by publishing the configuration file :
php artisan vendor:publish --provider='Bnb\Laravel\Attachments\AttachmentsServiceProvider'
Add attachments to a model class
Add the HasAttachment
trait to your model class :
<?php namespace App; use Bnb\Laravel\Attachments\HasAttachment; use Illuminate\Notifications\Notifiable; use Illuminate\Foundation\Auth\User as Authenticatable; class User extends Authenticatable { use Notifiable, HasAttachment; // ... }
Then use it to bind a file to an instance :
$user = App\User::create([ 'name' => 'name', 'email' => 'email@foo.bar', 'password' => 'password', ]); // Bind a local file $attachment = $user->attach('local/path/to/file.txt'); // Bind an uploaded file $attachment = $user->attach(\Request::file('uploaded_file')); // Bind an uploaded file with options $attachment = $user->attach(\Request::file('uploaded_file'), [ 'disk' => 's3', 'title' => \Request::input('attachment_title'), 'description' => \Request::input('attachment_description'), 'key' => \Request::input('attachment_key'), ]);
Retrieve model's attachments
$user = App\User::first(); $allAttachments = $user->attachments()->get(); $attachmentByKey = $user->attachment('myKey'); // Attachment public URL $publicUrl = $attachmentByKey->url;
Regroup model's attachments
The group
attribute allows to group attachements.
The attachementsGroup
method provided by the HasAttachment
trait
returns all the attachments with the given group
value.
$user = App\User::first(); $user->attach($somefile, [' 'group' => 'album', ']); $user->attach($otherfile, [' 'group' => 'album', ']); $attachmentsByGroup = $user->attachmentsGroup('album');
Delete an attachment
Calling the delete()
method on an attachment model instance will
delete the database row and the file. The deletion of the file can
be disabled by setting the behaviors.cascade_delete
to false
in
the configuration.
Note that calling
delete()
on aquery()
like statement will not cascade to the filesystem because it will not call thedelete()
method of theAttachment
model class.
$user = App\User::first(); $attachmentByKey = $user->attachment('myKey'); $attachmentByKey->delete(); // Will also delete the file on the storage by default
Soft Deletes
The package also supports the Laravel's SoftDeletes trait (disabled by default).
It can be enabled by setting the behaviors.soft_delete
to true
in
the configuration.
Note that
behaviors.cascade_delete
setting will then work only with theforceDelete()
method of theAttachment
model class. All the files will be kept while the record is soft-deleted
Hooking the file output
The Bnb\Laravel\Attachments\Attachment
model class provides
an outputting
event that you can observe.
In the application service provider you could write for example :
<?php use Bnb\Laravel\Attachments\Attachment; class AppServiceProvider extends ServiceProvider { // ... public function boot() { // ... Attachment::outputting(function ($attachment) { /** @var Attachment $attachment */ // Get the related model $model = $attachment->model; if (empty($model)) { // Deny output for attachments not linked to a model return false; } if ($model instanceof \App\User) { // Check if current user is granted and owner $user = \Auth::user(); return $user && $user->can('download-file') && $user->id == $model->id; } }); // ... } // ... }
Dropzone
Upload
This package provides a server endpoint for Dropzone.js or equivalent
via the attachments.dropzone
route alias.
It returns the attachment uuid
along other fields as a JSON response.
This value can be sent back later to the server to bind it to a model
instance (deferred saving).
The form :
<form action="{{ route('attachments.dropzone') }}" class="dropzone" id="my-dropzone"> {{ csrf_field() }} </form>
The response :
{ "title": "b39ffd84524b", "filename": "readme.md", "filesize": 2906, "filetype": "text\/html", "uuid": "f5a8eec2-d860-4e53-8451-b39ffd84524b", "key": "58ac52e90db938.72105394", "url": "http:\/\/laravel.dev:8888\/attachments\/f5a8eec2-d860-4e53-8451-b39ffd84524b\/readme.md" }
Send it back later :
<form action="/upload" method="post"> {{ csrf_field() }} <input type="hidden" name="attachment_id" id="attachment_id"> <button type="submit">Save</button> </form> <!-- Where attachment_id is populated on success --> <script> Dropzone.options.myDropzone = { init: function () { this.on("success", function (file, response) { document.getElementById('attachment_id').value = response.uuid; }); } }; </script>
Bind the value later :
<?php Route::post('/upload', function () { $model = App\User::first(); Bnb\Laravel\Attachments\Attachment::attach(Request::input('attachment_id'), $model); return redirect('/dropzone'); });
Delete
The route attachments.dropzone.delete
can be called via HTTP DELETE
.
The attachment ID must be provided as parameter.
The delete action provided by this route only works for pending attachement (not bound to a model).
To prevent deletion of other users file, the current CSRF token is saved when uploading via the dropzone endpoint and it must be the same when calling the dropzone delete endpoint. This behavior can be deactivated via the configuration or env key (see config/attachments.php).
Usage example :
<script> var MyDropzone = { url: "{{ route('attachments.dropzone.delete', ['id' => ':id']) }}" // ... deletedfile: function (file) { axios.delete(this.url.replace(/:id/, file.id)).then(function () { //... }); } //... } </script>
Events
Two event are fired by the dropzone endpoints controller :
attachments.dropzone.uploading
with the$request : Request
as parameterattachments.dropzone.deleting
with the$request : Request
and the$file : Attachement
as parameters
If one of the listeners returns false, the action is aborted.
public function boot() { Event::listen('attachments.dropzone.uploading', function ($request) { return $this->isAllowedToUploadFile($request); }); Event::listen('attachments.dropzone.deleting', function ($request, $file) { return $this->canDeletePendingFile($request, $file); }); }
Temporary URLs
It is possible to generate a unique temporary URL for downloading the attachments via the getTemporaryUrl
method of the Attachment
model, for sharing purposes foremost.
The getTemporaryUrl
method has one parameter : a Carbon
date, after which the link will no longer be valid.
The default generated URL is of the form : http://example.com/attachments/shared/<a very long string>
. The share path can be modified in the config file under the shared_pattern
key.
Cleanup commands
A command is provided to cleanup the attachments not bound to a model
(when model_type
and model_id
are null
).
php artisan attachment:cleanup
The -s
(or --since=[timeInMinutes]
) option can be set to specify
another time limit in minutes : only unbound files older than the
specified age will be deleted. This value is set to 1440 by default.
Migrate command
To migrate all attachments from one source disk to another :
php artisan attachments:migrate public s3
Files are removed from source disk if successfully saved on the target disk.
Customization
Set a custom database connection name for the models
You can customize the database connection name by either :
- Adding an
.env
variable forATTACHMENTS_DATABASE_CONNECTION
(recommended) OR - Changing the configuration option
attachments.database.connection
inconfig/attachments.php
.
Extends Attachment model columns
The configuration defines the list of fillable attachment attributes in the attachment.attributes
key.
This allows you to create migration to add new columns in the attachment table
and declare them in your published config at config/attachments.php
.
Customize the attachment storage directory prefix
You may easily customize the folder/prefix where new attachments are stored by either:
- Adding an
.env
variable forATTACHMENTS_STORAGE_DIRECTORY_PREFIX
(recommended) OR - Changing the configuration option
attachments.storage_directory.prefix
inconfig/attachments.php
.
The default value is attachments
and any trailing /
s will be trimmed automatically.
Customize the attachment storage filepath
If you don't want to use the default storage filepath generation, you can provide the filepath
option (relative to the root of storage disk).
It must contain the directory and filename. It's up to you to ensure that the provided filepath is not in conflict with another file.
$model->attach('/foo/bar/pdf.pdf', ['filepath' => 'foo/bar/test.pdf']);
This does not apply to attachments uploaded via the integrated DropZone controller. Only available for explicit attachments.
Extending the Attachment model class
This can be helpful to add some relations to the attachment model.
Create your own model that extends Bnb\Laravel\Attachments\Attachment
:
<?php namespace App; class MyAttachment extends Bnb\Laravel\Attachments\Attachment { // ... public function someCustomRelation() { // ... } // ... }
To configure your own model class you can use one of the following possibilities :
- Publish the configuration and update the
attachment_model
value - Set the
ATTACHMENTS_MODEL
environment value - Bind your model to the
Bnb\Laravel\Attachments\Contracts\AttachmentContract
interface in a service provider
Examples :
<?php return [ // ... 'attachment_model' => \App\MyAttachment::class, // .. ];
# ... ATTACHMENTS_MODEL=\App\MyAttachment # ...
<?php // ... class AppServiceProvider extends ServiceProvider { // ... public function register() { // ... $this->app->bind( \Bnb\Laravel\Attachments\Contracts\AttachmentContract::class, \App\MyAttachment::class ); // ... } // ... }