interface.backend_toolbaritem.php

Go to the documentation of this file.

<?php
/***************************************************************
*  Copyright notice
*
*  (c) 2007 Ingo Renner <ingo@typo3.org>
*  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!
***************************************************************/


/**
 * interface for classes which extend the backend by adding items to the top toolbar
 *
 * @author  Ingo Renner <ingo@typo3.org>
 * @package TYPO3
 * @subpackage t3lib
 */
interface backend_toolbarItem {

    /**
     * constructor that receives a back reference to the backend
     *
     * @param   TYPO3backend    TYPO3 backend object reference
     */
    public function __construct(TYPO3backend &$backendReference = null);

    /**
     * checks whether the user has access to this toolbar item
     *
     * @return  boolean  true if user has access, false if not
     */
    public function checkAccess();

    /**
     * renders the toolbar item
     *
     * @return  string  the toolbar item rendered as HTML string
     */
    public function render();

    /**
     * returns additional attributes for the list item in the toolbar
     *
     * @return  string      list item HTML attibutes
     */
    public function getAdditionalAttributes();
}

?>

---