Horde_Core_Block_Layout_View
extends Horde_Core_Block_Layout
in package
This object represents the user defined portal layout.
Copyright 2003-2017 Horde LLC (http://www.horde.org/)
See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
Tags
Table of Contents
Properties
- $_applications : array<string|int, mixed>
- All applications used in this layout.
- $_editUrl : string
- Edit URL.
- $_layout : array<string|int, mixed>
- The current block layout.
- $_viewUrl : string
- View URL.
Methods
- __construct() : mixed
- Constructor.
- getActionUrl() : Horde_Url
- Returns an URL triggering an action to a block.
- getApplications() : array<string|int, mixed>
- Return a list of all the applications used by blocks in this layout.
- getHeaderIcons() : string
- Returns the actions for the block header.
- getStylesheets() : array<string|int, mixed>
- isRemovable() : bool
- Returns whether the specified block may be removed.
- toHtml() : string
- Render the current layout as HTML.
Properties
$_applications
All applications used in this layout.
protected
array<string|int, mixed>
$_applications
= array()
$_editUrl
Edit URL.
protected
string
$_editUrl
$_layout
The current block layout.
protected
array<string|int, mixed>
$_layout
= array()
$_viewUrl
View URL.
protected
string
$_viewUrl
Methods
__construct()
Constructor.
public
__construct(array<string|int, mixed> $layout, Horde_Url $editUrl, Horde_Url $viewUrl) : mixed
Parameters
- $layout : array<string|int, mixed>
- $editUrl : Horde_Url
- $viewUrl : Horde_Url
getActionUrl()
Returns an URL triggering an action to a block.
public
getActionUrl(string $action, int $row, int $col) : Horde_Url
Parameters
- $action : string
-
An action to trigger.
- $row : int
-
A layout row.
- $col : int
-
A layout column.
Return values
Horde_Url —An URL with all necessary parameters.
getApplications()
Return a list of all the applications used by blocks in this layout.
public
getApplications() : array<string|int, mixed>
Return values
array<string|int, mixed> —List of applications.
getHeaderIcons()
Returns the actions for the block header.
public
getHeaderIcons(int $row, int $col, bool $edit[, $url = null ]) : string
Parameters
- $row : int
-
A layout row.
- $col : int
-
A layout column.
- $edit : bool
-
Whether to include the edit icon.
- $url : = null
-
TODO
Return values
string —HTML code for the block action icons.
getStylesheets()
public
getStylesheets() : array<string|int, mixed>
Return values
array<string|int, mixed> —List of stylesheet information.
isRemovable()
Returns whether the specified block may be removed.
public
isRemovable(int $row, int $col) : bool
Parameters
- $row : int
-
A layout row.
- $col : int
-
A layout column.
Return values
bool —True if this block may be removed.
toHtml()
Render the current layout as HTML.
public
toHtml() : string
Return values
string —HTML layout.