TYPO3\CMS\Install\FolderStructure\NodeInterface Interface Reference

Inheritance diagram for TYPO3\CMS\Install\FolderStructure\NodeInterface:

Public Member Functions
	__construct (array $structure, NodeInterface $parent=null)
string	getName ()
string	getAbsolutePath ()
FlashMessage[]	getStatus ()
bool	isWritable ()
FlashMessage[]	fix ()

Detailed Description

Interface for structure nodes root, link, file, ...

Definition at line 23 of file NodeInterface.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Install\FolderStructure\NodeInterface::__construct	(	array	$structure,
		NodeInterface	$parent = null
	)

Constructor gets structure and parent object defaulting to NULL

Parameters

array	$structure	‪Structure
NodeInterface	$parent	‪Parent

Implemented in TYPO3\CMS\Install\FolderStructure\FileNode, TYPO3\CMS\Install\FolderStructure\DirectoryNode, TYPO3\CMS\Install\FolderStructure\LinkNode, and TYPO3\CMS\Install\FolderStructure\RootNode.

Member Function Documentation

fix()

FlashMessage [] TYPO3\CMS\Install\FolderStructure\NodeInterface::fix

(

)

Fix structure

If there is nothing to fix, returns an empty array

Returns

‪FlashMessage[]

Implemented in TYPO3\CMS\Install\FolderStructure\LinkNode, TYPO3\CMS\Install\FolderStructure\FileNode, and TYPO3\CMS\Install\FolderStructure\DirectoryNode.

getAbsolutePath()

string TYPO3\CMS\Install\FolderStructure\NodeInterface::getAbsolutePath

(

)

Get absolute path of node

Returns

‪string Absolute path

Implemented in TYPO3\CMS\Install\FolderStructure\RootNode.

Referenced by TYPO3\CMS\Install\FolderStructure\AbstractNode\getAbsolutePath().

getName()

string TYPO3\CMS\Install\FolderStructure\NodeInterface::getName

(

)

Get node name

Returns

‪string Node name

getStatus()

FlashMessage [] TYPO3\CMS\Install\FolderStructure\NodeInterface::getStatus

(

)

Get the status of the object tree, recursive for directory and root node

Returns

‪FlashMessage[]

Implemented in TYPO3\CMS\Install\FolderStructure\FileNode, TYPO3\CMS\Install\FolderStructure\DirectoryNode, TYPO3\CMS\Install\FolderStructure\LinkNode, and TYPO3\CMS\Install\FolderStructure\RootNode.

isWritable()

bool TYPO3\CMS\Install\FolderStructure\NodeInterface::isWritable

(

)

Check if node is writable - can be created and permission can be fixed

Returns

‪bool TRUE if node is writable

Implemented in TYPO3\CMS\Install\FolderStructure\DirectoryNode.

Referenced by TYPO3\CMS\Install\FolderStructure\AbstractNode\isWritable().