Horde_Core_Block_Layout
in package
Provides basic functionality for both managing and displaying blocks.
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
Methods
- getActionUrl() : Horde_Url
- Returns an URL triggering an action to a block.
- getHeaderIcons() : string
- Returns the actions for the block header.
- isRemovable() : bool
- Returns whether the specified block may be removed.
Properties
$_editUrl
Edit URL.
protected
string
$_editUrl
$_layout
protected
mixed
$_layout
$_viewUrl
View URL.
protected
string
$_viewUrl
Methods
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.
getHeaderIcons()
Returns the actions for the block header.
public
getHeaderIcons(int $row, int $col, bool $edit[, mixed $url = null ]) : string
Parameters
- $row : int
-
A layout row.
- $col : int
-
A layout column.
- $edit : bool
-
Whether to include the edit icon.
- $url : mixed = null
-
TODO
Return values
string —HTML code for the block action icons.
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.