HumHub Documentation (unofficial)

Column extends BaseObject
in package

Column is the base class of all [[GridView]] column classes.

For more details and usage information on Column, see the guide article on data widgets.

Tags
author

Qiang Xue qiang.xue@gmail.com

since
2.0

Table of Contents

Properties

$content  : callable
$contentOptions  : array<string|int, mixed>|Closure
$filterOptions  : array<string|int, mixed>
$footer  : string
$footerOptions  : array<string|int, mixed>
$grid  : GridView
$header  : string|null
$headerOptions  : array<string|int, mixed>
$options  : array<string|int, mixed>
$visible  : bool

Methods

__call()  : mixed
Calls the named method which is not a class method.
__construct()  : mixed
Constructor.
__get()  : mixed
Returns the value of an object property.
__isset()  : bool
Checks if a property is set, i.e. defined and not null.
__set()  : mixed
Sets value of an object property.
__unset()  : mixed
Sets an object property to null.
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.
hasMethod()  : bool
Returns a value indicating whether a method is defined.
hasProperty()  : bool
Returns a value indicating whether a property is defined.
init()  : mixed
Initializes the object.
renderDataCell()  : string
Renders a data cell.
renderFilterCell()  : mixed
Renders the filter cell.
renderFooterCell()  : mixed
Renders the footer cell.
renderHeaderCell()  : mixed
Renders the header cell.
getHeaderCellLabel()  : string
Returns header cell label.
renderDataCellContent()  : string
Renders the data cell content.
renderFilterCellContent()  : string
Renders the filter cell content.
renderFooterCellContent()  : string
Renders the footer cell content.
renderHeaderCellContent()  : string
Renders the header cell content.

Properties

$content

public callable $content

This is a callable that will be used to generate the content of each cell. The signature of the function should be the following: function ($model, $key, $index, $column). Where $model, $key, and $index refer to the model, key and index of the row currently being rendered and $column is a reference to the [[Column]] object.

$contentOptions

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

the HTML attributes for the data cell tag. This can either be an array of attributes or an anonymous function ([[Closure]]) that returns such an array. The signature of the function should be the following: function ($model, $key, $index, $column). Where $model, $key, and $index refer to the model, key and index of the row currently being rendered and $column is a reference to the [[Column]] object. A function may be used to assign different attributes to different rows based on the data in that row.

Tags
see
Html::renderTagAttributes()

for details on how attributes are being rendered.

$filterOptions

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

the HTML attributes for the filter cell tag.

Tags
see
Html::renderTagAttributes()

for details on how attributes are being rendered.

$footer

public string $footer

the footer cell content. Note that it will not be HTML-encoded.

$footerOptions

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

the HTML attributes for the footer cell tag.

Tags
see
Html::renderTagAttributes()

for details on how attributes are being rendered.

$header

public string|null $header

the header cell content. Note that it will not be HTML-encoded.

$headerOptions

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

the HTML attributes for the header cell tag.

Tags
see
Html::renderTagAttributes()

for details on how attributes are being rendered.

$options

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

the HTML attributes for the column group tag.

Tags
see
Html::renderTagAttributes()

for details on how attributes are being rendered.

$visible

public bool $visible = true

whether this column is visible. Defaults to true.

Methods

__call()

Calls the named method which is not a class method.

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

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

Tags
throws
UnknownMethodException

when calling unknown method

Return values
mixed —

the method return value

__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 an object property.

public __get(string $name) : mixed

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $object->property;.

Parameters
$name : string

the property name

Tags
throws
UnknownPropertyException

if the property is not defined

throws
InvalidCallException

if the property is write-only

see
__set()
Return values
mixed —

the property value

__isset()

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

public __isset(string $name) : bool

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing isset($object->property).

Note that if the property is not defined, false will be returned.

Parameters
$name : string

the property name or the event name

Tags
see
https://www.php.net/manual/en/function.isset.php
Return values
bool —

whether the named property is set (not null).

__set()

Sets value of an object property.

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

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $object->property = $value;.

Parameters
$name : string

the property name or the event name

$value : mixed

the property value

Tags
throws
UnknownPropertyException

if the property is not defined

throws
InvalidCallException

if the property is read-only

see
__get()

__unset()

Sets an object property to null.

public __unset(string $name) : mixed

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing unset($object->property).

Note that if the property is not defined, this method will do nothing. If the property is read-only, it will throw an exception.

Parameters
$name : string

the property name

Tags
throws
InvalidCallException

if the property is read only.

see
https://www.php.net/manual/en/function.unset.php

canGetProperty()

Returns a value indicating whether a property can be read.

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

A property is readable 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);
Parameters
$name : string

the property name

$checkVars : bool = true

whether to treat member variables as properties

Tags
see
canSetProperty()
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

A property is writable 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);
Parameters
$name : string

the property name

$checkVars : bool = true

whether to treat member variables as properties

Tags
see
canGetProperty()
Return values
bool —

whether the property can be written

className()

Returns the fully qualified name of this class.

public static className() : string
Tags
deprecated

since 2.0.14. On PHP >=5.5, use ::class instead.

Return values
string —

the fully qualified name of this class.

hasMethod()

Returns a value indicating whether a method is defined.

public hasMethod(string $name) : bool

The default implementation is a call to php function method_exists(). You may override this method when you implemented the php magic method __call().

Parameters
$name : string

the method name

Return values
bool —

whether the method is defined

hasProperty()

Returns a value indicating whether a property is defined.

public hasProperty(string $name[, bool $checkVars = 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);
Parameters
$name : string

the property name

$checkVars : bool = true

whether to treat member variables as properties

Tags
see
canGetProperty()
see
canSetProperty()
Return values
bool —

whether the property is defined

init()

Initializes the object.

public init() : mixed

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

renderDataCell()

Renders a data cell.

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

the data model being rendered

$key : mixed

the key associated with the data model

$index : int

the zero-based index of the data item among the item array returned by [[GridView::dataProvider]].

Return values
string —

the rendering result

renderFilterCell()

Renders the filter cell.

public renderFilterCell() : mixed

renderFooterCell()

Renders the footer cell.

public renderFooterCell() : mixed

renderHeaderCell()

Renders the header cell.

public renderHeaderCell() : mixed

getHeaderCellLabel()

Returns header cell label.

protected getHeaderCellLabel() : string

This method may be overridden to customize the label of the header cell.

Tags
since
2.0.8
Return values
string —

label

renderDataCellContent()

Renders the data cell content.

protected renderDataCellContent(mixed $model, mixed $key, int $index) : string
Parameters
$model : mixed

the data model

$key : mixed

the key associated with the data model

$index : int

the zero-based index of the data model among the models array returned by [[GridView::dataProvider]].

Return values
string —

the rendering result

renderFilterCellContent()

Renders the filter cell content.

protected renderFilterCellContent() : string

The default implementation simply renders a space. This method may be overridden to customize the rendering of the filter cell (if any).

Return values
string —

the rendering result

renderFooterCellContent()

Renders the footer cell content.

protected renderFooterCellContent() : string

The default implementation simply renders [[footer]]. This method may be overridden to customize the rendering of the footer cell.

Return values
string —

the rendering result

renderHeaderCellContent()

Renders the header cell content.

protected renderHeaderCellContent() : string

The default implementation simply renders [[header]]. This method may be overridden to customize the rendering of the header cell.

Return values
string —

the rendering result


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results