TYPO3 CMS  TYPO3_7-6
Public Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Backend\ContextMenu\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 = []
 

Detailed Description

Context Menu Action

Definition at line 20 of file ContextMenuAction.php.

Member Function Documentation

◆ getCallbackAction()

TYPO3\CMS\Backend\ContextMenu\ContextMenuAction::getCallbackAction ( )

Returns the callback action

Returns
string

Definition at line 169 of file ContextMenuAction.php.

References TYPO3\CMS\Backend\ContextMenu\ContextMenuAction\$callbackAction.

Referenced by TYPO3\CMS\Backend\ContextMenu\ContextMenuAction\toArray().

◆ getChildActions()

TYPO3\CMS\Backend\ContextMenu\ContextMenuAction::getChildActions ( )

Returns the child actions

Returns

Definition at line 210 of file ContextMenuAction.php.

References TYPO3\CMS\Backend\ContextMenu\ContextMenuAction\$childActions.

◆ getClass()

TYPO3\CMS\Backend\ContextMenu\ContextMenuAction::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 TYPO3\CMS\Backend\ContextMenu\ContextMenuAction\$class, and TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction().

◆ getCustomAttributes()

TYPO3\CMS\Backend\ContextMenu\ContextMenuAction::getCustomAttributes ( )

Returns the custom attributes

Returns
array

Definition at line 255 of file ContextMenuAction.php.

References TYPO3\CMS\Backend\ContextMenu\ContextMenuAction\$customAttributes.

Referenced by TYPO3\CMS\Backend\ContextMenu\ContextMenuAction\toArray().

◆ getIcon()

TYPO3\CMS\Backend\ContextMenu\ContextMenuAction::getIcon ( )

Returns the icon

Returns
string

Definition at line 124 of file ContextMenuAction.php.

References TYPO3\CMS\Backend\ContextMenu\ContextMenuAction\$icon.

Referenced by TYPO3\CMS\Backend\ContextMenu\ContextMenuAction\toArray().

◆ getId()

TYPO3\CMS\Backend\ContextMenu\ContextMenuAction::getId ( )

Returns the identifier

Returns
string

Definition at line 104 of file ContextMenuAction.php.

References TYPO3\CMS\Backend\ContextMenu\ContextMenuAction\$id.

Referenced by TYPO3\CMS\Backend\ContextMenu\ContextMenuAction\toArray().

◆ getLabel()

TYPO3\CMS\Backend\ContextMenu\ContextMenuAction::getLabel ( )

Returns the label

Returns
string

Definition at line 84 of file ContextMenuAction.php.

References TYPO3\CMS\Backend\ContextMenu\ContextMenuAction\$label.

Referenced by TYPO3\CMS\Backend\ContextMenu\ContextMenuAction\toArray().

◆ getType()

TYPO3\CMS\Backend\ContextMenu\ContextMenuAction::getType ( )

Returns the type

Returns
string

Definition at line 189 of file ContextMenuAction.php.

References TYPO3\CMS\Backend\ContextMenu\ContextMenuAction\$type.

Referenced by TYPO3\CMS\Backend\ContextMenu\ContextMenuAction\toArray().

◆ hasChildActions()

TYPO3\CMS\Backend\ContextMenu\ContextMenuAction::hasChildActions ( )

Returns TRUE if the action has child actions

Returns
bool

Definition at line 231 of file ContextMenuAction.php.

Referenced by TYPO3\CMS\Backend\ContextMenu\ContextMenuAction\toArray().

◆ setCallbackAction()

TYPO3\CMS\Backend\ContextMenu\ContextMenuAction::setCallbackAction (   $callbackAction)

Sets the callback action

Parameters
string$callbackAction

Definition at line 179 of file ContextMenuAction.php.

References TYPO3\CMS\Backend\ContextMenu\ContextMenuAction\$callbackAction.

◆ setChildActions()

TYPO3\CMS\Backend\ContextMenu\ContextMenuAction::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()

TYPO3\CMS\Backend\ContextMenu\ContextMenuAction::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 TYPO3\CMS\Backend\ContextMenu\ContextMenuAction\$class, and TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction().

◆ setCustomAttributes()

TYPO3\CMS\Backend\ContextMenu\ContextMenuAction::setCustomAttributes ( array  $customAttributes)

Sets the custom attributes

Parameters
array$customAttributes
Returns
void

Definition at line 245 of file ContextMenuAction.php.

References TYPO3\CMS\Backend\ContextMenu\ContextMenuAction\$customAttributes.

◆ setIcon()

TYPO3\CMS\Backend\ContextMenu\ContextMenuAction::setIcon (   $icon)

Sets the icon

Parameters
string$icon
Returns
void

Definition at line 135 of file ContextMenuAction.php.

References TYPO3\CMS\Backend\ContextMenu\ContextMenuAction\$icon.

◆ setId()

TYPO3\CMS\Backend\ContextMenu\ContextMenuAction::setId (   $id)

Sets the identifier

Parameters
string$id

Definition at line 114 of file ContextMenuAction.php.

References TYPO3\CMS\Backend\ContextMenu\ContextMenuAction\$id.

◆ setLabel()

TYPO3\CMS\Backend\ContextMenu\ContextMenuAction::setLabel (   $label)

Sets the label

Parameters
string$label

Definition at line 94 of file ContextMenuAction.php.

References TYPO3\CMS\Backend\ContextMenu\ContextMenuAction\$label.

◆ setType()

TYPO3\CMS\Backend\ContextMenu\ContextMenuAction::setType (   $type)

Sets the type

Parameters
string$type
Returns
void

Definition at line 200 of file ContextMenuAction.php.

References TYPO3\CMS\Backend\ContextMenu\ContextMenuAction\$type.

◆ toArray()

TYPO3\CMS\Backend\ContextMenu\ContextMenuAction::toArray ( )

Returns the action as an array

Returns
array

Definition at line 265 of file ContextMenuAction.php.

References TYPO3\CMS\Backend\ContextMenu\ContextMenuAction\getCallbackAction(), TYPO3\CMS\Backend\ContextMenu\ContextMenuAction\getCustomAttributes(), TYPO3\CMS\Backend\ContextMenu\ContextMenuAction\getIcon(), TYPO3\CMS\Backend\ContextMenu\ContextMenuAction\getId(), TYPO3\CMS\Backend\ContextMenu\ContextMenuAction\getLabel(), TYPO3\CMS\Backend\ContextMenu\ContextMenuAction\getType(), and TYPO3\CMS\Backend\ContextMenu\ContextMenuAction\hasChildActions().

Member Data Documentation

◆ $callbackAction

TYPO3\CMS\Backend\ContextMenu\ContextMenuAction::$callbackAction = ''
protected

Definition at line 56 of file ContextMenuAction.php.

Referenced by TYPO3\CMS\Backend\ContextMenu\ContextMenuAction\getCallbackAction(), and TYPO3\CMS\Backend\ContextMenu\ContextMenuAction\setCallbackAction().

◆ $childActions

TYPO3\CMS\Backend\ContextMenu\ContextMenuAction::$childActions = null
protected

Definition at line 70 of file ContextMenuAction.php.

Referenced by TYPO3\CMS\Backend\ContextMenu\ContextMenuAction\getChildActions().

◆ $class

TYPO3\CMS\Backend\ContextMenu\ContextMenuAction::$class = ''
protected

Definition at line 49 of file ContextMenuAction.php.

Referenced by TYPO3\CMS\Backend\ContextMenu\ContextMenuAction\getClass(), and TYPO3\CMS\Backend\ContextMenu\ContextMenuAction\setClass().

◆ $customAttributes

TYPO3\CMS\Backend\ContextMenu\ContextMenuAction::$customAttributes = []
protected

Definition at line 77 of file ContextMenuAction.php.

Referenced by TYPO3\CMS\Backend\ContextMenu\ContextMenuAction\getCustomAttributes(), and TYPO3\CMS\Backend\ContextMenu\ContextMenuAction\setCustomAttributes().

◆ $icon

TYPO3\CMS\Backend\ContextMenu\ContextMenuAction::$icon = ''
protected

Definition at line 41 of file ContextMenuAction.php.

Referenced by TYPO3\CMS\Backend\ContextMenu\ContextMenuAction\getIcon(), and TYPO3\CMS\Backend\ContextMenu\ContextMenuAction\setIcon().

◆ $id

TYPO3\CMS\Backend\ContextMenu\ContextMenuAction::$id = ''
protected

Definition at line 34 of file ContextMenuAction.php.

Referenced by TYPO3\CMS\Backend\ContextMenu\ContextMenuAction\getId(), and TYPO3\CMS\Backend\ContextMenu\ContextMenuAction\setId().

◆ $label

TYPO3\CMS\Backend\ContextMenu\ContextMenuAction::$label = ''
protected

Definition at line 27 of file ContextMenuAction.php.

Referenced by TYPO3\CMS\Backend\ContextMenu\ContextMenuAction\getLabel(), and TYPO3\CMS\Backend\ContextMenu\ContextMenuAction\setLabel().

◆ $type

TYPO3\CMS\Backend\ContextMenu\ContextMenuAction::$type = ''
protected

Definition at line 63 of file ContextMenuAction.php.

Referenced by TYPO3\CMS\Backend\ContextMenu\ContextMenuAction\getType(), and TYPO3\CMS\Backend\ContextMenu\ContextMenuAction\setType().