Interface luya\admin\aws\FlowActiveWindowInterface

All Classes | Methods

Available since version	1.0.0
Source Code	https://github.com/luyadev/luya-module-admin/blob/master/src/aws/FlowActiveWindowInterface.php

This interface must be implement by the model class provided in the FlowActiveWindow modelClass property.

Example implementations for FlowActiveWindowInterface on a NgRest or ActiveRecord Model:

public function flowSaveImage(Item $image)
{
    Yii::$app->db->createCommand()->insert('flow_gallery', [
        'model_id' => $this->id,
        'image_id' => $image->id,
    ])->execute();
}

public function flowDeleteImage(Item $image)
{
	Yii::$app->db->createCommand()->delete('flow_gallery', ['image_id' => $image->id])->execute();
}

public function flowListImages()
{
    return ArrayHelper::getColumn((new Query())->select(['image_id'])->from('flow_gallery')->where(['model_id' => $this->id])->indexBy('image_id')->all(), 'image_id');
}

You can aslo use the admin\aws\FlowActiveWindowTrait which enables those methods and you only have to configure the relation table between the model/item and the image.

use FlowActiveWindowTrait;

public function flowConfig()
{
    return [
        'table' => 'relation_table_name', // the table which contains the relation data between model/item and image.
        'itemField' => 'group_id', // the field defined on where the window is attached
        'imageField' => 'image_id', // the value of the image id can be stored in.
    ];
}

Public Methods

Hide inherited methods

Method	Description	Defined By
findOne()	Active Record findOne method to retrieve the model row by the itemId.	luya\admin\aws\FlowActiveWindowInterface
flowDeleteImage()	This method will be called when the delete button will be triggered for an uploaded image. Now you should removed the corresponding reference item in your database table. The image objec deletion will be trigger by the active window.	luya\admin\aws\FlowActiveWindowInterface
flowListImages()	Get an array with all ids for the storage component. Only the image ids for the current model/item id should be returned:	luya\admin\aws\FlowActiveWindowInterface
flowSaveImage()	This method will be called when the storage item is created, so you can perform the database save action by implementing this method.	luya\admin\aws\FlowActiveWindowInterface

Method Details

Hide inherited methods

findOne() public abstract static method

Active Record findOne method to retrieve the model row by the itemId.

public abstract static void findOne ( $condition )
$condition	mixed

Source code

                public static function findOne($condition);

flowDeleteImage() public abstract method

This method will be called when the delete button will be triggered for an uploaded image. Now you should removed the corresponding reference item in your database table. The image objec deletion will be trigger by the active window.

public abstract void flowDeleteImage ( luya\admin\image\Item $image )
$image	\admin\image\Item

Source code

                public function flowDeleteImage(Item $image);

flowListImages() public abstract method

Get an array with all ids for the storage component. Only the image ids for the current model/item id should be returned:

return [1,2,3]; // where 1,2,3 are ids of the image from the storage component

public abstract array flowListImages ( )
return	array	An array where only the images are returned.

Source code

                public function flowListImages();

flowSaveImage() public abstract method

This method will be called when the storage item is created, so you can perform the database save action by implementing this method.

public abstract void flowSaveImage ( luya\admin\image\Item $image )
$image	\admin\image\Item	The storage image item object which has been generated from active window.

Source code

                public function flowSaveImage(Item $image);