PHP Class DashboardHelper

Inheritance: extends AppHelper

Show file Open project: openeyes/openeyes Class Usage Examples

Public Properties

Property	Type	Description
$sortable	boolean	Flag to toggle the drag and drop sorting controls for widgets.

Protected Properties

Property	Type	Description
$items	array
$user	OEWebUser

Public Methods

Method	Description
__construct ( array $items = null, OEWebUser $user = null )
getItemPosition ( $item ) : integer \| null	Gets the position for an item in the render list.
render ( ) : mixed	Renders the HTML snippet of the Dashboard.

Protected Methods

Method	Description
getNextItemPosition ( ) : integer	Calculates the next position index to use for a rendered item.
moduleRender ( &$renders, $item )
objRender ( &$renders, $item )
renderItems ( )

Method Details

__construct() public method

public __construct ( array $items = null, OEWebUser $user = null )
$items	array	expected to be of the form: [ [ 'module' => 'ModuleName', 'restricted' => (optional) ] ]
$user	OEWebUser

getItemPosition() public method

Gets the position for an item in the render list.

public getItemPosition ( $item ) : integer \| null
$item
return	integer \| null

getNextItemPosition() protected method

Calculates the next position index to use for a rendered item.

protected getNextItemPosition ( ) : integer
return	integer

moduleRender() protected method

protected moduleRender ( &$renders, $item )
$renders
$item

objRender() protected method

protected objRender ( &$renders, $item )
$renders
$item

render() public method

Renders the HTML snippet of the Dashboard.

public render ( ) : mixed
return	mixed

renderItems() protected method

protected renderItems ( )

Property Details

$items protected property

protected array $items
return	array

$sortable public property

Flag to toggle the drag and drop sorting controls for widgets.

public bool $sortable
return	boolean

$user protected property

protected OEWebUser $user
return	OEWebUser