interface.t3lib_tceformsinlinehook.php

Go to the documentation of this file.

<?php
/***************************************************************
 * Copyright notice
 *
 * (c) 2008-2011 Oliver Hader <oh@inpublica.de>
 * 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 hook into t3lib_TCEforms_inline.
 *
 * $Id: interface.t3lib_tceformsinlinehook.php 10121 2011-01-18 20:15:30Z ohader $
 *
 * @author      Oliver Hader <oh@inpublica.de>
 * @package  TYPO3
 * @subpackage  t3lib
 */
interface t3lib_tceformsInlineHook {
    /**
     * Initializes this hook object.
     *
     * @param   t3lib_TCEforms_inline       $parentObject: The calling t3lib_TCEforms_inline object.
     * @return  void
     */
    public function init(&$parentObject);

    /**
     * Pre-processing to define which control items are enabled or disabled.
     *
     * @param   string      $parentUid: The uid of the parent (embedding) record (uid or NEW...)
     * @param   string      $foreignTable: The table (foreign_table) we create control-icons for
     * @param   array       $childRecord: The current record of that foreign_table
     * @param   array       $childConfig: TCA configuration of the current field of the child record
     * @param   boolean     $isVirtual: Defines whether the current records is only virtually shown and not physically part of the parent record
     * @param   array       &$enabledControls: (reference) Associative array with the enabled control items
     * @return  void
     */
    public function renderForeignRecordHeaderControl_preProcess($parentUid, $foreignTable, array $childRecord, array $childConfig, $isVirtual, array &$enabledControls);

    /**
     * Post-processing to define which control items to show. Possibly own icons can be added here.
     *
     * @param   string      $parentUid: The uid of the parent (embedding) record (uid or NEW...)
     * @param   string      $foreignTable: The table (foreign_table) we create control-icons for
     * @param   array       $childRecord: The current record of that foreign_table
     * @param   array       $childConfig: TCA configuration of the current field of the child record
     * @param   boolean     $isVirtual: Defines whether the current records is only virtually shown and not physically part of the parent record
     * @param   array       &$controlItems: (reference) Associative array with the currently available control items
     * @return  void
     */
    public function renderForeignRecordHeaderControl_postProcess($parentUid, $foreignTable, array $childRecord, array $childConfig, $isVirtual, array &$controlItems);
}

?>