ContextMenuAction Class Reference

Public Member Functions
	getLabel ()
	setLabel ($label)
	getId ()
	setId ($id)
	getIcon ()
	setIcon ($icon)
	getClass ()
	setClass ($class)
	getCallbackAction ()
	setCallbackAction ($callbackAction)
	getType ()
	setType ($type)
	getChildActions ()
	setChildActions (\TYPO3\CMS\Backend\ContextMenu\ContextMenuActionCollection $actions)
	hasChildActions ()
	setCustomAttributes (array $customAttributes)
	getCustomAttributes ()
	toArray ()

Protected Attributes
	$label = ''
	$id = ''
	$icon = ''
	$class = ''
	$callbackAction = ''
	$type = ''
	$childActions = null
	$customAttributes = array()

Detailed Description

Context Menu Action

Definition at line 20 of file ContextMenuAction.php.

Member Function Documentation

getCallbackAction

(

)

Returns the callback action

Returns

string

Definition at line 169 of file ContextMenuAction.php.

References ContextMenuAction\$callbackAction.

Referenced by ContextMenuAction\toArray().

getChildActions

(

)

Returns the child actions

Returns

Definition at line 210 of file ContextMenuAction.php.

References ContextMenuAction\$childActions.

getClass

(

)

Returns the class

Returns

string

Deprecated:

since TYPO3 CMS 7, will be removed in TYPO3 CMS 8

Definition at line 146 of file ContextMenuAction.php.

References ContextMenuAction\$class, and GeneralUtility\logDeprecatedFunction().

getCustomAttributes

(

)

Returns the custom attributes

Returns

array

Definition at line 255 of file ContextMenuAction.php.

References ContextMenuAction\$customAttributes.

Referenced by ContextMenuAction\toArray().

getIcon

(

)

Returns the icon

Returns

string

Definition at line 124 of file ContextMenuAction.php.

References ContextMenuAction\$icon.

Referenced by ContextMenuAction\toArray().

getId

(

)

Returns the identifier

Returns

string

Definition at line 104 of file ContextMenuAction.php.

References ContextMenuAction\$id.

Referenced by ContextMenuAction\toArray().

getLabel

(

)

Returns the label

Returns

string

Definition at line 84 of file ContextMenuAction.php.

References ContextMenuAction\$label.

Referenced by ContextMenuAction\toArray().

getType

(

)

Returns the type

Returns

string

Definition at line 189 of file ContextMenuAction.php.

References ContextMenuAction\$type.

Referenced by ContextMenuAction\toArray().

hasChildActions

(

)

Returns TRUE if the action has child actions

Returns

bool

Definition at line 231 of file ContextMenuAction.php.

Referenced by ContextMenuAction\toArray().

setCallbackAction

(

$callbackAction

)

Sets the callback action

Parameters

string

$callbackAction

Definition at line 179 of file ContextMenuAction.php.

References ContextMenuAction\$callbackAction.

setChildActions

(

\TYPO3\CMS\Backend\ContextMenu\ContextMenuActionCollection

$actions

)

Sets the child actions

Parameters

\TYPO3\CMS\Backend\ContextMenu\ContextMenuActionCollection

$actions

Returns

void

Definition at line 221 of file ContextMenuAction.php.

setClass

(

$class

)

Sets the class

Parameters

string

$class

Deprecated:

since TYPO3 CMS 7, will be removed in TYPO3 CMS 8

Definition at line 158 of file ContextMenuAction.php.

References ContextMenuAction\$class, and GeneralUtility\logDeprecatedFunction().

setCustomAttributes

(

array

$customAttributes

)

Sets the custom attributes

Parameters

array

$customAttributes

Returns

void

Definition at line 245 of file ContextMenuAction.php.

References ContextMenuAction\$customAttributes.

setIcon

(

$icon

)

Sets the icon

Parameters

string

$icon

Returns

void

Definition at line 135 of file ContextMenuAction.php.

References ContextMenuAction\$icon.

setId

(

$id

)

Sets the identifier

Parameters

string

$id

Definition at line 114 of file ContextMenuAction.php.

References ContextMenuAction\$id.

setLabel

(

$label

)

Sets the label

Parameters

string

$label

Definition at line 94 of file ContextMenuAction.php.

References ContextMenuAction\$label.

setType

(

$type

)

Sets the type

Parameters

string

$type

Returns

void

Definition at line 200 of file ContextMenuAction.php.

References ContextMenuAction\$type.

toArray

(

)

Returns the action as an array

Returns

array

Definition at line 265 of file ContextMenuAction.php.

References ContextMenuAction\getCallbackAction(), ContextMenuAction\getCustomAttributes(), ContextMenuAction\getIcon(), ContextMenuAction\getId(), ContextMenuAction\getLabel(), ContextMenuAction\getType(), and ContextMenuAction\hasChildActions().

Member Data Documentation

$callbackAction = ''

protected

Definition at line 56 of file ContextMenuAction.php.

Referenced by ContextMenuAction\getCallbackAction(), and ContextMenuAction\setCallbackAction().

$childActions = null

protected

Definition at line 70 of file ContextMenuAction.php.

Referenced by ContextMenuAction\getChildActions().

$class = ''

protected

Definition at line 49 of file ContextMenuAction.php.

Referenced by ContextMenuAction\getClass(), and ContextMenuAction\setClass().

$customAttributes = array()

protected

Definition at line 77 of file ContextMenuAction.php.

Referenced by ContextMenuAction\getCustomAttributes(), and ContextMenuAction\setCustomAttributes().

$icon = ''

protected

Definition at line 41 of file ContextMenuAction.php.

Referenced by ContextMenuAction\getIcon(), and ContextMenuAction\setIcon().

$id = ''

protected

Definition at line 34 of file ContextMenuAction.php.

Referenced by ContextMenuAction\getId(), and ContextMenuAction\setId().

$label = ''

protected

Definition at line 27 of file ContextMenuAction.php.

Referenced by ContextMenuAction\getLabel(), and ContextMenuAction\setLabel().

$type = ''

protected

Definition at line 63 of file ContextMenuAction.php.

Referenced by ContextMenuAction\getType(), and ContextMenuAction\setType().