README

Take newly added media backup associated with any model rather than full backup on daily basis.

This package will be useful in the case where you have lot of media/attachment with any models but rather than taking all media directories each day it might be better to just take newly added media.

BinBytes is an web & mobile application development agency in Rajkot, India. You'll find an overview of all our services on our website.

Installation

You can install this package via composer using:

$ composer require binbytes/laravel-model-media-backup

The package will automatically register itself.

To publish the config file to config/modelmediabackup.php run:

php artisan vendor:publish --provider="BinBytes\ModelMediaBackup\ModelMediaBackupServiceProvider"

This will publish a file modelmediabackup.php in your config directory with the following contents:

return [
    /*
     * Models from which you want to take media for backup
     */
    'models' => [
        // Example 'App\User'
    ],

    /*
     * Backup FILESYSTEM_DRIVER name on which you want to take backup
     */
    'backup_disk' => null, // FILESYSTEM_DRIVER

    /*
     * Number of records to be chunk in backup process
     */
    'chunk_size' => 100,

    /*
     * Notification configuration
     */
    'notification' => [

        /*
         * Email address where you want to receive email alert
         */
        'mail_to' => null,

        /*
         * Here you can specify the notifiable to which the notifications should be sent. The default
         *
         * notifiable will use the variables specified in this config file.
         */
        'notifiable' => \BinBytes\ModelMediaBackup\Notifications\Notifiable::class,

        'notifications' => [
            \BinBytes\ModelMediaBackup\Notifications\Notifications\MediaBackupSuccessful::class,
        ],
    ],
];

Usage

After you've installed the package and filled in the values in the config-file, you need to setup model from which you want to take media.

Your Eloquent models should use the BinBytes\ModelMediaBackup\Traits\HasBackupRecord trait.

The trait contains an abstract method backupFiles() that you must implement yourself.

Here's an example of how to implement the trait:

<?php

namespace App;

use BinBytes\ModelMediaBackup\Traits\HasBackupRecords;
use Illuminate\Database\Eloquent\Model;

class YourEloquentModel extends Model
{
    use HasBackupRecords;

    /**
     * Media file associated with record
     * @return string|array
     */
    public function backupFiles()
    {
        return $this->path(); // Full path of your media file OR array of paths
    }
}

Want to take records as per own strategy? according to your need? No problem! By default the records of yesterday will be taken for backup.

/**
 * Select records to processed
 */
public static function backupRecords()
{
    return self::latest()
            ->whereDate('created_at', Carbon::yesterday()->toDateString());
}

Now you are ready to go, just run below artisan command to take backup

php artisan model:media:backup

To run backup on daily basis add this in App\Console\Kernel

$schedule->command('model:media:backup')->daily();

Security

If you discover any security related issues, please email author email instead of using the issue tracker.

Credits

License

MIT License. Please see the license file for more information.

binbytes / laravel-model-media-backup

Maintainers

Details