API Documentation
\

\Horde_Core_Block_Layout_View

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.

Summary

Methods
Properties
Constants
isRemovable()
getActionUrl()
getHeaderIcons()
__construct()
toHtml()
getApplications()
getStylesheets()
No public properties found
No constants found
No protected methods found
$_editUrl
$_viewUrl
$_applications
$_layout
N/A
No private methods found
No private properties found
N/A

Properties

$_editUrl

$_editUrl : string

Edit URL.

Type

string

$_viewUrl

$_viewUrl : string

View URL.

Type

string

$_applications

$_applications : array

All applications used in this layout.

Type

array

$_layout

$_layout : array

The current block layout.

Type

array

Methods

isRemovable()

isRemovable(integer  $row, integer  $col) : boolean

Returns whether the specified block may be removed.

Parameters

integer $row

A layout row.
integer $col

A layout column.

Returns

boolean —

True if this block may be removed.

getActionUrl()

getActionUrl(string  $action, integer  $row, integer  $col) : \Horde_Url

Returns an URL triggering an action to a block.

Parameters

string $action

An action to trigger.
integer $row

A layout row.
integer $col

A layout column.

Returns

\Horde_Url —

An URL with all necessary parameters.

getHeaderIcons()

getHeaderIcons(integer  $row, integer  $col, boolean  $edit,   $url = null) : string

Returns the actions for the block header.

Parameters

integer $row

A layout row.
integer $col

A layout column.
boolean $edit

Whether to include the edit icon.
$url

TODO

Returns

string —

HTML code for the block action icons.

__construct()

__construct(array  $layout, \Horde_Url  $editUrl, \Horde_Url  $viewUrl)

Constructor.

Parameters

array $layout
\Horde_Url $editUrl
\Horde_Url $viewUrl

toHtml()

toHtml() : string

Render the current layout as HTML.

Returns

string —

HTML layout.

getApplications()

getApplications() : array

Return a list of all the applications used by blocks in this layout.

Returns

array —

List of applications.

getStylesheets()

getStylesheets() : array

Returns

array —

List of stylesheet information.