baaaaane/image-optimizer

Image optimizer

v1.0.2 2019-09-03 09:41 UTC

Requires

• php: ^7.2
• illuminate/container: ^5.7
• spatie/image-optimizer: ^1.1
• symfony/var-dumper: ^4.1.1

Requires (Dev)

• mockery/mockery: ^1.0
• phpunit/phpunit: ^7.0

MIT

• Arianne Nicole Batac

README

This package can generate different size of optimized images (Thumbnail-Mobile-Desktop). Here's how you can use it:

use Baaane\ImageOptimizer\Action\ImageOptimizer;

$imageOptimizer = new ImageOptimizer($defaultPath);

$imageOptimizer->upload($_FILES['filename']);

Installation

You can install the package via github or composer

git clone https://github.com/baaane/image-optimizer.git

composer require baaaaane/image-optimizer

Tools

This package is required in this library to optimize the image:

• image-optimizer

Here's how to install via composer:

composer require spatie/image-optimizer

Instructions

The filenames can be randomized or customized by the user.

UploadFile from Laravel's request. (OPTIONAL)

$imageOptimizer->uploadRequestFile($request->file('filename'));

Set File Path - use it before upload() (OPTIONAL)

$imageOptimizer->setPath($optionalPath)->upload();

Customizable Name (OPTIONAL)

$new_name = [
    'new_name' => 'new_name1'
];

Customizable Size (FORMAT: WIDTH, HEIGHT) (OPTIONAL)

$size = [
    'size' => $imageOptimizer->setThumbnailSize(width,height)
                            ->setMobileSize(width,height)
                            ->setDesktopSize(width,height)
                            ->get(), 
];

For multiple uploads, use this line of code for re-arrange the array before pass it to imageOptimizer->upload():

$data = $imageOptimizer->reArray($data_merge);

Delete Original File - use it before upload() (OPTIONAL)

$imageOptimizer->deleteOriginalFile()->upload();

Parameter for upload should be an array. It should look like this:

[
    'name' => 'uploaded-image.jpg',
    'type' => 'image/jpeg',
    'size' => 542,
    'tmp_name' => __DIR__. '/_files/test.jpg',
    'error' => 0,
    'new_name' => 'new_name1',
    'new_size' => [
        'thumbnail' => [
            'width' => 200,
            'height' => 200
        ]
        'mobile' => [
            'width' => 691,
            'height' => 961
        ]
        'desktop' => [
            'width' => 1920,
            'height' => 1080
        ]
    ]
]

Sample Single Upload

// Before merge
$_FILES = [
    'filename' => [
        'name' => 'uploaded-image.jpg',
        'type' => 'image/jpeg',
        'size' => 542,
        'tmp_name' =>	__DIR__. '/_files/test.jpg',
        'error' => 0,
    ]
];

// OPTIONAL PARAMETER: If the input post is string, convert it to array
$new_name = [
	'new_name' => 'new_name1'
];

// OPTIONAL PARAMETER: If the input post is string, convert it to array
$new_size = [
    'new_size' => $imageOptimizer->setThumbnailSize(200,200)
                                ->setMobileSize(691,961)
                                ->setDesktopSize(1920,1080)
                                ->get(), 
];

// Then merge
$data = array_merge($_FILES['filename'], $new_name, $new_size);

// OPTIONAL PARAMETER: desired path of uploaded files
$path = __DIR__. '/_files';

$imageOptimizer = new ImageOptimizer($defaultPath);
$imageOptimizer->setPath($optionalPath)->upload($data);

Sample Multiple Upload

$_FILES = [
    'filename' => [
        'name' => [
            0 => 'uploaded-image.jpg',
            1 => 'uploaded-image1.jpg',
        ],
        'type' => [
            0 => 'image/jpeg',
            1 => 'image/jpeg',
        ],
        'size' => [
            0 => 542,
            1 => 542,
        ],
        'tmp_name' => [
            0 => __DIR__. '/_files/test.jpg',
            1 => __DIR__. '/_files/test1.jpg',
        ],
        'error' => [
            0 => 0,
            1 => 0,
        ]
    ]
];

// OPTIONAL PARAMETER: If the input post is string, convert it to array
$new_name = [
    'new_name' => ['new_name1', 'new_name2']
];

// OPTIONAL PARAMETER: If the input post is string, convert it to array
$size = [ 
    'new_size' => [
        $imageOptimizer->setThumbnailSize(200,200)
                        ->setMobileSize(691,961)
                        ->setDesktopSize(800,750)
                        ->get(),
        $imageOptimizer->setThumbnailSize()
                        ->setMobileSize(345,789)
                        ->setDesktopSize(0,0)
                        ->get(),
    ]
];

// Then merge
$data_merge = array_merge($_FILES['filename'], $new_name, $new_size);

// Re-arrange the merge data array
$data = $imageOptimizer->reArray($data_merge);

// OPTIONAL PARAMETER: desired path of uploaded files
$path = __DIR__. '/_files';

$imageOptimizer = new ImageOptimizer(defaultPath);
$imageOptimizer->setPath($optionalPath)->upload($data);

Sample retrieve files after uploading. Return an array upon success.

// single upload file
Array 
(
  0 => Array (
    "thumbnail" => "/_files/thumbnail_new_name1.jpg"
    "mobile" => "/_files/mobile_new_name1.jpg"
    "desktop" => "/_files/desktop_new_name1.jpg"
  )
)

// multiple upload file
Array 
(
  0 => Array (
    "thumbnail" => "/_files/thumbnail_new_name1.jpg"
    "mobile" => "/_files/mobile_new_name1.jpg"
    "desktop" => "/_files/desktop_new_name1.jpg"
  )
  1 => Array (
    "thumbnail" => "/_files/thumbnail_new_name2.jpg"
    "mobile" => "/_files/mobile_new_name2.jpg"
    "desktop" => "/_files/desktop_new_name2.jpg"
  )
)

Example conversions

Here are the example conversions done by this package.

Original:

1920 x 1080 | JPEG | 272KB

Optimized and Converted to Desktop | Mobile | Thumbnail:

Desktop 1920 x 1080 | JPEG | 218KB

Mobile 690 x 960 | JPEG | 50KB

Thumbnail 300x300 | JPEG | 14KB

Credits

• Spatie This package has been inspired by spatie/image-optimizer

License

The MIT License (MIT). Please see License File for more information.