Docs For Class atkAttributeEditHandler

Home

Documentation home

Atk index

Docs For Class atkAttributeEditHandler [ package: atk ]

Class: atkAttributeEditHandler

Source Location: /handlers/class.atkattributeedithandler.inc

Class atkAttributeEditHandler

Class Overview

Handler for the 'attributeedit' action of a node. It shows a dialog for altering the value of a selectable attribute for multiple records at the same time.

This handler only supports dialogs.

Located in /handlers/class.atkattributeedithandler.inc [line 42]

Wiki documentation

atkActionHandler
   |
   --atkAttributeEditHandler

Author(s):

Dennis Luitwieler <dennis@ibuildings.nl>

Information Tags:

Properties

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 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 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 ]

Property Summary

mixed	$m_masterNode
mixed	$m_processUrl

[ Top ]

Method Summary

void	action_attributeedit()	The action method.
String	attributeEditPage()	AttributeEdit page.
string	getAttributeEditPage()	Returns the attributeEdit page contents.
string	getContent()	Returns the attributeEdit page contents.
String	getErrorPage()	Get a page indicating an error has occurred.
string	getFormStart()	Returns the form start.
Array	getIgnoreList()	Get a list of attributenames that we can ignore (i.e. when calling validate() on a node.)
string	getProcessUrl()	Returns the process URL.
Array	getSelector()	Get the atkselector from the postvars.
array	getSupportedAttributes()	Get the supported attributes.
void	handleDialog()	Handle dialog partial.
void	handleError()	Handle errors of different types.
void	handleProcess()	Handle process partial.
void	handleRefreshValuesField()	Handle refresh values
String	onChange()	Return the onchange code
void	registerExternalFiles()	Register external files
string	renderAttributeEditPage()	Render the add or copy page using the given parameters.
void	setMasterNode()	Set the maste node
void	setProcessUrl()	Override the default process URL.
String	_getDropDownAttributes()	Get dropdown attributes
unknown	_getDropDownValues()	Get the dropdown with the possible values for the selected attribute.

[ Top ]

Properties

mixed $m_masterNode = null [line 45]

[ Top ]

mixed $m_processUrl = null [line 44]

[ Top ]

Methods

action_attributeedit [line 60]

void action_attributeedit(
)

The action method.

[ Top ]

attributeEditPage [line 280]

String attributeEditPage(
)

AttributeEdit page.

API Tags:

Return:

The attribute edit page

[ Top ]

getAttributeEditPage [line 290]

string getAttributeEditPage(
)

Returns the attributeEdit page contents.

API Tags:

Return:

attributeEdit page contents

[ Top ]

getContent [line 344]

string getContent(
)

Returns the attributeEdit page contents.

API Tags:

Return:

attributeEdit page contents

[ Top ]

getErrorPage [line 229]

String getErrorPage(
Int
$error, [array
$record = null], [String
$customerror = ''] 
)

Get a page indicating an error has occurred.

Parameters:

Int	$error:
array	$record:	The record
String	$customerror:

API Tags:

Return:

HTML Error page

[ Top ]

getFormStart [line 534]

string getFormStart(
)

Returns the form start.

API Tags:

Return:

Html form start

[ Top ]

getIgnoreList [line 513]

Array getIgnoreList(
String
$selectedattributename 
)

Get a list of attributenames that we can ignore (i.e. when calling validate() on a node.)

Parameters:

String

$selectedattributename:

API Tags:

Return:

A list of attributenames.

[ Top ]

getProcessUrl [line 578]

string getProcessUrl(
)

Returns the process URL.

API Tags:

Return:

process URL

[ Top ]

getSelector [line 100]

Array getSelector(
)

Get the atkselector from the postvars.

The atkselector could be prefixed, depending on the page where we come from. From the admin page it will be prefixed with the formname, from the attributeedit dialog, it will not be prefixed anymore.

[ Top ]

getSupportedAttributes [line 453]

array getSupportedAttributes(
)

Get the supported attributes.

If no supported attributes were set, ATK determines them by itself.

API Tags:

Return:

Array with attribute objects

[ Top ]

handleDialog [line 109]

void handleDialog(
)

Handle dialog partial.

[ Top ]

handleError [line 200]

void handleError(
int
$error, [array
$record = null], [bool
$reload = false] 
)

Handle errors of different types.

Parameters:

int	$error:	The AttributeEditHandler error type.
array	$record:	The record
bool	$reload:	Reload the page?

[ Top ]

handleProcess [line 119]

void handleProcess(
)

Handle process partial.

[ Top ]

handleRefreshValuesField [line 557]

void handleRefreshValuesField(
)

Handle refresh values

[ Top ]

onChange [line 403]

String onChange(
)

Return the onchange code

API Tags:

Return:

The onchange javascript code

[ Top ]

registerExternalFiles [line 311]

void registerExternalFiles(
)

[ Top ]

renderAttributeEditPage [line 326]

string renderAttributeEditPage(
array
$params 
)

Render the add or copy page using the given parameters.

Parameters:

array

$params:

parameters

API Tags:

Return:

rendered page

[ Top ]

setMasterNode [line 52]

void setMasterNode(
atkNode
$node 
)

Set the maste node

Parameters:

atkNode

$node:

The master node

[ Top ]

setProcessUrl [line 595]

void setProcessUrl(
string
$url 
)

Override the default process URL.

Parameters:

string

$url:

process URL

[ Top ]

_getDropDownAttributes [line 364]

String _getDropDownAttributes(
[string
$selectedAttribute = ""] 
)

Get dropdown attributes

Parameters:

string

$selectedAttribute:

API Tags:

Return:

Dropdown with attributenames

[ Top ]

_getDropDownValues [line 420]

unknown _getDropDownValues(
[String
$selectedAttribute = ""] 
)

Get the dropdown with the possible values for the selected attribute.

Parameters:

String

$selectedAttribute:

[ Top ]