opensmarty/opensmarty-image

Opensmarty Image is a helper service to handle uploaded images and store images without duplicates.

Opensmarty Image Service

, _(*1)

Opensmarty Image is a helper service to handle uploaded images and store images without duplicates., _(*2)

Build for Laravel and Opensmarty Starter., _(*3)

Install

Via Composer

Install composer package to your laravel project, _(*4)

``` bash composer require opensmarty/opensmarty-image, <sub>(*5)</sub>

Add Service Provider to `config/app.php`

``` php
    'providers' => [
        ...
        Opensmarty\Image\OpensmartyImageServiceProvider::class,
        ...
    ],

Publishing config file., <sub>(*6)</sub>

``` bash php artisan vendor:publish, <sub>(*7)</sub>

After published, config file for Rest Client is `config/opensmarty-image.php`, you will need to config it to use Rest Client.

## Usage

#### Routes

``` php
Route::get('/image/{name}', 'ImageController@showOriginalImage');
Route::post('/image', 'ImageController@postImage');

Many Imageables

Use on the Model:, <sub>(*8)</sub>

    use OpensmartyHasImageablesTrait;

Usage:, <sub>(*9)</sub>

``` php, <sub>(*10)</sub>

/** @var OpensmartyImage $opensmartyImage */ $opensmartyImage = OpensmartyImage::find(1);, <sub>(*11)</sub>

/** @var User $user */ $user = User::find(1);, <sub>(*12)</sub>

// save image relations smartly with sequence support (recommended) $user->syncImages([1, 2], ['type' => 'cover', 'data' => json_encode('a')]);, <sub>(*13)</sub>

// save image relations via save $user->images()->save($opensmartyImage, ['type' => 'cover', 'data' => json_encode('a')]);, <sub>(*14)</sub>

// save image relations via attach $user->images()->attach(1, ['type' => 'cover', 'data' => json_encode('a')]);, <sub>(*15)</sub>

// update image relations via sync $user->images()->sync([1]);, <sub>(*16)</sub>

// set as main image $user->setAsMainImage($opensmartyImage);, <sub>(*17)</sub>

// set as type main image $user->setAsTypeMainImage('cover', $opensmartyImage);, <sub>(*18)</sub>

// get all images print_r($user->getImages()->toArray());, <sub>(*19)</sub>

// get first main image print_r($user->getMainImage()->toArray());, <sub>(*20)</sub>

// get all main images print_r($user->getMainImages()->toArray());, <sub>(*21)</sub>

// get all type images print_r($user->getTypeImages('cover')->toArray());, <sub>(*22)</sub>

// get all type images and are main images print_r($user->getTypeMainImages('cover')->toArray());, <sub>(*23)</sub>

#### Sample Controller File

`app/Http/Controllers/ImageController.php`

``` php
<?php namespace App\Http\Controllers;

use Exception;
use Illuminate\Http\Request;
use Opensmarty\Image\Controllers\OpensmartyImageController;
use Opensmarty\Models\Image\OpensmartyImage;
use Opensmarty\Image\OpensmartyImageService;

class ImageController extends Controller
{

    public function postImage(Request $request)
    {
        $opensmartyImageService = new OpensmartyImageService();
        $file = $request->file('image');

        $opensmartyImage = null;
        try {
            /** @var OpensmartyImage $opensmartyImage */
            $opensmartyImage = $opensmartyImageService->handleUploadedFile($file);
        } catch (Exception $e) {
            return 'Failed to save: ' . $e->getMessage();
        }

        if (!$opensmartyImage) {
            return 'Failed to save uploaded image.';
        }

        $opensmartyImageId = $opensmartyImage->getOpensmartyImageId();
        return 'Saved: ' . $opensmartyImage->getImageUrl();
    }

    public function showOriginalImage($image_name)
    {
        return OpensmartyImageController::showImage('original', $image_name);
    }

}

Testing

bash phpunit, <sub>(*24)</sub>

Contributing

Please see CONTRIBUTING for details., <sub>(*25)</sub>

Credits

• Opensmarty
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*26)</sub>