luyadev/luya-module-admin

<?php

namespace luya\admin\ngrest\plugins;

use luya\admin\ngrest\base\Plugin;
use Yii;

/**
 * Type Image Upload.
 *
 * Usage example inside your {{luya\admin\ngrest\base\NgRestModel::ngRestAttributeTypes}} method:
 *
 * ```php
 * return [
 *     'myimage' => 'image',
 * ];
 * ```
 *
 * If you like to get the {{luya\admin\image\Item}} object directly from the {{luya\admin\storage\BaseFileSystemStorage}} component just enable `$imageItem`.
 *
 * ```php
 * return [
 *     'myimage' => ['image', 'imageItem' => true],
 * ];
 * ```
 *
 * Now when accessing the `$myimage` variabled defined from above the {{luya\admin\image\Item}} will be returned ottherwise false.
 *
 * If the user should not have the ability to selecte a filter disable `$filter`.
 *
 * ```php
 * return [
 *     'myimage' => ['filter' => false],
 * ];
 * ```
 *
 * @author Basil Suter <basil@nadar.io>
 * @since 1.0.0
 */
class Image extends Plugin
{
    /**
     * @var boolean Whether the user can choose a filter or not.
     */
    public $filter = true;

    /**
     * @var boolean Whether to return a {{luya\admin\image\Item}} instead of the numeric image id value from the database.
     */
    public $imageItem = false;

    /**
     * @inheritdoc
     */
    public function renderList($id, $ngModel)
    {
        return $this->createTag('storage-image-crud-list', null, ['image-id' => "{{{$ngModel}}}"]);
    }

    /**
     * @inheritdoc
     */
    public function renderCreate($id, $ngModel)
    {
        return $this->createFormTag('zaa-image-upload', $id, $ngModel, ['options' => json_encode(['no_filter' => !$this->filter], JSON_THROW_ON_ERROR)]);
    }

    /**
     * @inheritdoc
     */
    public function renderUpdate($id, $ngModel)
    {
        return $this->renderCreate($id, $ngModel);
    }

    /**
     * @inheritDoc
     */
    public function onAfterFind($event)
    {
        if ($this->imageItem) {
            $this->writeAttribute($event, Yii::$app->storage->getImage($event->sender->getAttribute($this->name)));
        }

        return true;
    }

    public function serviceData($event)
    {
        return [
            'lazyload_images' => true,
        ];
    }
}