Interface luya\admin\ngrest\base\ActiveWindowInterface

Implemented byluya\admin\aws\ApiOverviewActiveWindow, luya\admin\aws\ApiRequestInsightActiveWindow, luya\admin\aws\ChangePasswordActiveWindow, luya\admin\aws\CoordinatesActiveWindow, luya\admin\aws\DeleteTagsActiveWindow, luya\admin\aws\DetailViewActiveWindow, luya\admin\aws\FlowActiveWindow, luya\admin\aws\GroupAuthActiveWindow, luya\admin\aws\ImageSelectCollectionActiveWindow, luya\admin\aws\StorageFilterImagesActiveWindow, luya\admin\aws\TaggableActiveWindow, luya\admin\aws\UserHistorySummaryActiveWindow, luya\admin\ngrest\base\ActiveWindow, luya\cms\admin\aws\BlockPagesActiveWindow
Available since version1.0.0

Active Window Interface.

Public Methods

Hide inherited methods

Method Description Defined By
getIcon() Return the current icon defined for this Active Window. luya\admin\ngrest\base\ActiveWindowInterface
getIsCompositeItem() luya\admin\ngrest\base\ActiveWindowInterface
getItemId() Get the item id of the current ActiveWindow context item id. luya\admin\ngrest\base\ActiveWindowInterface
getItemIds() Returns an array with all items if its a composite key. luya\admin\ngrest\base\ActiveWindowInterface
getLabel() Return the current label defined for this Active Window. luya\admin\ngrest\base\ActiveWindowInterface
getTitle() By default the title just returns the {{getLabel()}} value if not overriden. luya\admin\ngrest\base\ActiveWindowInterface
index() The default action which is going to be requested when clicking the active window. luya\admin\ngrest\base\ActiveWindowInterface
setActiveWindowHash() Set the hash of the current active window which is calculated by the ActiveWindow. luya\admin\ngrest\base\ActiveWindowInterface
setConfigHash() Set the current configratuion hash name to the ActiveWindow. luya\admin\ngrest\base\ActiveWindowInterface
setItemId() Set the value of the item Id in where the active window context is initialized. luya\admin\ngrest\base\ActiveWindowInterface

Method Details

Hide inherited methods

getIcon() public abstract method

Return the current icon defined for this Active Window.

public abstract string getIcon ( )
return string

Returns the material icon name as string.

                public function getIcon();

            
getIsCompositeItem() public abstract method

public abstract \luya\admin\ngrest\base\Whether getIsCompositeItem ( )
return \luya\admin\ngrest\base\Whether

The current item is a composite key or not.

                public function getIsCompositeItem();

            
getItemId() public abstract method

Get the item id of the current ActiveWindow context item id.

public abstract integer|array getItemId ( )
return integer|array

If its a composite key an array is returned, otherwise the integer number for the PK.

                public function getItemId();

            
getItemIds() public abstract method

Returns an array with all items if its a composite key.

public abstract array getItemIds ( )

                public function getItemIds();

            
getLabel() public abstract method

Return the current label defined for this Active Window.

public abstract string getLabel ( )
return string

Returns the label of the active window, keep in mind this value has not model context.

                public function getLabel();

            
getTitle() public abstract method (available since version 1.2.2)

By default the title just returns the {{getLabel()}} value if not overriden.

In getTitle() its allowed to access the model context, which is not allowed in {{getLabel()}}.

Display the username as title could look like this:

public function getTitle()
{
    return $this->model->username;
}
public abstract string getTitle ( )
return string

Returns the title string which can have model context.

                public function getTitle();

            
index() public abstract method

The default action which is going to be requested when clicking the active window.

public abstract string index ( )
return string

The response string, render and displayed trough the angular ajax request.

                public function index();

            
setActiveWindowHash() public abstract method

Set the hash of the current active window which is calculated by the ActiveWindow.

Setting the hash happens in the {{luya\admin\ngrest\render\RenderActiveWindow::render}} method.

public abstract void setActiveWindowHash ( $hash )
$hash string

                public function setActiveWindowHash($hash);

            
setConfigHash() public abstract method

Set the current configratuion hash name to the ActiveWindow.

Setting the hash happens in the {{luya\admin\ngrest\render\RenderActiveWindow::render}} method.

public abstract void setConfigHash ( $hash )
$hash string

The hash name of the current active config.

                public function setConfigHash($hash);

            
setItemId() public abstract method

Set the value of the item Id in where the active window context is initialized.

public abstract void setItemId ( $id )
$id integer

The item id context

                public function setItemId($id);