contenido\classes\widgets\class.widgets.actionbutton.php

Show:

inherited

Constants
- QUESTIONACTION_PROMPT
- QUESTIONACTION_YESNO
Functions
Classes
- \cApiClickableAction
- \cApiClickableQuestionAction

Table of Contents

Project: Contenido Content Management System

Description:

Requirements:

Author: Unknown
Con_php_req: 5.0
Copyright: four for business AG
License: http://www.contenido.org/license/LIZENZ.txt
Link: http://www.4fb.de
Link: {@internal $Id: class.widgets.actionbutton.php 738 2008-08-27 10:21:19Z timo.trautmann $: }}
Package: Contenido Backend classes
Version: 1.0

Constants

 
                QUESTIONACTION_PROMPT
                = "prompt"

 
                QUESTIONACTION_YESNO
                = "yesno"

\cApiClickableAction
jump to top

Package: Default

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.

Parent(s): \cApiAction < \Item
Children: \cApiClickableQuestionAction
Author: Timo A. Hummel
Copyright: four for business 2003
Version: 0.1

Properties

array $_arrInFilters = array('urlencode', 'conHtmlSpecialChars', 'addslashes')

inherited

Array storing the funcion names of the filters used when data is stored to the db

Inherited from: \Item::$$_arrInFilters \cApiAction::$$_arrInFilters

Default valuearray('urlencode', 'conHtmlSpecialChars', 'addslashes')Details

Type: array
Access: private
Inherited_from: \Item::$$_arrInFilters
Inherited_from: \cApiAction::$$_arrInFilters

array $_arrOutFilters = array('stripslashes', 'htmldecode', 'urldecode')

inherited

Array storing the funcion names of the filters used when data is retrieved from the db

Inherited from: \Item::$$_arrOutFilters \cApiAction::$$_arrOutFilters

Default valuearray('stripslashes', 'htmldecode', 'urldecode')Details

Type: array
Access: private
Inherited_from: \Item::$$_arrOutFilters
Inherited_from: \cApiAction::$$_arrOutFilters

$_helpText

Help text

Details

Type: n/a
Access: private

$_img

cHTMLImage for rendering the icon

Details

Type: n/a
Access: private

$_link

cHTMLLink for rendering the icon

Details

Type: n/a
Access: private

$_metaObject

inheritedInherited from: \Item::$$_metaObject \cApiAction::$$_metaObject

Details

Type: n/a
Inherited_from: \Item::$$_metaObject
Inherited_from: \cApiAction::$$_metaObject

$_objectInvalid

inheritedInherited from: \cApiAction::$$_objectInvalid

Details

Type: n/a
Inherited_from: \cApiAction::$$_objectInvalid

array $cache

inherited

Cache the result items

Inherited from: \Item::$$cache \cApiAction::$$cache

Details

Type: array
Access: private
Inherited_from: \Item::$$cache
Inherited_from: \cApiAction::$$cache

object $db

inherited

DB_Contenido instance

Inherited from: \Item::$$db \cApiAction::$$db

Details

Type: object
Access: private
Inherited_from: \Item::$$db
Inherited_from: \cApiAction::$$db

string $lasterror

inherited

Storage of the last error

Inherited from: \Item::$$lasterror \cApiAction::$$lasterror

Details

Type: string
Access: private
Inherited_from: \Item::$$lasterror
Inherited_from: \cApiAction::$$lasterror

int $lifetime

inherited

Lifetime in seconds

Inherited from: \Item::$$lifetime \cApiAction::$$lifetime

Details

Type: int
Access: private
Inherited_from: \Item::$$lifetime
Inherited_from: \cApiAction::$$lifetime

array $modifiedValues

inherited

Storage of the fields which were modified

Inherited from: \Item::$$modifiedValues \cApiAction::$$modifiedValues

Details

Type: array
Access: private
Inherited_from: \Item::$$modifiedValues
Inherited_from: \cApiAction::$$modifiedValues

string $oldPrimaryKey

inherited

stores the old primary key, just in case somebody wants to change it

Inherited from: \Item::$$oldPrimaryKey \cApiAction::$$oldPrimaryKey

Details

Type: string
Access: private
Inherited_from: \Item::$$oldPrimaryKey
Inherited_from: \cApiAction::$$oldPrimaryKey

object $primaryKey

inherited

Primary key of the table

Inherited from: \Item::$$primaryKey \cApiAction::$$primaryKey

Details

Type: object
Access: private
Inherited_from: \Item::$$primaryKey
Inherited_from: \cApiAction::$$primaryKey

object $properties

inherited

PropertyCollection object

Inherited from: \Item::$$properties \cApiAction::$$properties

Details

Type: object
Access: private
Inherited_from: \Item::$$properties
Inherited_from: \cApiAction::$$properties

string $table

inherited

Storage of the source table to use for the user informations

Inherited from: \Item::$$table \cApiAction::$$table

Details

Type: string
Access: private
Inherited_from: \Item::$$table
Inherited_from: \cApiAction::$$table

array $values

inherited

Storage of the source table to use for the user informations

Inherited from: \Item::$$values \cApiAction::$$values

Details

Type: array
Access: private
Inherited_from: \Item::$$values
Inherited_from: \cApiAction::$$values

boolean $virgin

inherited

Checks for the virginity of this object.

Inherited from: \Item::$$virgin \cApiAction::$$virgin

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

Details

Type: boolean
Access: private
Inherited_from: \Item::$$virgin
Inherited_from: \cApiAction::$$virgin

Methods

Item(string $table = "", string $primaryKey = "", $lifetime = 10) : void

inherited

Constructor Function

Inherited from: \Item::Item()\cApiAction::Item()

Parameters

Name	Type	Description
$table	string	The table to use as information source
$primaryKey	string	The primary key to use
$lifetime

_inFilter(mixed $data) : mixed

inherited

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

Inherited from: \Item::_inFilter()\cApiAction::_inFilter()

Parameters

Name	Type	Description
$data	mixed	Data to filter

Returns

Type	Description
mixed	Filtered data

Details

Access: private
See: \setFilters

_onDisable() : void

_onEnable() : void

_onLoad() : \none

inherited

_onLoad ()

Inherited from: \Item::_onLoad()\cApiAction::_onLoad()

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

Returns

Type	Description
\none

_outFilter(mixed $data) : mixed

inherited

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

Inherited from: \Item::_outFilter()\cApiAction::_outFilter()

Parameters

Name	Type	Description
$data	mixed	Data to filter

Returns

Type	Description
mixed	Filtered data

Details

Access: private
See: \setFilters

_setMetaObject( $objectname) : void

inherited

Inherited from: \Item::_setMetaObject()\cApiAction::_setMetaObject()

Parameters

Name	Type	Description
$objectname

cApiAction(integer $idaction = false) : void

inherited

Constructor

Inherited from: \cApiAction::cApiAction()

Parameters

Name	Type	Description
$idaction	integer	area to load

cApiClickableAction() : void

changeArea( $sArea) : void

Change linked area

Parameters

Name	Type	Description
$sArea

deleteProperty(string $type, string $name) : void

inherited

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

Inherited from: \Item::deleteProperty()\cApiAction::deleteProperty()

Parameters

Name	Type	Description
$type	string	Specifies the type
$name	string	Specifies the name

get(string $field) : mixed

inherited

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

Inherited from: \Item::get()\cApiAction::get()

Parameters

Name	Type	Description
$field	string	Specifies the field to retrieve

Returns

Type	Description
mixed	Value of the field

getField(string $field) : mixed

inherited

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

Inherited from: \Item::getField()\cApiAction::getField()

Parameters

Name	Type	Description
$field	string	Specifies the field to retrieve

Returns

Type	Description
mixed	Value of the field

getHelpText() : void

getIcon() : void

getMetaObject() : void

inherited

Inherited from: \Item::getMetaObject()\cApiAction::getMetaObject()

getProperty(string $type, string $name) : boolean

inherited

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

Inherited from: \Item::getProperty()\cApiAction::getProperty()

Parameters

Name	Type	Description
$type	string	Specifies the type
$name	string	Specifies the name

Returns

Type	Description
boolean	Value of the given property

loadBy(string $field, string $value, bool $bSafe = true) : bool

inherited

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

Inherited from: \Item::loadBy()\cApiAction::loadBy()

Parameters

Name	Type	Description
$field	string	Specifies the field
$value	string	Specifies the value
$bSafe	bool	use inFilter or not

Returns

Type	Description
bool	True if the load was successful

loadByPrimaryKey(string $value) : bool

inherited

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

Inherited from: \Item::loadByPrimaryKey()\cApiAction::loadByPrimaryKey()

Parameters

Name	Type	Description
$value	string	Specifies the primary key value

Returns

Type	Description
bool	True if the load was successful

process( $parameters) : void

Parameters

Name	Type	Description
$parameters

render() : void

renderText() : void

set(string $field, string $value, $safe = true) : void

inherited

set($field, $value) Shortcut to setField

Inherited from: \Item::set()\cApiAction::set()

Parameters

Name	Type	Description
$field	string	Specifies the field to set
$value	string	Specifies the value to set
$safe

setDisabled() : void

setEnabled() : void

setField(string $field, string $value, boolean $safe = true) : void

inherited

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

Inherited from: \Item::setField()\cApiAction::setField()

Parameters

Name	Type	Description
$field	string	Specifies the field to set
$value	string	Specifies the value to set
$safe	boolean	Speficies if we should translate characters

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

inherited

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

Inherited from: \Item::setFilters()\cApiAction::setFilters()

Examples:

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

Parameters

Name	Type	Description
$arrInFilters	array	inFilters array with function names
$arrOutFilters	array	outFilters array with function names

setHelpText(string $helptext) : void

sets the help text for this action.

Parameters

Name	Type	Description
$helptext	string	helptext The helptext to apply

Details

Access: public

setIcon(string $icon) : void

Sets the action icon for this action.

Parameters

Name	Type	Description
$icon	string	icon Path to the icon. Relative to the backend, if not passed as absolute path.

Details

Access: public

setNamedAction(string $actionName) : void

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

Parameters

Name	Type	Description
$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.

Details

Access: public

setParameter( $name, $value) : void

Parameters

Name	Type	Description
$name
$value

setProperty(string $type, string $name, string $value) : void

inherited

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

Inherited from: \Item::setProperty()\cApiAction::setProperty()

Parameters

Name	Type	Description
$type	string	Specifies the type
$name	string	Specifies the name
$value	string	Specifies the value

store() : void

inherited

store() Stores the modified user object to the database

Inherited from: \Item::store()\cApiAction::store()

wantParameter( $parameter) : void

Parameters

Name	Type	Description
$parameter

\cApiClickableQuestionAction
jump to top

Package: Default

class cApiClickableAction cApiClickableAction is a subclass of cApiAction.

Parent(s): \cApiClickableAction < \cApiAction < \Item
Author: Timo A. Hummel
Copyright: four for business 2003
Version: 0.1

Properties

array $_arrInFilters = array('urlencode', 'conHtmlSpecialChars', 'addslashes')

inherited

Array storing the funcion names of the filters used when data is stored to the db

Inherited from: \Item::$$_arrInFilters \cApiAction::$$_arrInFilters \cApiClickableAction::$$_arrInFilters

Default valuearray('urlencode', 'conHtmlSpecialChars', 'addslashes')Details

Type: array
Access: private
Inherited_from: \Item::$$_arrInFilters
Inherited_from: \cApiAction::$$_arrInFilters
Inherited_from: \cApiClickableAction::$$_arrInFilters

array $_arrOutFilters = array('stripslashes', 'htmldecode', 'urldecode')

inherited

Array storing the funcion names of the filters used when data is retrieved from the db

Inherited from: \Item::$$_arrOutFilters \cApiAction::$$_arrOutFilters \cApiClickableAction::$$_arrOutFilters

Default valuearray('stripslashes', 'htmldecode', 'urldecode')Details

Type: array
Access: private
Inherited_from: \Item::$$_arrOutFilters
Inherited_from: \cApiAction::$$_arrOutFilters
Inherited_from: \cApiClickableAction::$$_arrOutFilters

$_helpText

inherited

Help text

Inherited from: \cApiClickableAction::$$_helpText

Details

Type: n/a
Access: private
Inherited_from: \cApiClickableAction::$$_helpText

$_img

inherited

cHTMLImage for rendering the icon

Inherited from: \cApiClickableAction::$$_img

Details

Type: n/a
Access: private
Inherited_from: \cApiClickableAction::$$_img

$_link

inherited

cHTMLLink for rendering the icon

Inherited from: \cApiClickableAction::$$_link

Details

Type: n/a
Access: private
Inherited_from: \cApiClickableAction::$$_link

$_metaObject

inheritedInherited from: \Item::$$_metaObject \cApiAction::$$_metaObject \cApiClickableAction::$$_metaObject

Details

Type: n/a
Inherited_from: \Item::$$_metaObject
Inherited_from: \cApiAction::$$_metaObject
Inherited_from: \cApiClickableAction::$$_metaObject

$_objectInvalid

inheritedInherited from: \cApiAction::$$_objectInvalid \cApiClickableAction::$$_objectInvalid

Details

Type: n/a
Inherited_from: \cApiAction::$$_objectInvalid
Inherited_from: \cApiClickableAction::$$_objectInvalid

array $cache

inherited

Cache the result items

Inherited from: \Item::$$cache \cApiAction::$$cache \cApiClickableAction::$$cache

Details

Type: array
Access: private
Inherited_from: \Item::$$cache
Inherited_from: \cApiAction::$$cache
Inherited_from: \cApiClickableAction::$$cache

object $db

inherited

DB_Contenido instance

Inherited from: \Item::$$db \cApiAction::$$db \cApiClickableAction::$$db

Details

Type: object
Access: private
Inherited_from: \Item::$$db
Inherited_from: \cApiAction::$$db
Inherited_from: \cApiClickableAction::$$db

string $lasterror

inherited

Storage of the last error

Inherited from: \Item::$$lasterror \cApiAction::$$lasterror \cApiClickableAction::$$lasterror

Details

Type: string
Access: private
Inherited_from: \Item::$$lasterror
Inherited_from: \cApiAction::$$lasterror
Inherited_from: \cApiClickableAction::$$lasterror

int $lifetime

inherited

Lifetime in seconds

Inherited from: \Item::$$lifetime \cApiAction::$$lifetime \cApiClickableAction::$$lifetime

Details

Type: int
Access: private
Inherited_from: \Item::$$lifetime
Inherited_from: \cApiAction::$$lifetime
Inherited_from: \cApiClickableAction::$$lifetime

array $modifiedValues

inherited

Storage of the fields which were modified

Inherited from: \Item::$$modifiedValues \cApiAction::$$modifiedValues \cApiClickableAction::$$modifiedValues

Details

Type: array
Access: private
Inherited_from: \Item::$$modifiedValues
Inherited_from: \cApiAction::$$modifiedValues
Inherited_from: \cApiClickableAction::$$modifiedValues

string $oldPrimaryKey

inherited

stores the old primary key, just in case somebody wants to change it

Inherited from: \Item::$$oldPrimaryKey \cApiAction::$$oldPrimaryKey \cApiClickableAction::$$oldPrimaryKey

Details

Type: string
Access: private
Inherited_from: \Item::$$oldPrimaryKey
Inherited_from: \cApiAction::$$oldPrimaryKey
Inherited_from: \cApiClickableAction::$$oldPrimaryKey

object $primaryKey

inherited

Primary key of the table

Inherited from: \Item::$$primaryKey \cApiAction::$$primaryKey \cApiClickableAction::$$primaryKey

Details

Type: object
Access: private
Inherited_from: \Item::$$primaryKey
Inherited_from: \cApiAction::$$primaryKey
Inherited_from: \cApiClickableAction::$$primaryKey

object $properties

inherited

PropertyCollection object

Inherited from: \Item::$$properties \cApiAction::$$properties \cApiClickableAction::$$properties

Details

Type: object
Access: private
Inherited_from: \Item::$$properties
Inherited_from: \cApiAction::$$properties
Inherited_from: \cApiClickableAction::$$properties

string $table

inherited

Storage of the source table to use for the user informations

Inherited from: \Item::$$table \cApiAction::$$table \cApiClickableAction::$$table

Details

Type: string
Access: private
Inherited_from: \Item::$$table
Inherited_from: \cApiAction::$$table
Inherited_from: \cApiClickableAction::$$table

array $values

inherited

Storage of the source table to use for the user informations

Inherited from: \Item::$$values \cApiAction::$$values \cApiClickableAction::$$values

Details

Type: array
Access: private
Inherited_from: \Item::$$values
Inherited_from: \cApiAction::$$values
Inherited_from: \cApiClickableAction::$$values

boolean $virgin

inherited

Checks for the virginity of this object.

Inherited from: \Item::$$virgin \cApiAction::$$virgin \cApiClickableAction::$$virgin

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

Details

Type: boolean
Access: private
Inherited_from: \Item::$$virgin
Inherited_from: \cApiAction::$$virgin
Inherited_from: \cApiClickableAction::$$virgin

Methods

Item(string $table = "", string $primaryKey = "", $lifetime = 10) : void

inherited

Constructor Function

Inherited from: \Item::Item()\cApiAction::Item()\cApiClickableAction::Item()

Parameters

Name	Type	Description
$table	string	The table to use as information source
$primaryKey	string	The primary key to use
$lifetime

_inFilter(mixed $data) : mixed

inherited

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

Inherited from: \Item::_inFilter()\cApiAction::_inFilter()\cApiClickableAction::_inFilter()

Parameters

Name	Type	Description
$data	mixed	Data to filter

Returns

Type	Description
mixed	Filtered data

Details

Access: private
See: \setFilters

_onDisable() : void

inherited

Inherited from: \cApiClickableAction::_onDisable()

_onEnable() : void

inherited

Inherited from: \cApiClickableAction::_onEnable()

_onLoad() : \none

inherited

_onLoad ()

Inherited from: \Item::_onLoad()\cApiAction::_onLoad()\cApiClickableAction::_onLoad()

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

Returns

Type	Description
\none

_outFilter(mixed $data) : mixed

inherited

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

Inherited from: \Item::_outFilter()\cApiAction::_outFilter()\cApiClickableAction::_outFilter()

Parameters

Name	Type	Description
$data	mixed	Data to filter

Returns

Type	Description
mixed	Filtered data

Details

Access: private
See: \setFilters

_setMetaObject( $objectname) : void

inherited

Inherited from: \Item::_setMetaObject()\cApiAction::_setMetaObject()\cApiClickableAction::_setMetaObject()

Parameters

Name	Type	Description
$objectname

cApiAction(integer $idaction = false) : void

inherited

Constructor

Inherited from: \cApiAction::cApiAction()\cApiClickableAction::cApiAction()

Parameters

Name	Type	Description
$idaction	integer	area to load

cApiClickableAction() : void

inherited

Inherited from: \cApiClickableAction::cApiClickableAction()

cApiClickableQuestionAction() : void

changeArea( $sArea) : void

inherited

Change linked area

Inherited from: \cApiClickableAction::changeArea()

Parameters

Name	Type	Description
$sArea

deleteProperty(string $type, string $name) : void

inherited

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

Inherited from: \Item::deleteProperty()\cApiAction::deleteProperty()\cApiClickableAction::deleteProperty()

Parameters

Name	Type	Description
$type	string	Specifies the type
$name	string	Specifies the name

get(string $field) : mixed

inherited

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

Inherited from: \Item::get()\cApiAction::get()\cApiClickableAction::get()

Parameters

Name	Type	Description
$field	string	Specifies the field to retrieve

Returns

Type	Description
mixed	Value of the field

getField(string $field) : mixed

inherited

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

Inherited from: \Item::getField()\cApiAction::getField()\cApiClickableAction::getField()

Parameters

Name	Type	Description
$field	string	Specifies the field to retrieve

Returns

Type	Description
mixed	Value of the field

getHelpText() : void

inherited

Inherited from: \cApiClickableAction::getHelpText()

getIcon() : void

inherited

Inherited from: \cApiClickableAction::getIcon()

getMetaObject() : void

inherited

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

getProperty(string $type, string $name) : boolean

inherited

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

Inherited from: \Item::getProperty()\cApiAction::getProperty()\cApiClickableAction::getProperty()

Parameters

Name	Type	Description
$type	string	Specifies the type
$name	string	Specifies the name

Returns

Type	Description
boolean	Value of the given property

loadBy(string $field, string $value, bool $bSafe = true) : bool

inherited

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

Inherited from: \Item::loadBy()\cApiAction::loadBy()\cApiClickableAction::loadBy()

Parameters

Name	Type	Description
$field	string	Specifies the field
$value	string	Specifies the value
$bSafe	bool	use inFilter or not

Returns

Type	Description
bool	True if the load was successful

loadByPrimaryKey(string $value) : bool

inherited

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

Inherited from: \Item::loadByPrimaryKey()\cApiAction::loadByPrimaryKey()\cApiClickableAction::loadByPrimaryKey()

Parameters

Name	Type	Description
$value	string	Specifies the primary key value

Returns

Type	Description
bool	True if the load was successful

process( $parameters) : void

inherited

Inherited from: \cApiClickableAction::process()

Parameters

Name	Type	Description
$parameters

render() : void

renderText() : void

inherited

Inherited from: \cApiClickableAction::renderText()

set(string $field, string $value, $safe = true) : void

inherited

set($field, $value) Shortcut to setField

Inherited from: \Item::set()\cApiAction::set()\cApiClickableAction::set()

Parameters

Name	Type	Description
$field	string	Specifies the field to set
$value	string	Specifies the value to set
$safe

setDisabled() : void

inherited

Inherited from: \cApiClickableAction::setDisabled()

setEnabled() : void

inherited

Inherited from: \cApiClickableAction::setEnabled()

setField(string $field, string $value, boolean $safe = true) : void

inherited

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

Inherited from: \Item::setField()\cApiAction::setField()\cApiClickableAction::setField()

Parameters

Name	Type	Description
$field	string	Specifies the field to set
$value	string	Specifies the value to set
$safe	boolean	Speficies if we should translate characters

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

inherited

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

Inherited from: \Item::setFilters()\cApiAction::setFilters()\cApiClickableAction::setFilters()

Examples:

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

Parameters

Name	Type	Description
$arrInFilters	array	inFilters array with function names
$arrOutFilters	array	outFilters array with function names

setHelpText(string $helptext) : void

inherited

sets the help text for this action.

Inherited from: \cApiClickableAction::setHelpText()

Parameters

Name	Type	Description
$helptext	string	helptext The helptext to apply

Details

Access: public

setIcon(string $icon) : void

inherited

Sets the action icon for this action.

Inherited from: \cApiClickableAction::setIcon()

Parameters

Name	Type	Description
$icon	string	icon Path to the icon. Relative to the backend, if not passed as absolute path.

Details

Access: public

setNamedAction(string $actionName) : void

inherited

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

Inherited from: \cApiClickableAction::setNamedAction()

Parameters

Name	Type	Description
$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.

Details

Access: public

setParameter( $name, $value) : void

inherited

Inherited from: \cApiClickableAction::setParameter()

Parameters

Name	Type	Description
$name
$value

setProperty(string $type, string $name, string $value) : void

inherited

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

Inherited from: \Item::setProperty()\cApiAction::setProperty()\cApiClickableAction::setProperty()

Parameters

Name	Type	Description
$type	string	Specifies the type
$name	string	Specifies the name
$value	string	Specifies the value

setQuestion( $question) : void

Parameters

Name	Type	Description
$question

setQuestionMode( $mode) : void

Parameters

Name	Type	Description
$mode

setResultVar( $var) : void

Parameters

Name	Type	Description
$var

store() : void

inherited

store() Stores the modified user object to the database

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

wantParameter( $parameter) : void

inherited

Inherited from: \cApiClickableAction::wantParameter()

Parameters

Name	Type	Description
$parameter

contenido\classes\widgets\class.widgets.actionbutton.php

Constants

\cApiClickableActionjump to top

Properties

Methods

\cApiClickableQuestionActionjump to top

Properties

Methods

\cApiClickableAction
jump to top

\cApiClickableQuestionAction
jump to top