ContextMenuAction.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Backend\ContextMenu;

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

class ContextMenuAction
{
    protected $label = '';

    protected $id = '';

    protected $icon = '';

    protected $class = '';

    protected $callbackAction = '';

    protected $type = '';

    protected $childActions = null;

    protected $customAttributes = [];

    public function getLabel()
    {
        return $this->label;
    }

    public function setLabel($label)
    {
        $this->label = $label;
    }

    public function getId()
    {
        return $this->id;
    }

    public function setId($id)
    {
        $this->id = $id;
    }

    public function getIcon()
    {
        return $this->icon;
    }

    public function setIcon($icon)
    {
        $this->icon = $icon;
    }

    public function getClass()
    {
        GeneralUtility::logDeprecatedFunction();
        return $this->class;
    }

    public function setClass($class)
    {
        GeneralUtility::logDeprecatedFunction();
        $this->class = $class;
    }

    public function getCallbackAction()
    {
        return $this->callbackAction;
    }

    public function setCallbackAction($callbackAction)
    {
        $this->callbackAction = $callbackAction;
    }

    public function getType()
    {
        return $this->type;
    }

    public function setType($type)
    {
        $this->type = $type;
    }

    public function getChildActions()
    {
        return $this->childActions;
    }

    public function setChildActions(\TYPO3\CMS\Backend\ContextMenu\ContextMenuActionCollection $actions)
    {
        $this->childActions = $actions;
    }

    public function hasChildActions()
    {
        if ($this->childActions !== null) {
            return true;
        }
        return false;
    }

    public function setCustomAttributes(array $customAttributes)
    {
        $this->customAttributes = $customAttributes;
    }

    public function getCustomAttributes()
    {
        return $this->customAttributes;
    }

    public function toArray()
    {
        $arrayRepresentation = [
            'label' => $this->getLabel(),
            'id' => $this->getId(),
            'icon' => $this->getIcon(),
            'callbackAction' => $this->getCallbackAction(),
            'type' => $this->getType(),
            'customAttributes' => $this->getCustomAttributes()
        ];
        $arrayRepresentation['childActions'] = '';
        if ($this->hasChildActions()) {
            $arrayRepresentation['childActions'] = $this->childActions->toArray();
        }
        return $arrayRepresentation;
    }
}