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

Show: PublicProtectedPrivateinherited
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

>VConstant  QUESTIONACTION_PROMPT = "prompt"
>VConstant  QUESTIONACTION_YESNO = "yesno"

\cApiClickableAction

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

>VPropertypublicarray $_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  
>VPropertypublicarray $_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  
>VPropertypublic$_helpText
Help text
Details
Type
n/a
Access
private  
>VPropertypublic$_img
cHTMLImage for rendering the icon
Details
Type
n/a
Access
private  
>VPropertypublic$_link
cHTMLLink for rendering the icon
Details
Type
n/a
Access
private  
>VPropertypublic$_metaObject
Details
Type
n/a
Inherited_from
\Item::$$_metaObject  
Inherited_from
\cApiAction::$$_metaObject  
>VPropertypublic$_objectInvalid
inheritedInherited from: \cApiAction::$$_objectInvalid
Details
Type
n/a
Inherited_from
\cApiAction::$$_objectInvalid  
>VPropertypublicarray $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  
>VPropertypublicobject $db
inherited
DB_Contenido instance
Inherited from: \Item::$$db\cApiAction::$$db
Details
Type
object
Access
private  
Inherited_from
\Item::$$db  
Inherited_from
\cApiAction::$$db  
>VPropertypublicstring $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  
>VPropertypublicint $lifetime
inherited

Lifetime in seconds

Inherited from: \Item::$$lifetime\cApiAction::$$lifetime
Details
Type
int
Access
private  
Inherited_from
\Item::$$lifetime  
Inherited_from
\cApiAction::$$lifetime  
>VPropertypublicarray $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  
>VPropertypublicstring $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  
>VPropertypublicobject $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  
>VPropertypublicobject $properties
inherited

PropertyCollection object

Inherited from: \Item::$$properties\cApiAction::$$properties
Details
Type
object
Access
private  
Inherited_from
\Item::$$properties  
Inherited_from
\cApiAction::$$properties  
>VPropertypublicstring $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  
>VPropertypublicarray $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  
>VPropertypublicboolean $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

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

Constructor Function

Inherited from: \Item::Item()\cApiAction::Item()
Parameters
NameTypeDescription
$tablestring

The table to use as information source

$primaryKeystring

The primary key to use

$lifetime
methodpublic_inFilter(mixed $data) : mixed
inherited

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

Inherited from: \Item::_inFilter()\cApiAction::_inFilter()
Parameters
NameTypeDescription
$datamixed

Data to filter

Returns
TypeDescription
mixedFiltered data
Details
Access
private  
See
\setFilters  
methodpublic_onDisable() : void

methodpublic_onEnable() : void

methodpublic_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
TypeDescription
\none
methodpublic_outFilter(mixed $data) : mixed
inherited

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

Inherited from: \Item::_outFilter()\cApiAction::_outFilter()
Parameters
NameTypeDescription
$datamixed

Data to filter

Returns
TypeDescription
mixedFiltered data
Details
Access
private  
See
\setFilters  
methodpublic_setMetaObject( $objectname) : void
Parameters
NameTypeDescription
$objectname
methodpubliccApiAction(integer $idaction = false) : void
inherited

Constructor

Inherited from: \cApiAction::cApiAction()
Parameters
NameTypeDescription
$idactioninteger

area to load

methodpubliccApiClickableAction() : void

methodpublicchangeArea( $sArea) : void

Change linked area

Parameters
NameTypeDescription
$sArea
methodpublicdeleteProperty(string $type, string $name) : void
inherited

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

Inherited from: \Item::deleteProperty()\cApiAction::deleteProperty()
Parameters
NameTypeDescription
$typestring

Specifies the type

$namestring

Specifies the name

methodpublicget(string $field) : mixed
inherited

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

Inherited from: \Item::get()\cApiAction::get()
Parameters
NameTypeDescription
$fieldstring

Specifies the field to retrieve

Returns
TypeDescription
mixedValue of the field
methodpublicgetField(string $field) : mixed
inherited

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

Inherited from: \Item::getField()\cApiAction::getField()
Parameters
NameTypeDescription
$fieldstring

Specifies the field to retrieve

Returns
TypeDescription
mixedValue of the field
methodpublicgetHelpText() : void

methodpublicgetIcon() : void

methodpublicgetMetaObject() : void
methodpublicgetProperty(string $type, string $name) : boolean
inherited

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

Inherited from: \Item::getProperty()\cApiAction::getProperty()
Parameters
NameTypeDescription
$typestring

Specifies the type

$namestring

Specifies the name

Returns
TypeDescription
booleanValue of the given property
methodpublicloadBy(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
NameTypeDescription
$fieldstring

Specifies the field

$valuestring

Specifies the value

$bSafebool

use inFilter or not

Returns
TypeDescription
boolTrue if the load was successful
methodpublicloadByPrimaryKey(string $value) : bool
inherited

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

Inherited from: \Item::loadByPrimaryKey()\cApiAction::loadByPrimaryKey()
Parameters
NameTypeDescription
$valuestring

Specifies the primary key value

Returns
TypeDescription
boolTrue if the load was successful
methodpublicprocess( $parameters) : void

Parameters
NameTypeDescription
$parameters
methodpublicrender() : void

methodpublicrenderText() : void

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

set($field, $value) Shortcut to setField

Inherited from: \Item::set()\cApiAction::set()
Parameters
NameTypeDescription
$fieldstring

Specifies the field to set

$valuestring

Specifies the value to set

$safe
methodpublicsetDisabled() : void

methodpublicsetEnabled() : void

methodpublicsetField(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
NameTypeDescription
$fieldstring

Specifies the field to set

$valuestring

Specifies the value to set

$safeboolean

Speficies if we should translate characters

methodpublicsetFilters(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
NameTypeDescription
$arrInFiltersarray

inFilters array with function names

$arrOutFiltersarray

outFilters array with function names

methodpublicsetHelpText(string $helptext) : void

sets the help text for this action.

Parameters
NameTypeDescription
$helptextstring

helptext The helptext to apply

Details
Access
public  
methodpublicsetIcon(string $icon) : void

Sets the action icon for this action.

Parameters
NameTypeDescription
$iconstring

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

Details
Access
public  
methodpublicsetNamedAction(string $actionName) : void

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

Parameters
NameTypeDescription
$actionNamestring

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  
methodpublicsetParameter( $name,  $value) : void

Parameters
NameTypeDescription
$name
$value
methodpublicsetProperty(string $type, string $name, string $value) : void
inherited

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

Inherited from: \Item::setProperty()\cApiAction::setProperty()
Parameters
NameTypeDescription
$typestring

Specifies the type

$namestring

Specifies the name

$valuestring

Specifies the value

methodpublicstore() : void
inherited

store() Stores the modified user object to the database

Inherited from: \Item::store()\cApiAction::store()
methodpublicwantParameter( $parameter) : void

Parameters
NameTypeDescription
$parameter

\cApiClickableQuestionAction

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)
\cApiClickableAction < \cApiAction < \Item
Author
Timo A. Hummel  
Copyright
four for business 2003  
Version
0.1  

Properties

>VPropertypublicarray $_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  
>VPropertypublicarray $_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  
>VPropertypublic$_helpText
inherited
Help text
Inherited from: \cApiClickableAction::$$_helpText
Details
Type
n/a
Access
private  
Inherited_from
\cApiClickableAction::$$_helpText  
>VPropertypublic$_img
inherited
cHTMLImage for rendering the icon
Inherited from: \cApiClickableAction::$$_img
Details
Type
n/a
Access
private  
Inherited_from
\cApiClickableAction::$$_img  
>VPropertypublic$_link
inherited
cHTMLLink for rendering the icon
Inherited from: \cApiClickableAction::$$_link
Details
Type
n/a
Access
private  
Inherited_from
\cApiClickableAction::$$_link  
>VPropertypublic$_objectInvalid
Details
Type
n/a
Inherited_from
\cApiAction::$$_objectInvalid  
Inherited_from
\cApiClickableAction::$$_objectInvalid  
>VPropertypublicarray $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  
>VPropertypublicobject $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  
>VPropertypublicstring $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  
>VPropertypublicint $lifetime
Details
Type
int
Access
private  
Inherited_from
\Item::$$lifetime  
Inherited_from
\cApiAction::$$lifetime  
Inherited_from
\cApiClickableAction::$$lifetime  
>VPropertypublicarray $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  
>VPropertypublicstring $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  
>VPropertypublicobject $primaryKey
Details
Type
object
Access
private  
Inherited_from
\Item::$$primaryKey  
Inherited_from
\cApiAction::$$primaryKey  
Inherited_from
\cApiClickableAction::$$primaryKey  
>VPropertypublicobject $properties
Details
Type
object
Access
private  
Inherited_from
\Item::$$properties  
Inherited_from
\cApiAction::$$properties  
Inherited_from
\cApiClickableAction::$$properties  
>VPropertypublicstring $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  
>VPropertypublicarray $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  
>VPropertypublicboolean $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

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

Constructor Function

Inherited from: \Item::Item()\cApiAction::Item()\cApiClickableAction::Item()
Parameters
NameTypeDescription
$tablestring

The table to use as information source

$primaryKeystring

The primary key to use

$lifetime
methodpublic_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
NameTypeDescription
$datamixed

Data to filter

Returns
TypeDescription
mixedFiltered data
Details
Access
private  
See
\setFilters  
methodpublic_onDisable() : void
inherited

Inherited from: \cApiClickableAction::_onDisable()
methodpublic_onEnable() : void
inherited

Inherited from: \cApiClickableAction::_onEnable()
methodpublic_onLoad() : \none

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

Returns
TypeDescription
\none
methodpublic_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
NameTypeDescription
$datamixed

Data to filter

Returns
TypeDescription
mixedFiltered data
Details
Access
private  
See
\setFilters  
methodpublic_setMetaObject( $objectname) : void
Parameters
NameTypeDescription
$objectname
methodpubliccApiAction(integer $idaction = false) : void
Parameters
NameTypeDescription
$idactioninteger

area to load

methodpubliccApiClickableAction() : void
methodpubliccApiClickableQuestionAction() : void

methodpublicchangeArea( $sArea) : void
inherited

Change linked area

Inherited from: \cApiClickableAction::changeArea()
Parameters
NameTypeDescription
$sArea
methodpublicdeleteProperty(string $type, string $name) : void
inherited

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

Inherited from: \Item::deleteProperty()\cApiAction::deleteProperty()\cApiClickableAction::deleteProperty()
Parameters
NameTypeDescription
$typestring

Specifies the type

$namestring

Specifies the name

methodpublicget(string $field) : mixed
inherited

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

Inherited from: \Item::get()\cApiAction::get()\cApiClickableAction::get()
Parameters
NameTypeDescription
$fieldstring

Specifies the field to retrieve

Returns
TypeDescription
mixedValue of the field
methodpublicgetField(string $field) : mixed
inherited

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

Inherited from: \Item::getField()\cApiAction::getField()\cApiClickableAction::getField()
Parameters
NameTypeDescription
$fieldstring

Specifies the field to retrieve

Returns
TypeDescription
mixedValue of the field
methodpublicgetHelpText() : void
inherited

Inherited from: \cApiClickableAction::getHelpText()
methodpublicgetIcon() : void
inherited

Inherited from: \cApiClickableAction::getIcon()
methodpublicgetProperty(string $type, string $name) : boolean
inherited

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

Inherited from: \Item::getProperty()\cApiAction::getProperty()\cApiClickableAction::getProperty()
Parameters
NameTypeDescription
$typestring

Specifies the type

$namestring

Specifies the name

Returns
TypeDescription
booleanValue of the given property
methodpublicloadBy(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
NameTypeDescription
$fieldstring

Specifies the field

$valuestring

Specifies the value

$bSafebool

use inFilter or not

Returns
TypeDescription
boolTrue if the load was successful
methodpublicloadByPrimaryKey(string $value) : bool
inherited

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

Inherited from: \Item::loadByPrimaryKey()\cApiAction::loadByPrimaryKey()\cApiClickableAction::loadByPrimaryKey()
Parameters
NameTypeDescription
$valuestring

Specifies the primary key value

Returns
TypeDescription
boolTrue if the load was successful
methodpublicprocess( $parameters) : void
inherited

Inherited from: \cApiClickableAction::process()
Parameters
NameTypeDescription
$parameters
methodpublicrender() : void

methodpublicrenderText() : void
inherited

Inherited from: \cApiClickableAction::renderText()
methodpublicset(string $field, string $value,  $safe = true) : void
inherited

set($field, $value) Shortcut to setField

Inherited from: \Item::set()\cApiAction::set()\cApiClickableAction::set()
Parameters
NameTypeDescription
$fieldstring

Specifies the field to set

$valuestring

Specifies the value to set

$safe
methodpublicsetDisabled() : void
inherited

Inherited from: \cApiClickableAction::setDisabled()
methodpublicsetEnabled() : void
inherited

Inherited from: \cApiClickableAction::setEnabled()
methodpublicsetField(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
NameTypeDescription
$fieldstring

Specifies the field to set

$valuestring

Specifies the value to set

$safeboolean

Speficies if we should translate characters

methodpublicsetFilters(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
NameTypeDescription
$arrInFiltersarray

inFilters array with function names

$arrOutFiltersarray

outFilters array with function names

methodpublicsetHelpText(string $helptext) : void
inherited

sets the help text for this action.

Inherited from: \cApiClickableAction::setHelpText()
Parameters
NameTypeDescription
$helptextstring

helptext The helptext to apply

Details
Access
public  
methodpublicsetIcon(string $icon) : void
inherited

Sets the action icon for this action.

Inherited from: \cApiClickableAction::setIcon()
Parameters
NameTypeDescription
$iconstring

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

Details
Access
public  
methodpublicsetNamedAction(string $actionName) : void
inherited

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

Inherited from: \cApiClickableAction::setNamedAction()
Parameters
NameTypeDescription
$actionNamestring

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  
methodpublicsetParameter( $name,  $value) : void
inherited

Inherited from: \cApiClickableAction::setParameter()
Parameters
NameTypeDescription
$name
$value
methodpublicsetProperty(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
NameTypeDescription
$typestring

Specifies the type

$namestring

Specifies the name

$valuestring

Specifies the value

methodpublicsetQuestion( $question) : void

Parameters
NameTypeDescription
$question
methodpublicsetQuestionMode( $mode) : void

Parameters
NameTypeDescription
$mode
methodpublicsetResultVar( $var) : void

Parameters
NameTypeDescription
$var
methodpublicstore() : void
inherited

store() Stores the modified user object to the database

Inherited from: \Item::store()\cApiAction::store()\cApiClickableAction::store()
methodpublicwantParameter( $parameter) : void
inherited

Inherited from: \cApiClickableAction::wantParameter()
Parameters
NameTypeDescription
$parameter
Documentation was generated by phpDocumentor 2.0.0a12.