HumHub Documentation (unofficial)

Pjax extends Pjax
in package

Application

Pjax is a widget integrating the [pjax](https://github.com/yiisoft/jquery-pjax) jQuery plugin.

Pjax only deals with the content enclosed between its [[begin()]] and [[end()]] calls, called the body content of the widget. By default, any link click or form submission (for those forms with data-pjax attribute) within the body content will trigger an AJAX request. In responding to the AJAX request, Pjax will send the updated body content (based on the AJAX request) to the client which will replace the old content with the new one. The browser's URL will then be updated using pushState. The whole process requires no reloading of the layout or resources (js, css).

You may configure [[linkSelector]] to specify which links should trigger pjax, and configure [[formSelector]] to specify which form submission may trigger pjax.

You may disable pjax for a specific link inside the container by adding data-pjax="0" attribute to this link.

The following example shows how to use Pjax with the [[\yii\grid\GridView]] widget so that the grid pagination, sorting and filtering can be done via pjax:

use yii\widgets\Pjax;

Pjax::begin();
echo GridView::widget([...]);
Pjax::end();

Constants

EVENT_AFTER_RUN = 'afterRun'
EVENT_BEFORE_RUN = 'beforeRun'
EVENT_INIT = 'init'

Properties

$autoIdPrefix : string
$behaviors : array<string|int, Behavior>
$clientOptions : array<string|int, mixed>
$enablePushState : bool
$enableReplaceState : bool
$formSelector : string|null|false
$id : string|null
$linkSelector : string|null|false
$options : array<string|int, mixed>
$scrollTo : bool|int
$submitEvent : string
$timeout : int
$view : View
$viewPath : string
$_behaviors : array<string|int, Behavior>|null
$_events : array<string|int, mixed>
$_eventWildcards : array<string|int, mixed>
$_id : mixed
$_view : mixed

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.
afterRun() : mixed: This method is invoked right after a widget is executed.
attachBehavior() : Behavior: Attaches a behavior to this component.
attachBehaviors() : mixed: Attaches a list of behaviors to the component.
beforeRun() : bool: This method is invoked right before the widget is executed.
begin() : static: Begins a widget.
behaviors() : array<string|int, mixed>: Returns a list of behaviors that this component should behave as.
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.
detachBehavior() : Behavior|null: Detaches a behavior from the component.
detachBehaviors() : mixed: Detaches all behaviors from the component.
end() : static: Ends a widget.
ensureBehaviors() : mixed: Makes sure that the behaviors declared in [[behaviors()]] are attached to this component.
getBehavior() : Behavior|null: Returns the named behavior object.
getBehaviors() : array<string|int, Behavior>: Returns all behaviors attached to this component.
getId() : string|null: Returns the ID of the widget.
getView() : View: Returns the view object that can be used to render views or view files.
getViewPath() : string: Returns the directory containing the view files for this widget.
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.
init() : mixed: Initializes the object.
off() : bool: Detaches an existing event handler from this component.
on() : mixed: Attaches an event handler to an event.
registerClientScript() : mixed: Registers the needed JavaScript.
render() : string: Renders a view.
renderFile() : string: Renders a view file.
run() : string|void: Executes the widget.
setId() : mixed: Sets the ID of the widget.
setView() : mixed: Sets the view object to be used by this widget.
trigger() : mixed: Triggers an event.
widget() : string: Creates a widget instance and runs it.
requiresPjax() : bool
attachBehaviorInternal() : Behavior: Attaches a behavior to this component.

EVENT_AFTER_RUN


    public
        mixed
    EVENT_AFTER_RUN
    = 'afterRun'

EVENT_BEFORE_RUN


    public
        mixed
    EVENT_BEFORE_RUN
    = 'beforeRun'

EVENT_INIT


    public
        mixed
    EVENT_INIT
    = 'init'

$autoIdPrefix


    public
    static    string
    $autoIdPrefix
     = 'p'

the prefix to the automatically generated widget IDs.

$behaviors read-only


    public
        array<string|int, Behavior>
    $behaviors

List of behaviors attached to this component.

$clientOptions


    public
        array<string|int, mixed>
    $clientOptions

additional options to be passed to the pjax JS plugin. Please refer to the pjax project page for available options.

$enablePushState


    public
        bool
    $enablePushState
     = true

whether to enable push state.

$enableReplaceState


    public
        bool
    $enableReplaceState
     = false

whether to enable replace state.

$formSelector


    public
        string|null|false
    $formSelector

the jQuery selector of the forms whose submissions should trigger pjax requests. If not set, all forms with data-pjax attribute within the enclosed content of Pjax will trigger pjax requests. If set to false, no code will be registered to handle forms. Note that if the response to the pjax request is a full page, a normal request will be sent again.

$id


    public
        string|null
    $id

ID of the widget. Note that the type of this property differs in getter and setter. See [[getId()]] and [[setId()]] for details.

$linkSelector


    public
        string|null|false
    $linkSelector

the jQuery selector of the links that should trigger pjax requests. If not set, all links within the enclosed content of Pjax will trigger pjax requests. If set to false, no code will be registered to handle links. Note that if the response to the pjax request is a full page, a normal request will be sent again.

$options


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

the HTML attributes for the widget container tag. The following special options are recognized:

tag: string, the tag name for the container. Defaults to div This option is available since version 2.0.7. See also [[\yii\helpers\Html::tag()]].

$scrollTo


    public
        bool|int
    $scrollTo
     = false

how to scroll the page when pjax response is received. If false, no page scroll will be made. Use a number if you want to scroll to a particular place.

$submitEvent


    public
        string
    $submitEvent
     = 'submit'

The jQuery event that will trigger form handler. Defaults to "submit".

$timeout


    public
        int
    $timeout
     = 30000

pjax timeout setting (in milliseconds). This timeout is used when making AJAX requests. Use a bigger number if your server is slow. If the server does not respond within the timeout, a full page load will be triggered.

$view


    public
        View
    $view

The view object that can be used to render views or view files. Note that the type of this property differs in getter and setter. See [[getView()]] and [[setView()]] for details.

$viewPath read-only


    public
        string
    $viewPath

The directory containing the view files for this widget.

$_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)

$_id


    private
        mixed
    $_id

$_view


    private
        mixed
    $_view

__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([array<string|int, mixed> $config = [] ]) : mixed

The default implementation does two things:

Initializes the object with the given configuration $config.
Call [[init()]].

If this method is overridden in a child class, it is recommended that

the last parameter of the constructor is a configuration array, like $config here.
call the parent implementation at the end of the constructor.

Parameters

$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

afterRun()

This method is invoked right after a widget is executed.


    public
                    afterRun(mixed $result) : mixed

The method will trigger the [[EVENT_AFTER_RUN]] event. The return value of the method will be used as the widget return value.

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

public function afterRun($result)
{
    $result = parent::afterRun($result);
    // your custom code here
    return $result;
}

Parameters

$result : mixed: the widget return result.

Return values

mixed —

the processed widget result.

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

beforeRun()

This method is invoked right before the widget is executed.


    public
                    beforeRun() : bool

The method will trigger the [[EVENT_BEFORE_RUN]] event. The return value of the method will determine whether the widget should continue to run.

When overriding this method, make sure you call the parent implementation like the following:

public function beforeRun()
{
    if (!parent::beforeRun()) {
        return false;
    }

    // your custom code here

    return true; // or false to not run the widget
}

Return values

bool —

whether the widget should continue to be executed.

begin()

Begins a widget.


    public
            static        begin([array<string|int, mixed> $config = [] ]) : static

This method creates an instance of the calling class. It will apply the configuration to the created instance. A matching [[end()]] call should be called later. As some widgets may use output buffering, the [[end()]] call should be made in the same view to avoid breaking the nesting of output buffers.

Parameters

$config : array<string|int, mixed> = []: name-value pairs that will be used to initialize the object properties

Return values

static —

the newly created widget instance

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.

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.

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

end()

Ends a widget.


    public
            static        end() : static

Note that the rendering result of the widget is directly echoed out.

Return values

static —

the widget instance that is ended.

ensureBehaviors()

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


    public
                    ensureBehaviors() : mixed

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

getId()

Returns the ID of the widget.


    public
                    getId([bool $autoGenerate = true ]) : string|null

Parameters

$autoGenerate : bool = true: whether to generate an ID if it is not set previously

Return values

string|null —

ID of the widget.

getView()

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


    public
                    getView() : View

The [[render()]] 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 —

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

getViewPath()

Returns the directory containing the view files for this widget.


    public
                    getViewPath() : string

The default implementation returns the 'views' subdirectory under the directory containing the widget class file.

Return values

string —

the directory containing the view files for this widget.

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

init()

Initializes the object.


    public
                    init() : mixed

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.

registerClientScript()

Registers the needed JavaScript.


    public
                    registerClientScript() : mixed

render()

Renders a view.


    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 the currently active module.
relative path (e.g. "index"): the actual view file will be looked for under [[viewPath]].

If the view 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.

Return values

string —

the rendering result.

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.

run()

Executes the widget.


    public
                    run() : string|void

Return values

string|void —

the rendering result may be directly "echoed" or returned as a string

setId()

Sets the ID of the widget.


    public
                    setId(string $value) : mixed

Parameters

$value : string: id of the widget.

setView()

Sets the view object to be used by this widget.


    public
                    setView(View $view) : mixed

Parameters

$view : View: the view object that can be used to render views or 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.

widget()

Creates a widget instance and runs it.


    public
            static        widget([array<string|int, mixed> $config = [] ]) : string

The widget rendering result is returned by this method.

Parameters

$config : array<string|int, mixed> = []: name-value pairs that will be used to initialize the object properties

Return values

string —

the rendering result of the widget.

requiresPjax()


    protected
                    requiresPjax() : bool

Return values

bool —

whether the current request requires pjax response from this widget

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.

Pjax extends Pjax in package Application

Table of Contents

Constants

Properties

Methods

Constants

EVENT_AFTER_RUN

Tags

EVENT_BEFORE_RUN

Tags

EVENT_INIT

Tags

Properties

$autoIdPrefix

$behaviors read-only

$clientOptions

$enablePushState

$enableReplaceState

$formSelector

$id

$linkSelector

$options

Tags

$scrollTo

$submitEvent

Tags

$timeout

$view

$viewPath read-only

$_behaviors

$_events

$_eventWildcards

Tags

$_id

$_view

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

afterRun()

Parameters

Tags

Return values

attachBehavior()

Parameters

Tags

Return values

attachBehaviors()

Parameters

Tags

beforeRun()

Tags

Return values

begin()

Parameters

Pjax extends Pjax
in package

Application