class.t3lib_tree_representationnode.php

Go to the documentation of this file.

<?php
/***************************************************************
 *  Copyright notice
 *
 *  (c) 2010-2011 TYPO3 Tree Team <http://forge.typo3.org/projects/typo3v4-extjstrees>
 *  All rights reserved
 *
 *  This script is part of the TYPO3 project. The TYPO3 project is
 *  free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  The GNU General Public License can be found at
 *  http://www.gnu.org/copyleft/gpl.html.
 *  A copy is found in the textfile GPL.txt and important notices to the license
 *  from the author is found in LICENSE.txt distributed with these scripts.
 *
 *
 *  This script is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/

/**
 * Representation Tree Node
 *
 * @author Stefan Galinski <stefan.galinski@gmail.com>
 * @author Steffen Ritter <info@steffen-ritter.net>
 * @package TYPO3
 * @subpackage t3lib
 */
class t3lib_tree_RepresentationNode extends t3lib_tree_Node {
    /**
     * Node Label
     *
     * @var string
     */
    protected $label = '';

    /**
     * Node Type
     *
     * @var string
     */
    protected $type = '';

    /**
     * Node CSS Class
     *
     * @var string
     */
    protected $class = '';

    /**
     * Node Icon
     *
     * @var string
     */
    protected $icon = '';

    /**
     * Callback function that is called e.g after a click on the label
     *
     * @var string
     */
    protected $callbackAction = '';

    /**
     * @param string $class
     * @return void
     */
    public function setClass($class) {
        $this->class = $class;
    }

    /**
     * @return string
     */
    public function getClass() {
        return $this->class;
    }

    /**
     * @param string $icon
     * @return void
     */
    public function setIcon($icon) {
        $this->icon = $icon;
    }

    /**
     * @return string
     */
    public function getIcon() {
        return $this->icon;
    }

    /**
     * @param string $label
     */
    public function setLabel($label) {
        $this->label = $label;
    }

    /**
     * @return string
     */
    public function getLabel() {
        return $this->label;
    }

    /**
     * @param string $type
     * @return void
     */
    public function setType($type) {
        $this->type = $type;
    }

    /**
     * @return string
     */
    public function getType() {
        return $this->type;
    }

    /**
     * Sets the callback action
     *
     * @param string $callbackAction
     * @return void
     */
    public function setCallbackAction($callbackAction) {
        $this->callbackAction = $callbackAction;
    }

    /**
     * Returns the callback action
     *
     * @return string
     */
    public function getCallbackAction() {
        return $this->callbackAction;
    }

    /**
     * Returns the node in an array representation that can be used for serialization
     *
     * @return array
     */
    public function toArray() {
        $arrayRepresentation = parent::toArray();
        $arrayRepresentation = array_merge($arrayRepresentation, array(
                                                                      'label' => $this->label,
                                                                      'type' => $this->type,
                                                                      'class' => $this->class,
                                                                      'icon' => $this->icon,
                                                                      'callbackAction' => $this->callbackAction
                                                                 ));
        return $arrayRepresentation;
    }

    /**
     * Sets data of the node by a given data array
     *
     * @param array $data
     * @return void
     */
    public function dataFromArray($data) {
        parent::dataFromArray($data);

        $this->setLabel($data['label']);
        $this->setType($data['type']);
        $this->setClass($data['class']);
        $this->setIcon($data['icon']);
        $this->setCallbackAction($data['callbackAction']);
    }
}

?>