Class luya\admin\controllers\LoggerController
Inheritance | luya\admin\controllers\LoggerController » luya\admin\ngrest\base\Controller » luya\admin\base\Controller » luya\web\Controller » yii\web\Controller » yii\base\Controller » yii\base\Component » yii\base\BaseObject |
---|---|
Implements | yii\base\Configurable, yii\base\ViewContextInterface |
Available since version | 1.0.0 |
Source Code | https://github.com/luyadev/luya-module-admin/blob/master/src/controllers/LoggerController.php |
NgRest Logger Controller
Public 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 |
$apiResponseActions | array | A list of actions which should be treated as api response, this will convert a returned array into an application/json header. | luya\admin\base\Controller |
$behaviors | yii\base\Behavior[] | List of behaviors attached to this component. | yii\base\Component |
$clearButton | boolean | Whether the CRUD dropdown shows a button with "Delete all data" which will then truncate the whole table content. | luya\admin\controllers\LoggerController |
$defaultAction | string | The ID of the action that is used when the action ID is not specified in the request. | yii\base\Controller |
$description | string | A text descirption for the CRUD which is display below the CRUD title | luya\admin\ngrest\base\Controller |
$disablePermissionCheck | boolean | Disables the permission | luya\admin\ngrest\base\Controller |
$enableCsrfValidation | boolean | Whether to enable CSRF validation for the actions in this controller. | yii\web\Controller |
$globalButtons | array | Define global ngrest controller buttons you can choose in the drop down menu of an ngrest page. | luya\admin\ngrest\base\Controller |
$id | string | The ID of this controller. | yii\base\Controller |
$layout | string | Path to the admin layout | luya\admin\ngrest\base\Controller |
$model | luya\admin\ngrest\base\NgRestModel | The model based from the modelClass instance | luya\admin\ngrest\base\Controller |
$modelClass | string | Defines the related model for the NgRest Controller. | luya\admin\controllers\LoggerController |
$module | yii\base\Module | The module that this controller belongs to. | yii\base\Controller |
$moduleLayoutViewPath | string | The path to the layout for the current Module. | luya\web\Controller |
$modules | yii\base\Module[] | All ancestor modules that this controller is located within. | yii\base\Controller |
$renderCrud | string|array|luya\admin\ngrest\render\RenderCrudInterface | You can customize crud rendering using this property. | luya\admin\ngrest\base\Controller |
$request | yii\web\Request | The request object. | yii\web\Controller |
$response | yii\web\Response | The response object. | yii\web\Controller |
$route | string | The route (module ID, controller ID and action ID) of the current request. | yii\base\Controller |
$rules | array | A list of rules. | luya\admin\base\Controller |
$uniqueId | string | The controller ID that is prefixed with the module ID (if any). | yii\base\Controller |
$view | yii\web\View | The view object that can be used to render views or view files. | yii\web\Controller |
$viewPath | string | The directory containing the view files for this controller. | yii\base\Controller |
Public 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 |
actionExportDownload() | Get the file content response for a given key. | luya\admin\ngrest\base\Controller |
actionIndex() | Render the ngrest default index template. | luya\admin\ngrest\base\Controller |
actions() | Declares external actions for the controller. | yii\base\Controller |
afterAction() | This method is invoked right after an action is executed. | yii\base\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() | This method is invoked right before an action is executed. | luya\admin\base\Controller |
behaviors() | Attach the AccessControl filter behavior for the controler. | luya\admin\base\Controller |
bindActionParams() | Binds the parameters to the action. | yii\web\Controller |
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 |
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 |
getBehavior() | Returns the named behavior object. | yii\base\Component |
getBehaviors() | Returns all behaviors attached to this component. | yii\base\Component |
getDescription() | Getter method for description | luya\admin\controllers\LoggerController |
getModel() | Get Model Object | luya\admin\ngrest\base\Controller |
getModuleLayoutViewPath() | Returns the path for layout files when using {{\luya\web\Controller::renderLayout()}} method. Those module layouts are located in @app/views folder. | luya\web\Controller |
getModules() | Returns all ancestor modules of this controller. | yii\base\Controller |
getRoute() | Returns the route of the current request. | yii\base\Controller |
getRules() | Returns the rules for the AccessControl filter behavior. | luya\admin\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() | Override the default Yii controller getViewPath method. To define the template folders in where the templates are located. Why? Basically some modules needs to put theyr templates inside of the client repository. | luya\web\Controller |
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\ngrest\base\Controller |
off() | Detaches an existing event handler from this component. | yii\base\Component |
on() | Attaches an event handler to an event. | yii\base\Component |
redirect() | Redirects the browser to the specified URL. | yii\web\Controller |
refresh() | Refreshes the current page. | yii\web\Controller |
registerAsset() | Helper method for registring an asset into the view. | luya\web\Controller |
render() | If we are acting in the module context and the layout is empty we only should renderPartial the content. | luya\web\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 |
renderLayout() | Luya implementation of layouts for controllers. The method will return a view file wrapped by a custom module layout. | luya\web\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 |
setDescription() | Setter method for description | luya\admin\ngrest\base\Controller |
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 |
Protected Methods
Method | Description | Defined By |
---|---|---|
bindInjectedParams() | Fills parameters based on types and names in action method signature. | yii\base\Controller |
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 |
Property Details
Whether the CRUD dropdown shows a button with "Delete all data" which will then truncate the whole table content. Usefull for tables which contain only temporary informations like logs and errors. If the user does not have delete permission, the button is hidden. In order to make the clear buutton (truncates all the data) work, the {{luya\admin\ngrest\base\Api::$truncateAction}} must be enabled.
Defines the related model for the NgRest Controller. The full qualified model name is required.
public $modelClass = 'admin\models\User';
Method Details
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()");
}
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;
}
Defined in: yii\base\Controller::__construct()
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);
}
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);
}
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)
.
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;
}
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);
}
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)
.
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);
}
Defined in: luya\admin\ngrest\base\Controller::actionExportDownload()
Get the file content response for a given key.
public yii\web\Response actionExportDownload ( $key ) | ||
$key | string | |
throws | yii\web\ForbiddenHttpException |
---|
public function actionExportDownload($key)
{
$sessionkey = Yii::$app->session->get('tempNgRestFileKey');
$fileName = Yii::$app->session->get('tempNgRestFileName');
$mimeType = Yii::$app->session->get('tempNgRestFileMime');
if ($sessionkey !== base64_decode($key)) {
throw new ForbiddenHttpException('Invalid download key.');
}
$content = FileHelper::getFileContent('@runtime/'.$sessionkey.'.tmp');
Yii::$app->session->remove('tempNgRestFileKey');
Yii::$app->session->remove('tempNgRestFileName');
Yii::$app->session->remove('tempNgRestFileMime');
@unlink(Yii::getAlias('@runtime/'.$sessionkey.'.tmp'));
return Yii::$app->response->sendContentAsFile($content, $fileName, ['mimeType' => $mimeType]);
}
Defined in: luya\admin\ngrest\base\Controller::actionIndex()
Render the ngrest default index template.
public string actionIndex ( $inline = false, $relation = false, $arrayIndex = false, $modelClass = false, $modelSelection = false ) | ||
$inline | string | |
$relation | string | |
$arrayIndex | string | |
$modelClass | string | |
$modelSelection | string | |
throws | Exception |
---|
public function actionIndex($inline = false, $relation = false, $arrayIndex = false, $modelClass = false, $modelSelection = false)
{
$apiEndpoint = $this->model->ngRestApiEndpoint();
$config = $this->model->getNgRestConfig();
$userSortSettings = Yii::$app->adminuser->identity->setting->get('ngrestorder.admin/'.$apiEndpoint, false);
if ($userSortSettings && is_array($userSortSettings) && $config->getDefaultOrder() !== false) {
$config->defaultOrder = [$userSortSettings['field'] => $userSortSettings['sort']];
}
// check if delete permissions exists for the current user in this crud.
if ($this->clearButton && Yii::$app->auth->matchApi(Yii::$app->adminuser->getId(), $config->apiEndpoint, Auth::CAN_DELETE)) {
array_push($this->globalButtons, [
'icon' => 'delete',
'label' => Module::t('ngrest_delete_all_button_label'),
'ng-click' => "clearData()"
]);
}
// generate crud renderer
$crud = Yii::createObject($this->renderCrud);
$crud->description = $this->description;
$crud->setModel($this->model);
$crud->setSettingButtonDefinitions($this->globalButtons);
$crud->setIsInline($inline);
$crud->setModelSelection($modelSelection);
if ($relation && is_scalar($relation) && $arrayIndex !== false && $modelClass !== false) {
$crud->setRelationCall(['id' => $relation, 'arrayIndex' => $arrayIndex, 'modelClass' => $modelClass]);
}
// generate ngrest object from config and render renderer
$ngrest = new NgRest($config);
return $ngrest->render($crud);
}
Defined in: yii\base\Controller::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()
{
return [];
}
Defined in: yii\base\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)
{
$event = new ActionEvent($action);
$event->result = $result;
$this->trigger(self::EVENT_AFTER_ACTION, $event);
return $event->result;
}
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 |
---|
public function asJson($data)
{
$this->response->format = Response::FORMAT_JSON;
$this->response->data = $data;
return $this->response;
}
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 |
---|
public function asXml($data)
{
$this->response->format = Response::FORMAT_XML;
$this->response->data = $data;
return $this->response;
}
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);
}
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);
}
}
Defined in: luya\admin\base\Controller::beforeAction()
This method is invoked right before an action is executed.
The method will trigger the EVENT_BEFORE_ACTION event. The return value of the method will determine whether the action should continue to run.
In case the action should not run, the request should be handled inside of the beforeAction
code
by either providing the necessary output or redirecting the request. Otherwise the response will be empty.
If you override this method, your code should look like the following:
public function beforeAction($action)
{
// your custom code here, if you want the code to run before action filters,
// which are triggered on the [[EVENT_BEFORE_ACTION]] event, e.g. PageCache or AccessControl
if (!parent::beforeAction($action)) {
return false;
}
// other custom code here
return true; // or false to not run the action
}
public boolean beforeAction ( $action ) | ||
$action | yii\base\Action |
The action to be executed. |
return | boolean |
Whether the action should continue to run. |
---|
public function beforeAction($action)
{
if (parent::beforeAction($action)) {
Yii::$app->language = Yii::$app->adminuser->interfaceLanguage;
return true;
}
return false;
}
Defined in: luya\admin\base\Controller::behaviors()
Attach the AccessControl filter behavior for the controler.
public array behaviors ( ) |
public function behaviors()
{
$behaviors = [
'access' => [
'class' => AccessControl::class,
'user' => Yii::$app->adminuser,
'rules' => $this->getRules(),
],
];
if (!empty($this->apiResponseActions)) {
$behaviors['negotiator'] = [
'class' => ContentNegotiator::class,
'only' => $this->apiResponseActions,
'formats' => [
'application/json' => Response::FORMAT_JSON,
],
];
}
return $behaviors;
}
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;
}
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);
}
}
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;
}
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;
}
::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();
}
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;
}
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;
}
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);
}
}
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);
}
}
}
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;
}
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;
}
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;
}
Getter method for description
public string getDescription ( ) |
public function getDescription()
{
return Module::t('logger_controller_description');
}
Defined in: luya\admin\ngrest\base\Controller::getModel()
Get Model Object
public luya\admin\ngrest\base\NgRestModel getModel ( ) |
public function getModel()
{
if ($this->_model === null) {
$this->_model = Yii::createObject($this->modelClass);
}
return $this->_model;
}
Defined in: luya\web\Controller::getModuleLayoutViewPath()
Returns the path for layout files when using {{\luya\web\Controller::renderLayout()}} method. Those module layouts are located in @app/views folder.
public string getModuleLayoutViewPath ( ) | ||
return | string |
The path to the layout for the current Module. |
---|
public function getModuleLayoutViewPath()
{
if ($this->module->useAppViewPath) {
return '@app/views/'.$this->module->id.'/';
}
return '@'.$this->module->id.'/views/';
}
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;
}
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();
}
Defined in: luya\admin\base\Controller::getRules()
Returns the rules for the AccessControl filter behavior.
The rules are applied as following:
- Administration User must be logged in, this is by default for all actions inside the controller.
- Check the current given route against {{luya\admin\components\Auth::matchRoute()}}. 2a. If {{luya\admin\base\Controller::$disabledPermissionCheck}} enabled, the match route behavior is disabled.
See also \luya\admin\base\yii\filters\AccessControl.
public array getRules ( ) | ||
return | array |
A list of rules. |
---|
public function getRules()
{
return [
[
'allow' => true,
'actions' => [], // apply to all actions by default
'roles' => ['@'],
'matchCallback' => function ($rule, $action) {
// see if a controller property has been defined to disabled the permission checks
if ($action->controller->disablePermissionCheck) {
return true;
}
// get the route based on the current $action object
$route = implode('/', [$action->controller->module->id, $action->controller->id, $action->id]);
UserOnline::refreshUser($this->user->identity, $route);
// check the access inside auth->matchRoute and return true/false.
return Yii::$app->auth->matchRoute($this->user->id, $route);
},
],
];
}
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;
}
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;
}
Defined in: luya\web\Controller::getViewPath()
Override the default Yii controller getViewPath method. To define the template folders in where the templates are located. Why? Basically some modules needs to put theyr templates inside of the client repository.
public string getViewPath ( ) |
public function getViewPath()
{
if ($this->module instanceof Module) {
if ($this->module->useAppViewPath) {
return '@app/views/' . $this->module->id . '/' . $this->id;
} elseif (is_array($this->module->viewMap)) {
$currentAction = $this->id . '/' . ($this->action ? $this->action->id : $this->defaultAction);
foreach ($this->module->viewMap as $action => $viewPath) {
// Special case for map all views of controller
if ($action === '*') {
return $viewPath . '/' . $this->id;
} elseif (fnmatch($action, $currentAction)) {
return $viewPath;
}
}
}
}
return parent::getViewPath();
}
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));
}
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());
}
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);
}
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;
}
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);
}
Defined in: luya\admin\ngrest\base\Controller::init()
Initializes the object.
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();
if ($this->modelClass === null) {
throw new InvalidConfigException("The property `modelClass` must be defined by the Controller.");
}
if (is_array($this->renderCrud) && empty($this->renderCrud['class'])) {
$this->renderCrud['class'] = RenderCrud::class;
}
}
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;
}
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]);
}
}
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:
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);
}
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);
}
Defined in: luya\web\Controller::registerAsset()
Helper method for registring an asset into the view.
public void registerAsset ( $className ) | ||
$className | string |
The asset class to register, example |
public function registerAsset($className)
{
$className::register($this->view);
}
Defined in: luya\web\Controller::render()
If we are acting in the module context and the layout is empty we only should renderPartial the content.
public string render ( $view, $params = [] ) | ||
$view | string |
The name of the view file (e.g. index) |
$params | array |
The params to assign into the value for key is the variable and value the content. |
public function render($view, $params = [])
{
if (!empty($this->module->context) && empty($this->layout)) {
return $this->renderPartial($view, $params);
}
return parent::render($view, $params);
}
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);
}
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 |
---|
public function renderContent($content)
{
$layoutFile = $this->findLayoutFile($this->getView());
if ($layoutFile !== false) {
return $this->getView()->renderFile($layoutFile, ['content' => $content], $this);
}
return $content;
}
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);
}
Defined in: luya\web\Controller::renderLayout()
Luya implementation of layouts for controllers. The method will return a view file wrapped by a custom module layout.
For example you have a e-store module with a header which returns the basket you can use the module layout in all the actions to retrieve the same header. Example e-store controller class:.
class EstoreController extends \luya\base\Controller
{
public function actionIndex()
{
return $this->renderLayout('index', ['content' => 'This is my index content in variabel $content.']);
}
public function actionBasket()
{
return $this->renderLayout('basket', ['otherVariable' => 'This is a variable for the basket view file in variable $otherVariable.']);
}
}
The example layout file which is located in @app/views/module/layout
could look something like this:
<ul>
<li>E-Store Frontpage</li>
<li>Basket</li>
</ul>
<div id="estore-wrapper">
<?php echo $content; ?>
</div>
public string renderLayout ( $view, $params = [] ) | ||
$view | string |
The name of the view file |
$params | array |
The params to assign into the view file. |
return | string |
Rendered template wrapped by the module layout file. |
---|
public function renderLayout($view, $params = [])
{
$content = $this->view->render($view, $params, $this);
return $this->render($this->getModuleLayoutViewPath().$this->module->moduleLayout, ['content' => $content]);
}
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);
}
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);
}
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;
}
Defined in: luya\admin\ngrest\base\Controller::setDescription()
Setter method for description
public void setDescription ( $description ) | ||
$description | string |
public function setDescription($description)
{
$this->_description = $description;
}
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;
}
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);
}
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);
}