Fixed issue #14560: Violation of naming conventions in sprite generation API
[Packages/TYPO3.CMS.git] / t3lib / interfaces / interface.t3lib_tceformsinlinehook.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 2008-2009 Oliver Hader <oh@inpublica.de>
6 * All rights reserved
7 *
8 * This script is part of the TYPO3 project. The TYPO3 project is
9 * free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * The GNU General Public License can be found at
15 * http://www.gnu.org/copyleft/gpl.html.
16 * A copy is found in the textfile GPL.txt and important notices to the license
17 * from the author is found in LICENSE.txt distributed with these scripts.
18 *
19 *
20 * This script is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
24 *
25 * This copyright notice MUST APPEAR in all copies of the script!
26 ***************************************************************/
27
28 /**
29 * Interface for classes which hook into t3lib_TCEforms_inline.
30 *
31 * $Id$
32 *
33 * @author Oliver Hader <oh@inpublica.de>
34 * @package TYPO3
35 * @subpackage t3lib
36 */
37 interface t3lib_tceformsInlineHook {
38 /**
39 * Initializes this hook object.
40 *
41 * @param t3lib_TCEforms_inline $parentObject: The calling t3lib_TCEforms_inline object.
42 * @return void
43 */
44 public function init(&$parentObject);
45
46 /**
47 * Pre-processing to define which control items are enabled or disabled.
48 *
49 * @param string $parentUid: The uid of the parent (embedding) record (uid or NEW...)
50 * @param string $foreignTable: The table (foreign_table) we create control-icons for
51 * @param array $childRecord: The current record of that foreign_table
52 * @param array $childConfig: TCA configuration of the current field of the child record
53 * @param boolean $isVirtual: Defines whether the current records is only virtually shown and not physically part of the parent record
54 * @param array &$enabledControls: (reference) Associative array with the enabled control items
55 * @return void
56 */
57 public function renderForeignRecordHeaderControl_preProcess($parentUid, $foreignTable, array $childRecord, array $childConfig, $isVirtual, array &$enabledControls);
58
59 /**
60 * Post-processing to define which control items to show. Possibly own icons can be added here.
61 *
62 * @param string $parentUid: The uid of the parent (embedding) record (uid or NEW...)
63 * @param string $foreignTable: The table (foreign_table) we create control-icons for
64 * @param array $childRecord: The current record of that foreign_table
65 * @param array $childConfig: TCA configuration of the current field of the child record
66 * @param boolean $isVirtual: Defines whether the current records is only virtually shown and not physically part of the parent record
67 * @param array &$controlItems: (reference) Associative array with the currently available control items
68 * @return void
69 */
70 public function renderForeignRecordHeaderControl_postProcess($parentUid, $foreignTable, array $childRecord, array $childConfig, $isVirtual, array &$controlItems);
71 }
72 ?>