‪TYPO3CMS  10.4
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)
 
FlashMessage[] getStatus ()
 
bool isWritable ()
 
FlashMessage[] fix ()
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Install\FolderStructure\AbstractNode
string getName ()
 
string getAbsolutePath ()
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Install\FolderStructure\NodeInterface
string getName ()
 
string getAbsolutePath ()
 

Protected Member Functions

FlashMessage[] fixSelf ()
 
FlashMessage createDirectory ()
 
FlashMessage[] getSelfStatus ()
 
FlashMessage[] getChildrenStatus ()
 
bool canFileBeCreated ()
 
bool isDirectory ()
 
 createChildren (array $structure)
 
- ‪Protected Member Functions inherited from ‪TYPO3\CMS\Install\FolderStructure\AbstractNode
string getTargetPermission ()
 
 setTargetPermission ($permission)
 
array getChildren ()
 
NodeInterface null getParent ()
 
bool exists ()
 
FlashMessage fixPermission ()
 
bool isPermissionCorrect ()
 
string getCurrentPermission ()
 
bool isWindowsOs ()
 
string getRelativePathBelowSiteRoot ($path=null)
 

Protected Attributes

string $targetPermission = '2775'
 
- ‪Protected Attributes inherited from ‪TYPO3\CMS\Install\FolderStructure\AbstractNode
string $name = ''
 
string null $targetPermission
 
NodeInterface null $parent
 
array $children = array( )
 

Detailed Description

A directory

This class is only meant to be used within EXT:install and is not part of the TYPO3 Core API.

Definition at line 26 of file DirectoryNode.php.

Constructor & Destructor Documentation

◆ __construct()

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

Implement constructor

Parameters
array$structure‪Structure array
NodeInterface$parent‪Parent object
Exceptions
Exception

Implements TYPO3\CMS\Install\FolderStructure\NodeInterface.

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

Definition at line 39 of file DirectoryNode.php.

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

Member Function Documentation

◆ canFileBeCreated()

bool 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 255 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().

◆ createChildren()

TYPO3\CMS\Install\FolderStructure\DirectoryNode::createChildren ( array  $structure)
protected

Create children nodes - done in directory and root node

Parameters
array$structure‪Array of children
Exceptions
Exception

Definition at line 282 of file DirectoryNode.php.

References TYPO3\CMS\Install\FolderStructure\AbstractNode\$name.

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

◆ createDirectory()

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

Create directory if not exists

Exceptions
Exception
Returns
‪FlashMessage

Definition at line 174 of file DirectoryNode.php.

References TYPO3\CMS\Core\Messaging\AbstractMessage\ERROR, 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().

◆ fix()

FlashMessage [] TYPO3\CMS\Install\FolderStructure\DirectoryNode::fix ( )

Fix structure

If there is nothing to fix, returns an empty array

Returns
‪FlashMessage[]

Implements TYPO3\CMS\Install\FolderStructure\NodeInterface.

Definition at line 112 of file DirectoryNode.php.

References TYPO3\CMS\Install\FolderStructure\DirectoryNode\fixSelf().

◆ fixSelf()

FlashMessage [] 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
‪FlashMessage[]

Definition at line 131 of file DirectoryNode.php.

References TYPO3\CMS\Install\FolderStructure\DirectoryNode\createDirectory(), TYPO3\CMS\Core\Messaging\AbstractMessage\ERROR, 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\DirectoryNode\isWritable(), and TYPO3\CMS\Core\Messaging\AbstractMessage\OK.

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

◆ getChildrenStatus()

FlashMessage [] TYPO3\CMS\Install\FolderStructure\DirectoryNode::getChildrenStatus ( )
protected

Get status of children

Returns
‪FlashMessage[]

Definition at line 240 of file DirectoryNode.php.

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

◆ getSelfStatus()

FlashMessage [] TYPO3\CMS\Install\FolderStructure\DirectoryNode::getSelfStatus ( )
protected

Get status of directory - used in root and directory node

Returns
‪FlashMessage[]

Definition at line 202 of file DirectoryNode.php.

References TYPO3\CMS\Core\Messaging\AbstractMessage\ERROR, 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(), TYPO3\CMS\Install\FolderStructure\DirectoryNode\isWritable(), and TYPO3\CMS\Core\Messaging\AbstractMessage\NOTICE.

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

◆ getStatus()

FlashMessage [] TYPO3\CMS\Install\FolderStructure\DirectoryNode::getStatus ( )

Get own status and status of child objects

Returns
‪FlashMessage[]

Implements TYPO3\CMS\Install\FolderStructure\NodeInterface.

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

Definition at line 72 of file DirectoryNode.php.

References TYPO3\CMS\Install\FolderStructure\AbstractNode\exists(), TYPO3\CMS\Install\FolderStructure\DirectoryNode\getChildrenStatus(), TYPO3\CMS\Install\FolderStructure\AbstractNode\getRelativePathBelowSiteRoot(), TYPO3\CMS\Install\FolderStructure\DirectoryNode\getSelfStatus(), and TYPO3\CMS\Core\Messaging\AbstractMessage\WARNING.

◆ isDirectory()

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

Checks if not is a directory

Returns
‪bool True if node is a directory

Definition at line 270 of file DirectoryNode.php.

References TYPO3\CMS\Install\FolderStructure\AbstractNode\getAbsolutePath().

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

◆ isWritable()

bool 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

Reimplemented from TYPO3\CMS\Install\FolderStructure\AbstractNode.

Definition at line 94 of file DirectoryNode.php.

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

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

Member Data Documentation

◆ $targetPermission

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

Default for directories is octal 02775 == decimal 1533

Definition at line 30 of file DirectoryNode.php.