Interface luya\admin\ngrest\ConfigInterface

All Classes | Methods
Implemented byluya\admin\ngrest\Config
Available since version1.0.0
Source Code https://github.com/luyadev/luya-module-admin/blob/master/src/ngrest/ConfigInterface.php

NgRest Config Interface

Public Methods

Hide inherited methods

Method Description Defined By
getActiveButtons() Get an array with the button configuration like hash, label and icon. luya\admin\ngrest\ConfigInterface
getActiveSelections() Returns an array with object instance of {{luya\admin\ngrest\base\ActiveSelection}} luya\admin\ngrest\ConfigInterface
getApiEndpoint() luya\admin\ngrest\ConfigInterface
getAttributeGroups() luya\admin\ngrest\ConfigInterface
getConfig() luya\admin\ngrest\ConfigInterface
getDefaultOrderDirection() luya\admin\ngrest\ConfigInterface
getDefaultOrderField() luya\admin\ngrest\ConfigInterface
getExtraFields() luya\admin\ngrest\ConfigInterface
getFilters() luya\admin\ngrest\ConfigInterface
getGroupByExpanded() Determine whether the groups are expanded by default or not. luya\admin\ngrest\ConfigInterface
getGroupByField() luya\admin\ngrest\ConfigInterface
getHash() luya\admin\ngrest\ConfigInterface
getOption() luya\admin\ngrest\ConfigInterface
getPrimaryKey() luya\admin\ngrest\ConfigInterface
getRelations() luya\admin\ngrest\ConfigInterface
getTableName() luya\admin\ngrest\ConfigInterface
onFinish() luya\admin\ngrest\ConfigInterface
setAttributeLabels() luya\admin\ngrest\ConfigInterface
setConfig() luya\admin\ngrest\ConfigInterface
setDefaultOrder() luya\admin\ngrest\ConfigInterface

Method Details

Hide inherited methods

getActiveButtons() public abstract method (available since version 1.2.3)

Get an array with the button configuration like hash, label and icon.

public abstract array getActiveButtons ( )
return array

An array with hash, label and icon key.

 

                public function getActiveButtons();
getActiveSelections() public abstract method (available since version 4.0.0)

Returns an array with object instance of {{luya\admin\ngrest\base\ActiveSelection}}

public abstract luya\admin\ngrest\base\ActiveSelection[] getActiveSelections ( )

                public function getActiveSelections();
getApiEndpoint() public abstract method

public abstract void getApiEndpoint ( )

                public function getApiEndpoint();
getAttributeGroups() public abstract method

public abstract void getAttributeGroups ( )

                public function getAttributeGroups();
getConfig() public abstract method

public abstract void getConfig ( )

                public function getConfig();
getDefaultOrderDirection() public abstract method

public abstract void getDefaultOrderDirection ( )

                public function getDefaultOrderDirection();
getDefaultOrderField() public abstract method

public abstract void getDefaultOrderField ( )

                public function getDefaultOrderField();
getExtraFields() public abstract method

public abstract void getExtraFields ( )

                public function getExtraFields();
getFilters() public abstract method

public abstract void getFilters ( )

                public function getFilters();
getGroupByExpanded() public abstract method (available since version 1.2.2.1)

Determine whether the groups are expanded by default or not.

If enabled, the groups are expanded otherwise they are collapsed.

public abstract boolean getGroupByExpanded ( )

                public function getGroupByExpanded();
getGroupByField() public abstract method

public abstract void getGroupByField ( )

                public function getGroupByField();
getHash() public abstract method

public abstract void getHash ( )

                public function getHash();
getOption() public abstract method

public abstract void getOption ( $key )
$key 

                public function getOption($key);
getPrimaryKey() public abstract method

public abstract void getPrimaryKey ( )

                public function getPrimaryKey();
getRelations() public abstract method

public abstract void getRelations ( )

                public function getRelations();
getTableName() public abstract method

public abstract void getTableName ( )

                public function getTableName();
onFinish() public abstract method

public abstract void onFinish ( )

                public function onFinish();
setAttributeLabels() public abstract method

public abstract void setAttributeLabels ( array $labels )
$labels 

                public function setAttributeLabels(array $labels);
setConfig() public abstract method

public abstract void setConfig ( array $config )
$config 

                public function setConfig(array $config);
setDefaultOrder() public abstract method

public abstract void setDefaultOrder ( $defaultOrder )
$defaultOrder 

                public function setDefaultOrder($defaultOrder);