Namespace: Alpha\
View
Copyright:
Copyright (c) 2015, John Collins (founder of Alpha Framework). All rights
reserved. <pre> 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. </pre>
License:
The BSD License
Author:
John Collins <
dev@alphaframework.org>
Since:
1.0
Located at View/View.php
Methods summary
protected
|
#
__construct( Alpha\Model\ActiveRecord $BO, string $acceptHeader = null )
Constructor for the View. As this is protected, use the View::getInstance
method from a public scope.
Constructor for the View. As this is protected, use the View::getInstance
method from a public scope.
Parameters
- $BO
- ActiveRecord $BO The main business object that this view is going to render
- $acceptHeader
- string $acceptHeader Optionally pass the HTTP Accept header to select the
correct renderer provider.
Throws
Since
1.0
|
public static
Alpha\View\View
|
#
getInstance( Alpha\Model\ActiveRecord $BO, boolean $returnParent = false, string $acceptHeader = null )
Static method which returns a View object or a custom child view for the BO
specified if one exists.
Static method which returns a View object or a custom child view for the BO
specified if one exists.
Parameters
- $BO
- ActiveRecord $BO The main business object that this view is going to render
- $returnParent
- bool $returnParent Flag to enforce the return of this object instead of a child
(defaults to false)
- $acceptHeader
- string $acceptHeader Optionally pass the HTTP Accept header to select the
correct renderer provider.
Returns
Alpha\View\View
Returns a View object, or a child view object if one exists for this BO
Since
1.0
|
public
|
#
setBO( Alpha\Model\ActiveRecord $BO )
Simple setter for the view business object.
Simple setter for the view business object.
Parameters
- $BO
- Alpha\Model\ActiveRecord $BO
Throws
Since
1.0
|
public
Alpha\Model\ActiveRecord
|
#
getBO( )
Gets the BO attached to this view (if any).
Gets the BO attached to this view (if any).
Returns
Since
1.0
|
public
string
|
#
createView( array $fields = array() )
Renders the default create view.
Renders the default create view.
Parameters
- $fields
- array $fields Hash array of fields to pass to the template
Returns
string string
Since
1.0
|
public
string
|
#
editView( array $fields = array() )
Renders a form to enable object editing.
Renders a form to enable object editing.
Parameters
- $fields
- array $fields Hash array of fields to pass to the template
Returns
string string
Since
1.0
|
public
string
|
#
listView( array $fields = array() )
Renders the list view.
Parameters
- $fields
- array $fields Hash array of fields to pass to the template
Returns
string string
Since
1.0
|
public
string
|
#
detailedView( array $fields = array() )
Renders a detailed view of the object (read-only).
Renders a detailed view of the object (read-only).
Parameters
- $fields
- array $fields Hash array of fields to pass to the template
Returns
string string
Since
1.0
|
public
string
|
#
adminView( array $fields = array() )
Renders the admin view for the business object screen.
Renders the admin view for the business object screen.
Parameters
- $fields
- array $fields Hash array of fields to pass to the template
Returns
string string
Since
1.0
|
public static
string
|
#
displayPageHead( Alpha\Controller\Controller $controller )
Method to render the page header content.
Method to render the page header content.
Parameters
- $controller
- Alpha\Controller\Controller $controller
Returns
string string
Throws
Since
1.0
|
public static
string
|
#
displayUpdateMessage( string $message )
Renders the content for an update (e.g. successful save) message.
Renders the content for an update (e.g. successful save) message.
Parameters
Returns
string string
Since
1.0
|
public static
string
|
#
displayErrorMessage( string $message )
Renders the content for an error (e.g. save failed) message.
Renders the content for an error (e.g. save failed) message.
Parameters
Returns
string string
Since
1.0
|
public static
string
|
#
renderErrorPage( string $code, string $message )
Renders an error page with the supplied error code (typlically a HTTP code)
and a message.
Renders an error page with the supplied error code (typlically a HTTP code)
and a message.
Parameters
- $code
- string $code
- $message
- string $message
Returns
string string
Since
1.0
|
public static
string
|
#
renderDeleteForm( string $URI )
Method to render a hidden HTML form for posting the OID of an object to be
deleted.
Method to render a hidden HTML form for posting the OID of an object to be
deleted.
Parameters
- $URI
- string $URI The URI that the form will point to
Returns
string string
Since
1.0
|
public static
string
|
#
renderSecurityFields( )
Method to render a HTML form with two hidden, hashed (MD5) form fields to be
used as a check to ensure that a post to the controller is being sent from the
same server as hosting it.
Method to render a HTML form with two hidden, hashed (MD5) form fields to be
used as a check to ensure that a post to the controller is being sent from the
same server as hosting it.
Returns
string string
Since
1.0
|
public
string
|
#
renderIntegerField( string $name, string $label, string $mode, string $value = '', boolean $tableTags = true )
Method to render the default Integer HTML.
Method to render the default Integer HTML.
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
- bool $tableTags Include table tags and label (optional)
Returns
string string
Since
1.0
|
public
string
|
#
renderDoubleField( string $name, string $label, string $mode, string $value = '', boolean $tableTags = true )
Method to render the default Double HTML.
Method to render the default Double HTML.
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
- bool $tableTags Include table tags and label (optional)
Returns
string string
Since
1.0
|
public
string
|
#
renderBooleanField( string $name, string $label, string $mode, string $value = '', boolean $tableTags = true )
Method to render the default Boolean HTML.
Method to render the default Boolean HTML.
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
- bool $tableTags Include table tags and label (optional)
Returns
string string
Since
1.0
|
public
string
|
#
renderEnumField( string $name, string $label, string $mode, array $options, string $value = '', boolean $tableTags = true )
Method to render the default Enum HTML.
Method to render the default Enum HTML.
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
- bool $tableTags Include table tags and label (optional)
Returns
string string
Since
1.0
|
public
string
|
#
renderDEnumField( string $name, string $label, string $mode, array $options, string $value = '', boolean $tableTags = true )
Method to render the default DEnum HTML.
Method to render the default DEnum HTML.
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
- bool $tableTags Include table tags and label (optional)
Returns
string string
Since
1.0
|
public
string
|
#
renderDefaultField( string $name, string $label, string $mode, string $value = '', boolean $tableTags = true )
Method to render the default field HTML when type is not known.
Method to render the default field HTML when type is not known.
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
- bool $tableTags Include table tags and label (optional)
Returns
string string
Since
1.0
|
public
string
|
#
renderTextField( string $name, string $label, string $mode, string $value = '', boolean $tableTags = true )
render the default Text HTML.
render the default Text HTML.
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
- bool $tableTags Include table tags and label (optional)
Returns
string string
Since
1.0
|
public
string
|
#
renderRelationField( string $name, string $label, string $mode, string $value = '', boolean $tableTags = true, boolean $expanded = false, boolean $buttons = true )
render the default Relation HTML.
render the default Relation HTML.
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
- bool $tableTags Include table tags and label (optional)
- $expanded
- bool $expanded Render the related fields in expanded format or not (optional)
- $buttons
- bool $buttons Render buttons for expanding/contacting the related fields
(optional)
Returns
string string
Since
1.0
|
public
string
|
#
renderAllFields( string $mode, array $filterFields = array(), array $readOnlyFields = array() )
Renders all fields for the current BO in edit/create/view mode.
Renders all fields for the current BO in edit/create/view mode.
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 string
Since
1.0
|
public static
string
|
#
loadTemplate( Alpha\Model\ActiveRecord $BO, string $mode, array $fields = array() )
Loads a template for the BO specified if one exists. Lower level custom
templates take precedence.
Loads a template for the BO specified if one exists. Lower level custom
templates take precedence.
Parameters
- $BO
- Alpha\Model\ActiveRecord $BO
- $mode
- string $mode
- $fields
- array $fields
Returns
string string
Throws
Since
1.0
|
public static
string
|
#
loadTemplateFragment( string $type, string $fileName, array $fields = array() )
Loads a template fragment from the Renderer/[type]/Fragments/[filename.ext]
location.
Loads a template fragment from the Renderer/[type]/Fragments/[filename.ext]
location.
Parameters
- $type
- string $type Currently only html supported, later json and xml.
- $fileName
- string $fileName The name of the fragment file
- $fields
- array $fields A hash array of field values to pass to the template fragment.
Returns
string string
Throws
Since
1.2
|
public static
|
#
setProvider( string $ProviderClassName, string $acceptHeader = null )
Enables you to set an explicit type of RendererProviderInterface
implementation to use for rendering the records attached to this view.
Enables you to set an explicit type of RendererProviderInterface
implementation to use for rendering the records attached to this view.
Parameters
- $ProviderClassName
- string $ProviderClassName The name of the RendererProviderInterface
implementation to use in this view object
- $acceptHeader
- string $acceptHeader Optional pass the HTTP Accept header to select the correct
renderer provider.
Throws
Since
1.2
|
public static
Alpha\View\Renderer\RendererProviderInterface
|
#
getProvider( )
Get the current view renderer provider.
Get the current view renderer provider.
Returns
Since
2.0
|