Docs For Class atkViewEditBase

Home

Documentation home

Atk index

Docs For Class atkViewEditBase [ package: atk ]

Class: atkViewEditBase

Source Location: /handlers/class.atkvieweditbase.inc

Class atkViewEditBase

Class Overview

Handler class for the edit action of a node. The handler draws a generic edit form for the given node.

Located in /handlers/class.atkvieweditbase.inc [line 32]

Wiki documentation

atkActionHandler
   |
   --atkViewEditBase

Author(s):

Ivo Jansch <ivo@achievo.org>
Peter C. Verhage <peter@ibuildings.nl>

Information Tags:

Properties

$m_record

Methods

[ Top ]

Descendants

Child Class	Description
atkEditHandler	Handler class for the edit action of a node. The handler draws a generic edit form for the given node.
atkViewHandler	Handler class for a readonly view action. Similar to the edit handler, but all fields are displayed readonly.

[ Top ]

Inherited from parent

Inherited Properties	Inherited Methods
Inherited From atkActionHandler atkActionHandler::$m_action atkActionHandler::$m_boxTemplate atkActionHandler::$m_node atkActionHandler::$m_partial atkActionHandler::$m_rejecting atkActionHandler::$m_renderBoxVars atkActionHandler::$m_renderMode atkActionHandler::$m_returnbehaviour	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::getCSRFToken() Get/generate CSRF token for the current session stack. 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::isValidCSRFToken() Checks whatever the given CSRF token matches the one stored in the session stack. atkActionHandler::modifyDataGrid() Modify grid. 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::setBoxTemplate() 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_boxTemplate

atkActionHandler::$m_node

atkActionHandler::$m_partial

atkActionHandler::$m_rejecting

atkActionHandler::$m_renderBoxVars

atkActionHandler::$m_renderMode

atkActionHandler::$m_returnbehaviour

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::getCSRFToken()

Get/generate CSRF token for the current session stack.

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::isValidCSRFToken()

Checks whatever the given CSRF token matches the one stored in the session stack.

atkActionHandler::modifyDataGrid()

Modify grid.

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::setBoxTemplate()

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 ]

Property Summary

array

$m_record

Holds the record for the node. It is cached as long as the instance exists, unless we force a reload.

[ Top ]

Method Summary

static string	getSectionLabel()	Get section label.
static string	getTabLabel()	Get tab label.
Array	getRecord()	Get the record to view/edit. It is cached as long as the instance exists, unless we force a reload.
array	getRecordFromDb()	Get the record for the database with the current selector
array	getRecordFromSession()	Get the current record from the database with the current selector
string	getSectionControl()	Create the clickable label for the section.
boolean	isSectionInitialHidden()	Based on the attributes that are part of this section we check if this section should initially be shown or not.
void	partial_attribute()	Attribute handler.
void	partial_sectionstate()	Section state handler.
void	_addNumbering()	Adds numbering to the label of a field
array	_getTabTpl()	Get array with tab name as key and tab template as value
array	_renderTabs()	Render tabs using templates

[ Top ]

Properties

array $m_record = null [line 40]

Holds the record for the node. It is cached as long as the instance exists, unless we force a reload.

API Tags:

Access:

private

[ Top ]

Methods

static method getSectionLabel [line 114]

static string getSectionLabel(
atkNode
$node, string
$rawName 
)

Get section label.

Parameters:

atkNode	$node:
string	$rawName:

API Tags:

Return:

label

[ Top ]

static method getTabLabel [line 131]

static string getTabLabel(
atkNode
$node, string
$tab 
)

Get tab label.

Parameters:

atkNode	$node:
string	$tab:

API Tags:

Return:

label

[ Top ]

getRecord [line 49]

Array getRecord(
[bool
$force = false] 
)

Get the record to view/edit. It is cached as long as the instance exists, unless we force a reload.

Parameters:

bool

$force:

Whether or not to force the fetching of the record

API Tags:

Return:	The record for viewing/editting
Access:	public

[ Top ]

getRecordFromDb [line 82]

array getRecordFromDb(
)

Get the record for the database with the current selector

API Tags:

Access:

protected

Redefined in descendants as:

atkViewHandler::getRecordFromDb() : Returns the view record.

[ Top ]

getRecordFromSession [line 98]

array getRecordFromSession(
)

Get the current record from the database with the current selector

API Tags:

Access:

protected

[ Top ]

getSectionControl [line 144]

string getSectionControl(
array
$field, string
$mode 
)

Create the clickable label for the section.

Parameters:

array	$field:
string	$mode:

API Tags:

Return:

Html

[ Top ]

isSectionInitialHidden [line 183]

boolean isSectionInitialHidden(
string
$section, array
$fields 
)

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

Parameters:

string	$section:	section name
array	$fields:	edit fields

[ Top ]

partial_attribute [line 316]

void partial_attribute(
string
$partial 
)

Attribute handler.

Parameters:

string

$partial:

full partial

API Tags:

Access:

public

[ Top ]

partial_sectionstate [line 233]

void partial_sectionstate(
)

Section state handler.

[ Top ]

_addNumbering [line 203]

void _addNumbering(

&$field, 
&$tplfield, 
&$i, array
$field, array
$tplfield, int
$i 
)

Adds numbering to the label of a field

Parameters:

array	$field:	the currently handled attribute
array	$tplfield:	the template data for the current attribute
int	$i:	the counter being used to loop the node for each attribute
	&$field:
	&$tplfield:
	&$i:

API Tags:

Access:

private

[ Top ]

_getTabTpl [line 249]

array _getTabTpl(
object
$node, array
$tabs, string
$mode, array
$record 
)

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

Parameters:

object	$node:
array	$tabs:
string	$mode:
array	$record:

API Tags:

Return:

with tab=>template pear

[ Top ]

_renderTabs [line 268]

array _renderTabs(
array
$fields, array
$tabTpl 
)

Render tabs using templates

Parameters:

array	$fields:
array	$tabTpl:

API Tags:

Return:

with already rendering tabs

Information Tags:

Todo:

this method seems broken by design, read comments for more info!

[ Top ]