Class luya\admin\apis\LoggerController

Inheritanceluya\admin\apis\LoggerController » luya\admin\ngrest\base\Api » luya\admin\base\RestActiveController » luya\rest\ActiveController » yii\rest\ActiveController » yii\rest\Controller » yii\web\Controller » yii\base\Controller » yii\base\Component » yii\base\BaseObject
Implementsluya\rest\UserBehaviorInterface, yii\base\Configurable, yii\base\ViewContextInterface
Uses Traitsluya\admin\traits\AdminRestBehaviorTrait, luya\traits\RestBehaviorsTrait
Available since version1.0.0

Logger Api to list the logger model data.

Public Properties

Hide inherited properties

Property Type Description Defined By
$action yii\base\Action|null The action that is currently being executed. yii\base\Controller
$actionParams array The parameters bound to the current action. yii\web\Controller
$actionPermissions array luya\admin\base\RestActiveController
$authOptional array List of action IDs that this filter will be applied to, but auth failure will not lead to error. luya\traits\RestBehaviorsTrait
$behaviors yii\base\Behavior[] List of behaviors attached to this component. yii\base\Component
$cacheDependency array|string Define a yii caching depency will enable the caching for this API. luya\admin\ngrest\base\Api
$compositeAuthMethods array luya\traits\RestBehaviorsTrait
$createScenario string The create scenario name from self::SCENARIO_RESTCREATE luya\rest\ActiveController
$dataFilter array|boolean luya\admin\ngrest\base\Api
$defaultAction string The ID of the action that is used when the action ID is not specified in the request. yii\base\Controller
$enableCors boolean Whether CORS should be enabled or not. luya\traits\RestBehaviorsTrait
$enableCsrfValidation boolean Whether to enable CSRF validation for the actions in this controller. yii\rest\Controller
$filterSearchModelClass string When a filter model is provided filter is enabled trough json request body, works only for index and list. luya\admin\ngrest\base\Api
$id string The ID of this controller. yii\base\Controller
$jsonCruft boolean Whether a unparsable cruf should be added to the json response or not. luya\traits\RestBehaviorsTrait
$languages array An array with languages which are passed to {{yii\filters\ContentNegotiator::$languages}}. luya\traits\RestBehaviorsTrait
$layout string|null|false The name of the layout to be applied to this controller's views. yii\base\Controller
$model \luya\admin\ngrest\NgRestModel Get the model object based on the $modelClass property. luya\admin\ngrest\base\Api
$modelClass string Defines the related model for the NgRest Controller. luya\admin\apis\LoggerController
$module yii\base\Module The module that this controller belongs to. yii\base\Controller
$modules yii\base\Module[] All ancestor modules that this controller is located within. yii\base\Controller
$pagination array An array with default pagination configuration luya\admin\ngrest\base\Api
$request yii\base\Request|array|string The request. yii\base\Controller
$response yii\base\Response|array|string The response. yii\base\Controller
$route string The route (module ID, controller ID and action ID) of the current request. yii\base\Controller
$serializer string|array The configuration for creating the serializer that formats the response data. yii\rest\Controller
$truncateAction boolean If enabled, the truncate action is attached to the API. luya\admin\apis\LoggerController
$uniqueId string The controller ID that is prefixed with the module ID (if any). yii\base\Controller
$updateScenario string The update scenario name from self::SCENARIO_RESTUPDATE luya\rest\ActiveController
$view yii\base\View|yii\web\View The view object that can be used to render views or view files. yii\base\Controller
$viewPath string The directory containing the view files for this controller. yii\base\Controller

Protected Properties

Hide inherited properties

Property Type Description Defined By
$authId integer Contains the id of the current running auth id luya\admin\base\RestActiveController

Public Methods

Hide inherited methods

Method Description Defined By
__call() Calls the named method which is not a class method. yii\base\Component
__clone() This method is called after the object is created by cloning an existing one. yii\base\Component
__construct() yii\base\Controller
__get() Returns the value of a component property. yii\base\Component
__isset() Checks if a property is set, i.e. defined and not null. yii\base\Component
__set() Sets the value of a component property. yii\base\Component
__unset() Sets a component property to be null. yii\base\Component
actionActiveButton() Active Button luya\admin\ngrest\base\Api
actionActiveSelection() Run the active selection handler for the given item luya\admin\ngrest\base\Api
actionActiveWindowCallback() Renders ActiveWindow Callback luya\admin\ngrest\base\Api
actionActiveWindowRender() Render ActiveWindow luya\admin\ngrest\base\Api
actionExport() Export Data. luya\admin\ngrest\base\Api
actionFilter() Filter luya\admin\ngrest\base\Api
actionPermissions() Provide a list of actions with the given permission luya\admin\base\RestActiveController
actionRelationCall() Get Relation Data luya\admin\ngrest\base\Api
actionSearch() Search luya\admin\ngrest\base\Api
actionServices() Service Data luya\admin\ngrest\base\Api
actionToggleNotification() Toggle Notifications luya\admin\ngrest\base\Api
actionUnlock() User Unlock luya\admin\ngrest\base\Api
actions() Declares external actions for the controller. luya\admin\ngrest\base\Api
addActionPermission() Add a permission with a function. luya\admin\base\RestActiveController
afterAction() This method is invoked right after an action is executed. yii\rest\Controller
asJson() Send data formatted as JSON. yii\web\Controller
asXml() Send data formatted as XML. yii\web\Controller
attachBehavior() Attaches a behavior to this component. yii\base\Component
attachBehaviors() Attaches a list of behaviors to the component. yii\base\Component
beforeAction() Ensure the action of rest controllers can not viewed by api users by default. luya\admin\base\RestActiveController
behaviors() Override the default {{yii\rest\Controller::behaviors()}} method. luya\traits\RestBehaviorsTrait
bindActionParams() Binds the parameters to the action. yii\web\Controller
canApiUserAccess() If the current user is an API user this action might be not permitted. As Api Users also acts as proxy for JWT authenticated users sensitive informations could be exposed. luya\admin\traits\AdminRestBehaviorTrait
canGetProperty() Returns a value indicating whether a property can be read. yii\base\Component
canSetProperty() Returns a value indicating whether a property can be set. yii\base\Component
checkAccess() If a user should not get access to the rest api, an ForbiddenHttpException must be thrown: luya\admin\base\RestActiveController
className() Returns the fully qualified name of this class. yii\base\BaseObject
createAction() Creates an action based on the given action ID. yii\base\Controller
detachBehavior() Detaches a behavior from the component. yii\base\Component
detachBehaviors() Detaches all behaviors from the component. yii\base\Component
ensureBehaviors() Makes sure that the behaviors declared in behaviors() are attached to this component. yii\base\Component
findLayoutFile() Finds the applicable layout file. yii\base\Controller
findModel() Get the Model for the API based on a given Id. luya\admin\ngrest\base\Api
findModelClassObject() Find the model for a given class and id. luya\admin\ngrest\base\Api
generateSortAttributes() Generate Sort attributes luya\admin\ngrest\base\Api
getActionPermissions() Get all actions as array from {{actionPermissions()}} method and those wo where inject by {{åddActionPermission}}. luya\admin\base\RestActiveController
getBehavior() Returns the named behavior object. yii\base\Component
getBehaviors() Returns all behaviors attached to this component. yii\base\Component
getCompositeAuthMethods() Return all Auth methods for Composite Auth. luya\traits\RestBehaviorsTrait
getDataFilter() Returns whether the $dataFilter property of IndexAction should be set with the according value. luya\admin\ngrest\base\Api
getModel() Get the ngrest model object (unloaded). luya\admin\ngrest\base\Api
getModules() Returns all ancestor modules of this controller. yii\base\Controller
getRoute() Returns the route of the current request. yii\base\Controller
getUniqueId() Returns the unique ID of the controller. yii\base\Controller
getView() Returns the view object that can be used to render views or view files. yii\base\Controller
getViewPath() Returns the directory containing view files for this controller. yii\base\Controller
getWithRelation() Get the relations for the corresponding action name. luya\admin\ngrest\base\Api
goBack() Redirects the browser to the last visited page. yii\web\Controller
goHome() Redirects the browser to the home page. yii\web\Controller
hasEventHandlers() Returns a value indicating whether there is any handler attached to the named event. yii\base\Component
hasMethod() Returns a value indicating whether a method is defined. yii\base\Component
hasProperty() Returns a value indicating whether a property is defined for this component. yii\base\Component
init() Initializes the object. luya\admin\traits\AdminRestBehaviorTrait
isActionAllowed() Checks if the given action id is allowed or not luya\admin\base\RestActiveController
isActionAuthOptional() Wether the given action id does not required authentication or not. luya\admin\traits\AdminRestBehaviorTrait
off() Detaches an existing event handler from this component. yii\base\Component
on() Attaches an event handler to an event. yii\base\Component
prepareIndexQuery() Prepare Index Query. luya\admin\ngrest\base\Api
prepareListQuery() Prepare the NgRest List Query. luya\admin\ngrest\base\Api
redirect() Redirects the browser to the specified URL. yii\web\Controller
refresh() Refreshes the current page. yii\web\Controller
render() Renders a view and applies layout if available. yii\base\Controller
renderAjax() Renders a view in response to an AJAX request. yii\web\Controller
renderContent() Renders a static string by applying a layout. yii\base\Controller
renderFile() Renders a view file. yii\base\Controller
renderPartial() Renders a view without applying layout. yii\base\Controller
run() Runs a request specified in terms of a route. yii\base\Controller
runAction() Runs an action within this controller with the specified action ID and parameters. yii\base\Controller
sendArrayError() Send Array validation error. luya\traits\RestBehaviorsTrait
sendModelError() Send Model errors with correct headers. luya\traits\RestBehaviorsTrait
setView() Sets the view object to be used by this controller. yii\base\Controller
setViewPath() Sets the directory that contains the view files. yii\base\Controller
trigger() Triggers an event. yii\base\Component
userAuthClass() Get the current user auth object. luya\admin\traits\AdminRestBehaviorTrait
withRelations() Auto add those relations to queries. luya\admin\ngrest\base\Api

Protected Methods

Hide inherited methods

Method Description Defined By
bindInjectedParams() Fills parameters based on types and names in action method signature. yii\base\Controller
findModelFromCondition() This equals to the ActieRecord::findByCondition which is sadly a protected method. luya\admin\ngrest\base\Api
handleNotifications() Add new notification or update to latest primary key if exists luya\admin\ngrest\base\Api
serializeData() Serializes the specified data. yii\rest\Controller
verbs() Declares the allowed HTTP verbs. yii\rest\ActiveController

Events

Hide inherited events

Event Type Description Defined By
EVENT_AFTER_ACTION yii\base\ActionEvent An event raised right after executing a controller action. yii\base\Controller
EVENT_BEFORE_ACTION yii\base\ActionEvent An event raised right before executing a controller action. yii\base\Controller

Constants

Hide inherited constants

Constant Value Description Defined By
SCENARIO_RESTCREATE 'restcreate' luya\rest\ActiveController
SCENARIO_RESTUPDATE 'restupdate' luya\rest\ActiveController

Property Details

Hide inherited properties

$modelClass public property

Defines the related model for the NgRest Controller. The full qualiefied model name is required.

public $modelClass = 'admin\models\User';
public string $modelClass 'luya\admin\models\Logger'
$truncateAction public property (available since version 3.2.0)

If enabled, the truncate action is attached to the API. In order to run the truncate action the delete permission is required.

public boolean $truncateAction true

Method Details

Hide inherited methods

__call() public method

Defined in: yii\base\Component::__call()

Calls the named method which is not a class method.

This method will check if any attached behavior has the named method and will execute it if available.

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

public mixed __call ( $name, $params )
$name string

The method name

$params array

Method parameters

return mixed

The method return value

throws yii\base\UnknownMethodException

when calling unknown method

                public function __call($name, $params)
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $object) {
        if ($object->hasMethod($name)) {
            return call_user_func_array([$object, $name], $params);
        }
    }
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}

            
__clone() public method

Defined in: yii\base\Component::__clone()

This method is called after the object is created by cloning an existing one.

It removes all behaviors because they are attached to the old object.

public void __clone ( )

                public function __clone()
{
    $this->_events = [];
    $this->_eventWildcards = [];
    $this->_behaviors = null;
}

            
__construct() public method
public void __construct ( $id, $module, $config = [] )
$id string

The ID of this controller.

$module yii\base\Module

The module that this controller belongs to.

$config array

Name-value pairs that will be used to initialize the object properties.

                public function __construct($id, $module, $config = [])
{
    $this->id = $id;
    $this->module = $module;
    parent::__construct($config);
}

            
__get() public method

Defined in: yii\base\Component::__get()

Returns the value of a component property.

This method will check in the following order and act accordingly:

  • a property defined by a getter: return the getter result
  • a property of a behavior: return the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $component->property;.

See also __set().

public mixed __get ( $name )
$name string

The property name

return mixed

The property value or the value of a behavior's property

throws yii\base\UnknownPropertyException

if the property is not defined

throws yii\base\InvalidCallException

if the property is write-only.

                public function __get($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        // read property, e.g. getName()
        return $this->$getter();
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name;
        }
    }
    if (method_exists($this, 'set' . $name)) {
        throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}

            
__isset() public method

Defined in: yii\base\Component::__isset()

Checks if a property is set, i.e. defined and not null.

This method will check in the following order and act accordingly:

  • a property defined by a setter: return whether the property is set
  • a property of a behavior: return whether the property is set
  • return false for non existing properties

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing isset($component->property).

See also https://www.php.net/manual/en/function.isset.php.

public boolean __isset ( $name )
$name string

The property name or the event name

return boolean

Whether the named property is set

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name !== null;
        }
    }
    return false;
}

            
__set() public method

Defined in: yii\base\Component::__set()

Sets the value of a component property.

This method will check in the following order and act accordingly:

  • a property defined by a setter: set the property value
  • an event in the format of "on xyz": attach the handler to the event "xyz"
  • a behavior in the format of "as xyz": attach the behavior named as "xyz"
  • a property of a behavior: set the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $component->property = $value;.

See also __get().

public void __set ( $name, $value )
$name string

The property name or the event name

$value mixed

The property value

throws yii\base\UnknownPropertyException

if the property is not defined

throws yii\base\InvalidCallException

if the property is read-only.

                public function __set($name, $value)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        // set property
        $this->$setter($value);
        return;
    } elseif (strncmp($name, 'on ', 3) === 0) {
        // on event: attach event handler
        $this->on(trim(substr($name, 3)), $value);
        return;
    } elseif (strncmp($name, 'as ', 3) === 0) {
        // as behavior: attach behavior
        $name = trim(substr($name, 3));
        $this->attachBehavior($name, $value instanceof Behavior ? $value : Yii::createObject($value));
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = $value;
            return;
        }
    }
    if (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}

            
__unset() public method

Defined in: yii\base\Component::__unset()

Sets a component property to be null.

This method will check in the following order and act accordingly:

  • a property defined by a setter: set the property value to be null
  • a property of a behavior: set the property value to be null

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing unset($component->property).

See also https://www.php.net/manual/en/function.unset.php.

public void __unset ( $name )
$name string

The property name

throws yii\base\InvalidCallException

if the property is read only.

                public function __unset($name)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter(null);
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = null;
            return;
        }
    }
    throw new InvalidCallException('Unsetting an unknown or read-only property: ' . get_class($this) . '::' . $name);
}

            
actionActiveButton() public method (available since version 1.2.3)
public array|boolean actionActiveButton ( $hash, $id )
$hash string

The hash from the class name.

$id string|integer

                public function actionActiveButton($hash, $id)
{
    $model = $this->findModel($id);
    return $model->handleNgRestActiveButton($hash);
}

            
actionActiveSelection() public method (available since version 4.0.0)

Defined in: luya\admin\ngrest\base\Api::actionActiveSelection()

Run the active selection handler for the given item

public array actionActiveSelection ( $index )
$index integer
throws yii\web\NotFoundHttpException

                public function actionActiveSelection($index)
{
    $class = $this->modelClass;
    $items = $class::findAll(Yii::$app->request->getBodyParam('ids', [0]));
    /** @var NgRestModel $model */
    $model = new $class();
    $activeSelections = $model->getNgRestConfig()->getActiveSelections();
    if (!array_key_exists($index, $activeSelections)) {
        throw new NotFoundHttpException("Unable to find the active selection handler.");
    }
    $object = $activeSelections[$index];
    return $object->handle($items);
}

            
actionActiveWindowCallback() public method

Defined in: luya\admin\ngrest\base\Api::actionActiveWindowCallback()

Renders ActiveWindow Callback

public string actionActiveWindowCallback ( )
return string

Returns the rendered string from the callback.

                public function actionActiveWindowCallback()
{
    $config = $this->model->getNgRestConfig();
    $render = new RenderActiveWindowCallback();
    $ngrest = new NgRest($config);
    return $ngrest->render($render);
}

            
actionActiveWindowRender() public method
public array actionActiveWindowRender ( )
return array

An array with content, icon, label, title and requestDate

                public function actionActiveWindowRender()
{
    // generate ngrest active window
    $render = new RenderActiveWindow();
    $render->setItemId(Yii::$app->request->getBodyParam('itemId', false));
    $render->setActiveWindowHash(Yii::$app->request->getBodyParam('activeWindowHash', false));
    // process ngrest render view with config context
    $ngrest = new NgRest($this->model->getNgRestConfig());
    return [
        'content' => $ngrest->render($render),
        'icon' => $render->getActiveWindowObject()->getIcon(),
        'label' => $render->getActiveWindowObject()->getLabel(),
        'title' => $render->getActiveWindowObject()->getTitle(),
        'requestDate' => time(),
    ];
}

            
actionExport() public method

Defined in: luya\admin\ngrest\base\Api::actionExport()

Export Data.

See {{luya\admin\ngrest\base\NgRestModel::ngRestExport()}} in order to configure custom export behavior for attributes.

public array actionExport ( )
return array

An array with the key url which contains the download path to the file

throws yii\base\ErrorException

                public function actionExport()
{
    $extension = null;
    $mime = null;
    $header = Yii::$app->request->getBodyParam('header', 1);
    $type = Yii::$app->request->getBodyParam('type');
    $attributes = Yii::$app->request->getBodyParam('attributes', []);
    $filter = Yii::$app->request->getBodyParam('filter', null);
    $fields = ArrayHelper::getColumn($attributes, 'value');
    if (!in_array($type, ['xlsx', 'csv'])) {
        throw new InvalidConfigException("Invalid export type");
    }
    switch (strtolower($type)) {
        case "csv":
            $mime = 'application/csv';
            $extension = 'csv';
            break;
        case "xlsx":
            $mime = 'application/vnd.ms-excel';
            $extension = 'xlsx';
            break;
    }
    if (!empty($filter)) {
        $filter = Html::encode($filter);
        $filtersList = $this->model->ngRestFilters();
        if (!array_key_exists($filter, $filtersList)) {
            throw new InvalidCallException("The requested filter '$filter' does not exists in the filter list.");
        }
        $query = $filtersList[$filter]->select($fields)->with($this->getWithRelation('export'));
    } else {
        $query = $this->prepareListQuery()->with($this->getWithRelation('export'))->select($fields);
    }
    $this->appendPoolWhereCondition($query);
    $exportFormatter = $this->model->ngRestExport();
    if (!empty($exportFormatter)) {
        $query = $this->formatExportValues($query, $exportFormatter);
        foreach ($fields as $fieldIndex => $fieldValue) {
            $fields[$fieldIndex] = $this->model->getAttributeLabel($fieldValue);
        }
    }
    $tempData = ExportHelper::$type($query, $fields, (bool) $header, ['sort' => empty($exportFormatter)]);
    $key = uniqid('ngrestexport', true);
    $store = FileHelper::writeFile('@runtime/'.$key.'.tmp', $tempData);
    $menu = Yii::$app->adminmenu->getApiDetail($this->model->ngRestApiEndpoint());
    $route = $menu['route'];
    $route = str_replace("/index", "/export-download", $route);
    if ($store) {
        Yii::$app->session->set('tempNgRestFileName', Inflector::slug($this->model->tableName())  . '-export-'.date("Y-m-d-H-i").'.' . $extension);
        Yii::$app->session->set('tempNgRestFileMime', $mime);
        Yii::$app->session->set('tempNgRestFileKey', $key);
        $url = Url::toRoute(['/'.$route], true);
        $param = http_build_query(['key' => base64_encode($key), 'time' => time()]);
        if (StringHelper::contains('?', $url)) {
            $route = $url . "&" . $param;
        } else {
            $route = $url . "?" . $param;
        }
        return [
            'url' => $route,
        ];
    }
    throw new ErrorException("Unable to write the temporary file. Make sure the runtime folder is writeable.");
}

            
actionFilter() public method
public yii\data\ActiveDataProvider actionFilter ( $filterName, $query null )
$filterName string

The filter name to apply.

$query string

An optional query to search inside the data.

throws yii\base\InvalidCallException

                public function actionFilter($filterName, $query = null)
{
    $model = $this->model;
    $filterName = Html::encode($filterName);
    $filtersList = $model->ngRestFilters();
    if (!array_key_exists($filterName, $filtersList)) {
        throw new InvalidCallException("The requested filter '$filterName' does not exists in the filter list.");
    }
    $this->handleNotifications($this->modelClass, $this->authId);
    $find = $filtersList[$filterName];
    if ($query) {
        foreach ($model->getNgRestPrimaryKey() as $pkName) {
            $searchQuery = $model->ngRestFullQuerySearch($query)->select([$model->tableName() . '.' . $pkName]);
            $find->andWhere(['in', $model->tableName() . '.' . $pkName, $searchQuery]);
        }
    }
    $this->appendPoolWhereCondition($find);
    return new ActiveDataProvider([
        'query' => $find,
        'pagination' => $this->pagination,
        'sort' => [
            'attributes' => $this->generateSortAttributes($model->getNgRestConfig()),
        ]
    ]);
}

            
actionPermissions() public method (available since version 2.2.0)

Defined in: luya\admin\base\RestActiveController::actionPermissions()

Provide a list of actions with the given permission

return [
    'my-action' => Auth::CAN_UPDATE,
];

the action actionMyAction() would now require at least CAN UPDATE permission on this API to work.

public array actionPermissions ( )
return array

An array where key is the action id and value the Auth type

                public function actionPermissions()
{
    return [];
}

            
actionRelationCall() public method

Defined in: luya\admin\ngrest\base\Api::actionRelationCall()

Get Relation Data

public yii\data\ActiveDataProvider actionRelationCall ( $arrayIndex, $id, $modelClass, $query null )
$arrayIndex mixed
$id mixed
$modelClass string

The name of the model where the ngRestRelation is defined.

$query string

An optional query to filter the response for the given search term (since 2.0.0)

throws yii\base\InvalidCallException

                public function actionRelationCall($arrayIndex, $id, $modelClass, $query = null)
{
    $modelClass = base64_decode($modelClass);
    if (!class_exists($modelClass)) {
        throw new InvalidCallException("Unable to find the given class \"$modelClass\".");
    }
    // `findOne((int) $id)`: (int) $id is not required as the value is safed by action param $id
    $model = $modelClass::findOne($id);
    if (!$model) {
        throw new InvalidCallException("Unable to resolve relation call model.");
    }
    /** @var \luya\admin\ngrest\base\NgRestRelationInterface $relation */
    $relation = $model->getNgRestRelationByIndex($arrayIndex);
    if (!$relation) {
        throw new InvalidCallException("Unable to find the given ng rest relation for this index value.");
    }
    $find = $relation->getDataProvider();
    if ($find instanceof ActiveQueryInterface) {
        $find->with($this->getWithRelation('relation-call'));
        $this->appendPoolWhereCondition($find);
    }
    $targetModel = Yii::createObject(['class' => $relation->getTargetModel()]);
    if ($query) {
        foreach ($targetModel->getNgRestPrimaryKey() as $pkName) {
            $searchQuery = $targetModel->ngRestFullQuerySearch($query)->select([$targetModel->tableName() . '.' . $pkName]);
            $find->andWhere(['in', $targetModel->tableName() . '.' . $pkName, $searchQuery]);
        }
    }
    return new ActiveDataProvider([
        'query' => $find,
        'pagination' => $this->pagination,
        'sort' => [
            'attributes' => $this->generateSortAttributes($targetModel->getNgRestConfig()),
        ]
    ]);
}

            
actionSearch() public method

Defined in: luya\admin\ngrest\base\Api::actionSearch()

Search

Search querys with Pagination will be handled by this action.

public yii\data\ActiveDataProvider actionSearch ( $query null )
$query string

The query to lookup the database, if query is empty a post request with query can be used instead.

                public function actionSearch($query = null)
{
    if (empty($query)) {
        $query = Yii::$app->request->post('query');
    }
    $find = $this->model->ngRestFullQuerySearch($query);
    $this->appendPoolWhereCondition($find);
    return new ActiveDataProvider([
        'query' => $find->with($this->getWithRelation('search')),
        'pagination' => $this->pagination,
        'sort' => [
            'attributes' => $this->generateSortAttributes($this->model->getNgRestConfig()),
        ]
    ]);
}

            
actionServices() public method
public array actionServices ( )
return array

An array with all services information for the given ngrest model.

                public function actionServices()
{
    $settings = [];
    $apiEndpoint = $this->model->ngRestApiEndpoint();
    $userSortSettings = Yii::$app->adminuser->identity->setting->get('ngrestorder.admin/'.$apiEndpoint, false);
    if ($userSortSettings && is_array($userSortSettings)) {
        if ($userSortSettings['sort'] == SORT_DESC) {
            $order = '-'.$userSortSettings['field'];
        } else {
            $order = '+'.$userSortSettings['field'];
        }
        $settings['order'] = $order;
    }
    $userFilter = Yii::$app->adminuser->identity->setting->get('ngrestfilter.admin/'.$apiEndpoint, false);
    if ($userFilter) {
        $settings['filterName'] = $userFilter;
    }
    $modelClass = $this->modelClass;
    // check if taggable exists, if yes return all used tags for the
    if (ObjectHelper::isTraitInstanceOf($this->model, TaggableTrait::class)) {
        $tags = ArrayHelper::toArray($this->model->findTags(), [
            Tag::class => ['id', 'name']
        ]);
    } else {
        $tags = false;
    }
    $notificationMuteState = false;
    $userAuthNotificationModel = UserAuthNotification::find()->where(['user_id' => Yii::$app->adminuser->id, 'auth_id' => $this->authId])->one();
    if ($userAuthNotificationModel) {
        $notificationMuteState = $userAuthNotificationModel->is_muted;
    }
    return [
        'service' => $this->model->getNgRestServices(),
        '_authId' => $this->authId,
        '_tags' => $tags,
        '_hints' => $this->model->attributeHints(),
        '_settings' => $settings,
        '_notifcation_mute_state' => $notificationMuteState,
        '_locked' => [
            'data' => UserOnline::find()
                ->select(['user_id', 'lock_pk', 'last_timestamp', 'firstname', 'lastname', 'admin_user.id'])
                ->where(['lock_table' => $modelClass::tableName()])
                ->joinWith('user')
                ->asArray()
                ->all(),
            'userId' => Yii::$app->adminuser->id,
        ],
    ];
}

            
actionToggleNotification() public method (available since version 2.0.0)
public luya\admin\models\UserAuthNotification actionToggleNotification ( )
return luya\admin\models\UserAuthNotification

The user auth notification model. If model does not exists a new model will be created.

                public function actionToggleNotification()
{
    $newMuteState = Yii::$app->request->getBodyParam('mute');
    $model = UserAuthNotification::find()->where(['user_id' => Yii::$app->adminuser->id, 'auth_id' => $this->authId])->one();
    if ($model) {
        $model->is_muted = (int) $newMuteState;
        $model->save();
    } else {
        $model = new UserAuthNotification();
        $model->is_muted = (int) $newMuteState;
        $model->auth_id = $this->authId;
        $model->user_id = Yii::$app->adminuser->id;
        $model->model_class = $this->modelClass;
    }
    return $model;
}

            
actionUnlock() public method

Defined in: luya\admin\ngrest\base\Api::actionUnlock()

User Unlock

Unlock this API for the current logged in user.

public void actionUnlock ( )

                public function actionUnlock()
{
    UserOnline::unlock(Yii::$app->adminuser->id);
}

            
actions() public method

Defined in: luya\admin\ngrest\base\Api::actions()

Declares external actions for the controller.

This method is meant to be overwritten to declare external actions for the controller. It should return an array, with array keys being action IDs, and array values the corresponding action class names or action configuration arrays. For example,

return [
    'action1' => 'app\components\Action1',
    'action2' => [
        'class' => 'app\components\Action2',
        'property1' => 'value1',
        'property2' => 'value2',
    ],
];

Yii::createObject() will be used later to create the requested action using the configuration provided here.

public array actions ( )

                public function actions()
{
    $actions = [
        'index' => [ // for casual api request behavior
            'class' => 'luya\admin\ngrest\base\actions\IndexAction',
            'modelClass' => $this->modelClass,
            'checkAccess' => [$this, 'checkAccess'],
            'prepareActiveDataQuery' => [$this, 'prepareIndexQuery'],
            'dataFilter' => $this->getDataFilter(),
        ],
        'list' => [ // for ngrest list
            'class' => 'luya\admin\ngrest\base\actions\IndexAction',
            'modelClass' => $this->modelClass,
            'checkAccess' => [$this, 'checkAccess'],
            'prepareActiveDataQuery' => [$this, 'prepareListQuery'],
            'dataFilter' => $this->getDataFilter(),
        ],
        'view' => [
            'class' => 'luya\admin\ngrest\base\actions\ViewAction',
            'modelClass' => $this->modelClass,
            'checkAccess' => [$this, 'checkAccess'],
        ],
        'create' => [
            'class' => 'luya\admin\ngrest\base\actions\CreateAction',
            'modelClass' => $this->modelClass,
            'checkAccess' => [$this, 'checkAccess'],
            'scenario' => $this->createScenario,
        ],
        'update' => [
            'class' => 'luya\admin\ngrest\base\actions\UpdateAction',
            'modelClass' => $this->modelClass,
            'checkAccess' => [$this, 'checkAccess'],
            'scenario' => $this->updateScenario,
        ],
        'delete' => [
            'class' => 'luya\admin\ngrest\base\actions\DeleteAction',
            'modelClass' => $this->modelClass,
            'checkAccess' => [$this, 'checkAccess'],
        ],
        'options' => [
            'class' => 'luya\admin\ngrest\base\actions\OptionsAction',
        ],
    ];
    if ($this->truncateAction) {
        $actions['truncate'] = [
            'class' => 'luya\admin\ngrest\base\actions\TruncateAction',
            'modelClass' => $this->modelClass,
            'checkAccess' => [$this, 'checkAccess'],
        ];
    }
    if ($this->enableCors) {
        $actions['options']['class'] = 'luya\admin\ngrest\base\actions\OptionsAction';
    }
    return $actions;
}

            
addActionPermission() public method (available since version 2.2.0)

Defined in: luya\admin\base\RestActiveController::addActionPermission()

Add a permission with a function.

This allows you to inject permission on init() which won't allow them to override.

public function init()
{
    parent::init();

    $this->addActionPermission(Auth::CAN_UPDATE, [
        'my-action', 'another-action',
    ]);
}
public void addActionPermission ( $type, $actions )
$type integer

The type of permission

$actions string

The name of the action

                public function addActionPermission($type, $actions)
{
    foreach ((array) $actions as $actionName) {
        $this->_actionPermissions[$actionName] = $type;
    }
}

            
afterAction() public method

Defined in: yii\rest\Controller::afterAction()

This method is invoked right after an action is executed.

The method will trigger the EVENT_AFTER_ACTION event. The return value of the method will be used as the action return value.

If you override this method, your code should look like the following:

public function afterAction($action, $result)
{
    $result = parent::afterAction($action, $result);
    // your custom code here
    return $result;
}
public mixed afterAction ( $action, $result )
$action yii\base\Action

The action just executed.

$result mixed

The action return result.

return mixed

The processed action result.

                public function afterAction($action, $result)
{
    $result = parent::afterAction($action, $result);
    return $this->serializeData($result);
}

            
asJson() public method (available since version 2.0.11)

Defined in: yii\web\Controller::asJson()

Send data formatted as JSON.

This method is a shortcut for sending data formatted as JSON. It will return the response application component after configuring the format and setting the data that should be formatted. A common usage will be:

return $this->asJson($data);

See also:

public yii\web\Response asJson ( $data )
$data mixed

The data that should be formatted.

return yii\web\Response

A response that is configured to send $data formatted as JSON.

                public function asJson($data)
{
    $this->response->format = Response::FORMAT_JSON;
    $this->response->data = $data;
    return $this->response;
}

            
asXml() public method (available since version 2.0.11)

Defined in: yii\web\Controller::asXml()

Send data formatted as XML.

This method is a shortcut for sending data formatted as XML. It will return the response application component after configuring the format and setting the data that should be formatted. A common usage will be:

return $this->asXml($data);

See also:

public yii\web\Response asXml ( $data )
$data mixed

The data that should be formatted.

return yii\web\Response

A response that is configured to send $data formatted as XML.

                public function asXml($data)
{
    $this->response->format = Response::FORMAT_XML;
    $this->response->data = $data;
    return $this->response;
}

            
attachBehavior() public method

Defined in: yii\base\Component::attachBehavior()

Attaches a behavior to this component.

This method will create the behavior object based on the given configuration. After that, the behavior object will be attached to this component by calling the yii\base\Behavior::attach() method.

See also detachBehavior().

public yii\base\Behavior attachBehavior ( $name, $behavior )
$name string

The name of the behavior.

$behavior string|array|yii\base\Behavior

The behavior configuration. This can be one of the following:

return yii\base\Behavior

The behavior object

                public function attachBehavior($name, $behavior)
{
    $this->ensureBehaviors();
    return $this->attachBehaviorInternal($name, $behavior);
}

            
attachBehaviors() public method

Defined in: yii\base\Component::attachBehaviors()

Attaches a list of behaviors to the component.

Each behavior is indexed by its name and should be a yii\base\Behavior object, a string specifying the behavior class, or an configuration array for creating the behavior.

See also attachBehavior().

public void attachBehaviors ( $behaviors )
$behaviors array

List of behaviors to be attached to the component

                public function attachBehaviors($behaviors)
{
    $this->ensureBehaviors();
    foreach ($behaviors as $name => $behavior) {
        $this->attachBehaviorInternal($name, $behavior);
    }
}

            
beforeAction() public method (available since version 2.2.0)

Defined in: luya\admin\base\RestActiveController::beforeAction()

Ensure the action of rest controllers can not viewed by api users by default.

public boolean beforeAction ( $action )
$action yii\base\Action

                public function beforeAction($action)
{
    if (parent::beforeAction($action)) {
        return $this->isActionAllowed($action->id);
    }
    return false;
}

            
behaviors() public method

Defined in: luya\traits\RestBehaviorsTrait::behaviors()

Override the default {{yii\rest\Controller::behaviors()}} method.

The following changes are differ to the base implementation:

  • If {{luya\rest\UserBehaviorInterface}} is not implemented, the authenticator behavior ({{yii\filters\auth\CompositeAuth}}) is removed.
  • If {{luya\rest\UserBehaviorInterface}} is implemented, the authenticator behavior ({{yii\filters\auth\CompositeAuth}}) is enabled.
  • If {{luya\rest\UserBehaviorInterface}} is implemented, the contentNegotiator behavior ({{yii\filters\ContentNegotiator}}) is enabled.
  • The rateLimiter behavior filter is removed by default.
public array behaviors ( )
return array

Returns an array with registered behavior filters based on the implementation type.

                public function behaviors()
{
    $behaviors = parent::behaviors();
    if ($this->enableCors) {
        $behaviors['cors'] = Yii::$app->corsConfig;
    }
    unset($behaviors['authenticator']);
    if ($this->getUserAuthClass()) {
        
        // change to admin user auth class
        $behaviors['authenticator'] = [
            'class' => CompositeAuth::class,
            'user' => $this->getUserAuthClass(),
            'authMethods' => $this->getCompositeAuthMethods(),
            'optional' => $this->authOptional,
        ];
        
        if ($this->enableCors) {
            $behaviors['authenticator']['except'] = ['options'];
        }
    }
    $behaviors['contentNegotiator'] = [
        'class' => ContentNegotiator::class,
        'formats' => [
            'application/json' => Response::FORMAT_JSON,
            'application/xml' => Response::FORMAT_XML,
        ],
        'languages' => $this->languages,
    ];
    
    // by default rate limiter behavior is removed as it requires a database
    // user given from the admin module.
    if (isset($behaviors['rateLimiter'])) {
        unset($behaviors['rateLimiter']);
    }
    if ($this->jsonCruft) {
        $behaviors['cruft'] = JsonCruftFilter::class;
    }
    
    return $behaviors;
}

            
bindActionParams() public method

Defined in: yii\web\Controller::bindActionParams()

Binds the parameters to the action.

This method is invoked by yii\base\Action when it begins to run with the given parameters. This method will check the parameter names that the action requires and return the provided parameters according to the requirement. If there is any missing parameter, an exception will be thrown.

public array bindActionParams ( $action, $params )
$action yii\base\Action

The action to be bound with parameters

$params array

The parameters to be bound to the action

return array

The valid parameters that the action can run with.

throws yii\web\BadRequestHttpException

if there are missing or invalid parameters.

                public function bindActionParams($action, $params)
{
    if ($action instanceof InlineAction) {
        $method = new \ReflectionMethod($this, $action->actionMethod);
    } else {
        $method = new \ReflectionMethod($action, 'run');
    }
    $args = [];
    $missing = [];
    $actionParams = [];
    $requestedParams = [];
    foreach ($method->getParameters() as $param) {
        $name = $param->getName();
        if (array_key_exists($name, $params)) {
            $isValid = true;
            if (PHP_VERSION_ID >= 80000) {
                $isArray = ($type = $param->getType()) instanceof \ReflectionNamedType && $type->getName() === 'array';
            } else {
                $isArray = $param->isArray();
            }
            if ($isArray) {
                $params[$name] = (array)$params[$name];
            } elseif (is_array($params[$name])) {
                $isValid = false;
            } elseif (
                PHP_VERSION_ID >= 70000
                && ($type = $param->getType()) !== null
                && $type->isBuiltin()
                && ($params[$name] !== null || !$type->allowsNull())
            ) {
                $typeName = PHP_VERSION_ID >= 70100 ? $type->getName() : (string)$type;
                if ($params[$name] === '' && $type->allowsNull()) {
                    if ($typeName !== 'string') { // for old string behavior compatibility
                        $params[$name] = null;
                    }
                } else {
                    switch ($typeName) {
                        case 'int':
                            $params[$name] = filter_var($params[$name], FILTER_VALIDATE_INT, FILTER_NULL_ON_FAILURE);
                            break;
                        case 'float':
                            $params[$name] = filter_var($params[$name], FILTER_VALIDATE_FLOAT, FILTER_NULL_ON_FAILURE);
                            break;
                        case 'bool':
                            $params[$name] = filter_var($params[$name], FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE);
                            break;
                    }
                    if ($params[$name] === null) {
                        $isValid = false;
                    }
                }
            }
            if (!$isValid) {
                throw new BadRequestHttpException(
                    Yii::t('yii', 'Invalid data received for parameter "{param}".', ['param' => $name])
                );
            }
            $args[] = $actionParams[$name] = $params[$name];
            unset($params[$name]);
        } elseif (
            PHP_VERSION_ID >= 70100
            && ($type = $param->getType()) !== null
            && $type instanceof \ReflectionNamedType
            && !$type->isBuiltin()
        ) {
            try {
                $this->bindInjectedParams($type, $name, $args, $requestedParams);
            } catch (HttpException $e) {
                throw $e;
            } catch (Exception $e) {
                throw new ServerErrorHttpException($e->getMessage(), 0, $e);
            }
        } elseif ($param->isDefaultValueAvailable()) {
            $args[] = $actionParams[$name] = $param->getDefaultValue();
        } else {
            $missing[] = $name;
        }
    }
    if (!empty($missing)) {
        throw new BadRequestHttpException(
            Yii::t('yii', 'Missing required parameters: {params}', ['params' => implode(', ', $missing)])
        );
    }
    $this->actionParams = $actionParams;
    // We use a different array here, specifically one that doesn't contain service instances but descriptions instead.
    if (Yii::$app->requestedParams === null) {
        Yii::$app->requestedParams = array_merge($actionParams, $requestedParams);
    }
    return $args;
}

            
bindInjectedParams() protected method (available since version 2.0.36)

Defined in: yii\base\Controller::bindInjectedParams()

Fills parameters based on types and names in action method signature.

protected void bindInjectedParams ( ReflectionType $type, $name, &$args, &$requestedParams )
$type ReflectionType

The reflected type of the action parameter.

$name string

The name of the parameter.

$args array

The array of arguments for the action, this function may append items to it.

$requestedParams array

The array with requested params, this function may write specific keys to it.

throws yii\base\ErrorException

when we cannot load a required service.

throws yii\base\InvalidConfigException

Thrown when there is an error in the DI configuration.

throws yii\di\NotInstantiableException

Thrown when a definition cannot be resolved to a concrete class (for example an interface type hint) without a proper definition in the container.

                final protected function bindInjectedParams(\ReflectionType $type, $name, &$args, &$requestedParams)
{
    // Since it is not a builtin type it must be DI injection.
    $typeName = $type->getName();
    if (($component = $this->module->get($name, false)) instanceof $typeName) {
        $args[] = $component;
        $requestedParams[$name] = "Component: " . get_class($component) . " \$$name";
    } elseif ($this->module->has($typeName) && ($service = $this->module->get($typeName)) instanceof $typeName) {
        $args[] = $service;
        $requestedParams[$name] = 'Module ' . get_class($this->module) . " DI: $typeName \$$name";
    } elseif (\Yii::$container->has($typeName) && ($service = \Yii::$container->get($typeName)) instanceof $typeName) {
        $args[] = $service;
        $requestedParams[$name] = "Container DI: $typeName \$$name";
    } elseif ($type->allowsNull()) {
        $args[] = null;
        $requestedParams[$name] = "Unavailable service: $name";
    } else {
        throw new Exception('Could not load required service: ' . $name);
    }
}

            
canApiUserAccess() public method (available since version 2.2.0)

Defined in: luya\admin\traits\AdminRestBehaviorTrait::canApiUserAccess()

If the current user is an API user this action might be not permitted. As Api Users also acts as proxy for JWT authenticated users sensitive informations could be exposed.

For example a JWT authenticated user proxied trough Api User could access admin/api-admin-user/session as the {{luya\admin\apis\UserController::actionSession()}} is only secured through authentification and not trough a given permission (let's say "view my session data").

As Api Users are not allowed to login the don't need access to those generic admin ui API endpoints, this method checks if the current user is an api user and therefore restricsts the access to such calls, unless the property {{luya\admin\Module::$apiUserAllowActionsWithoutPermissions}} is enabled.

public void canApiUserAccess ( )

                public function canApiUserAccess()
{
    if ($this->userAuthClass()->identity->is_api_user && !$this->_module->apiUserAllowActionsWithoutPermissions) {
        throw new ForbiddenHttpException("This controller ({$this->id}) action is forbidden for API users unless apiUserAllowActionsWithoutPermissions is enabled in admin module config.");
    }
}

            
canGetProperty() public method

Defined in: yii\base\Component::canGetProperty()

Returns a value indicating whether a property can be read.

A property can be read if:

  • the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
  • an attached behavior has a readable property of the given name (when $checkBehaviors is true).

See also canSetProperty().

public boolean canGetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

The property name

$checkVars boolean

Whether to treat member variables as properties

$checkBehaviors boolean

Whether to treat behaviors' properties as properties of this component

return boolean

Whether the property can be read

                public function canGetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canGetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
canSetProperty() public method

Defined in: yii\base\Component::canSetProperty()

Returns a value indicating whether a property can be set.

A property can be written if:

  • the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
  • an attached behavior has a writable property of the given name (when $checkBehaviors is true).

See also canGetProperty().

public boolean canSetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

The property name

$checkVars boolean

Whether to treat member variables as properties

$checkBehaviors boolean

Whether to treat behaviors' properties as properties of this component

return boolean

Whether the property can be written

                public function canSetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canSetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
checkAccess() public method

Defined in: luya\admin\base\RestActiveController::checkAccess()

If a user should not get access to the rest api, an ForbiddenHttpException must be thrown:

throw new \yii\web\ForbiddenHttpException

To make access restrictions checks in your Rest controller you have to override this method, otherwise there is no access check.

This method should be overridden to check whether the current user has the privilege to run the specified action against the specified data model. If the user does not have access, a yii\web\ForbiddenHttpException should be thrown.

public void checkAccess ( $action, $model null, $params = [] )
$action string

The ID of the action to be executed

$model object|null

The model to be accessed. If null, it means no specific model is being accessed.

$params array

Additional parameters

throws yii\web\ForbiddenHttpException

if the user does not have access

                public function checkAccess($action, $model = null, $params = [])
{
    // use the check access method to ensure whether a certain item is valid to a certain user or not.
    // the main purpose of validation whether the action can be access or not is done in {{isActionAllowed()}}
    // which runs always in {{beforeAction()}}.
}

            
className() public static method
Deprecated since 2.0.14. On PHP >=5.5, use ::class instead.

Defined in: yii\base\BaseObject::className()

Returns the fully qualified name of this class.

public static string className ( )
return string

The fully qualified name of this class.

                public static function className()
{
    return get_called_class();
}

            
createAction() public method

Defined in: yii\base\Controller::createAction()

Creates an action based on the given action ID.

The method first checks if the action ID has been declared in actions(). If so, it will use the configuration declared there to create the action object. If not, it will look for a controller method whose name is in the format of actionXyz where xyz is the action ID. If found, an yii\base\InlineAction representing that method will be created and returned.

public yii\base\Action|null createAction ( $id )
$id string

The action ID.

return yii\base\Action|null

The newly created action instance. Null if the ID doesn't resolve into any action.

                public function createAction($id)
{
    if ($id === '') {
        $id = $this->defaultAction;
    }
    $actionMap = $this->actions();
    if (isset($actionMap[$id])) {
        return Yii::createObject($actionMap[$id], [$id, $this]);
    }
    if (preg_match('/^(?:[a-z0-9_]+-)*[a-z0-9_]+$/', $id)) {
        $methodName = 'action' . str_replace(' ', '', ucwords(str_replace('-', ' ', $id)));
        if (method_exists($this, $methodName)) {
            $method = new \ReflectionMethod($this, $methodName);
            if ($method->isPublic() && $method->getName() === $methodName) {
                return new InlineAction($id, $this, $methodName);
            }
        }
    }
    return null;
}

            
detachBehavior() public method

Defined in: yii\base\Component::detachBehavior()

Detaches a behavior from the component.

The behavior's yii\base\Behavior::detach() method will be invoked.

public yii\base\Behavior|null detachBehavior ( $name )
$name string

The behavior's name.

return yii\base\Behavior|null

The detached behavior. Null if the behavior does not exist.

                public function detachBehavior($name)
{
    $this->ensureBehaviors();
    if (isset($this->_behaviors[$name])) {
        $behavior = $this->_behaviors[$name];
        unset($this->_behaviors[$name]);
        $behavior->detach();
        return $behavior;
    }
    return null;
}

            
detachBehaviors() public method

Defined in: yii\base\Component::detachBehaviors()

Detaches all behaviors from the component.

public void detachBehaviors ( )

                public function detachBehaviors()
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $name => $behavior) {
        $this->detachBehavior($name);
    }
}

            
ensureBehaviors() public method

Defined in: yii\base\Component::ensureBehaviors()

Makes sure that the behaviors declared in behaviors() are attached to this component.

public void ensureBehaviors ( )

                public function ensureBehaviors()
{
    if ($this->_behaviors === null) {
        $this->_behaviors = [];
        foreach ($this->behaviors() as $name => $behavior) {
            $this->attachBehaviorInternal($name, $behavior);
        }
    }
}

            
findLayoutFile() public method

Defined in: yii\base\Controller::findLayoutFile()

Finds the applicable layout file.

public string|boolean findLayoutFile ( $view )
$view yii\base\View

The view object to render the layout file.

return string|boolean

The layout file path, or false if layout is not needed. Please refer to render() on how to specify this parameter.

throws yii\base\InvalidArgumentException

if an invalid path alias is used to specify the layout.

                public function findLayoutFile($view)
{
    $module = $this->module;
    $layout = null;
    if (is_string($this->layout)) {
        $layout = $this->layout;
    } elseif ($this->layout === null) {
        while ($module !== null && $module->layout === null) {
            $module = $module->module;
        }
        if ($module !== null && is_string($module->layout)) {
            $layout = $module->layout;
        }
    }
    if ($layout === null) {
        return false;
    }
    if (strncmp($layout, '@', 1) === 0) {
        $file = Yii::getAlias($layout);
    } elseif (strncmp($layout, '/', 1) === 0) {
        $file = Yii::$app->getLayoutPath() . DIRECTORY_SEPARATOR . substr($layout, 1);
    } else {
        $file = $module->getLayoutPath() . DIRECTORY_SEPARATOR . $layout;
    }
    if (pathinfo($file, PATHINFO_EXTENSION) !== '') {
        return $file;
    }
    $path = $file . '.' . $view->defaultExtension;
    if ($view->defaultExtension !== 'php' && !is_file($path)) {
        $path = $file . '.php';
    }
    return $path;
}

            
findModel() public method

Defined in: luya\admin\ngrest\base\Api::findModel()

Get the Model for the API based on a given Id.

If not found a NotFoundHttpException will be thrown.

public luya\admin\ngrest\base\NgRestModel findModel ( $id )
$id integer|string

The id to performe the findOne() method.

throws yii\web\NotFoundHttpException

                public function findModel($id)
{
    $model = $this->findModelClassObject($this->modelClass, $id, 'view');
    if (!$model) {
        throw new NotFoundHttpException("Unable to find the Model for the given ID");
    }
    return $model;
}

            
findModelClassObject() public method

Defined in: luya\admin\ngrest\base\Api::findModelClassObject()

Find the model for a given class and id.

public \luya\admin\ngrest\base\yii\db\ActiveRecord|boolean findModelClassObject ( $modelClass, $id, $relationContext )
$modelClass string

The full qualified path to the model

$id string

The id which is a string, for example 1 or for composite keys its 1,4

$relationContext string

The name of the context, which is actually the action like search or index.

                public function findModelClassObject($modelClass, $id, $relationContext)
{
    // returns an array with the names of the primary keys
    $keys = $modelClass::primaryKey();
    if ((is_countable($keys) ? count($keys) : 0) > 1) {
        $values = explode(',', $id);
        if ((is_countable($keys) ? count($keys) : 0) === count($values)) {
            return $this->findModelFromCondition($values, $keys, $modelClass, $relationContext);
        }
    } elseif ($id !== null) {
        return $this->findModelFromCondition([$id], $keys, $modelClass, $relationContext);
    }
    return false;
}

            
findModelFromCondition() protected method (available since version 1.2.3)

Defined in: luya\admin\ngrest\base\Api::findModelFromCondition()

This equals to the ActieRecord::findByCondition which is sadly a protected method.

protected \luya\admin\ngrest\base\yii\db\ActiveRecord findModelFromCondition ( array $values, array $keys, $modelClass, $relationContext )
$values array

An array with values for the given primary keys

$keys array

An array holding all primary keys

$modelClass string

The full qualified namespace to the model

$relationContext string

The name of the context like "search", "index", "list". Its acutally the action name

                protected function findModelFromCondition(array $values, array $keys, $modelClass, $relationContext)
{
    $condition = array_combine($keys, $values);
    // If an api user the internal find methods are used to find items.
    if (!Yii::$app->adminuser->isGuest && Yii::$app->adminuser->identity->is_api_user) {
        // api calls will always use the "original" find method which is based on yii2 guide the best approach to hide given data by default.
        $findModelInstance = $modelClass::find();
    } else {
        // if its an admin user which is browsing the ui the internal ngRestFind method is used.
        $findModelInstance = $modelClass::ngRestFind();
    }
    return $findModelInstance->andWhere($condition)->with($this->getWithRelation($relationContext))->one();
}

            
generateSortAttributes() public method (available since version 2.0.0)

Defined in: luya\admin\ngrest\base\Api::generateSortAttributes()

Generate Sort attributes

Generate an array of sortable attribute definitions from a ngrest config object.

public array generateSortAttributes ( luya\admin\ngrest\Config $config )
$config luya\admin\ngrest\Config

The Ngrest Config object

return array

Returns an array with sortable attributes.

                public function generateSortAttributes(Config $config)
{
    $sortAttributes = [];
    foreach ($config->getPointerPlugins('list') as $plugin) {
        $sortAttributes = ArrayHelper::merge($plugin->getSortField(), $sortAttributes);
    }
    return $sortAttributes;
}

            
getActionPermissions() public method (available since version 2.2.0)

Defined in: luya\admin\base\RestActiveController::getActionPermissions()

Get all actions as array from {{actionPermissions()}} method and those wo where inject by {{åddActionPermission}}.

public array getActionPermissions ( )

                public function getActionPermissions()
{
    foreach ($this->actionPermissions() as $type => $actionName) {
        $this->addActionPermission($actionName, $type);
    }
    return $this->_actionPermissions;
}

            
getBehavior() public method

Defined in: yii\base\Component::getBehavior()

Returns the named behavior object.

public yii\base\Behavior|null getBehavior ( $name )
$name string

The behavior name

return yii\base\Behavior|null

The behavior object, or null if the behavior does not exist

                public function getBehavior($name)
{
    $this->ensureBehaviors();
    return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
}

            
getBehaviors() public method

Defined in: yii\base\Component::getBehaviors()

Returns all behaviors attached to this component.

public yii\base\Behavior[] getBehaviors ( )
return yii\base\Behavior[]

List of behaviors attached to this component

                public function getBehaviors()
{
    $this->ensureBehaviors();
    return $this->_behaviors;
}

            
getCompositeAuthMethods() public method (available since version 1.0.21)

Defined in: luya\traits\RestBehaviorsTrait::getCompositeAuthMethods()

Return all Auth methods for Composite Auth.

public array getCompositeAuthMethods ( )

                public function getCompositeAuthMethods()
{
    return [
        QueryParamAuth::class,
        HttpBearerAuth::class,
    ];
}

            
getDataFilter() public method (available since version 1.2.2)

Defined in: luya\admin\ngrest\base\Api::getDataFilter()

Returns whether the $dataFilter property of IndexAction should be set with the according value.

public array|boolean getDataFilter ( )

                public function getDataFilter()
{
    if ($this->filterSearchModelClass) {
        return [
            'class' => 'yii\data\ActiveDataFilter',
            'searchModel' => $this->filterSearchModelClass,
        ];
    }
    return null;
}

            
getModel() public method

Defined in: luya\admin\ngrest\base\Api::getModel()

Get the ngrest model object (unloaded).

public luya\admin\ngrest\base\NgRestModel getModel ( )
throws yii\base\InvalidConfigException

                public function getModel()
{
    if ($this->_model === null) {
        $this->_model = Yii::createObject($this->modelClass);
        if (!$this->_model instanceof NgRestModelInterface) {
            throw new InvalidConfigException("The modelClass '$this->modelClass' must be an instance of NgRestModelInterface.");
        }
    }
    return $this->_model;
}

            
getModules() public method

Defined in: yii\base\Controller::getModules()

Returns all ancestor modules of this controller.

The first module in the array is the outermost one (i.e., the application instance), while the last is the innermost one.

public yii\base\Module[] getModules ( )
return yii\base\Module[]

All ancestor modules that this controller is located within.

                public function getModules()
{
    $modules = [$this->module];
    $module = $this->module;
    while ($module->module !== null) {
        array_unshift($modules, $module->module);
        $module = $module->module;
    }
    return $modules;
}

            
getRoute() public method

Defined in: yii\base\Controller::getRoute()

Returns the route of the current request.

public string getRoute ( )
return string

The route (module ID, controller ID and action ID) of the current request.

                public function getRoute()
{
    return $this->action !== null ? $this->action->getUniqueId() : $this->getUniqueId();
}

            
getUniqueId() public method

Defined in: yii\base\Controller::getUniqueId()

Returns the unique ID of the controller.

public string getUniqueId ( )
return string

The controller ID that is prefixed with the module ID (if any).

                public function getUniqueId()
{
    return $this->module instanceof Application ? $this->id : $this->module->getUniqueId() . '/' . $this->id;
}

            
getView() public method

Defined in: yii\base\Controller::getView()

Returns the view object that can be used to render views or view files.

The render(), renderPartial() and renderFile() methods will use this view object to implement the actual view rendering. If not set, it will default to the "view" application component.

public yii\base\View|yii\web\View getView ( )
return yii\base\View|yii\web\View

The view object that can be used to render views or view files.

                public function getView()
{
    if ($this->_view === null) {
        $this->_view = Yii::$app->getView();
    }
    return $this->_view;
}

            
getViewPath() public method

Defined in: yii\base\Controller::getViewPath()

Returns the directory containing view files for this controller.

The default implementation returns the directory named as controller $id under the $module's $viewPath directory.

public string getViewPath ( )
return string

The directory containing the view files for this controller.

                public function getViewPath()
{
    if ($this->_viewPath === null) {
        $this->_viewPath = $this->module->getViewPath() . DIRECTORY_SEPARATOR . $this->id;
    }
    return $this->_viewPath;
}

            
getWithRelation() public method (available since version 1.2.2)

Defined in: luya\admin\ngrest\base\Api::getWithRelation()

Get the relations for the corresponding action name.

Since version 1.2.3 it also checks if the $expand get param is provided for the given relations, otherwise the relation will not be joined trough with. This reduces the database querie time.

public array getWithRelation ( $actionName )
$actionName string

The action name like index, list, search, relation-call.

return array

An array with relation names.

                public function getWithRelation($actionName)
{
    $expand = Yii::$app->request->get('expand', '');
    $relationPrefixes = [];
    foreach (StringHelper::explode($expand, ',', true, true) as $relation) {
        // check for subrelation dot notation.
        $relationPrefixes[] = current(explode(".", $relation));
    }
    // no expand param found, return empty array which means no relations to load
    if (empty($relationPrefixes)) {
        return [];
    }
    $withRelations = $this->withRelations();
    foreach ($withRelations as $relationName) {
        // it seem to be the advance strucutre for given actions.
        if (is_array($relationName) && isset($withRelations[$actionName])) {
            return $this->relationsFromExpand($withRelations[$actionName], $relationPrefixes);
        }
    }
    // simple structure
    return $this->relationsFromExpand($withRelations, $relationPrefixes);
}

            
goBack() public method

Defined in: yii\web\Controller::goBack()

Redirects the browser to the last visited page.

You can use this method in an action by returning the yii\web\Response directly:

// stop executing this action and redirect to last visited page
return $this->goBack();

For this function to work you have to set the return URL in appropriate places before.

See also yii\web\User::getReturnUrl().

public yii\web\Response goBack ( $defaultUrl null )
$defaultUrl string|array|null

The default return URL in case it was not set previously. If this is null and the return URL was not set previously, yii\web\Application::$homeUrl will be redirected to. Please refer to yii\web\User::setReturnUrl() on accepted format of the URL.

return yii\web\Response

The current response object

                public function goBack($defaultUrl = null)
{
    return $this->response->redirect(Yii::$app->getUser()->getReturnUrl($defaultUrl));
}

            
goHome() public method

Defined in: yii\web\Controller::goHome()

Redirects the browser to the home page.

You can use this method in an action by returning the yii\web\Response directly:

// stop executing this action and redirect to home page
return $this->goHome();
public yii\web\Response goHome ( )
return yii\web\Response

The current response object

                public function goHome()
{
    return $this->response->redirect(Yii::$app->getHomeUrl());
}

            
handleNotifications() protected method (available since version 2.0.1)

Defined in: luya\admin\ngrest\base\Api::handleNotifications()

Add new notification or update to latest primary key if exists

protected boolean handleNotifications ( $modelClass, $authId )
$modelClass string
$authId integer

                protected function handleNotifications($modelClass, $authId)
{
    // find the latest primary key value and store into row notifications user auth table
    $pkValue = Json::encode($modelClass::findLatestPrimaryKeyValue());
    $model = UserAuthNotification::find()->where(['user_id' => Yii::$app->adminuser->id, 'auth_id' => $authId])->one();
    if ($model) {
        $model->model_latest_pk_value = $pkValue;
        $model->model_class = $modelClass::className();
        return $model->save();
    }
    $model = new UserAuthNotification();
    $model->auth_id = $authId;
    $model->user_id = Yii::$app->adminuser->id;
    $model->model_latest_pk_value = $pkValue;
    $model->model_class = $modelClass::className();
    return $model->save();
}

            
hasEventHandlers() public method

Defined in: yii\base\Component::hasEventHandlers()

Returns a value indicating whether there is any handler attached to the named event.

public boolean hasEventHandlers ( $name )
$name string

The event name

return boolean

Whether there is any handler attached to the event.

                public function hasEventHandlers($name)
{
    $this->ensureBehaviors();
    if (!empty($this->_events[$name])) {
        return true;
    }
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (!empty($handlers) && StringHelper::matchWildcard($wildcard, $name)) {
            return true;
        }
    }
    return Event::hasHandlers($this, $name);
}

            
hasMethod() public method

Defined in: yii\base\Component::hasMethod()

Returns a value indicating whether a method is defined.

A method is defined if:

  • the class has a method with the specified name
  • an attached behavior has a method with the given name (when $checkBehaviors is true).
public boolean hasMethod ( $name, $checkBehaviors true )
$name string

The property name

$checkBehaviors boolean

Whether to treat behaviors' methods as methods of this component

return boolean

Whether the method is defined

                public function hasMethod($name, $checkBehaviors = true)
{
    if (method_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->hasMethod($name)) {
                return true;
            }
        }
    }
    return false;
}

            
hasProperty() public method

Defined in: yii\base\Component::hasProperty()

Returns a value indicating whether a property is defined for this component.

A property is defined if:

  • the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
  • an attached behavior has a property of the given name (when $checkBehaviors is true).

See also:

public boolean hasProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

The property name

$checkVars boolean

Whether to treat member variables as properties

$checkBehaviors boolean

Whether to treat behaviors' properties as properties of this component

return boolean

Whether the property is defined

                public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
{
    return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
}

            
init() public method (available since version 2.0.36)

Defined in: luya\admin\traits\AdminRestBehaviorTrait::init()

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

public void init ( )

                public function init()
{
    parent::init();
    $this->_module = AdminModule::getInstance();
    $this->enableCors = $this->_module->cors;
    $this->jsonCruft = $this->_module->jsonCruft;
    // pass all the luya admin languages to the content negoiator, the default language must be the first
    // element in the array.
    $this->languages = [Yii::$app->composition->langShortCode];
    foreach (Yii::$app->adminLanguage->languages as $lang) {
        array_push($this->languages, $lang['short_code']);
    }
    // disable session for rest usage
    Yii::$app->adminuser->enableSession = false;
}

            
isActionAllowed() public method (available since version 2.2.0)

Defined in: luya\admin\base\RestActiveController::isActionAllowed()

Checks if the given action id is allowed or not

public boolean isActionAllowed ( $action )
$action string

The action id

                public function isActionAllowed($action)
{
    if ($this->isActionAuthOptional($action)) {
        return true;
    }
    // a permission action exists, ensure if user has permission for this action or not:
    if (array_key_exists($action, $this->getActionPermissions())) {
        $type = $this->getActionPermissions()[$action];
        if (!in_array($type, [false, Auth::CAN_CREATE, Auth::CAN_DELETE, Auth::CAN_UPDATE, Auth::CAN_VIEW], true)) {
            throw new InvalidConfigException("Invalid type \"$type\" of action permission.");
        }
        $this->authId = Yii::$app->auth->matchApi($this->userAuthClass()->identity, $this->id, $type);
        if (!$this->authId) {
            throw new ForbiddenHttpException("User is unable to access the API \"{$this->id}\" due to insufficient permissions.");
        }
    } else {
        // there is no permission for the given api and action id, ensure api user access.
        $this->canApiUserAccess();
    }
    UserOnline::refreshUser($this->userAuthClass()->identity, $action);
    return true;
}

            
isActionAuthOptional() public method (available since version 2.2.0)

Defined in: luya\admin\traits\AdminRestBehaviorTrait::isActionAuthOptional()

Wether the given action id does not required authentication or not.

{@since 3.6.0} this will also return true when cors is enabled and the request method is OPTIONS. As the optional actions list is passed to the authenticator behavior, this is the place where authentication happens and is done anyhow before isActionAuthOptional() is used in beforeAction()` checks.

public boolean isActionAuthOptional ( $actionId )
$actionId string

                public function isActionAuthOptional($actionId)
{
    if ($this->enableCors && Yii::$app->request->isOptions) {
        return true;
    }
    return in_array($actionId, $this->authOptional);
}

            
off() public method

Defined in: yii\base\Component::off()

Detaches an existing event handler from this component.

This method is the opposite of on().

Note: in case wildcard pattern is passed for event name, only the handlers registered with this wildcard will be removed, while handlers registered with plain names matching this wildcard will remain.

See also on().

public boolean off ( $name, $handler null )
$name string

Event name

$handler callable|null

The event handler to be removed. If it is null, all handlers attached to the named event will be removed.

return boolean

If a handler is found and detached

                public function off($name, $handler = null)
{
    $this->ensureBehaviors();
    if (empty($this->_events[$name]) && empty($this->_eventWildcards[$name])) {
        return false;
    }
    if ($handler === null) {
        unset($this->_events[$name], $this->_eventWildcards[$name]);
        return true;
    }
    $removed = false;
    // plain event names
    if (isset($this->_events[$name])) {
        foreach ($this->_events[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_events[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_events[$name] = array_values($this->_events[$name]);
            return true;
        }
    }
    // wildcard event names
    if (isset($this->_eventWildcards[$name])) {
        foreach ($this->_eventWildcards[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_eventWildcards[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_eventWildcards[$name] = array_values($this->_eventWildcards[$name]);
            // remove empty wildcards to save future redundant regex checks:
            if (empty($this->_eventWildcards[$name])) {
                unset($this->_eventWildcards[$name]);
            }
        }
    }
    return $removed;
}

            
on() public method

Defined in: yii\base\Component::on()

Attaches an event handler to an event.

The event handler must be a valid PHP callback. The following are some examples:

function ($event) { ... }         // anonymous function
[$object, 'handleClick']          // $object->handleClick()
['Page', 'handleClick']           // Page::handleClick()
'handleClick'                     // global function handleClick()

The event handler must be defined with the following signature,

function ($event)

where $event is an yii\base\Event object which includes parameters associated with the event.

Since 2.0.14 you can specify event name as a wildcard pattern:

$component->on('event.group.*', function ($event) {
    Yii::trace($event->name . ' is triggered.');
});

See also off().

public void on ( $name, $handler, $data null, $append true )
$name string

The event name

$handler callable

The event handler

$data mixed

The data to be passed to the event handler when the event is triggered. When the event handler is invoked, this data can be accessed via yii\base\Event::$data.

$append boolean

Whether to append new event handler to the end of the existing handler list. If false, the new handler will be inserted at the beginning of the existing handler list.

                public function on($name, $handler, $data = null, $append = true)
{
    $this->ensureBehaviors();
    if (strpos($name, '*') !== false) {
        if ($append || empty($this->_eventWildcards[$name])) {
            $this->_eventWildcards[$name][] = [$handler, $data];
        } else {
            array_unshift($this->_eventWildcards[$name], [$handler, $data]);
        }
        return;
    }
    if ($append || empty($this->_events[$name])) {
        $this->_events[$name][] = [$handler, $data];
    } else {
        array_unshift($this->_events[$name], [$handler, $data]);
    }
}

            
prepareIndexQuery() public method (available since version 1.2.1)

Defined in: luya\admin\ngrest\base\Api::prepareIndexQuery()

Prepare Index Query.

You can override the prepare index query to preload relation data like this:

public function prepareIndexQuery()
{
    return parent::prepareIndexQuery()->with(['relation1', 'relation2']);
}

Make sure to call the parent implementation.

This will call the find() method of the model.

public yii\db\ActiveQuery prepareIndexQuery ( )

                public function prepareIndexQuery()
{
    /* @var $modelClass \yii\db\BaseActiveRecord */
    $modelClass = $this->modelClass;
    return $modelClass::find()->with($this->getWithRelation('index'));
}

            
prepareListQuery() public method (available since version 1.2.2)

Defined in: luya\admin\ngrest\base\Api::prepareListQuery()

Prepare the NgRest List Query.

This will call the ngRestFind() method of the model.

Use in list, export

public yii\db\ActiveQuery prepareListQuery ( )

                public function prepareListQuery()
{
    /* @var $modelClass \yii\db\BaseActiveRecord */
    $modelClass = $this->modelClass;
    $find = $modelClass::ngRestFind();
    $this->handleNotifications($modelClass, $this->authId);
    // check if a pool id is requested:
    $this->appendPoolWhereCondition($find);
    // add tags condition
    $tagIds = Yii::$app->request->get('tags');
    if ($tagIds) {
        $subQuery = clone $find;
        $inQuery = $subQuery->joinWith(['tags tags'])->andWhere(['tags.id' => array_unique(explode(",", $tagIds))])->select(['pk_id']);
        $find->andWhere(['in', $modelClass::primaryKey(), $inQuery]);
    }
    return $find->with($this->getWithRelation('list'));
}

            
redirect() public method

Defined in: yii\web\Controller::redirect()

Redirects the browser to the specified URL.

This method is a shortcut to yii\web\Response::redirect().

You can use it in an action by returning the yii\web\Response directly:

// stop executing this action and redirect to login page
return $this->redirect(['login']);
public yii\web\Response redirect ( $url, $statusCode 302 )
$url string|array

The URL to be redirected to. This can be in one of the following formats:

  • a string representing a URL (e.g. "https://example.com")
  • a string representing a URL alias (e.g. "@example.com")
  • an array in the format of [$route, ...name-value pairs...] (e.g. ['site/index', 'ref' => 1]) yii\helpers\Url::to() will be used to convert the array into a URL.

Any relative URL that starts with a single forward slash "/" will be converted into an absolute one by prepending it with the host info of the current request.

$statusCode integer

The HTTP status code. Defaults to 302. See https://tools.ietf.org/html/rfc2616#section-10 for details about HTTP status code

return yii\web\Response

The current response object

                public function redirect($url, $statusCode = 302)
{
    // calling Url::to() here because Response::redirect() modifies route before calling Url::to()
    return $this->response->redirect(Url::to($url), $statusCode);
}

            
refresh() public method

Defined in: yii\web\Controller::refresh()

Refreshes the current page.

This method is a shortcut to yii\web\Response::refresh().

You can use it in an action by returning the yii\web\Response directly:

// stop executing this action and refresh the current page
return $this->refresh();
public yii\web\Response refresh ( $anchor '' )
$anchor string

The anchor that should be appended to the redirection URL. Defaults to empty. Make sure the anchor starts with '#' if you want to specify it.

return yii\web\Response

The response object itself

                public function refresh($anchor = '')
{
    return $this->response->redirect($this->request->getUrl() . $anchor);
}

            
render() public method

Defined in: yii\base\Controller::render()

Renders a view and applies layout if available.

The view to be rendered can be specified in one of the following formats:

  • path alias (e.g. "@app/views/site/index");
  • absolute path within application (e.g. "//site/index"): the view name starts with double slashes. The actual view file will be looked for under the view path of the application.
  • absolute path within module (e.g. "/site/index"): the view name starts with a single slash. The actual view file will be looked for under the view path of $module.
  • relative path (e.g. "index"): the actual view file will be looked for under $viewPath.

To determine which layout should be applied, the following two steps are conducted:

  1. In the first step, it determines the layout name and the context module:
  • If $layout is specified as a string, use it as the layout name and $module as the context module;
  • If $layout is null, search through all ancestor modules of this controller and find the first module whose layout is not null. The layout and the corresponding module are used as the layout name and the context module, respectively. If such a module is not found or the corresponding layout is not a string, it will return false, meaning no applicable layout.
  1. In the second step, it determines the actual layout file according to the previously found layout name and context module. The layout name can be:
  • a path alias (e.g. "@app/views/layouts/main");
  • an absolute path (e.g. "/main"): the layout name starts with a slash. The actual layout file will be looked for under the layout path of the application;
  • a relative path (e.g. "main"): the actual layout file will be looked for under the layout path of the context module.

If the layout name does not contain a file extension, it will use the default one .php.

public string render ( $view, $params = [] )
$view string

The view name.

$params array

The parameters (name-value pairs) that should be made available in the view. These parameters will not be available in the layout.

return string

The rendering result.

throws yii\base\InvalidArgumentException

if the view file or the layout file does not exist.

                public function render($view, $params = [])
{
    $content = $this->getView()->render($view, $params, $this);
    return $this->renderContent($content);
}

            
renderAjax() public method

Defined in: yii\web\Controller::renderAjax()

Renders a view in response to an AJAX request.

This method is similar to renderPartial() except that it will inject into the rendering result with JS/CSS scripts and files which are registered with the view. For this reason, you should use this method instead of renderPartial() to render a view to respond to an AJAX request.

public string renderAjax ( $view, $params = [] )
$view string

The view name. Please refer to render() on how to specify a view name.

$params array

The parameters (name-value pairs) that should be made available in the view.

return string

The rendering result.

                public function renderAjax($view, $params = [])
{
    return $this->getView()->renderAjax($view, $params, $this);
}

            
renderContent() public method (available since version 2.0.1)

Defined in: yii\base\Controller::renderContent()

Renders a static string by applying a layout.

public string renderContent ( $content )
$content string

The static string being rendered

return string

The rendering result of the layout with the given static string as the $content variable. If the layout is disabled, the string will be returned back.

                public function renderContent($content)
{
    $layoutFile = $this->findLayoutFile($this->getView());
    if ($layoutFile !== false) {
        return $this->getView()->renderFile($layoutFile, ['content' => $content], $this);
    }
    return $content;
}

            
renderFile() public method

Defined in: yii\base\Controller::renderFile()

Renders a view file.

public string renderFile ( $file, $params = [] )
$file string

The view file to be rendered. This can be either a file path or a path alias.

$params array

The parameters (name-value pairs) that should be made available in the view.

return string

The rendering result.

throws yii\base\InvalidArgumentException

if the view file does not exist.

                public function renderFile($file, $params = [])
{
    return $this->getView()->renderFile($file, $params, $this);
}

            
renderPartial() public method

Defined in: yii\base\Controller::renderPartial()

Renders a view without applying layout.

This method differs from render() in that it does not apply any layout.

public string renderPartial ( $view, $params = [] )
$view string

The view name. Please refer to render() on how to specify a view name.

$params array

The parameters (name-value pairs) that should be made available in the view.

return string

The rendering result.

throws yii\base\InvalidArgumentException

if the view file does not exist.

                public function renderPartial($view, $params = [])
{
    return $this->getView()->render($view, $params, $this);
}

            
run() public method

Defined in: yii\base\Controller::run()

Runs a request specified in terms of a route.

The route can be either an ID of an action within this controller or a complete route consisting of module IDs, controller ID and action ID. If the route starts with a slash '/', the parsing of the route will start from the application; otherwise, it will start from the parent module of this controller.

See also runAction().

public mixed run ( $route, $params = [] )
$route string

The route to be handled, e.g., 'view', 'comment/view', '/admin/comment/view'.

$params array

The parameters to be passed to the action.

return mixed

The result of the action.

                public function run($route, $params = [])
{
    $pos = strpos($route, '/');
    if ($pos === false) {
        return $this->runAction($route, $params);
    } elseif ($pos > 0) {
        return $this->module->runAction($route, $params);
    }
    return Yii::$app->runAction(ltrim($route, '/'), $params);
}

            
runAction() public method

Defined in: yii\base\Controller::runAction()

Runs an action within this controller with the specified action ID and parameters.

If the action ID is empty, the method will use $defaultAction.

See also createAction().

public mixed runAction ( $id, $params = [] )
$id string

The ID of the action to be executed.

$params array

The parameters (name-value pairs) to be passed to the action.

return mixed

The result of the action.

throws yii\base\InvalidRouteException

if the requested action ID cannot be resolved into an action successfully.

                public function runAction($id, $params = [])
{
    $action = $this->createAction($id);
    if ($action === null) {
        throw new InvalidRouteException('Unable to resolve the request: ' . $this->getUniqueId() . '/' . $id);
    }
    Yii::debug('Route to run: ' . $action->getUniqueId(), __METHOD__);
    if (Yii::$app->requestedAction === null) {
        Yii::$app->requestedAction = $action;
    }
    $oldAction = $this->action;
    $this->action = $action;
    $modules = [];
    $runAction = true;
    // call beforeAction on modules
    foreach ($this->getModules() as $module) {
        if ($module->beforeAction($action)) {
            array_unshift($modules, $module);
        } else {
            $runAction = false;
            break;
        }
    }
    $result = null;
    if ($runAction && $this->beforeAction($action)) {
        // run the action
        $result = $action->runWithParams($params);
        $result = $this->afterAction($action, $result);
        // call afterAction on modules
        foreach ($modules as $module) {
            /* @var $module Module */
            $result = $module->afterAction($action, $result);
        }
    }
    if ($oldAction !== null) {
        $this->action = $oldAction;
    }
    return $result;
}

            
sendArrayError() public method (available since version 1.0.3)

Defined in: luya\traits\RestBehaviorsTrait::sendArrayError()

Send Array validation error.

Example input:

return $this->sendArrayError(['firstname' => 'Firstname cannot be blank']);

Example return value:

Array
(
    [0] => Array
        (
            [field] => firstname
            [message] => Firstname cannot be blank.
        )
)
public array sendArrayError ( array $errors )
$errors array

Provide an array with messages. Where key is the field and value the message.

return array

Returns an array with field and message keys for each item.

                public function sendArrayError(array $errors)
{
    return RestHelper::sendArrayError($errors);
}

            
sendModelError() public method

Defined in: luya\traits\RestBehaviorsTrait::sendModelError()

Send Model errors with correct headers.

Helper method to correctly send model errors with the correct response headers.

Example return value:

Array
(
    [0] => Array
        (
            [field] => firstname
            [message] => Firstname cannot be blank.
        )
    [1] => Array
        (
            [field] => email
            [message] => Email cannot be blank.
        )
)
public array sendModelError ( yii\base\Model $model )
$model yii\base\Model

The model to find the first error.

return array

If the model has errors InvalidParamException will be thrown, otherwise an array with message and field key.

throws yii\base\InvalidParamException

                public function sendModelError(Model $model)
{
    return RestHelper::sendModelError($model);
}

            
serializeData() protected method

Defined in: yii\rest\Controller::serializeData()

Serializes the specified data.

The default implementation will create a serializer based on the configuration given by $serializer. It then uses the serializer to serialize the given data.

protected mixed serializeData ( $data )
$data mixed

The data to be serialized

return mixed

The serialized data.

                protected function serializeData($data)
{
    return Yii::createObject($this->serializer)->serialize($data);
}

            
setView() public method

Defined in: yii\base\Controller::setView()

Sets the view object to be used by this controller.

public void setView ( $view )
$view yii\base\View|yii\web\View

The view object that can be used to render views or view files.

                public function setView($view)
{
    $this->_view = $view;
}

            
setViewPath() public method (available since version 2.0.7)

Defined in: yii\base\Controller::setViewPath()

Sets the directory that contains the view files.

public void setViewPath ( $path )
$path string

The root directory of view files.

throws yii\base\InvalidArgumentException

if the directory is invalid

                public function setViewPath($path)
{
    $this->_viewPath = Yii::getAlias($path);
}

            
trigger() public method

Defined in: yii\base\Component::trigger()

Triggers an event.

This method represents the happening of an event. It invokes all attached handlers for the event including class-level handlers.

public void trigger ( $name, yii\base\Event $event null )
$name string

The event name

$event yii\base\Event|null

The event instance. If not set, a default yii\base\Event object will be created.

                public function trigger($name, Event $event = null)
{
    $this->ensureBehaviors();
    $eventHandlers = [];
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (StringHelper::matchWildcard($wildcard, $name)) {
            $eventHandlers[] = $handlers;
        }
    }
    if (!empty($this->_events[$name])) {
        $eventHandlers[] = $this->_events[$name];
    }
    if (!empty($eventHandlers)) {
        $eventHandlers = call_user_func_array('array_merge', $eventHandlers);
        if ($event === null) {
            $event = new Event();
        }
        if ($event->sender === null) {
            $event->sender = $this;
        }
        $event->handled = false;
        $event->name = $name;
        foreach ($eventHandlers as $handler) {
            $event->data = $handler[1];
            call_user_func($handler[0], $event);
            // stop further handling if the event is handled
            if ($event->handled) {
                return;
            }
        }
    }
    // invoke class-level attached handlers
    Event::trigger($this, $name, $event);
}

            
userAuthClass() public method

Defined in: luya\admin\traits\AdminRestBehaviorTrait::userAuthClass()

Get the current user auth object.

public luya\admin\components\AdminUser userAuthClass ( )

                public function userAuthClass()
{
    return Yii::$app->adminuser;
}

            
verbs() protected method

Defined in: yii\rest\ActiveController::verbs()

Declares the allowed HTTP verbs.

Please refer to yii\filters\VerbFilter::$actions on how to declare the allowed verbs.

protected array verbs ( )
return array

The allowed HTTP verbs.

                protected function verbs()
{
    return [
        'index' => ['GET', 'HEAD'],
        'view' => ['GET', 'HEAD'],
        'create' => ['POST'],
        'update' => ['PUT', 'PATCH'],
        'delete' => ['DELETE'],
    ];
}

            
withRelations() public method (available since version 1.2.2)

Defined in: luya\admin\ngrest\base\Api::withRelations()

Auto add those relations to queries.

The relation will only eager load when available in expand get params. ?expand=user f.e.

This can be either an array with relations which will be passed to index, list and view or an array with a subdefinition in order to define which relation should be us when.

basic:

return ['user', 'images'];

The above relations will be auto added trough {{yii\db\ActiveQuery::with()}}. In order to define view specific actions:

return [
    'index' => ['user', 'images'],
    'list' => ['user'],
];

Possible action column names:

  • index
  • list
  • search
  • export
public array withRelations ( )

                public function withRelations()
{
    return [];
}