class cApiClickableAction cApiClickableAction is a subclass of cApiAction.

It provides an image for visual representation. Inherited classes should call the "setNamedAction" operation in their constructors; on-the-fly-implementations should call it directly after creating an object instance.

author Timo A. Hummel <Timo.Hummel@4fb.de>
version 0.1
copyright four for business 2003

 Methods

Constructor Function

Item(string $table, string $primaryKey, $lifetime) 
Inherited
inherited_from \Item::Item()
inherited_from \cApiAction::Item()
inherited_from \cApiClickableAction::Item()

Parameters

$table

string

The table to use as information source

$primaryKey

string

The primary key to use

$lifetime

Filters the passed data using the functions defines in the _arrInFilters array.

_inFilter(mixed $data) : mixed
Inherited
see \setFilters
access private
inherited_from \Item::_inFilter()
inherited_from \cApiAction::_inFilter()
inherited_from \cApiClickableAction::_inFilter()

Parameters

$data

mixed

Data to filter

Returns

mixedFiltered data

_onDisable()

_onDisable() 
Inherited
inherited_from \cApiClickableAction::_onDisable()

_onEnable()

_onEnable() 
Inherited
inherited_from \cApiClickableAction::_onEnable()

_onLoad ()

_onLoad() : \none
Inherited

Function which is called whenever an item is loaded. Inherited classes should override this function if desired.

inherited_from \Item::_onLoad()
inherited_from \cApiAction::_onLoad()
inherited_from \cApiClickableAction::_onLoad()

Returns

\none

Filters the passed data using the functions defines in the _arrOutFilters array.

_outFilter(mixed $data) : mixed
Inherited
see \setFilters
access private
inherited_from \Item::_outFilter()
inherited_from \cApiAction::_outFilter()
inherited_from \cApiClickableAction::_outFilter()

Parameters

$data

mixed

Data to filter

Returns

mixedFiltered data

_setMetaObject()

_setMetaObject($objectname) 
Inherited
inherited_from \Item::_setMetaObject()
inherited_from \cApiAction::_setMetaObject()
inherited_from \cApiClickableAction::_setMetaObject()

Parameters

$objectname

Constructor

cApiAction(integer $idaction) 
Inherited
inherited_from \cApiAction::cApiAction()
inherited_from \cApiClickableAction::cApiAction()

Parameters

$idaction

integer

area to load

cApiClickableAction()

cApiClickableAction() 
Inherited
inherited_from \cApiClickableAction::cApiClickableAction()

cApiClickableQuestionAction()

cApiClickableQuestionAction() 

Change linked area

changeArea($sArea) 
Inherited
inherited_from \cApiClickableAction::changeArea()

Parameters

$sArea

deleteProperty ($type, $name) Deletes a custom property

deleteProperty(string $type, string $name) 
Inherited
inherited_from \Item::deleteProperty()
inherited_from \cApiAction::deleteProperty()
inherited_from \cApiClickableAction::deleteProperty()

Parameters

$type

string

Specifies the type

$name

string

Specifies the name

get($field) Wrapper for getField (less to type)

get(string $field) : mixed
Inherited
inherited_from \Item::get()
inherited_from \cApiAction::get()
inherited_from \cApiClickableAction::get()

Parameters

$field

string

Specifies the field to retrieve

Returns

mixedValue of the field

getField($field) Gets the value of a specific field

getField(string $field) : mixed
Inherited
inherited_from \Item::getField()
inherited_from \cApiAction::getField()
inherited_from \cApiClickableAction::getField()

Parameters

$field

string

Specifies the field to retrieve

Returns

mixedValue of the field

getHelpText()

getHelpText() 
Inherited
inherited_from \cApiClickableAction::getHelpText()

getIcon()

getIcon() 
Inherited
inherited_from \cApiClickableAction::getIcon()

getMetaObject()

getMetaObject() 
Inherited
inherited_from \Item::getMetaObject()
inherited_from \cApiAction::getMetaObject()
inherited_from \cApiClickableAction::getMetaObject()

getProperty ($type, $name) Sets a custom property

getProperty(string $type, string $name) : boolean
Inherited
inherited_from \Item::getProperty()
inherited_from \cApiAction::getProperty()
inherited_from \cApiClickableAction::getProperty()

Parameters

$type

string

Specifies the type

$name

string

Specifies the name

Returns

booleanValue of the given property

loadBy ($field, $value) Loads an item by colum/field from the database

loadBy(string $field, string $value, bool $bSafe) : bool
Inherited
inherited_from \Item::loadBy()
inherited_from \cApiAction::loadBy()
inherited_from \cApiClickableAction::loadBy()

Parameters

$field

string

Specifies the field

$value

string

Specifies the value

$bSafe

bool

use inFilter or not

Returns

boolTrue if the load was successful

loadByPrimaryKey ($value) Loads an item by ID from the database

loadByPrimaryKey(string $value) : bool
Inherited
inherited_from \Item::loadByPrimaryKey()
inherited_from \cApiAction::loadByPrimaryKey()
inherited_from \cApiClickableAction::loadByPrimaryKey()

Parameters

$value

string

Specifies the primary key value

Returns

boolTrue if the load was successful

process()

process($parameters) 
Inherited
inherited_from \cApiClickableAction::process()

Parameters

$parameters

render()

render() 

renderText()

renderText() 
Inherited
inherited_from \cApiClickableAction::renderText()

set($field, $value) Shortcut to setField

set(string $field, string $value, $safe) 
Inherited
inherited_from \Item::set()
inherited_from \cApiAction::set()
inherited_from \cApiClickableAction::set()

Parameters

$field

string

Specifies the field to set

$value

string

Specifies the value to set

$safe

setDisabled()

setDisabled() 
Inherited
inherited_from \cApiClickableAction::setDisabled()

setEnabled()

setEnabled() 
Inherited
inherited_from \cApiClickableAction::setEnabled()

setField($field, $value) Sets the value of a specific field

setField(string $field, string $value, boolean $safe) 
Inherited
inherited_from \Item::setField()
inherited_from \cApiAction::setField()
inherited_from \cApiClickableAction::setField()

Parameters

$field

string

Specifies the field to set

$value

string

Specifies the value to set

$safe

boolean

Speficies if we should translate characters

Define the filter functions used when data is being stored or retrieved from the database.

setFilters(array $arrInFilters, array $arrOutFilters) : void
Inherited

Examples:

$obj->setFilters(array('addslashes'), array('stripslashes')); $obj->setFilters(array('htmlencode', 'addslashes'), array('stripslashes', 'htmlencode'));

inherited_from \Item::setFilters()
inherited_from \cApiAction::setFilters()
inherited_from \cApiClickableAction::setFilters()

Parameters

$arrInFilters

array

inFilters array with function names

$arrOutFilters

array

outFilters array with function names

sets the help text for this action.

setHelpText(string $helptext) : void
Inherited
access public
inherited_from \cApiClickableAction::setHelpText()

Parameters

$helptext

string

helptext The helptext to apply

Sets the action icon for this action.

setIcon(string $icon) : void
Inherited
access public
inherited_from \cApiClickableAction::setIcon()

Parameters

$icon

string

icon Path to the icon. Relative to the backend, if not passed as absolute path.

Sets this class to use a specific action, example "con_makestart".

setNamedAction(string $actionName) : void
Inherited
access public
inherited_from \cApiClickableAction::setNamedAction()

Parameters

$actionName

string

actionName Name of the action to use. This action must exist in the actions table before using it, otherwise, this method will fail.

setParameter()

setParameter($name, $value) 
Inherited
inherited_from \cApiClickableAction::setParameter()

Parameters

$name

$value

setProperty ($type, $name, $value) Sets a custom property

setProperty(string $type, string $name, string $value) 
Inherited
inherited_from \Item::setProperty()
inherited_from \cApiAction::setProperty()
inherited_from \cApiClickableAction::setProperty()

Parameters

$type

string

Specifies the type

$name

string

Specifies the name

$value

string

Specifies the value

setQuestion()

setQuestion($question) 

Parameters

$question

setQuestionMode()

setQuestionMode($mode) 

Parameters

$mode

setResultVar()

setResultVar($var) 

Parameters

$var

store() Stores the modified user object to the database

store() 
Inherited
inherited_from \Item::store()
inherited_from \cApiAction::store()
inherited_from \cApiClickableAction::store()

wantParameter()

wantParameter($parameter) 
Inherited
inherited_from \cApiClickableAction::wantParameter()

Parameters

$parameter

 Properties

 

$_arrInFilters : array
Inherited
access private
inherited_from \Item::$$_arrInFilters
inherited_from \cApiAction::$$_arrInFilters
inherited_from \cApiClickableAction::$$_arrInFilters
 

$_arrOutFilters : array
Inherited
access private
inherited_from \Item::$$_arrOutFilters
inherited_from \cApiAction::$$_arrOutFilters
inherited_from \cApiClickableAction::$$_arrOutFilters
 

$_helpText 
Inherited
access private
inherited_from \cApiClickableAction::$$_helpText
 

$_img 
Inherited
access private
inherited_from \cApiClickableAction::$$_img
   

$_metaObject 
Inherited
inherited_from \Item::$$_metaObject
inherited_from \cApiAction::$$_metaObject
inherited_from \cApiClickableAction::$$_metaObject
 

$_objectInvalid 
Inherited
inherited_from \cApiAction::$$_objectInvalid
inherited_from \cApiClickableAction::$$_objectInvalid
 

$cache : array
Inherited
access private
inherited_from \Item::$$cache
inherited_from \cApiAction::$$cache
inherited_from \cApiClickableAction::$$cache
 

$db : object
Inherited
access private
inherited_from \Item::$$db
inherited_from \cApiAction::$$db
inherited_from \cApiClickableAction::$$db
 

$lasterror : string
Inherited
access private
inherited_from \Item::$$lasterror
inherited_from \cApiAction::$$lasterror
inherited_from \cApiClickableAction::$$lasterror
 

Lifetime in seconds

$lifetime : int
Inherited
access private
inherited_from \Item::$$lifetime
inherited_from \cApiAction::$$lifetime
inherited_from \cApiClickableAction::$$lifetime
 

$modifiedValues : array
Inherited
access private
inherited_from \Item::$$modifiedValues
inherited_from \cApiAction::$$modifiedValues
inherited_from \cApiClickableAction::$$modifiedValues
 

$oldPrimaryKey : string
Inherited
access private
inherited_from \Item::$$oldPrimaryKey
inherited_from \cApiAction::$$oldPrimaryKey
inherited_from \cApiClickableAction::$$oldPrimaryKey
 

$primaryKey : object
Inherited
access private
inherited_from \Item::$$primaryKey
inherited_from \cApiAction::$$primaryKey
inherited_from \cApiClickableAction::$$primaryKey
 

PropertyCollection object

$properties : object
Inherited
access private
inherited_from \Item::$$properties
inherited_from \cApiAction::$$properties
inherited_from \cApiClickableAction::$$properties
 

$table : string
Inherited
access private
inherited_from \Item::$$table
inherited_from \cApiAction::$$table
inherited_from \cApiClickableAction::$$table
 

$values : array
Inherited
access private
inherited_from \Item::$$values
inherited_from \cApiAction::$$values
inherited_from \cApiClickableAction::$$values
 

$virgin : boolean
Inherited

If true, the object is virgin and no operations on it except load-Functions are allowed.

access private
inherited_from \Item::$$virgin
inherited_from \cApiAction::$$virgin
inherited_from \cApiClickableAction::$$virgin