TYPO3 CMS  TYPO3_7-6
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Install\FolderStructure\DirectoryNode Class Reference
Inheritance diagram for TYPO3\CMS\Install\FolderStructure\DirectoryNode:
TYPO3\CMS\Install\FolderStructure\AbstractNode TYPO3\CMS\Install\FolderStructure\NodeInterface TYPO3\CMS\Install\FolderStructure\RootNode

Public Member Functions

 __construct (array $structure, NodeInterface $parent=null)
 
 getStatus ()
 
 isWritable ()
 
- Public Member Functions inherited from TYPO3\CMS\Install\FolderStructure\AbstractNode
 getName ()
 
 getAbsolutePath ()
 
 isWritable ()
 
- Public Member Functions inherited from TYPO3\CMS\Install\FolderStructure\NodeInterface
 getName ()
 
 getAbsolutePath ()
 
 fix ()
 

Protected Member Functions

 fixSelf ()
 
 createDirectory ()
 
 getSelfStatus ()
 
 canFileBeCreated ()
 
 isDirectory ()
 
- Protected Member Functions inherited from TYPO3\CMS\Install\FolderStructure\AbstractNode
 getTargetPermission ()
 
 setTargetPermission ($permission)
 
 getChildren ()
 
 getParent ()
 
 exists ()
 
 fixPermission ()
 
 isPermissionCorrect ()
 
 getCurrentPermission ()
 
 isWindowsOs ()
 
 getRelativePathBelowSiteRoot ($path=null)
 

Protected Attributes

 $targetPermission = '2775'
 
- Protected Attributes inherited from TYPO3\CMS\Install\FolderStructure\AbstractNode
 $name = ''
 
 $targetPermission = null
 
 $parent = null
 
 $children = []
 

Detailed Description

A directory

Definition at line 23 of file DirectoryNode.php.

Constructor & Destructor Documentation

◆ __construct()

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

Implement constructor

Parameters
array$structureStructure array
NodeInterface$parentParent object
Exceptions
Exception

Implements TYPO3\CMS\Install\FolderStructure\NodeInterface.

Definition at line 37 of file DirectoryNode.php.

References TYPO3\CMS\Install\FolderStructure\AbstractNode\$parent, and TYPO3\CMS\Install\FolderStructure\AbstractNode\setTargetPermission().

Member Function Documentation

◆ canFileBeCreated()

TYPO3\CMS\Install\FolderStructure\DirectoryNode::canFileBeCreated ( )
protected

Create a test file and delete again - helper for isWritable

Returns
bool TRUE if test file creation was successful

Definition at line 254 of file DirectoryNode.php.

References TYPO3\CMS\Install\FolderStructure\AbstractNode\getAbsolutePath(), and TYPO3\CMS\Core\Utility\StringUtility\getUniqueId().

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

◆ createDirectory()

TYPO3\CMS\Install\FolderStructure\DirectoryNode::createDirectory ( )
protected

Create directory if not exists

Exceptions
Exception
Returns

Definition at line 168 of file DirectoryNode.php.

References TYPO3\CMS\Install\FolderStructure\AbstractNode\exists(), TYPO3\CMS\Install\FolderStructure\AbstractNode\getAbsolutePath(), and TYPO3\CMS\Install\FolderStructure\AbstractNode\getRelativePathBelowSiteRoot().

Referenced by TYPO3\CMS\Install\FolderStructure\DirectoryNode\fixSelf().

◆ fixSelf()

TYPO3\CMS\Install\FolderStructure\DirectoryNode::fixSelf ( )
protected

Fix this directory:

  • create with correct permissions if it was not existing
  • if there is no "write" permissions, try to fix it
  • leave it alone otherwise
Returns
array<>

Definition at line 127 of file DirectoryNode.php.

References TYPO3\CMS\Install\FolderStructure\DirectoryNode\createDirectory(), TYPO3\CMS\Install\FolderStructure\AbstractNode\exists(), TYPO3\CMS\Install\FolderStructure\AbstractNode\fixPermission(), TYPO3\CMS\Install\FolderStructure\AbstractNode\getAbsolutePath(), TYPO3\CMS\Install\FolderStructure\AbstractNode\getRelativePathBelowSiteRoot(), TYPO3\CMS\Install\FolderStructure\DirectoryNode\isDirectory(), TYPO3\CMS\Install\FolderStructure\AbstractNode\isPermissionCorrect(), and TYPO3\CMS\Install\FolderStructure\DirectoryNode\isWritable().

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

◆ getSelfStatus()

TYPO3\CMS\Install\FolderStructure\DirectoryNode::getSelfStatus ( )
protected

Get status of directory - used in root and directory node

Returns
array<>

Definition at line 196 of file DirectoryNode.php.

References TYPO3\CMS\Install\FolderStructure\AbstractNode\getAbsolutePath(), TYPO3\CMS\Install\FolderStructure\AbstractNode\getCurrentPermission(), TYPO3\CMS\Install\FolderStructure\AbstractNode\getRelativePathBelowSiteRoot(), TYPO3\CMS\Install\FolderStructure\AbstractNode\getTargetPermission(), TYPO3\CMS\Install\FolderStructure\DirectoryNode\isDirectory(), TYPO3\CMS\Install\FolderStructure\AbstractNode\isPermissionCorrect(), and TYPO3\CMS\Install\FolderStructure\DirectoryNode\isWritable().

Referenced by TYPO3\CMS\Install\FolderStructure\RootNode\getStatus(), and TYPO3\CMS\Install\FolderStructure\DirectoryNode\getStatus().

◆ getStatus()

TYPO3\CMS\Install\FolderStructure\DirectoryNode::getStatus ( )

Get own status and status of child objects

Returns
array<>

Implements TYPO3\CMS\Install\FolderStructure\NodeInterface.

Definition at line 70 of file DirectoryNode.php.

References TYPO3\CMS\Install\FolderStructure\AbstractNode\exists(), TYPO3\CMS\Install\FolderStructure\AbstractNode\getRelativePathBelowSiteRoot(), and TYPO3\CMS\Install\FolderStructure\DirectoryNode\getSelfStatus().

◆ isDirectory()

TYPO3\CMS\Install\FolderStructure\DirectoryNode::isDirectory ( )
protected

Checks if not is a directory

Returns
bool True if node is a directory

Definition at line 269 of file DirectoryNode.php.

References TYPO3\CMS\Install\FolderStructure\AbstractNode\$name, and TYPO3\CMS\Install\FolderStructure\AbstractNode\getAbsolutePath().

Referenced by TYPO3\CMS\Install\FolderStructure\DirectoryNode\fixSelf(), and TYPO3\CMS\Install\FolderStructure\DirectoryNode\getSelfStatus().

◆ isWritable()

TYPO3\CMS\Install\FolderStructure\DirectoryNode::isWritable ( )

Create a test file and delete again if directory exists

Returns
bool TRUE if test file creation was successful

Implements TYPO3\CMS\Install\FolderStructure\NodeInterface.

Definition at line 90 of file DirectoryNode.php.

References TYPO3\CMS\Install\FolderStructure\DirectoryNode\canFileBeCreated(), TYPO3\CMS\Install\FolderStructure\AbstractNode\exists(), TYPO3\CMS\Install\FolderStructure\NodeInterface\fix(), and TYPO3\CMS\Install\FolderStructure\DirectoryNode\fixSelf().

Referenced by TYPO3\CMS\Install\FolderStructure\DirectoryNode\fixSelf(), and TYPO3\CMS\Install\FolderStructure\DirectoryNode\getSelfStatus().

Member Data Documentation

◆ $targetPermission

TYPO3\CMS\Install\FolderStructure\DirectoryNode::$targetPermission = '2775'
protected

Definition at line 28 of file DirectoryNode.php.