HumHub Documentation (unofficial)

FileController extends Controller
in package

Application

UploadController provides uploading functions for files

Constants

EVENT_AFTER_ACTION = 'afterAction'
EVENT_BEFORE_ACTION = 'beforeAction'
EVENT_INIT = 'init'

Properties

$action : Action|null
$actionParams : array<string|int, mixed>
$actionTitlesMap : array<string|int, mixed>
$behaviors : array<string|int, Behavior>
$defaultAction : string
$enableCsrfValidation : bool
$id : string
$layout : string|null|false
$module : Module
$modules : array<string|int, Module>
$pageTitle : string
$prependActionTitles : bool
$request : Request|array<string|int, mixed>|string
$response : Response|array<string|int, mixed>|string
$route : string
$subLayout : null|string
$uniqueId : string
$view : View|View
$view : View
$viewPath : string
$access : string
$doNotInterceptActionIds : array<string|int, string>
$_behaviors : array<string|int, Behavior>|null
$_events : array<string|int, mixed>
$_eventWildcards : array<string|int, mixed>
$_view : View|null
$_viewPath : string|null

Methods

__call() : mixed: Calls the named method which is not a class method.
__clone() : mixed: This method is called after the object is created by cloning an existing one.
__construct() : mixed: Constructor.
__get() : mixed: Returns the value of a component property.
__isset() : bool: Checks if a property is set, i.e. defined and not null.
__set() : mixed: Sets the value of a component property.
__unset() : mixed: Sets a component property to be null.
actionDelete() : mixed
actions() : array<string|int, mixed>: Declares external actions for the controller.
afterAction() : mixed: This method is invoked right after an action is executed.
appendPageTitle() : mixed: Append a page title.
asJson() : Response: Send data formatted as JSON.
asXml() : Response: Send data formatted as XML.
attachBehavior() : Behavior: Attaches a behavior to this component.
attachBehaviors() : mixed: Attaches a list of behaviors to the component.
beforeAction() : bool: This method is invoked right before an action is executed.
behaviors() : array<string|int, mixed>: Returns a list of behaviors that this component should behave as.
bindActionParams() : array<string|int, mixed>: Binds the parameters to the action.
canGetProperty() : bool: Returns a value indicating whether a property can be read.
canSetProperty() : bool: Returns a value indicating whether a property can be set.
className() : string: Returns the fully qualified name of this class.
createAction() : Action|null: Creates an action based on the given action ID.
detachBehavior() : Behavior|null: Detaches a behavior from the component.
detachBehaviors() : mixed: Detaches all behaviors from the component.
ensureBehaviors() : mixed: Makes sure that the behaviors declared in [[behaviors()]] are attached to this component.
findLayoutFile() : string|bool: Finds the applicable layout file.
forcePostRequest() : bool: Throws HttpException in case the request is not an post request, otherwise returns true.
getAccess() : null|ControllerAccess
getBehavior() : Behavior|null: Returns the named behavior object.
getBehaviors() : array<string|int, Behavior>: Returns all behaviors attached to this component.
getModules() : array<string|int, Module>: Returns all ancestor modules of this controller.
getRoute() : string: Returns the route of the current request.
getUniqueId() : string: Returns the unique ID of the controller.
getView() : View|View: Returns the view object that can be used to render views or view files.
getViewPath() : string: Returns the directory containing view files for this controller.
goBack() : Response: Redirects the browser to the last visited page.
goHome() : Response: Redirects the browser to the home page.
hasEventHandlers() : bool: Returns a value indicating whether there is any handler attached to the named event.
hasMethod() : bool: Returns a value indicating whether a method is defined.
hasProperty() : bool: Returns a value indicating whether a property is defined for this component.
htmlRedirect() : mixed: Create Redirect for AJAX Requests which output goes into HTML content.
init() : mixed: Initializes the object.
isNotInterceptedAction() : bool: Check if action cannot be intercepted
off() : bool: Detaches an existing event handler from this component.
on() : mixed: Attaches an event handler to an event.
prependPageTitle() : mixed: Prepend a page title.
redirect() : Response: Redirects the browser to the specified URL.
refresh() : Response: Refreshes the current page.
render() : string: Renders a view and applies layout if available.
renderAjax() : string: Renders a view in response to an AJAX request.
renderAjaxContent() : mixed
renderAjaxPartial() : string: Renders a string as Ajax including assets without end page so it can be called several times.
renderContent() : string: Renders a static string by applying the layouts (sublayout + layout.
renderFile() : string: Renders a view file.
renderModalClose() : mixed: Closes a modal
renderPartial() : string: Renders a view without applying layout.
run() : mixed: Runs a request specified in terms of a route.
runAction() : mixed: Runs an action within this controller with the specified action ID and parameters.
setActionTitles() : mixed: Set a map that indicates what page title should be shown for the currently active action.
setJsViewStatus() : mixed: Sets some ui state as current controller/module and active topmenu.
setPageTitle() : mixed: Set the page title.
setView() : mixed: Sets the view object to be used by this controller.
setViewPath() : mixed: Sets the directory that contains the view files.
trigger() : mixed: Triggers an event.
bindInjectedParams() : mixed: Fills parameters based on types and names in action method signature.
forbidden() : mixed
getAccessRules() : array<string|int, mixed>: Returns access rules for the standard access control behavior.
attachBehaviorInternal() : Behavior: Attaches a behavior to this component.

EVENT_AFTER_ACTION


    public
        mixed
    EVENT_AFTER_ACTION
    = 'afterAction'

EVENT_BEFORE_ACTION


    public
        mixed
    EVENT_BEFORE_ACTION
    = 'beforeAction'

EVENT_INIT


    public
        mixed
    EVENT_INIT
    = 'init'

$action


    public
        Action|null
    $action

the action that is currently being executed. This property will be set by [[run()]] when it is called by [[Application]] to run an action.

$actionParams


    public
        array<string|int, mixed>
    $actionParams
     = []

the parameters bound to the current action.

$actionTitlesMap


    public
        array<string|int, mixed>
    $actionTitlesMap
     = []

page titles

$behaviors read-only


    public
        array<string|int, Behavior>
    $behaviors

List of behaviors attached to this component.

$defaultAction


    public
        string
    $defaultAction
     = 'index'

the ID of the action that is used when the action ID is not specified in the request. Defaults to 'index'.

$enableCsrfValidation


    public
        bool
    $enableCsrfValidation
     = true

whether to enable CSRF validation for the actions in this controller. CSRF validation is enabled only when both this property and [[\yii\web\Request::enableCsrfValidation]] are true.

$id


    public
        string
    $id

the ID of this controller.

$layout


    public
        string|null|false
    $layout

the name of the layout to be applied to this controller's views. This property mainly affects the behavior of [[render()]]. Defaults to null, meaning the actual layout value should inherit that from [[module]]'s layout value. If false, no layout will be applied.

$module


    public
        Module
    $module

the module that this controller belongs to.

$modules read-only


    public
        array<string|int, Module>
    $modules

All ancestor modules that this controller is located within.

$pageTitle


    public
        string
    $pageTitle

title of the rendered page

$prependActionTitles


    public
        bool
    $prependActionTitles
     = true

append page title

$request


    public
        Request|array<string|int, mixed>|string
    $request
     = 'request'

The request.

$response


    public
        Response|array<string|int, mixed>|string
    $response
     = 'response'

The response.

$route read-only


    public
        string
    $route

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

$subLayout


    public
        null|string
    $subLayout
     = null

the name of the sub layout to be applied to this controller's views. This property mainly affects the behavior of [[render()]].

$uniqueId read-only


    public
        string
    $uniqueId

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

$view


    public
        View|View
    $view

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

$view


    public
        View
    $view

$viewPath


    public
        string
    $viewPath

The directory containing the view files for this controller.

$access


    protected
        string
    $access
     = \humhub\components\access\ControllerAccess::class

defines the ControllerAccess class for this controller responsible for managing access rules

$doNotInterceptActionIds


    protected
        array<string|int, string>
    $doNotInterceptActionIds
     = []

List of action ids which should not be intercepted by another actions. Use '*' for all action ids.

$_behaviors


    private
        array<string|int, Behavior>|null
    $_behaviors

the attached behaviors (behavior name => behavior). This is null when not initialized.

$_events


    private
        array<string|int, mixed>
    $_events
     = []

the attached event handlers (event name => handlers)

$_eventWildcards


    private
        array<string|int, mixed>
    $_eventWildcards
     = []

the event handlers attached for wildcard patterns (event name wildcard => handlers)

$_view


    private
        View|null
    $_view

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

$_viewPath


    private
        string|null
    $_viewPath

the root directory that contains view files for this controller.

__call()

Calls the named method which is not a class method.


    public
                    __call(string $name, array<string|int, mixed> $params) : mixed

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.

Parameters

$name : string: the method name
$params : array<string|int, mixed>: method parameters

Return values

mixed —

the method return value

__clone()

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


    public
                    __clone() : mixed

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

__construct()

Constructor.


    public
                    __construct(string $id, Module $module[, array<string|int, mixed> $config = [] ]) : mixed

Parameters

$id : string: the ID of this controller.
$module : Module: the module that this controller belongs to.
$config : array<string|int, mixed> = []: name-value pairs that will be used to initialize the object properties.

__get()

Returns the value of a component property.


    public
                    __get(string $name) : mixed

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;.

Parameters

$name : string: the property name

Return values

mixed —

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

__isset()

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


    public
                    __isset(string $name) : bool

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).

Parameters

$name : string: the property name or the event name

Return values

bool —

whether the named property is set

__set()

Sets the value of a component property.


    public
                    __set(string $name, mixed $value) : mixed

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;.

Parameters

$name : string: the property name or the event name
$value : mixed: the property value

__unset()

Sets a component property to be null.


    public
                    __unset(string $name) : mixed

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).

Parameters

$name : string: the property name

actionDelete()


    public
                    actionDelete() : mixed

actions()

Declares external actions for the controller.


    public
                    actions() : array<string|int, mixed>

Return values

array<string|int, mixed>

afterAction()

This method is invoked right after an action is executed.


    public
                    afterAction(Action $action, mixed $result) : mixed

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;
}

Parameters

$action : Action: the action just executed.
$result : mixed: the action return result.

Return values

mixed —

the processed action result.

appendPageTitle()

Append a page title.


    public
                    appendPageTitle(string $title) : mixed

Parameters

$title : string

asJson()

Send data formatted as JSON.


    public
                    asJson(mixed $data) : Response

This method is a shortcut for sending data formatted as JSON. It will return the [[Application::getResponse()|response]] application component after configuring the [[Response::$format|format]] and setting the [[Response::$data|data]] that should be formatted. A common usage will be:

return $this->asJson($data);

Parameters

$data : mixed: the data that should be formatted.

Return values

Response —

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

asXml()

Send data formatted as XML.


    public
                    asXml(mixed $data) : Response

This method is a shortcut for sending data formatted as XML. It will return the [[Application::getResponse()|response]] application component after configuring the [[Response::$format|format]] and setting the [[Response::$data|data]] that should be formatted. A common usage will be:

return $this->asXml($data);

Parameters

$data : mixed: the data that should be formatted.

Return values

Response —

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

attachBehavior()

Attaches a behavior to this component.


    public
                    attachBehavior(string $name, string|array<string|int, mixed>|Behavior $behavior) : Behavior

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 [[Behavior::attach()]] method.

Parameters

$name : string

the name of the behavior.

$behavior : string|array<string|int, mixed>|Behavior

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

a [[Behavior]] object
a string specifying the behavior class
an object configuration array that will be passed to [[Yii::createObject()]] to create the behavior object.

Return values

Behavior —

the behavior object

attachBehaviors()

Attaches a list of behaviors to the component.


    public
                    attachBehaviors(array<string|int, mixed> $behaviors) : mixed

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

Parameters

$behaviors : array<string|int, mixed>: list of behaviors to be attached to the component

beforeAction()

This method is invoked right before an action is executed.


    public
                    beforeAction(mixed $action) : bool

Parameters

$action : mixed: the action to be executed.

Return values

bool —

whether the action should continue to run.

behaviors()

Returns a list of behaviors that this component should behave as.


    public
                    behaviors() : array<string|int, mixed>

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 [[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).

Return values

array<string|int, mixed> —

the behavior configurations.

bindActionParams()

Binds the parameters to the action.


    public
                    bindActionParams(Action $action, array<string|int, mixed> $params) : array<string|int, mixed>

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.

Parameters

$action : Action: the action to be bound with parameters
$params : array<string|int, mixed>: the parameters to be bound to the action

Return values

array<string|int, mixed> —

the valid parameters that the action can run with.

canGetProperty()

Returns a value indicating whether a property can be read.


    public
                    canGetProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

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).

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties
$checkBehaviors : bool = true: whether to treat behaviors' properties as properties of this component

Return values

bool —

whether the property can be read

canSetProperty()

Returns a value indicating whether a property can be set.


    public
                    canSetProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

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).

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties
$checkBehaviors : bool = true: whether to treat behaviors' properties as properties of this component

Return values

bool —

whether the property can be written

className()

Returns the fully qualified name of this class.


    public
            static        className() : string

Return values

string —

the fully qualified name of this class.

createAction()

Creates an action based on the given action ID.


    public
                    createAction(string $id) : Action|null

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 [[InlineAction]] representing that method will be created and returned.

Parameters

$id : string: the action ID.

Return values

Action|null —

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

detachBehavior()

Detaches a behavior from the component.


    public
                    detachBehavior(string $name) : Behavior|null

The behavior's [[Behavior::detach()]] method will be invoked.

Parameters

$name : string: the behavior's name.

Return values

Behavior|null —

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

detachBehaviors()

Detaches all behaviors from the component.


    public
                    detachBehaviors() : mixed

ensureBehaviors()

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


    public
                    ensureBehaviors() : mixed

findLayoutFile()

Finds the applicable layout file.


    public
                    findLayoutFile(View $view) : string|bool

Parameters

$view : View: the view object to render the layout file.

Return values

string|bool —

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

forcePostRequest()

Throws HttpException in case the request is not an post request, otherwise returns true.


    public
                    forcePostRequest() : bool

Return values

bool —

returns true in case the current request is a POST

getAccess()


    public
                    getAccess() : null|ControllerAccess

Return values

null|ControllerAccess —

returns a ControllerAccess instance

getBehavior()

Returns the named behavior object.


    public
                    getBehavior(string $name) : Behavior|null

Parameters

$name : string: the behavior name

Return values

Behavior|null —

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

getBehaviors()

Returns all behaviors attached to this component.


    public
                    getBehaviors() : array<string|int, Behavior>

Return values

array<string|int, Behavior> —

list of behaviors attached to this component

getModules()

Returns all ancestor modules of this controller.


    public
                    getModules() : array<string|int, Module>

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

Return values

array<string|int, Module> —

all ancestor modules that this controller is located within.

getRoute()

Returns the route of the current request.


    public
                    getRoute() : string

Return values

string —

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

getUniqueId()

Returns the unique ID of the controller.


    public
                    getUniqueId() : string

Return values

string —

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

getView()

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


    public
                    getView() : View|View

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.

Return values

View|View —

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

getViewPath()

Returns the directory containing view files for this controller.


    public
                    getViewPath() : string

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

Return values

string —

the directory containing the view files for this controller.

goBack()

Redirects the browser to the last visited page.


    public
                    goBack([string|array<string|int, mixed>|null $defaultUrl = null ]) : Response

You can use this method in an action by returning the [[Response]] directly:

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

For this function to work you have to [[User::setReturnUrl()|set the return URL]] in appropriate places before.

Parameters

$defaultUrl : string|array<string|int, mixed>|null = null: the default return URL in case it was not set previously. If this is null and the return URL was not set previously, [[Application::homeUrl]] will be redirected to. Please refer to [[User::setReturnUrl()]] on accepted format of the URL.

Return values

Response —

the current response object

goHome()

Redirects the browser to the home page.


    public
                    goHome() : Response

You can use this method in an action by returning the [[Response]] directly:

// stop executing this action and redirect to home page
return $this->goHome();

Return values

Response —

the current response object

hasEventHandlers()

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


    public
                    hasEventHandlers(string $name) : bool

Parameters

$name : string: the event name

Return values

bool —

whether there is any handler attached to the event.

hasMethod()

Returns a value indicating whether a method is defined.


    public
                    hasMethod(string $name[, bool $checkBehaviors = true ]) : bool

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).

Parameters

$name : string: the property name
$checkBehaviors : bool = true: whether to treat behaviors' methods as methods of this component

Return values

bool —

whether the method is defined

hasProperty()

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


    public
                    hasProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

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).

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties
$checkBehaviors : bool = true: whether to treat behaviors' properties as properties of this component

Return values

bool —

whether the property is defined

htmlRedirect()

Create Redirect for AJAX Requests which output goes into HTML content.


    public
                    htmlRedirect([mixed $url = "" ]) : mixed

Is an alternative method to redirect, for ajax responses.

Parameters

$url : mixed = ""

init()

Initializes the object.


    public
                    init() : mixed

isNotInterceptedAction()

Check if action cannot be intercepted


    public
                    isNotInterceptedAction([string|null $actionId = null ]) : bool

Parameters

$actionId : string|null = null: , NULL - to use current action

Return values

bool

off()

Detaches an existing event handler from this component.


    public
                    off(string $name[, callable|null $handler = null ]) : bool

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.

Parameters

$name : string: event name
$handler : callable|null = null: the event handler to be removed. If it is null, all handlers attached to the named event will be removed.

Return values

bool —

if a handler is found and detached

on()

Attaches an event handler to an event.


    public
                    on(string $name, callable $handler[, mixed $data = null ][, bool $append = true ]) : mixed

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 [[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.');
});

Parameters

$name : string: the event name
$handler : callable: the event handler
$data : mixed = null: 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 [[Event::data]].
$append : bool = true: 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.

prependPageTitle()

Prepend a page title.


    public
                    prependPageTitle(string $title) : mixed

Parameters

$title : string

redirect()

Redirects the browser to the specified URL.


    public
                    redirect(mixed $url[, mixed $statusCode = 302 ]) : Response

Parameters

$url : mixed

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

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

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

$statusCode : mixed = 302

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

Return values

Response —

the current response object

refresh()

Refreshes the current page.


    public
                    refresh([string $anchor = '' ]) : Response

This method is a shortcut to [[Response::refresh()]].

You can use it in an action by returning the [[Response]] directly:

// stop executing this action and refresh the current page
return $this->refresh();

Parameters

$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 values

Response —

the response object itself

render()

Renders a view and applies layout if available.


    public
                    render(string $view[, array<string|int, mixed> $params = [] ]) : string

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 [[Application::viewPath|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 [[Module::viewPath|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 [[Module::layout|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 [[Application::layoutPath|layout path]] of the application;
a relative path (e.g. "main"): the actual layout file will be looked for under the [[Module::layoutPath|layout path]] of the context module.

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

Parameters

$view : string: the view name.
$params : array<string|int, mixed> = []: the parameters (name-value pairs) that should be made available in the view. These parameters will not be available in the layout.

Return values

string —

the rendering result.

renderAjax()

Renders a view in response to an AJAX request.


    public
                    renderAjax(string $view[, array<string|int, mixed> $params = [] ]) : string

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.

Parameters

$view : string: the view name. Please refer to [[render()]] on how to specify a view name.
$params : array<string|int, mixed> = []: the parameters (name-value pairs) that should be made available in the view.

Return values

string —

the rendering result.

renderAjaxContent()


    public
                    renderAjaxContent(mixed $content) : mixed

Parameters

$content : mixed

renderAjaxPartial()

Renders a string as Ajax including assets without end page so it can be called several times.


    public
                    renderAjaxPartial(string $content) : string

Parameters

$content : string

Return values

string —

Rendered content

renderContent()

Renders a static string by applying the layouts (sublayout + layout.


    public
                    renderContent(string $content) : string

Parameters

$content : string: the static string being rendered

Return values

string —

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

renderFile()

Renders a view file.


    public
                    renderFile(string $file[, array<string|int, mixed> $params = [] ]) : string

Parameters

$file : string: the view file to be rendered. This can be either a file path or a path alias.
$params : array<string|int, mixed> = []: the parameters (name-value pairs) that should be made available in the view.

Return values

string —

the rendering result.

renderModalClose()

Closes a modal


    public
                    renderModalClose() : mixed

renderPartial()

Renders a view without applying layout.


    public
                    renderPartial(string $view[, array<string|int, mixed> $params = [] ]) : string

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

Parameters

$view : string: the view name. Please refer to [[render()]] on how to specify a view name.
$params : array<string|int, mixed> = []: the parameters (name-value pairs) that should be made available in the view.

Return values

string —

the rendering result.

run()

Runs a request specified in terms of a route.


    public
                    run(string $route[, array<string|int, mixed> $params = [] ]) : mixed

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.

Parameters

$route : string: the route to be handled, e.g., 'view', 'comment/view', '/admin/comment/view'.
$params : array<string|int, mixed> = []: the parameters to be passed to the action.

Return values

mixed —

the result of the action.

runAction()

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


    public
                    runAction(string $id[, array<string|int, mixed> $params = [] ]) : mixed

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

Parameters

$id : string: the ID of the action to be executed.
$params : array<string|int, mixed> = []: the parameters (name-value pairs) to be passed to the action.

Return values

mixed —

the result of the action.

setActionTitles()

Set a map that indicates what page title should be shown for the currently active action.


    public
                    setActionTitles([array<string|int, mixed> $map = [] ][, bool $prependActionTitles = true ]) : mixed

It will be appended to

Parameters

$map : array<string|int, mixed> = []: [action_id => action_page_title]
$prependActionTitles : bool = true: set to false if the action titles should rather be appended

setJsViewStatus()

Sets some ui state as current controller/module and active topmenu.


    public
                    setJsViewStatus() : mixed

This is required for some modules in pjax mode.

setPageTitle()

Set the page title.


    public
                    setPageTitle(string $title) : mixed

Parameters

$title : string

setView()

Sets the view object to be used by this controller.


    public
                    setView(View|View $view) : mixed

Parameters

$view : View|View: the view object that can be used to render views or view files.

setViewPath()

Sets the directory that contains the view files.


    public
                    setViewPath(string $path) : mixed

Parameters

$path : string: the root directory of view files.

trigger()

Triggers an event.


    public
                    trigger(string $name[, Event|null $event = null ]) : mixed

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

Parameters

$name : string: the event name
$event : Event|null = null: the event instance. If not set, a default [[Event]] object will be created.

bindInjectedParams()

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


    protected
        final            bindInjectedParams(ReflectionType $type, string $name, array<string|int, mixed> &$args, array<string|int, mixed> &$requestedParams) : mixed

Parameters

$type : ReflectionType: The reflected type of the action parameter.
$name : string: The name of the parameter.
$args : array<string|int, mixed>: The array of arguments for the action, this function may append items to it.
$requestedParams : array<string|int, mixed>: The array with requested params, this function may write specific keys to it.

forbidden()


    protected
                    forbidden() : mixed

getAccessRules()

Returns access rules for the standard access control behavior.


    protected
                    getAccessRules() : array<string|int, mixed>

Return values

array<string|int, mixed> —

the access permissions

attachBehaviorInternal()

Attaches a behavior to this component.


    private
                    attachBehaviorInternal(string|int $name, string|array<string|int, mixed>|Behavior $behavior) : Behavior

Parameters

$name : string|int: the name of the behavior. If this is an integer, it means the behavior is an anonymous one. Otherwise, the behavior is a named one and any existing behavior with the same name will be detached first.
$behavior : string|array<string|int, mixed>|Behavior: the behavior to be attached

Return values

Behavior —

the attached behavior.

FileController extends Controller in package Application

Tags

Table of Contents

Constants

Properties

Methods

Constants

EVENT_AFTER_ACTION

Tags

EVENT_BEFORE_ACTION

Tags

EVENT_INIT

Tags

Properties

$action

$actionParams

$actionTitlesMap

$behaviors read-only

$defaultAction

$enableCsrfValidation

$id

$layout

$module

$modules read-only

$pageTitle

$prependActionTitles

$request

Tags

$response

Tags

$route read-only

$subLayout

$uniqueId read-only

$view

$view

$viewPath

$access

Tags

$doNotInterceptActionIds

Tags

$_behaviors

$_events

$_eventWildcards

Tags

$_view

$_viewPath

Methods

__call()

Parameters

Tags

Return values

__clone()

__construct()

Parameters

__get()

Parameters

Tags

Return values

__isset()

Parameters

Tags

Return values

__set()

Parameters

Tags

__unset()

Parameters

Tags

actionDelete()

actions()

Tags

Return values

afterAction()

FileController extends Controller
in package

Application