d36af82e787d6548b6f6a19104f861cd3bd5272a
[Packages/TYPO3.CMS.git] / typo3 / sysext / install / Classes / FolderStructure / NodeInterface.php
1 <?php
2 namespace TYPO3\CMS\Install\FolderStructure;
3
4 /***************************************************************
5 * Copyright notice
6 *
7 * (c) 2013 Christian Kuhn <lolli@schwarzbu.ch>
8 * All rights reserved
9 *
10 * This script is part of the TYPO3 project. The TYPO3 project is
11 * free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
15 *
16 * The GNU General Public License can be found at
17 * http://www.gnu.org/copyleft/gpl.html.
18 *
19 * This script is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
23 *
24 * This copyright notice MUST APPEAR in all copies of the script!
25 ***************************************************************/
26
27 /**
28 * Interface for structure nodes root, link, file, ...
29 */
30 interface NodeInterface {
31
32 /**
33 * Constructor gets structure and parent object defaulting to NULL
34 *
35 * @param array $structure Structure
36 * @param NodeInterface $parent Parent
37 */
38 public function __construct(array $structure, NodeInterface $parent = NULL);
39
40 /**
41 * Get node name
42 *
43 * @return string Node name
44 */
45 public function getName();
46
47 /**
48 * Get absolute path of node
49 *
50 * @return string Absolute path
51 */
52 public function getAbsolutePath();
53
54 /**
55 * Get the status of the object tree, recursive for directory and root node
56 *
57 * @return array<\TYPO3\CMS\Install\Status\StatusInterface>
58 */
59 public function getStatus();
60
61 /**
62 * Check if node is writable - can be created and permission can be fixed
63 *
64 * @return boolean TRUE if node is writable
65 */
66 public function isWritable();
67
68 /**
69 * Fix structure
70 *
71 * If there is nothing to fix, returns an empty array
72 *
73 * @return array<\TYPO3\CMS\Install\Status\StatusInterface>
74 */
75 public function fix();
76 }