Elgg  Version 3.0
Public Member Functions | List of all members
Elgg\Views\TableColumn\ViewColumn Class Reference

Table column rendered by a view. More...

Inheritance diagram for Elgg\Views\TableColumn\ViewColumn:
Elgg\Views\TableColumn

Public Member Functions

 __construct ($view, $heading=null, $vars=[])
 Constructor. More...
 
 renderHeading ()
 {Get the rendered heading cell as HTML.Cell will be auto-wrapped with a TH element if the returned string doesn't begin with "<th" or "<td".
Returns
string e.g. "Title" or "<th>Title</th>". You must filter/escape any user content.
} More...
 
 renderCell ($item, $type, $item_vars)
 {Render a value cell as HTML.Cell will be auto-wrapped with a TD element if the returned string doesn't begin with "<th" or "<td".
Parameters
mixed$itemObject/row from which to pull the value
string$typeType of object
array$item_varsParameters from the listing function
Returns
string e.g. "My Great Title" or "<td>My Great Title</td>". You must filter/escape any user content.
} More...
 

Detailed Description

Table column rendered by a view.

Definition at line 9 of file ViewColumn.php.

Constructor & Destructor Documentation

Elgg\Views\TableColumn\ViewColumn::__construct (   $view,
  $heading = null,
  $vars = [] 
)

Constructor.

Parameters
string$viewThe view to render the value
string$headingHeading
array$varsVars to merge into the view vars

Definition at line 33 of file ViewColumn.php.

Member Function Documentation

Elgg\Views\TableColumn\ViewColumn::renderCell (   $item,
  $type,
  $item_vars 
)

{Render a value cell as HTML.Cell will be auto-wrapped with a TD element if the returned string doesn't begin with "<th" or "<td".

Parameters
mixed$itemObject/row from which to pull the value
string$typeType of object
array$item_varsParameters from the listing function
Returns
string e.g. "My Great Title" or "<td>My Great Title</td>". You must filter/escape any user content.
}

Implements Elgg\Views\TableColumn.

Definition at line 53 of file ViewColumn.php.

Elgg\Views\TableColumn\ViewColumn::renderHeading ( )

{Get the rendered heading cell as HTML.Cell will be auto-wrapped with a TH element if the returned string doesn't begin with "<th" or "<td".

Returns
string e.g. "Title" or "<th>Title</th>". You must filter/escape any user content.
}

Implements Elgg\Views\TableColumn.

Definition at line 46 of file ViewColumn.php.


The documentation for this class was generated from the following file: