Interface luya\admin\ngrest\render\RenderCrudInterface

Implemented byluya\admin\ngrest\render\RenderCrud
Available since version1.0.0

Interface for CRUD renderers.

All CRUD renderers must implement this interface in order to interact with the API and Controllers.

Public Methods

Hide inherited methods

Method Description Defined By
canCreate() Whether create permission is granted. luya\admin\ngrest\render\RenderCrudInterface
canDelete() Whether delete permission is granted. luya\admin\ngrest\render\RenderCrudInterface
canUpdate() Whether update permission is granted. luya\admin\ngrest\render\RenderCrudInterface
getActivePoolConfig() Returns the pool config array for the current active pool if any. luya\admin\ngrest\render\RenderCrudInterface
getIsInline() Get whether the inline mode is enabled or not. luya\admin\ngrest\render\RenderCrudInterface
getModel() luya\admin\ngrest\render\RenderCrudInterface
getModelSelection() Model selection value from setter method. luya\admin\ngrest\render\RenderCrudInterface
getRelationCall() Get an array with all relations luya\admin\ngrest\render\RenderCrudInterface
getSettingButtonDefinitions() Get an array with additionals button definitions. luya\admin\ngrest\render\RenderCrudInterface
setIsInline() Setter method for inline mode. luya\admin\ngrest\render\RenderCrudInterface
setModel() Set the current ngrest model for the crud. luya\admin\ngrest\render\RenderCrudInterface
setModelSelection() Model preselection value when using ngrest relation calls. luya\admin\ngrest\render\RenderCrudInterface
setRelationCall() Set an array with relations. luya\admin\ngrest\render\RenderCrudInterface
setSettingButtonDefinitions() Optional definitions for settings button. Those definitions are made in the ngrest crud controller. luya\admin\ngrest\render\RenderCrudInterface

Method Details

Hide inherited methods

canCreate() public abstract method

Whether create permission is granted.

public abstract boolean canCreate ( )
return boolean

Whether current user can create items.

                public function canCreate();

            
canDelete() public abstract method

Whether delete permission is granted.

public abstract boolean canDelete ( )
return boolean

Whether current user can update items.

                public function canDelete();

            
canUpdate() public abstract method

Whether update permission is granted.

public abstract boolean canUpdate ( )
return boolean

Whether current user can update items.

                public function canUpdate();

            
getActivePoolConfig() public abstract method (available since version 2.0.0)

Returns the pool config array for the current active pool if any.

public abstract array getActivePoolConfig ( )

                public function getActivePoolConfig();

            
getIsInline() public abstract method

Get whether the inline mode is enabled or not.

public abstract boolean getIsInline ( )
return boolean

Determine whether this ngrest config is runing as inline window mode (a modal dialog with the crud inside) or not. When inline mode is enabled some features like ESC-Keys and URL chaning must be disabled.

                public function getIsInline();

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

public abstract luya\admin\ngrest\base\NgRestModelInterface getModel ( )
return luya\admin\ngrest\base\NgRestModelInterface

Returns the current ngrest model object.

                public function getModel();

            
getModelSelection() public abstract method

Model selection value from setter method.

public abstract string|boolean getModelSelection ( )

                public function getModelSelection();

            
getRelationCall() public abstract method

Get an array with all relations

public abstract array getRelationCall ( )

                public function getRelationCall();

            
getSettingButtonDefinitions() public abstract method

Get an array with additionals button definitions.

public abstract array getSettingButtonDefinitions ( )

                public function getSettingButtonDefinitions();

            
setIsInline() public abstract method

Setter method for inline mode.

public abstract void setIsInline ( $inline )
$inline boolean

                public function setIsInline($inline);

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

Set the current ngrest model for the crud.

public abstract void setModel ( luya\admin\ngrest\base\NgRestModelInterface $model )
$model luya\admin\ngrest\base\NgRestModelInterface

                public function setModel(NgRestModelInterface $model);

            
setModelSelection() public abstract method

Model preselection value when using ngrest relation calls.

public abstract void setModelSelection ( $selection )
$selection string

                public function setModelSelection($selection);

            
setRelationCall() public abstract method

Set an array with relations.

public abstract void setRelationCall ( array $options )
$options array

                public function setRelationCall(array $options);

            
setSettingButtonDefinitions() public abstract method

Optional definitions for settings button. Those definitions are made in the ngrest crud controller.

public abstract void setSettingButtonDefinitions ( array $buttons )
$buttons array

                public function setSettingButtonDefinitions(array $buttons);