Class luya\admin\apis\StorageController
Filemanager and Storage API.
Storage API, provides data from system image, files, filters and folders to build the filemanager, allows create/delete process to manipulate storage data.
The storage controller is used to make the luya angular file manager work with the {{luya\admin\storage\BaseFileSystemStorage}}.
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 |
$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 |
$compositeAuthMethods | array | luya\traits\RestBehaviorsTrait | |
$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 |
$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 |
$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 |
$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 |
$serializer | string|array | The configuration for creating the serializer that formats the response data. | yii\rest\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 |
Protected Properties
Property | Type | Description | Defined By |
---|---|---|---|
$whitelistedActions | array | A list of action ids which are whiteliste and does not require the file manager permission. | luya\admin\apis\StorageController |
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 |
actionDataFiles() | Get all files from the storage container. | luya\admin\apis\StorageController |
actionDataFilters() | Get all available registered filters. | luya\admin\apis\StorageController |
actionDataFolders() | Get all folders from the storage component. | luya\admin\apis\StorageController |
actionFile() | Get file model. | luya\admin\apis\StorageController |
actionFileCrop() | Create or replace a certain file based on new cropped image informations. | luya\admin\apis\StorageController |
actionFileInfo() | Get all storage file informations for a given ID. | luya\admin\apis\StorageController |
actionFileReplace() | Action to replace a current file with a new. | luya\admin\apis\StorageController |
actionFileUpdate() | luya\admin\apis\StorageController | |
actionFilemanagerMoveFiles() | Move files into another folder. | luya\admin\apis\StorageController |
actionFilemanagerRemoveFiles() | Remove files from the storage component. | luya\admin\apis\StorageController |
actionFilemanagerUpdateCaption() | Update the caption of storage file. | luya\admin\apis\StorageController |
actionFilesUpload() | Upload a new file from $_FILES array. | luya\admin\apis\StorageController |
actionFolderCreate() | Create a new folder pased on post data. | luya\admin\apis\StorageController |
actionFolderDelete() | Delete folder, all subfolders and all included files. | luya\admin\apis\StorageController |
actionFolderUpdate() | Update the folder model data. | luya\admin\apis\StorageController |
actionImage() | Get image model. | luya\admin\apis\StorageController |
actionImageFilter() | Upload an image to the filemanager. | luya\admin\apis\StorageController |
actionImageInfo() | luya\admin\apis\StorageController | |
actionImagesInfo() | A post request with an array of images to load! | luya\admin\apis\StorageController |
actionImagesUpload() | Image Upload with $_FILES array: | luya\admin\apis\StorageController |
actionIsFolderEmpty() | Check whether a folder is empty or not in order to delete this folder. | luya\admin\apis\StorageController |
actionToggleFileTag() | Toggle Tags for a given file. | luya\admin\apis\StorageController |
actions() | Declares external actions for the controller. | yii\base\Controller |
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\RestController |
behaviors() | Returns a list of behaviors that this component should behave as. | yii\rest\Controller |
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 |
checkRouteAccess() | Shorthand method to check whether the current user exists for the given route, otherwise throw forbidden exception. | luya\admin\base\RestController |
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 |
deleteHasCache() | Remove a value from the cache if caching is enabled. | luya\traits\CacheableTrait |
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 |
flushHasCache() | Deletes all values from cache. | luya\traits\CacheableTrait |
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 |
getHasCache() | Get the caching data if caching is allowed and there is any data stored for this key. | luya\traits\CacheableTrait |
getModules() | Returns all ancestor modules of this controller. | yii\base\Controller |
getOrSetHasCache() | Method combines both setHasCache() and getHasCache() methods to retrieve value identified by a $key, or to store the result of $closure execution if there is no cache available for the $key. | luya\traits\CacheableTrait |
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 |
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. | yii\base\Controller |
isActionAuthOptional() | Wether the given action id does not required authentication or not. | luya\admin\traits\AdminRestBehaviorTrait |
isCachable() | Check if the current configuration of the application and the property allows a caching of the language container data. | luya\traits\CacheableTrait |
off() | Detaches an existing event handler from this component. | yii\base\Component |
on() | Attaches an event handler to an event. | yii\base\Component |
permissionRoute() | Returns the default permission route to check. By default this will return the current route of the performed action. | luya\admin\apis\StorageController |
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 |
setHasCache() | Store cache data for a specific key if caching is enabled in this application. | luya\traits\CacheableTrait |
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 |
Protected Methods
Method | Description | Defined By |
---|---|---|
bindInjectedParams() | Fills parameters based on types and names in action method signature. | yii\base\Controller |
flushApiCache() | Flush the storage caching data. | luya\admin\apis\StorageController |
serializeData() | Serializes the specified data. | yii\rest\Controller |
verbs() | Declares the allowed HTTP verbs. | yii\rest\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 |
Constants
Constant | Value | Description | Defined By |
---|---|---|---|
PERMISSION_ROUTE | 'admin/storage/index' | luya\admin\apis\StorageController |
Property Details
A list of action ids which are whiteliste and does not require the file manager permission.
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);
}
Get all files from the storage container.
public array actionDataFiles ( $folderId = 0, $search = null ) | ||
$folderId | ||
$search |
public function actionDataFiles($folderId = 0, $search = null)
{
$query = StorageFile::find()
->select(['id', 'name_original', 'extension', 'upload_timestamp', 'file_size', 'mime_type'])
->where(['is_hidden' => false, 'is_deleted' => false])
->with(['images.file']);
if (!empty($search)) {
$query->andFilterWhere(['or',
['like', 'name_original', $search],
['like', 'caption', $search],
['=', 'id', $search],
]);
} else {
$query->andWhere(['folder_id' => $folderId]);
}
return new ActiveDataProvider([
'query' => $query,
]);
}
Get all available registered filters.
public array actionDataFilters ( ) |
public function actionDataFilters()
{
return Yii::$app->storage->filtersArray;
}
Get all folders from the storage component.
public array actionDataFolders ( ) |
public function actionDataFolders()
{
return $this->getOrSetHasCache('storageApiDataFolders', function () {
$folders = [];
foreach (Yii::$app->storage->findFolders() as $key => $folder) {
$folders[$key] = $folder->toArray();
$folders[$key]['toggle_open'] = (int) Yii::$app->adminuser->identity->setting->get('foldertree.'.$folder->id);
$folders[$key]['subfolder'] = Yii::$app->storage->getFolder($folder->id)->hasChild();
}
return $folders;
}, 0, new DbDependency(['sql' => 'SELECT MAX(id) FROM {{%admin_storage_folder}} WHERE is_deleted=false']));
}
Get file model.
This is mainly used for external api access.
public luya\admin\models\StorageFile actionFile ( $id ) | ||
$id | integer |
public function actionFile($id)
{
$model = StorageFile::find()->where(['id' => $id])->one();
if (!$model) {
throw new NotFoundHttpException("Unable to find the given storage file.");
}
return $model;
}
Create or replace a certain file based on new cropped image informations.
public \luya\admin\apis\Item actionFileCrop ( ) |
public function actionFileCrop()
{
$data = Yii::$app->request->getBodyParam('distImage');
$fileName = Yii::$app->request->getBodyParam('fileName');
$ext = Yii::$app->request->getBodyParam('extension');
$saveAsCopy = Yii::$app->request->getBodyParam('saveAsCopy');
$fileId = Yii::$app->request->getBodyParam('fileId');
$file = StorageFile::findOne($fileId);
if (empty($data) || empty($fileName) || empty($ext)) {
throw new InvalidArgumentException("Invalid Params");
}
[$type, $data] = explode(';', $data);
[, $data] = explode(',', $data);
$data = base64_decode($data);
if (!$saveAsCopy && $fileId) {
Storage::replaceFileFromContent($file->name_new_compound, $data);
return Storage::refreshFile($fileId, $file->getServerSource());
}
return Storage::uploadFromContent($data, $file->name_new .'_copy.'.$ext, $file->folder_id);
}
Get all storage file informations for a given ID.
public array actionFileInfo ( $id ) | ||
$id | ||
throws | yii\web\NotFoundHttpException |
---|
public function actionFileInfo($id)
{
$model = StorageFile::find()->where(['id' => $id])->with(['user', 'images', 'tags'])->one();
if (!$model) {
throw new NotFoundHttpException("Unable to find the given storage file.");
}
return $model->toArray([], ['user', 'file', 'images', 'source', 'tags']);
}
Action to replace a current file with a new.
public boolean actionFileReplace ( ) |
public function actionFileReplace()
{
$fileId = Yii::$app->request->post('fileId', false);
$pageId = Yii::$app->request->post('pageId', 0);
Yii::warning('replace request for file id' . $fileId, __METHOD__);
$raw = $_FILES['file'];
/** @var $file \luya\admin\file\Item */
if ($file = Yii::$app->storage->getFile($fileId)) {
$newFileSource = $raw['tmp_name'];
if (is_uploaded_file($newFileSource)) {
// check for same extension / mimeType
$fileData = Yii::$app->storage->ensureFileUpload($raw['tmp_name'], $raw['name']);
if ($fileData['mimeType'] != $file->mimeType) {
throw new BadRequestHttpException("The type must be the same as the original file in order to replace.");
}
if (Storage::replaceFile($file->systemFileName, $newFileSource, $raw['name'])) {
return Storage::refreshFile($file->id, $newFileSource);
}
}
}
return false;
}
public array actionFileUpdate ( $id, $pageId = 0 ) | ||
$id | integer | |
$pageId | ||
throws | yii\web\NotFoundHttpException |
---|
public function actionFileUpdate($id, $pageId = 0)
{
$model = StorageFile::find()->where(['id' => $id])->with(['user'])->one();
if (!$model) {
throw new NotFoundHttpException("Unable to find the given storage file.");
}
$post = Yii::$app->request->bodyParams;
$model->attributes = $post;
if ($model->update(true, ['name_original', 'inline_disposition']) !== false) {
Yii::$app->storage->trigger(BaseFileSystemStorage::FILE_UPDATE_EVENT, new FileEvent(['file' => $model]));
$this->flushApiCache($model->folder_id, $pageId);
return $model;
}
return $this->sendModelError($model);
}
Move files into another folder.
public boolean actionFilemanagerMoveFiles ( ) |
public function actionFilemanagerMoveFiles()
{
$toFolderId = Yii::$app->request->post('toFolderId', 0);
$fileIds = Yii::$app->request->post('fileIds', []);
$currentPageId = Yii::$app->request->post('currentPageId', 0);
$currentFolderId = Yii::$app->request->post('currentFolderId', 0);
$response = Storage::moveFilesToFolder($fileIds, $toFolderId);
$this->flushApiCache($currentFolderId, $currentPageId);
$this->flushApiCache($toFolderId, $currentPageId);
$this->flushHasCache();
return $response;
}
Remove files from the storage component.
public boolean actionFilemanagerRemoveFiles ( ) |
public function actionFilemanagerRemoveFiles()
{
$pageId = Yii::$app->request->post('pageId', 0);
$folderId = Yii::$app->request->post('folderId', 0);
foreach (Yii::$app->request->post('ids', []) as $id) {
if (!Storage::removeFile($id)) {
return false;
}
}
$this->flushApiCache($folderId, $pageId);
return true;
}
Update the caption of storage file.
public boolean actionFilemanagerUpdateCaption ( ) |
public function actionFilemanagerUpdateCaption()
{
$fileId = Yii::$app->request->post('id', false);
$captionsText = Yii::$app->request->post('captionsText', false);
$pageId = Yii::$app->request->post('pageId', 0);
if ($fileId && is_scalar($fileId) && $captionsText) {
$model = StorageFile::findOne($fileId);
if ($model) {
$model->updateAttributes([
'caption' => I18n::encode($captionsText),
]);
$this->flushApiCache($model->folder_id, $pageId);
return true;
}
}
return false;
}
Upload a new file from $_FILES array.
Post Values:
- file
- folderId
- isHidden
public array actionFilesUpload ( ) | ||
return | array |
An array with an assoc array containing the following keys
|
---|
public function actionFilesUpload()
{
foreach ($_FILES as $k => $file) {
if ($file['error'] !== UPLOAD_ERR_OK) {
Yii::$app->response->setStatusCode(422, 'Data Validation Failed.');
return ['upload' => false, 'message' => Storage::getUploadErrorMessage($file['error']), 'file' => null, 'queueIds' => []];
}
try {
$response = Yii::$app->storage->addFile($file['tmp_name'], $file['name'], Yii::$app->request->post('folderId', 0), Yii::$app->request->post('isHidden', false));
if ($response) {
return [
'upload' => true,
'message' => Module::t('api_storage_file_upload_succes'),
'file' => $response,
'queueIds' => Yii::$app->storage->queueJobIds,
];
} else {
Yii::$app->response->setStatusCode(422, 'Data Validation Failed.');
return ['upload' => false, 'message' => Module::t('api_storage_file_upload_folder_error'), 'file' => null, 'queueIds' => []];
}
} catch (Exception $err) {
Yii::$app->response->setStatusCode(422, 'Data Validation Failed.');
return ['upload' => false, 'message' => Module::t('api_sotrage_file_upload_error', ['error' => $err->getMessage()]), 'file' => null, 'queueIds' => []];
}
}
// If the files array is empty, this is an indicator for exceeding the upload_max_filesize from php ini or a wrong upload definition.
Yii::$app->response->setStatusCode(422, 'Data Validation Failed.');
return ['upload' => false, 'message' => Storage::getUploadErrorMessage(UPLOAD_ERR_NO_FILE), 'file' => null, 'queueIds' => []];
}
Create a new folder pased on post data.
public boolean actionFolderCreate ( ) |
public function actionFolderCreate()
{
$folderName = Yii::$app->request->post('folderName', null);
$parentFolderId = Yii::$app->request->post('parentFolderId', 0);
$response = Yii::$app->storage->addFolder($folderName, $parentFolderId);
$this->flushApiCache();
return $response;
}
Delete folder, all subfolders and all included files.
- search another folders with matching parentIds and call deleteFolder on them
- get all included files and delete them
- delete folder
public boolean actionFolderDelete ( $folderId ) | ||
$folderId | integer |
The folder to delete. |
public function actionFolderDelete($folderId)
{
// find all subfolders
$matchingChildFolders = StorageFolder::find()->where(['parent_id' => $folderId])->asArray()->all();
foreach ($matchingChildFolders as $matchingChildFolder) {
$this->actionFolderDelete($matchingChildFolder['id']);
}
// find all attached files and delete them
$folderFiles = StorageFile::find()->where(['folder_id' => $folderId])->all();
foreach ($folderFiles as $folderFile) {
$folderFile->delete();
}
// delete folder
$model = StorageFolder::findOne($folderId);
if (!$model) {
return false;
}
$model->is_deleted = true;
$this->flushApiCache();
return $model->update();
}
Update the folder model data.
public boolean actionFolderUpdate ( $folderId ) | ||
$folderId | integer |
The folder id. |
public function actionFolderUpdate($folderId)
{
$model = StorageFolder::findOne($folderId);
if (!$model) {
return false;
}
$model->attributes = Yii::$app->request->post();
$this->flushApiCache();
return $model->update();
}
Get image model.
This is mainly used for external api access.
public luya\admin\models\StorageImage actionImage ( $id ) | ||
$id | integer |
public function actionImage($id)
{
$model = StorageImage::find()->where(['id' => $id])->with(['file'])->one();
if (!$model) {
throw new NotFoundHttpException("Unable to find the given storage image.");
}
return $model;
}
Upload an image to the filemanager.
public array actionImageFilter ( ) | ||
return | array |
An array with
|
---|
public function actionImageFilter()
{
$image = Yii::$app->storage->createImage(Yii::$app->request->post('fileId', null), Yii::$app->request->post('filterId', null));
if ($image) {
return [
'error' => false,
'id' => $image->id,
'image' => $image
];
}
return $this->sendArrayError([
'error' => true,
'message' => Module::t('api_storage_image_upload_error', ['error' => 'Unable to create the filter for the given image. Maybe the file source is not readable.']),
]);
}
public array actionImageInfo ( $id ) | ||
$id | integer | |
throws | yii\web\NotFoundHttpException |
---|
public function actionImageInfo($id)
{
$model = StorageImage::find()->where(['id' => $id])->with(['file', 'tinyCropImage.file'])->one();
if (!$model) {
throw new NotFoundHttpException("Unable to find the given storage image.");
}
// try to create thumbnail on view if not done
if (empty($model->tinyCropImage)) {
// there are very rare cases where the thumbnail does not exists, therefore generate the thumbnail and reload the model.
Yii::$app->storage->createImage($model->file_id, Yii::$app->storage->getFiltersArrayItem(TinyCrop::identifier())['id']);
// refresh model internal (as $model->refresh() wont load the relations data we have to call the same model with relations again)
$model = StorageImage::find()->where(['id' => $id])->with(['file', 'tinyCropImage.file'])->one();
}
return $model->toArray(['id', 'source', 'file_id', 'filter_id', 'resolution_width', 'resolution_height', 'file'], ['source', 'tinyCropImage.file']);
}
A post request with an array of images to load!
public void actionImagesInfo ( ) |
public function actionImagesInfo()
{
$ids = Yii::$app->request->getBodyParam('ids', []);
$ids = array_unique($ids);
return new ActiveDataProvider([
'query' => StorageImage::find()->where(['in', 'id', $ids])->with(['file', 'tinyCropImage.file']),
'pagination' => false,
]);
}
Image Upload with $_FILES array:
Post values:
- file
- folderId
- isHidden
public array actionImagesUpload ( ) |
public function actionImagesUpload()
{
$result = $this->actionFilesUpload();
if ($result['upload'] && $result['file']) {
$fileId = $result['file']->id;
$image = Yii::$app->storage->createImage($fileId, 0);
if ($image) {
// create system thumbnails
$tinyCrop = Yii::$app->storage->createImage($fileId, Yii::$app->storage->getFilterId(TinyCrop::identifier()));
$mediumThumbnail = Yii::$app->storage->createImage($fileId, Yii::$app->storage->getFilterId(MediumThumbnail::identifier()));
}
return [
'image' => $image,
'tinyCrop' => $tinyCrop,
'mediumThumbnail' => $mediumThumbnail,
];
}
return $this->sendArrayError(['image' => 'Unable to create the given with and the corresponding filters.']);
}
Check whether a folder is empty or not in order to delete this folder.
public boolean actionIsFolderEmpty ( $folderId ) | ||
$folderId | integer |
The folder id to check whether it has files or not. |
public function actionIsFolderEmpty($folderId)
{
$count = StorageFile::find()->where(['folder_id' => $folderId, 'is_deleted' => false])->count();
return [
'count' => $count,
'empty' => $count > 0 ? false : true,
];
}
Toggle Tags for a given file.
If a relation exists, remove, otherwise add.
public \luya\admin\apis\The actionToggleFileTag ( ) | ||
return | \luya\admin\apis\The |
Array of associated tags for the given file. |
---|
public function actionToggleFileTag()
{
$tagId = Yii::$app->request->getBodyParam('tagId');
$fileId = Yii::$app->request->getBodyParam('fileId');
$file = StorageFile::findOne($fileId);
if (!$file) {
throw new NotFoundHttpException("Unable to find the given file to toggle the tag.");
}
$relation = TagRelation::find()->where(['table_name' => StorageFile::cleanBaseTableName(StorageFile::tableName()), 'pk_id' => $fileId, 'tag_id' => $tagId])->one();
if ($relation) {
$relation->delete();
return $file->tags;
}
$model = new TagRelation();
$model->table_name = StorageFile::cleanBaseTableName(StorageFile::tableName());
$model->pk_id = $fileId;
$model->tag_id = $tagId;
$model->save();
return $file->tags;
}
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\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);
}
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\RestController::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)) {
if ($this->isActionAuthOptional($action->id)) {
return true;
}
$route = $this->permissionRoute($action);
// check whether for the current route exists a permission entry
// if the permission entry exists, a checkRouteAccess() must be done.
// otherwise just check whether api user can access the api without permission entry.
if ($route && Yii::$app->auth->isInRoutePermissionTable($route)) {
$this->checkRouteAccess($route);
} else {
$this->canApiUserAccess();
}
return true;
}
return false;
}
Defined in: yii\rest\Controller::behaviors()
Returns a list of behaviors that this component should behave as.
Child classes may override this method to specify the behaviors they want to behave as.
The return value of this method should be an array of behavior objects or configurations indexed by behavior names. A behavior configuration can be either a string specifying the behavior class or an array of the following structure:
'behaviorName' => [
'class' => 'BehaviorClass',
'property1' => 'value1',
'property2' => 'value2',
]
Note that a behavior class must extend from yii\base\Behavior. Behaviors can be attached using a name or anonymously. When a name is used as the array key, using this name, the behavior can later be retrieved using getBehavior() or be detached using detachBehavior(). Anonymous behaviors can not be retrieved or detached.
Behaviors declared in this method will be attached to the component automatically (on demand).
public array behaviors ( ) | ||
return | array |
The behavior configurations. |
---|
public function behaviors()
{
return [
'contentNegotiator' => [
'class' => ContentNegotiator::className(),
'formats' => [
'application/json' => Response::FORMAT_JSON,
'application/xml' => Response::FORMAT_XML,
],
],
'verbFilter' => [
'class' => VerbFilter::className(),
'actions' => $this->verbs(),
],
'authenticator' => [
'class' => CompositeAuth::className(),
],
'rateLimiter' => [
'class' => RateLimiter::className(),
],
];
}
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: 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.");
}
}
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;
}
Defined in: luya\admin\base\RestController::checkRouteAccess()
Shorthand method to check whether the current user exists for the given route, otherwise throw forbidden exception.
public void checkRouteAccess ( $route ) | ||
$route |
public function checkRouteAccess($route)
{
if (!Yii::$app->auth->matchRoute($this->userAuthClass()->identity, $route)) {
throw new ForbiddenHttpException("Unable to access route '$route' due to insufficient permissions.");
}
UserOnline::refreshUser($this->userAuthClass()->identity, $route);
}
::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: luya\traits\CacheableTrait::deleteHasCache()
Remove a value from the cache if caching is enabled.
public boolean deleteHasCache ( $key ) | ||
$key | string|array |
The cache identifier |
return | boolean |
Whether delete of key has been success or not |
---|
public function deleteHasCache($key)
{
if ($this->isCachable()) {
return Yii::$app->cache->delete($key);
}
return false;
}
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;
}
Flush the storage caching data.
protected void flushApiCache ( $folderId = 0, $page = 0 ) | ||
$folderId | ||
$page |
protected function flushApiCache($folderId = 0, $page = 0)
{
Yii::$app->storage->flushArrays();
$this->deleteHasCache('storageApiDataFolders');
$this->deleteHasCache(['storageApiDataFiles', (int) $folderId, (int) $page]);
}
Defined in: luya\traits\CacheableTrait::flushHasCache()
Deletes all values from cache.
public boolean flushHasCache ( ) | ||
return | boolean |
Whether the flush operation was successful. |
---|
public function flushHasCache()
{
if ($this->isCachable()) {
return Yii::$app->cache->flush();
}
return false;
}
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;
}
Defined in: luya\traits\RestBehaviorsTrait::getCompositeAuthMethods()
Return all Auth methods for Composite Auth.
public array getCompositeAuthMethods ( ) |
public function getCompositeAuthMethods()
{
return [
QueryParamAuth::class,
HttpBearerAuth::class,
];
}
Defined in: luya\traits\CacheableTrait::getHasCache()
Get the caching data if caching is allowed and there is any data stored for this key.
public mixed|boolean getHasCache ( $key ) | ||
$key | string|array |
The identifiere key, can be a string or an array which will be calculated. |
return | mixed|boolean |
Returns the data, if not found returns false. |
---|
public function getHasCache($key)
{
if ($this->isCachable()) {
$data = Yii::$app->cache->get($key);
$enumKey = (is_array($key)) ? implode(",", $key) : $key;
if ($data) {
Yii::debug("Cacheable trait key '$enumKey' successfully loaded from cache.", __METHOD__);
return $data;
}
Yii::debug("Cacheable trait key '$enumKey' has not been found in cache.", __METHOD__);
}
return false;
}
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: luya\traits\CacheableTrait::getOrSetHasCache()
Method combines both setHasCache() and getHasCache() methods to retrieve value identified by a $key, or to store the result of $closure execution if there is no cache available for the $key.
Usage example:
use CacheableTrait;
public function getTopProducts($count = 10)
{
return $this->getOrSetHasCache(['top-n-products', 'n' => $count], function ($cache) use ($count) {
return Products::find()->mostPopular()->limit(10)->all();
}, 1000);
}
public mixed getOrSetHasCache ( $key, Closure $closure, $duration = null, $dependency = null ) | ||
$key | mixed |
A key identifying the value to be cached. This can be a simple string or a complex data structure consisting of factors representing the key. |
$closure | Closure |
The closure that will be used to generate a value to be cached.
In case $closure returns |
$duration | integer |
Default duration in seconds before the cache will expire. If not set, defaultDuration value will be used. 0 means never expire. |
$dependency | yii\caching\Dependency |
Dependency of the cached item. If the dependency changes,
the corresponding value in the cache will be invalidated when it is fetched via get().
This parameter is ignored if serializer is |
return | mixed |
Result of $closure execution |
---|
public function getOrSetHasCache($key, \Closure $closure, $duration = null, $dependency = null)
{
if (($value = $this->getHasCache($key)) !== false) {
return $value;
}
$value = call_user_func($closure, $this);
$this->setHasCache($key, $value, $dependency, $duration);
return $value;
}
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: 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: 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;
}
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: yii\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();
$this->request = Instance::ensure($this->request, Request::className());
$this->response = Instance::ensure($this->response, Response::className());
}
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 beforeisActionAuthOptional() 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);
}
Defined in: luya\traits\CacheableTrait::isCachable()
Check if the current configuration of the application and the property allows a caching of the language container data.
public boolean isCachable ( ) |
public function isCachable()
{
if ($this->_cachable === null) {
$this->_cachable = Yii::$app->has('cache') ? true : false;
}
return $this->_cachable;
}
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]);
}
}
Returns the default permission route to check. By default this will return the current route of the performed action.
In order to override permission check use:
public function permissionRoute($action)
{
return 'my/custom/route';
}
Or to switch routes for given actions use:
public function permissionRoute(Action $action)
{
if ($action->id == 'my-index-action') {
return 'module/index/action';
}
return 'module/index/another-action';
}
Keep in mind this permission route check is mainly to determine if an action exists.
If the permission route returns false, this means the given action does not require a permission.
public string permissionRoute ( yii\base\Action $action ) | ||
$action | yii\base\Action |
public function permissionRoute(Action $action)
{
// whiteliste certain data endpoints from permission system as this would trigger a user logout
// if people without file permission visit any NgRest CRUD view.
if (in_array($action->id, $this->whitelistedActions)) {
return false;
}
return self::PERMISSION_ROUTE;
}
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: 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:
- 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.
- 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);
}
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: 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\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);
}
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);
}
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);
}
Defined in: luya\traits\CacheableTrait::setHasCache()
Store cache data for a specific key if caching is enabled in this application.
public boolean setHasCache ( $key, $value, $dependency = null, $cacheExpiration = null ) | ||
$key | string|array |
The identifier key or a array to store complex keys |
$value | mixed |
The value to store in the cache component. |
$dependency | yii\caching\Dependency|array |
Dependency of the cached item. If the dependency changes, the corresponding value in the cache will be invalidated when it is fetched via get(). This parameter is ignored if $serializer is false. You can also define an array with defintion which will generate the Object instead of object is provided. |
$cacheExpiration |
Integer The time in seconds before the cache data expires, 0 means never expire. |
|
return | boolean |
Whether set has been success or not |
---|
public function setHasCache($key, $value, $dependency = null, $cacheExpiration = null)
{
if ($this->isCachable()) {
if (is_array($dependency)) {
$dependency = Yii::createObject($dependency);
}
return Yii::$app->cache->set($key, $value, is_null($cacheExpiration) ? $this->_cacheExpiration : $cacheExpiration, $dependency);
}
return false;
}
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);
}
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;
}
Defined in: yii\rest\Controller::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 [];
}