Class Horde_Core_Block_Collection

This class provides an API to the blocks (applets) framework.

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Horde_Core_Block_Collection implements Serializable

Package: Core
Category: Horde
License: LGPL 2.1
Author: Mike Cochrane mike@graftonhall.co.nz
Author: Jan Schneider jan@horde.org
Author: Michael Slusarz slusarz@horde.org
Located at Horde/Core/Block/Collection.php

Methods summary
`public`	# `__construct( array $apps, string $layout )` Constructor. Constructor. Parameters `$apps` The applications whose blocks to list. `$layout` Layout configuration preference name.
`public array`	# `getLayout( )` Return the layout configuration for this collection. Return the layout configuration for this collection. Returns `array` The layout configuration.
`public Horde_Core_Block_Layout_Manager`	# `getLayoutManager( )` Return the layout manager for this collection. Return the layout manager for this collection. Returns `Horde_Core_Block_Layout_Manager` Layout manager object.
`public Horde_Core_Block`	# `getBlock( string $app, string $name, array $params = null )` Gets a block object. Gets a block object. Parameters `$app` Application name. `$name` The Block's classname. `$params` <p>Parameters. If null, the stored parameters will be used.</p> Returns `Horde_Core_Block` Block object. Throws Horde_Exception
`public array`	# `getBlocksList( )` Returns a pretty printed list of all available blocks. Returns a pretty printed list of all available blocks. Returns `array` A hash with block IDs as keys and application plus block block names as values.
`public string`	# `getFixedBlocks( )` Returns a layout with all fixed blocks as per configuration. Returns a layout with all fixed blocks as per configuration. Returns `string` A default serialized block layout.
`public string`	# `getBlocksWidget( string $cur_app = null, string $cur_block = null, boolean $onchange = false, boolean $readonly = false )` Returns a select widget with all available blocks. Returns a select widget with all available blocks. Parameters `$cur_app` The block from this application gets selected. `$cur_block` The block with this name gets selected. `$onchange` Include the onchange action `$readonly` Indicates if this block type is changeable. Returns `string` The select tag with all available blocks.
`public TODO`	# `getOptionType( mixed $app, mixed $block, mixed $param_id )` Returns the option type. Returns the option type. Parameters `$app` TODO `$block` TODO `$param_id` TODO Returns `TODO`
`public TODO`	# `getOptionRequired( mixed $app, mixed $block, mixed $param_id )` Returns whether the option is required or not. Defaults to true. Returns whether the option is required or not. Defaults to true. Parameters `$app` TODO `$block` TODO `$param_id` TODO Returns `TODO`
`public TODO`	# `getOptionValues( mixed $app, mixed $block, mixed $param_id )` Returns the values for an option. Returns the values for an option. Parameters `$app` TODO `$block` TODO `$param_id` TODO Returns `TODO`
`public TODO`	# `getOptionsWidget( mixed $app, mixed $block, mixed $param_id, mixed $val = null )` Returns the widget necessary to configure this block. Returns the widget necessary to configure this block. Parameters `$app` TODO `$block` TODO `$param_id` TODO `$val` TODO Returns `TODO`
`public string`	# `getName( string $app, string $block )` Returns the name of the specified block. Returns the name of the specified block. Parameters `$app` An application name. `$block` A block name. Returns `string` The name of the specified block.
`public array`	# `getParams( string $app, string $block )` Returns the parameter list of the specified block. Returns the parameter list of the specified block. Parameters `$app` An application name. `$block` A block name. Returns `array` An array with all parameter names.
`public string`	# `getParamName( string $app, string $block, string $param )` Returns the (clear text) name of the specified parameter. Returns the (clear text) name of the specified parameter. Parameters `$app` An application name. `$block` A block name. `$param` A parameter name. Returns `string` The name of the specified parameter.
`public string`	# `getDefaultValue( string $app, string $block, string $param )` Returns the default value of the specified parameter. Returns the default value of the specified parameter. Parameters `$app` An application name. `$block` A block name. `$param` A parameter name. Returns `string` The default value of the specified parameter or null.
`public boolean`	# `isEditable( string $app, string $block )` Returns if the specified block is customizeable by the user. Returns if the specified block is customizeable by the user. Parameters `$app` An application name. `$block` A block name. Returns `boolean` True is the block is customizeable.
`public`	# `serialize( )` Implementation of `Serializable::serialize()`
`public`	# `unserialize( mixed $data )` Implementation of `Serializable::unserialize()`

Packages

Classes

Exceptions

Class Horde_Core_Block_Collection

Parameters

Returns

Returns

Parameters

Returns

Throws

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Implementation of

Implementation of