PHP Class DashboardHelper

Inheritance: extends AppHelper
Afficher le fichier Open project: openeyes/openeyes Class Usage Examples

Méthodes publiques

Свойство Type Description
$sortable boolean Flag to toggle the drag and drop sorting controls for widgets.

Protected Properties

Свойство Type Description
$items array
$user OEWebUser

Méthodes publiques

Méthode 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.

Méthodes protégées

Méthode 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 méthode

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

getItemPosition() public méthode

Gets the position for an item in the render list.
public getItemPosition ( $item ) : integer | null
$item
Résultat integer | null

getNextItemPosition() protected méthode

Calculates the next position index to use for a rendered item.
protected getNextItemPosition ( ) : integer
Résultat integer

moduleRender() protected méthode

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

objRender() protected méthode

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

render() public méthode

Renders the HTML snippet of the Dashboard.
public render ( ) : mixed
Résultat mixed

renderItems() protected méthode

protected renderItems ( )

Property Details

$items protected_oe property

protected array $items
Résultat array

$sortable public_oe property

Flag to toggle the drag and drop sorting controls for widgets.
public bool $sortable
Résultat boolean

$user protected_oe property

protected OEWebUser $user
Résultat OEWebUser