Docs For Class atkViewHandler

Home

Documentation home

Atk index

Docs For Class atkViewHandler [ package: atk ]

Class: atkViewHandler

Source Location: /handlers/class.atkviewhandler.inc

Class atkViewHandler

Class Overview

Handler class for a readonly view action. Similar to the edit handler, but all fields are displayed readonly.

Located in /handlers/class.atkviewhandler.inc [line 30]

Wiki documentation

atkActionHandler
   |
   --atkViewEditBase
      |
      --atkViewHandler

Author(s):

Ivo Jansch <ivo@achievo.org>

Information Tags:

Methods

[ Top ]

Inherited from parent

Inherited Properties	Inherited Methods
Inherited From atkActionHandler atkActionHandler::$m_action atkActionHandler::$m_node atkActionHandler::$m_partial atkActionHandler::$m_rejecting atkActionHandler::$m_renderBoxVars atkActionHandler::$m_renderMode atkActionHandler::$m_returnbehaviour	Inherited From atkViewEditBase atkViewEditBase::getRecord() Get the record to view/edit atkViewEditBase::getRecordFromDb() Get the record for the database with the current selector atkViewEditBase::getRecordFromSession() Get the current record from the database with the current selector atkViewEditBase::getSectionControl() Create the clickable label for the section. atkViewEditBase::getSectionLabel() Get section label. atkViewEditBase::getTabLabel() Get tab label. atkViewEditBase::isSectionInitialHidden() Based on the attributes that are part of this section we check if this section should initially be shown or not. atkViewEditBase::partial_attribute() Attribute handler. atkViewEditBase::partial_sectionstate() Section state handler. atkViewEditBase::_addNumbering() Adds numbering to the label of a field atkViewEditBase::_getTabTpl() Get array with tab name as key and tab template as value atkViewEditBase::_renderTabs() Render tabs using templates Inherited From atkActionHandler atkActionHandler::atkActionHandler() Default constructor. atkActionHandler::addRenderBoxVar() Add a variable to the renderbox atkActionHandler::allowed() Current action allowed on the given record? atkActionHandler::clearCache() Clear the recordlist cache atkActionHandler::closeDialog() Output JavaScript to close the dialog. atkActionHandler::getDefaultHandler() Static factory method to get the default action handler for a certain action. atkActionHandler::getNode() Returns the node object. atkActionHandler::getPage() Get the page instance for generating output. atkActionHandler::getRecordlistCache() Get the cached recordlist atkActionHandler::getRejectInfo() Get the reject info from the session This is used by the atkAddHandler and atkEditHandler to show the validation errors atkActionHandler::getRenderMode() Returns the render mode. atkActionHandler::getReturnBehaviour() Get the returnbehaviour of this action atkActionHandler::getUi() Get the ui instance for drawing and templating purposes. atkActionHandler::handle() The handle() method handles the action. atkActionHandler::invoke() Generic method invoker. atkActionHandler::notify() Notify the node that an action has occured atkActionHandler::partial() Handle partial. atkActionHandler::renderAccessDeniedDialog() Render access denied dialog contents. atkActionHandler::renderAccessDeniedPage() Render access denied page. atkActionHandler::renderMessageDialog() Render message dialog contents. atkActionHandler::setAction() Sets the current action. atkActionHandler::setNode() Set the calling node of the current action. atkActionHandler::setPostvars() Set postvars of the the calling node of the current action. atkActionHandler::setRejectInfo() Store the reject info in the session This is used by the atkSaveHandler and atkUpdateHandler to store the record if the record is not validated atkActionHandler::setRenderMode() Sets the render mode ("box" or "dialog"). atkActionHandler::setReturnBehaviour() Set the returnbehaviour of this action atkActionHandler::updateDialog() Outputs JavaScript for updating the existing dialog contents. atkActionHandler::_getAccessDeniedPage() Get the access denied page

Inherited Properties

Inherited Methods

Inherited From atkActionHandler

atkActionHandler::$m_action

atkActionHandler::$m_node

atkActionHandler::$m_partial

atkActionHandler::$m_rejecting

atkActionHandler::$m_renderBoxVars

atkActionHandler::$m_renderMode

atkActionHandler::$m_returnbehaviour

Inherited From atkViewEditBase

atkViewEditBase::getRecord()

Get the record to view/edit

atkViewEditBase::getRecordFromDb()

Get the record for the database with the current selector

atkViewEditBase::getRecordFromSession()

Get the current record from the database with the current selector

atkViewEditBase::getSectionControl()

Create the clickable label for the section.

atkViewEditBase::getSectionLabel()

Get section label.

atkViewEditBase::getTabLabel()

Get tab label.

atkViewEditBase::isSectionInitialHidden()

Based on the attributes that are part of this section we check if this section should initially be shown or not.

atkViewEditBase::partial_attribute()

Attribute handler.

atkViewEditBase::partial_sectionstate()

Section state handler.

atkViewEditBase::_addNumbering()

Adds numbering to the label of a field

atkViewEditBase::_getTabTpl()

Get array with tab name as key and tab template as value

atkViewEditBase::_renderTabs()

Render tabs using templates

Inherited From atkActionHandler

atkActionHandler::atkActionHandler()

Default constructor.

atkActionHandler::addRenderBoxVar()

Add a variable to the renderbox

atkActionHandler::allowed()

Current action allowed on the given record?

atkActionHandler::clearCache()

Clear the recordlist cache

atkActionHandler::closeDialog()

Output JavaScript to close the dialog.

atkActionHandler::getDefaultHandler()

Static factory method to get the default action handler for a certain action.

atkActionHandler::getNode()

Returns the node object.

atkActionHandler::getPage()

Get the page instance for generating output.

atkActionHandler::getRecordlistCache()

Get the cached recordlist

atkActionHandler::getRejectInfo()

Get the reject info from the session This is used by the atkAddHandler and atkEditHandler to show the validation errors

atkActionHandler::getRenderMode()

Returns the render mode.

atkActionHandler::getReturnBehaviour()

Get the returnbehaviour of this action

atkActionHandler::getUi()

Get the ui instance for drawing and templating purposes.

atkActionHandler::handle()

The handle() method handles the action.

atkActionHandler::invoke()

Generic method invoker.

atkActionHandler::notify()

Notify the node that an action has occured

atkActionHandler::partial()

Handle partial.

atkActionHandler::renderAccessDeniedDialog()

Render access denied dialog contents.

atkActionHandler::renderAccessDeniedPage()

Render access denied page.

atkActionHandler::renderMessageDialog()

Render message dialog contents.

atkActionHandler::setAction()

Sets the current action.

atkActionHandler::setNode()

Set the calling node of the current action.

atkActionHandler::setPostvars()

Set postvars of the the calling node of the current action.

atkActionHandler::setRejectInfo()

Store the reject info in the session This is used by the atkSaveHandler and atkUpdateHandler to store the record if the record is not validated

atkActionHandler::setRenderMode()

Sets the render mode ("box" or "dialog").

atkActionHandler::setReturnBehaviour()

Set the returnbehaviour of this action

atkActionHandler::updateDialog()

Outputs JavaScript for updating the existing dialog contents.

atkActionHandler::_getAccessDeniedPage()

Get the access denied page

[ Top ]

Method Summary

void	action_view()	The action handler method.
void	getRecordFromDb()	Returns the view record.
String	partial_dialog()	The dialog partial
string	renderViewDialog()	Render view dialog.
String	viewForm()	Get the view page
void	viewHeader()	Overrideable function to create a header for view mode.
String	viewPage()	Returns an htmlpage displaying all displayable attributes.

[ Top ]

Properties

Methods

action_view [line 37]

void action_view(
[Bool
$renderbox = true] 
)

The action handler method.

Parameters:

Bool

$renderbox:

Render this action in a renderbox or just output the HTML

[ Top ]

getRecordFromDb [line 62]

void getRecordFromDb(
)

Returns the view record.

Redefinition of:

atkViewEditBase::getRecordFromDb(): Get the record for the database with the current selector

[ Top ]

partial_dialog [line 295]

String partial_dialog(
)

The dialog partial

API Tags:

Return:

HTML code for the view dialog

[ Top ]

renderViewDialog [line 306]

string renderViewDialog(
[array
$record = null] 
)

Render view dialog.

Parameters:

array

$record:

API Tags:

Return:

html

[ Top ]

viewForm [line 144]

String viewForm(
Array
$record, [String
$mode = "view"] 
)

Get the view page

Parameters:

Array	$record:	The record
String	$mode:	The mode we're in (defaults to "view")

API Tags:

Return:

HTML code of the page

[ Top ]

viewHeader [line 132]

void viewHeader(
)

Overrideable function to create a header for view mode.

Similar to the admin header functionality.

[ Top ]

viewPage [line 80]

String viewPage(
array
$record, atkNode
$node, [Bool
$renderbox = true] 
)

Returns an htmlpage displaying all displayable attributes.

Parameters:

array	$record:	The record to display.
atkNode	$node:	The node for which a viewPage is displayed.
Bool	$renderbox:	Render this action in a renderbox or just output the HTML

API Tags:

Return:

The html page with a reaonly view of relevant fields.

[ Top ]