HumHub Documentation (unofficial)

PermissionGridEditor extends GridView
in package

Application

PermissionGridView

Constants

EVENT_AFTER_RUN = 'afterRun'
EVENT_BEFORE_RUN = 'beforeRun'
EVENT_INIT = 'init'
FILTER_POS_BODY = 'body'
FILTER_POS_FOOTER = 'footer'
FILTER_POS_HEADER = 'header'

Properties

$afterRow : Closure
$autoIdPrefix : string
$beforeRow : Closure
$behaviors : array<string|int, Behavior>
$caption : string
$captionOptions : array<string|int, mixed>
$columns : array<string|int, mixed>
$dataColumnClass : string
$dataProvider : DataProviderInterface
$emptyCell : string
$emptyText : string|false
$emptyTextOptions : array<string|int, mixed>
$filterErrorOptions : array<string|int, mixed>
$filterErrorSummaryOptions : array<string|int, mixed>
$filterModel : Model|null
$filterOnFocusOut : bool
$filterPosition : string
$filterRowOptions : array<string|int, mixed>
$filterSelector : string
$filterUrl : string|array<string|int, mixed>|null
$footerRowOptions : array<string|int, mixed>
$formatter : array<string|int, mixed>|Formatter|null
$groupId : string
$headerRowOptions : array<string|int, mixed>
$hideFixedPermissions : bool
$id : string|null
$layout : string
$options : mixed
$pager : array<string|int, mixed>
$permissionManager : PermissionManager
$placeFooterAfterBody : bool
$rowOptions : array<string|int, mixed>|Closure
$showFooter : bool
$showHeader : mixed
$showOnEmpty : bool
$sorter : array<string|int, mixed>
$summary : string
$summaryOptions : array<string|int, mixed>
$tableOptions : array<string|int, mixed>
$view : View
$viewPath : string
$_behaviors : array<string|int, Behavior>|null
$_events : array<string|int, mixed>
$_eventWildcards : array<string|int, mixed>
$_id : mixed
$_view : mixed
$lastModuleId : string

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 grid view.
off() : bool: Detaches an existing event handler from this component.
on() : mixed: Attaches an event handler to an event.
render() : string: Renders a view.
renderCaption() : bool|string: Renders the caption element.
renderColumnGroup() : bool|string: Renders the column group HTML.
renderEmpty() : string: Renders the HTML content indicating that the list view has no data.
renderErrors() : string: Renders validator errors of filter model.
renderFile() : string: Renders a view file.
renderFilters() : string: Renders the filter.
renderItems() : string: Renders the data models for the grid view.
renderPager() : string: Renders the pager.
renderSection() : string|bool: Renders a section of the specified name.
renderSorter() : string: Renders the sorter.
renderSummary() : mixed: Renders the summary text.
renderTableBody() : string: Renders the table body.
renderTableFooter() : string: Renders the table footer.
renderTableHeader() : string: Renders the table header.
renderTableRow() : string: Renders a table row with the given data model and key.
run() : string|void: Runs 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.
createDataColumn() : DataColumn: Creates a [[DataColumn]] object based on a string in the format of "attribute:format:label".
getClientOptions() : array<string|int, mixed>: Returns the options for the grid view JS widget.
getDataProvider() : DataProviderInterface: Returns data provider
guessColumns() : mixed: This function tries to guess the columns to show from the given data if [[columns]] are not explicitly specified.
initColumns() : mixed: Creates column objects and initializes them.
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'

FILTER_POS_BODY


    public
        mixed
    FILTER_POS_BODY
    = 'body'

FILTER_POS_FOOTER


    public
        mixed
    FILTER_POS_FOOTER
    = 'footer'

FILTER_POS_HEADER


    public
        mixed
    FILTER_POS_HEADER
    = 'header'

$afterRow


    public
        Closure
    $afterRow

an anonymous function that is called once AFTER rendering each data model. It should have the similar signature as [[rowOptions]]. The return result of the function will be rendered directly.

$autoIdPrefix


    public
    static    string
    $autoIdPrefix
     = 'w'

the prefix to the automatically generated widget IDs.

$beforeRow


    public
        Closure
    $beforeRow

an anonymous function that is called once BEFORE rendering each data model. It should have the similar signature as [[rowOptions]]. The return result of the function will be rendered directly.

$behaviors read-only


    public
        array<string|int, Behavior>
    $behaviors

List of behaviors attached to this component.

$caption


    public
        string
    $caption

the caption of the grid table

$captionOptions


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

the HTML attributes for the caption element.

$columns


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

grid column configuration. Each array element represents the configuration for one particular grid column. For example,

[
    ['class' => SerialColumn::class],
    [
        'class' => DataColumn::class, // this line is optional
        'attribute' => 'name',
        'format' => 'text',
        'label' => 'Name',
    ],
    ['class' => CheckboxColumn::class],
]

If a column is of class [[DataColumn]], the "class" element can be omitted.

As a shortcut format, a string may be used to specify the configuration of a data column which only contains [[DataColumn::attribute|attribute]], [[DataColumn::format|format]], and/or [[DataColumn::label|label]] options: "attribute:format:label". For example, the above "name" column can also be specified as: "name:text:Name". Both "format" and "label" are optional. They will take default values if absent.

Using the shortcut format the configuration for columns in simple cases would look like this:

[
    'id',
    'amount:currency:Total Amount',
    'created_at:datetime',
]

When using a [[dataProvider]] with active records, you can also display values from related records, e.g. the name attribute of the author relation:

// shortcut syntax
'author.name',
// full syntax
[
    'attribute' => 'author.name',
    // ...
]

$dataColumnClass


    public
        string
    $dataColumnClass

the default data column class if the class name is not explicitly specified when configuring a data column. Defaults to 'yii\grid\DataColumn'.

$dataProvider


    public
        DataProviderInterface
    $dataProvider

the data provider for the view. This property is required.

$emptyCell


    public
        string
    $emptyCell
     = '&nbsp;'

the HTML display when the content of a cell is empty. This property is used to render cells that have no defined content, e.g. empty footer or filter cells.

Note that this is not used by the [[DataColumn]] if a data item is null. In that case the [[\yii\i18n\Formatter::nullDisplay|nullDisplay]] property of the [[formatter]] will be used to indicate an empty data value.

$emptyText


    public
        string|false
    $emptyText

the HTML content to be displayed when [[dataProvider]] does not have any data. When this is set to false no extra HTML content will be generated. The default value is the text "No results found." which will be translated to the current application language.

$emptyTextOptions


    public
        array<string|int, mixed>
    $emptyTextOptions
     = ['class' => 'empty']

the HTML attributes for the emptyText of the list view. The "tag" element specifies the tag name of the emptyText element and defaults to "div".

$filterErrorOptions


    public
        array<string|int, mixed>
    $filterErrorOptions
     = ['class' => 'help-block']

the options for rendering every filter error message. This is mainly used by [[Html::error()]] when rendering an error message next to every filter input field.

$filterErrorSummaryOptions


    public
        array<string|int, mixed>
    $filterErrorSummaryOptions
     = ['class' => 'error-summary']

the options for rendering the filter error summary. Please refer to [[Html::errorSummary()]] for more details about how to specify the options.

$filterModel


    public
        Model|null
    $filterModel

the model that keeps the user-entered filter data. When this property is set, the grid view will enable column-based filtering. Each data column by default will display a text field at the top that users can fill in to filter the data.

Note that in order to show an input field for filtering, a column must have its [[DataColumn::attribute]] property set and the attribute should be active in the current scenario of $filterModel or have [[DataColumn::filter]] set as the HTML code for the input field.

When this property is not set (null) the filtering feature is disabled.

$filterOnFocusOut


    public
        bool
    $filterOnFocusOut
     = true

whatever to apply filters on losing focus. Leaves an ability to manage filters via yiiGridView JS

$filterPosition


    public
        string
    $filterPosition
     = self::FILTER_POS_BODY

whether the filters should be displayed in the grid view. Valid values include:

[[FILTER_POS_HEADER]]: the filters will be displayed on top of each column's header cell.
[[FILTER_POS_BODY]]: the filters will be displayed right below each column's header cell.
[[FILTER_POS_FOOTER]]: the filters will be displayed below each column's footer cell.

$filterRowOptions


    public
        array<string|int, mixed>
    $filterRowOptions
     = ['class' => 'filters']

the HTML attributes for the filter row element.

$filterSelector


    public
        string
    $filterSelector

additional jQuery selector for selecting filter input fields

$filterUrl


    public
        string|array<string|int, mixed>|null
    $filterUrl

the URL for returning the filtering result. [[Url::to()]] will be called to normalize the URL. If not set, the current controller action will be used. When the user makes change to any filter input, the current filtering inputs will be appended as GET parameters to this URL.

$footerRowOptions


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

the HTML attributes for the table footer row.

$formatter


    public
        array<string|int, mixed>|Formatter|null
    $formatter

the formatter used to format model attribute values into displayable texts. This can be either an instance of [[Formatter]] or an configuration array for creating the [[Formatter]] instance. If this property is not set, the "formatter" application component will be used.

$groupId


    public
        string
    $groupId
     = ""

Group Id

$headerRowOptions


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

the HTML attributes for the table header row.

$hideFixedPermissions


    public
        bool
    $hideFixedPermissions
     = true

hide not changeable permissions

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

$layout


    public
        string
    $layout
     = "{summary}\n{items}\n{pager}"

the layout that determines how different sections of the grid view should be organized. The following tokens will be replaced with the corresponding section contents:

{summary}: the summary section. See [[renderSummary()]].
{errors}: the filter model error summary. See [[renderErrors()]].
{items}: the list items. See [[renderItems()]].
{sorter}: the sorter. See [[renderSorter()]].
{pager}: the pager. See [[renderPager()]].

$options


    public
        mixed
    $options
     = ['class' => 'grid-view permission-grid-editor']

$pager


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

the configuration for the pager widget. By default, [[LinkPager]] will be used to render the pager. You can use a different widget class by configuring the "class" element. Note that the widget must support the pagination property which will be populated with the [[\yii\data\BaseDataProvider::pagination|pagination]] value of the [[dataProvider]] and will overwrite this value.

$permissionManager


    public
        PermissionManager
    $permissionManager

$placeFooterAfterBody


    public
        bool
    $placeFooterAfterBody
     = false

whether to place footer after body in DOM if $showFooter is true

$rowOptions


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

the HTML attributes for the table body rows. This can be either an array specifying the common HTML attributes for all body rows, or an anonymous function that returns an array of the HTML attributes. The anonymous function will be called once for every data model returned by [[dataProvider]]. It should have the following signature:

function ($model, $key, $index, $grid)

$model: the current data model being rendered
$key: the key value associated with the current data model
$index: the zero-based index of the data model in the model array returned by [[dataProvider]]
$grid: the GridView object

$showFooter


    public
        bool
    $showFooter
     = false

whether to show the footer section of the grid table.

$showHeader


    public
        mixed
    $showHeader
     = false

$showOnEmpty


    public
        bool
    $showOnEmpty
     = true

whether to show the grid view if [[dataProvider]] returns no data.

$sorter


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

the configuration for the sorter widget. By default, [[LinkSorter]] will be used to render the sorter. You can use a different widget class by configuring the "class" element. Note that the widget must support the sort property which will be populated with the [[\yii\data\BaseDataProvider::sort|sort]] value of the [[dataProvider]] and will overwrite this value.

$summary


    public
        string
    $summary

the HTML content to be displayed as the summary of the list view. If you do not want to show the summary, you may set it with an empty string.

The following tokens will be replaced with the corresponding values:

{begin}: the starting row number (1-based) currently being displayed
{end}: the ending row number (1-based) currently being displayed
{count}: the number of rows currently being displayed
{totalCount}: the total number of rows available
{page}: the page number (1-based) current being displayed
{pageCount}: the number of pages available

$summaryOptions


    public
        array<string|int, mixed>
    $summaryOptions
     = ['class' => 'summary']

the HTML attributes for the summary of the list view. The "tag" element specifies the tag name of the summary element and defaults to "div".

$tableOptions


    public
        array<string|int, mixed>
    $tableOptions
     = ['class' => 'table table-hover']

the HTML attributes for the grid table element.

$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

$lastModuleId


    private
        string
    $lastModuleId
     = ''

used to group row headers

__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 grid view.


    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.

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.

renderCaption()

Renders the caption element.


    public
                    renderCaption() : bool|string

Return values

bool|string —

the rendered caption element or false if no caption element should be rendered.

renderColumnGroup()

Renders the column group HTML.


    public
                    renderColumnGroup() : bool|string

Return values

bool|string —

the column group HTML or false if no column group should be rendered.

renderEmpty()

Renders the HTML content indicating that the list view has no data.


    public
                    renderEmpty() : string

Return values

string —

the rendering result

renderErrors()

Renders validator errors of filter model.


    public
                    renderErrors() : string

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.

renderFilters()

Renders the filter.


    public
                    renderFilters() : string

Return values

string —

the rendering result.

renderItems()

Renders the data models for the grid view.


    public
                    renderItems() : string

Return values

string —

the HTML code of table

renderPager()

Renders the pager.


    public
                    renderPager() : string

Return values

string —

the rendering result

renderSection()

Renders a section of the specified name.


    public
                    renderSection(mixed $name) : string|bool

Parameters

$name : mixed: the section name, e.g., {summary}, {items}.

Return values

string|bool —

the rendering result of the section, or false if the named section is not supported.

renderSorter()

Renders the sorter.


    public
                    renderSorter() : string

Return values

string —

the rendering result

renderSummary()

Renders the summary text.


    public
                    renderSummary() : mixed

renderTableBody()

Renders the table body.


    public
                    renderTableBody() : string

Return values

string —

the rendering result.

renderTableFooter()

Renders the table footer.


    public
                    renderTableFooter() : string

Return values

string —

the rendering result.

renderTableHeader()

Renders the table header.


    public
                    renderTableHeader() : string

Return values

string —

the rendering result.

renderTableRow()

Renders a table row with the given data model and key.


    public
                    renderTableRow(mixed $model, mixed $key, int $index) : string

Parameters

$model : mixed: the data model to be rendered
$key : mixed: the key associated with the data model
$index : int: the zero-based index of the data model among the model array returned by [[dataProvider]].

Return values

string —

the rendering result

run()

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

createDataColumn()

Creates a [[DataColumn]] object based on a string in the format of "attribute:format:label".


    protected
                    createDataColumn(string $text) : DataColumn

Parameters

$text : string: the column specification string

Return values

DataColumn —

the column instance

getClientOptions()

Returns the options for the grid view JS widget.


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

Return values

array<string|int, mixed> —

the options

getDataProvider()

Returns data provider


    protected
                    getDataProvider() : DataProviderInterface

Return values

DataProviderInterface

guessColumns()

This function tries to guess the columns to show from the given data if [[columns]] are not explicitly specified.


    protected
                    guessColumns() : mixed

initColumns()

Creates column objects and initializes them.


    protected
                    initColumns() : mixed

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.

PermissionGridEditor extends GridView in package Application

Tags

Table of Contents

Constants

Properties

Methods

Constants

EVENT_AFTER_RUN

Tags

EVENT_BEFORE_RUN

Tags

EVENT_INIT

Tags

FILTER_POS_BODY

FILTER_POS_FOOTER

FILTER_POS_HEADER

Properties

$afterRow

$autoIdPrefix

Tags

$beforeRow

$behaviors read-only

$caption

Tags

$captionOptions

Tags

$columns

$dataColumnClass

$dataProvider

$emptyCell

$emptyText

Tags

$emptyTextOptions

Tags

$filterErrorOptions

$filterErrorSummaryOptions

Tags

$filterModel

$filterOnFocusOut

Tags

$filterPosition

$filterRowOptions

Tags

$filterSelector

$filterUrl

$footerRowOptions

Tags

$formatter

$groupId

$headerRowOptions

Tags

$hideFixedPermissions

$id

$layout

$options

Tags

$pager

$permissionManager

$placeFooterAfterBody

Tags

$rowOptions

Tags

$showFooter

$showHeader

Tags

$showOnEmpty

$sorter

$summary

$summaryOptions

Tags

$tableOptions

Tags

$view

PermissionGridEditor extends GridView
in package

Application