Class AlphaRendererProviderHTML

HTML renderer. Will invoke widgets from the alpha::view::widgets package automatically for the correct data type. Templates from ./templates/html loaded by default, but these can be overridden on a per-DAO level in the application when required (consider the default ones to be scaffolding).

AlphaRendererProviderHTML implements AlphaRendererProviderInterface

Package: alpha::view::renderers
Copyright: Copyright (c) 2012, John Collins (founder of Alpha Framework). All rights reserved.

Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the
following conditions are met:

* Redistributions of source code must retain the above
  copyright notice, this list of conditions and the
  following disclaimer.
* Redistributions in binary form must reproduce the above
  copyright notice, this list of conditions and the
  following disclaimer in the documentation and/or other
  materials provided with the distribution.
* Neither the name of the Alpha Framework nor the names
  of its contributors may be used to endorse or promote
  products derived from this software without specific
  prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

License: The BSD License
Author: John Collins <dev@alphaframework.org>
Version: $Id: AlphaRendererProviderInterface.inc 1499 2012-02-16 19:29:16Z alphadev $
Since: 1.2
Located at view/renderers/html/AlphaRendererProviderHTML.inc

Methods summary
`public`	# `__construct( )` The constructor The constructor Since 1.2
`public`	# `setBO( AlphaDAO $BO )` (non-PHPdoc) (non-PHPdoc) Parameters `$BO` `AlphaDAO` $BO See alpha/view/renderers/AlphaRendererProvider::setBO() Implementation of `AlphaRendererProviderInterface::setBO()`
`public string`	# `createView( array $fields = array() )` (non-PHPdoc) (non-PHPdoc) Parameters `$fields` `array` $fields Hash array of fields to pass to the template. Returns `string` See alpha/view/renderers/AlphaRendererProviderInterface::createView() Implementation of `AlphaRendererProviderInterface::createView()`
`public string`	# `editView( array $fields = array() )` (non-PHPdoc) (non-PHPdoc) Parameters `$fields` `array` $fields Hash array of fields to pass to the template. Returns `string` See alpha/view/renderers/AlphaRendererProviderInterface::editView() Implementation of `AlphaRendererProviderInterface::editView()`
`public string`	# `listView( array $fields = array() )` (non-PHPdoc) (non-PHPdoc) Parameters `$fields` `array` $fields Hash array of fields to pass to the template. Returns `string` See alpha/view/renderers/AlphaRendererProviderInterface::listView() Implementation of `AlphaRendererProviderInterface::listView()`
`public string`	# `detailedView( array $fields = array() )` (non-PHPdoc) (non-PHPdoc) Parameters `$fields` `array` $fields Hash array of fields to pass to the template. Returns `string` See alpha/view/renderers/AlphaRendererProviderInterface::detailedView() Implementation of `AlphaRendererProviderInterface::detailedView()`
`public string`	# `adminView( array $fields = array() )` (non-PHPdoc) (non-PHPdoc) Parameters `$fields` `array` $fields Hash array of fields to pass to the template. Returns `string` See alpha/view/renderers/AlphaRendererProviderInterface::adminView() Implementation of `AlphaRendererProviderInterface::adminView()`
`public static string`	# `displayPageHead( AlphaController $controller )` (non-PHPdoc) (non-PHPdoc) Parameters `$controller` `AlphaController` $controller Returns `string` Throws `IllegalArguementException` See alpha/view/renderers/AlphaRendererProviderInterface::displayPageHead() Implementation of `AlphaRendererProviderInterface::displayPageHead()`
`public static string`	# `displayPageFoot( AlphaController $controller )` (non-PHPdoc) (non-PHPdoc) Parameters `$controller` `AlphaController` $controller Returns `string` See alpha/view/renderers/AlphaRendererProviderInterface::displayPageFoot() Implementation of `AlphaRendererProviderInterface::displayPageFoot()`
`public static string`	# `displayUpdateMessage( string $message )` (non-PHPdoc) (non-PHPdoc) Parameters `$message` `string` $message Returns `string` See alpha/view/renderers/AlphaRendererProviderInterface::displayUpdateMessage() Implementation of `AlphaRendererProviderInterface::displayUpdateMessage()`
`public static string`	# `displayErrorMessage( string $message )` (non-PHPdoc) (non-PHPdoc) Parameters `$message` `string` $message Returns `string` See alpha/view/renderers/AlphaRendererProviderInterface::displayErrorMessage() Implementation of `AlphaRendererProviderInterface::displayErrorMessage()`
`public static string`	# `renderErrorPage( string $code, string $message )` (non-PHPdoc) (non-PHPdoc) Parameters `$code` `string` $code `$message` `string` $message Returns `string` See alpha/view/renderers/AlphaRendererProviderInterface::renderErrorPage() Implementation of `AlphaRendererProviderInterface::renderErrorPage()`
`public static string`	# `renderDeleteForm( )` (non-PHPdoc) (non-PHPdoc) Returns `string` See alpha/view/renderers/AlphaRendererProviderInterface::renderDeleteForm() Implementation of `AlphaRendererProviderInterface::renderDeleteForm()`
`public static string`	# `renderSecurityFields( )` (non-PHPdoc) (non-PHPdoc) Returns `string` See alpha/view/renderers/AlphaRendererProviderInterface::renderSecurityFields() Implementation of `AlphaRendererProviderInterface::renderSecurityFields()`
`public string`	# `renderIntegerField( string $name, string $label, string $mode, string $value = '', boolean $tableTags = true )` (non-PHPdoc) (non-PHPdoc) Parameters `$name` `string` $name The field name `$label` `string` $label The label to apply to the field `$mode` `string` $mode The field mode (create/edit/view) `$value` `string` $value The field value (optional) `$tableTags` `boolean` $tableTags Include table tags and label (optional) Returns `string` See alpha/view/renderers/AlphaRendererProviderInterface::renderIntegerField() Implementation of `AlphaRendererProviderInterface::renderIntegerField()`
`public string`	# `renderDoubleField( string $name, string $label, string $mode, string $value = '', boolean $tableTags = true )` (non-PHPdoc) (non-PHPdoc) Parameters `$name` `string` $name The field name `$label` `string` $label The label to apply to the field `$mode` `string` $mode The field mode (create/edit/view) `$value` `string` $value The field value (optional) `$tableTags` `boolean` $tableTags Include table tags and label (optional) Returns `string` See alpha/view/renderers/AlphaRendererProviderInterface::renderDoubleField() Implementation of `AlphaRendererProviderInterface::renderDoubleField()`
`public string`	# `renderBooleanField( string $name, string $label, string $mode, string $value = '', boolean $tableTags = true )` (non-PHPdoc) (non-PHPdoc) Parameters `$name` `string` $name The field name `$label` `string` $label The label to apply to the field `$mode` `string` $mode The field mode (create/edit/view) `$value` `string` $value The field value (optional) `$tableTags` `boolean` $tableTags Include table tags and label (optional) Returns `string` See alpha/view/renderers/AlphaRendererProviderInterface::renderBooleanField() Implementation of `AlphaRendererProviderInterface::renderBooleanField()`
`public string`	# `renderEnumField( string $name, string $label, string $mode, array $options, string $value = '', boolean $tableTags = true )` (non-PHPdoc) (non-PHPdoc) Parameters `$name` `string` $name The field name `$label` `string` $label The label to apply to the field `$mode` `string` $mode The field mode (create/edit/view) `$options` `array` $options The Enum options `$value` `string` $value The field value (optional) `$tableTags` `boolean` $tableTags Include table tags and label (optional) Returns `string` See alpha/view/renderers/AlphaRendererProviderInterface::renderEnumField() Implementation of `AlphaRendererProviderInterface::renderEnumField()`
`public string`	# `renderDEnumField( string $name, string $label, string $mode, array $options, string $value = '', boolean $tableTags = true )` (non-PHPdoc) (non-PHPdoc) Parameters `$name` `string` $name The field name `$label` `string` $label The label to apply to the field `$mode` `string` $mode The field mode (create/edit/view) `$options` `array` $options The DEnum options `$value` `string` $value The field value (optional) `$tableTags` `boolean` $tableTags Include table tags and label (optional) Returns `string` See alpha/view/renderers/AlphaRendererProviderInterface::renderDEnumField() Implementation of `AlphaRendererProviderInterface::renderDEnumField()`
`public string`	# `renderDefaultField( string $name, string $label, string $mode, string $value = '', boolean $tableTags = true )` (non-PHPdoc) (non-PHPdoc) Parameters `$name` `string` $name The field name `$label` `string` $label The label to apply to the field `$mode` `string` $mode The field mode (create/edit/view) `$value` `string` $value The field value (optional) `$tableTags` `boolean` $tableTags Include table tags and label (optional) Returns `string` See alpha/view/renderers/AlphaRendererProviderInterface::renderDefaultField() Implementation of `AlphaRendererProviderInterface::renderDefaultField()`
`public string`	# `renderTextField( string $name, string $label, string $mode, string $value = '', boolean $tableTags = true )` (non-PHPdoc) (non-PHPdoc) Parameters `$name` `string` $name The field name `$label` `string` $label The label to apply to the field `$mode` `string` $mode The field mode (create/edit/view) `$value` `string` $value The field value (optional) `$tableTags` `boolean` $tableTags Include table tags and label (optional) Returns `string` See alpha/view/renderers/AlphaRendererProviderInterface::renderTextField() Implementation of `AlphaRendererProviderInterface::renderTextField()`
`public string`	# `renderStringField( string $name, string $label, string $mode, string $value = '', boolean $tableTags = true )` (non-PHPdoc) (non-PHPdoc) Parameters `$name` `string` $name The field name `$label` `string` $label The label to apply to the field `$mode` `string` $mode The field mode (create/edit/view) `$value` `string` $value The field value (optional) `$tableTags` `boolean` $tableTags Include table tags and label (optional) Returns `string` See alpha/view/renderers/AlphaRendererProviderInterface::renderStringField() Implementation of `AlphaRendererProviderInterface::renderStringField()`
`public string`	# `renderRelationField( string $name, string $label, string $mode, string $value = '', boolean $tableTags = true, boolean $expanded = false, boolean $buttons = true )` (non-PHPdoc) (non-PHPdoc) Parameters `$name` `string` $name The field name `$label` `string` $label The label to apply to the field `$mode` `string` $mode The field mode (create/edit/view) `$value` `string` $value The field value (optional) `$tableTags` `boolean` $tableTags Include table tags and label (optional) `$expanded` `boolean` $expanded Render the related fields in expanded format or not (optional) `$buttons` `boolean` $buttons Render buttons for expanding/contacting the related fields (optional) Returns `string` See alpha/view/renderers/AlphaRendererProviderInterface::renderRelationField() Implementation of `AlphaRendererProviderInterface::renderRelationField()`
`public string`	# `renderAllFields( string $mode, array $filterFields = array(), array $readOnlyFields = array() )` (non-PHPdoc) (non-PHPdoc) Parameters `$mode` `string` $mode (view\|edit\|create) `$filterFields` `array` $filterFields Optional list of field names to exclude from rendering. `$readOnlyFields` `array` $readOnlyFields Optional list of fields to render in a readonly fashion when rendering in create or edit mode. Returns `string` See alpha/view/renderers/AlphaRendererProviderInterface::renderAllFields() Implementation of `AlphaRendererProviderInterface::renderAllFields()`

Properties summary
`private static Logger`	`$logger`	`null`	# Trace logger Trace logger Since 1.2
`private AlphaDAO`	`$BO`		# The business object that we are renderering The business object that we are renderering Since 1.2

Packages

Classes

Interfaces

Class AlphaRendererProviderHTML

Since

Parameters

See

Implementation of

Parameters

Returns

See

Implementation of

Parameters

Returns

See

Implementation of

Parameters

Returns

See

Implementation of

Parameters

Returns

See

Implementation of

Parameters

Returns

See

Implementation of

Parameters

Returns

Throws

See

Implementation of

Parameters

Returns

See

Implementation of

Parameters

Returns

See

Implementation of

Parameters

Returns

See

Implementation of

Parameters

Returns

See

Implementation of

Returns

See

Implementation of

Returns

See

Implementation of

Parameters

Returns

See

Implementation of

Parameters

Returns

See

Implementation of

Parameters

Returns

See

Implementation of

Parameters

Returns

See

Implementation of

Parameters

Returns

See

Implementation of

Parameters

Returns

See

Implementation of

Parameters