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

Public Member Functions

 getName ()
 
 getAbsolutePath ()
 
 isWritable ()
 

Protected Member Functions

 getTargetPermission ()
 
 setTargetPermission ($permission)
 
 getChildren ()
 
 getParent ()
 
 exists ()
 
 fixPermission ()
 
 isPermissionCorrect ()
 
 getCurrentPermission ()
 
 isWindowsOs ()
 
 getRelativePathBelowSiteRoot ($path=null)
 

Protected Attributes

 $name = ''
 
 $targetPermission = null
 
 $parent = null
 
 $children = []
 

Detailed Description

Abstract node implements common methods

Definition at line 22 of file AbstractNode.php.

Member Function Documentation

◆ exists()

TYPO3\CMS\Install\FolderStructure\AbstractNode::exists ( )
protected

Checks if node exists. Returns TRUE if it is there, even if it is only a link. Does not check the type!

Returns
bool

Definition at line 128 of file AbstractNode.php.

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

Referenced by TYPO3\CMS\Install\FolderStructure\DirectoryNode\createDirectory(), TYPO3\CMS\Install\FolderStructure\FileNode\createFile(), TYPO3\CMS\Install\FolderStructure\FileNode\fixSelf(), TYPO3\CMS\Install\FolderStructure\DirectoryNode\fixSelf(), TYPO3\CMS\Install\FolderStructure\RootNode\getStatus(), TYPO3\CMS\Install\FolderStructure\LinkNode\getStatus(), TYPO3\CMS\Install\FolderStructure\DirectoryNode\getStatus(), TYPO3\CMS\Install\FolderStructure\FileNode\getStatus(), TYPO3\CMS\Install\FolderStructure\LinkNode\isLink(), TYPO3\CMS\Install\FolderStructure\LinkNode\isTargetCorrect(), and TYPO3\CMS\Install\FolderStructure\DirectoryNode\isWritable().

◆ fixPermission()

TYPO3\CMS\Install\FolderStructure\AbstractNode::fixPermission ( )
protected

Fix permission if they are not equal to target permission

Exceptions
Exception
Returns

Definition at line 143 of file AbstractNode.php.

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

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

◆ getAbsolutePath()

TYPO3\CMS\Install\FolderStructure\AbstractNode::getAbsolutePath ( )

Get absolute path of node

Returns
string

Definition at line 106 of file AbstractNode.php.

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

Referenced by TYPO3\CMS\Install\FolderStructure\DirectoryNode\canFileBeCreated(), TYPO3\CMS\Install\FolderStructure\DirectoryNode\createDirectory(), TYPO3\CMS\Install\FolderStructure\FileNode\createFile(), TYPO3\CMS\Install\FolderStructure\AbstractNode\exists(), TYPO3\CMS\Install\FolderStructure\AbstractNode\fixPermission(), TYPO3\CMS\Install\FolderStructure\FileNode\fixSelf(), TYPO3\CMS\Install\FolderStructure\DirectoryNode\fixSelf(), TYPO3\CMS\Install\FolderStructure\AbstractNode\getCurrentPermission(), TYPO3\CMS\Install\FolderStructure\LinkNode\getCurrentTarget(), TYPO3\CMS\Install\FolderStructure\AbstractNode\getRelativePathBelowSiteRoot(), TYPO3\CMS\Install\FolderStructure\FileNode\getSelfStatus(), TYPO3\CMS\Install\FolderStructure\DirectoryNode\getSelfStatus(), TYPO3\CMS\Install\FolderStructure\LinkNode\getStatus(), TYPO3\CMS\Install\FolderStructure\FileNode\isContentCorrect(), TYPO3\CMS\Install\FolderStructure\DirectoryNode\isDirectory(), TYPO3\CMS\Install\FolderStructure\FileNode\isFile(), TYPO3\CMS\Install\FolderStructure\LinkNode\isLink(), and TYPO3\CMS\Install\FolderStructure\FileNode\setContent().

◆ getChildren()

TYPO3\CMS\Install\FolderStructure\AbstractNode::getChildren ( )
protected

Get children

Returns
array

Definition at line 86 of file AbstractNode.php.

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

◆ getCurrentPermission()

TYPO3\CMS\Install\FolderStructure\AbstractNode::getCurrentPermission ( )
protected

Get current permission of node

Returns
string, eg. 2775 for dirs, 0664 for files

Definition at line 188 of file AbstractNode.php.

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

Referenced by TYPO3\CMS\Install\FolderStructure\FileNode\getSelfStatus(), TYPO3\CMS\Install\FolderStructure\DirectoryNode\getSelfStatus(), and TYPO3\CMS\Install\FolderStructure\AbstractNode\isPermissionCorrect().

◆ getName()

TYPO3\CMS\Install\FolderStructure\AbstractNode::getName ( )

Get name

Returns
string Name

Definition at line 49 of file AbstractNode.php.

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

◆ getParent()

TYPO3\CMS\Install\FolderStructure\AbstractNode::getParent ( )
protected

Get parent

Returns
NULL|NodeInterface

Definition at line 96 of file AbstractNode.php.

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

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

◆ getRelativePathBelowSiteRoot()

TYPO3\CMS\Install\FolderStructure\AbstractNode::getRelativePathBelowSiteRoot (   $path = null)
protected

Cut off PATH_site from given path

Parameters
string$pathGiven path
Returns
string Relative path, but beginning with /
Exceptions
Exception

Definition at line 214 of file AbstractNode.php.

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

Referenced by TYPO3\CMS\Install\FolderStructure\DirectoryNode\createDirectory(), TYPO3\CMS\Install\FolderStructure\FileNode\createFile(), TYPO3\CMS\Install\FolderStructure\AbstractNode\fixPermission(), TYPO3\CMS\Install\FolderStructure\FileNode\fixSelf(), TYPO3\CMS\Install\FolderStructure\DirectoryNode\fixSelf(), TYPO3\CMS\Install\FolderStructure\FileNode\getSelfStatus(), TYPO3\CMS\Install\FolderStructure\DirectoryNode\getSelfStatus(), TYPO3\CMS\Install\FolderStructure\LinkNode\getStatus(), TYPO3\CMS\Install\FolderStructure\DirectoryNode\getStatus(), TYPO3\CMS\Install\FolderStructure\FileNode\getStatus(), and TYPO3\CMS\Install\FolderStructure\FileNode\setContent().

◆ getTargetPermission()

TYPO3\CMS\Install\FolderStructure\AbstractNode::getTargetPermission ( )
protected

Get target permission

Make sure to call octdec on the value when passing this to chmod

Returns
string Permissions as a 4 character octal string, i.e. 2775 or 0644

Definition at line 61 of file AbstractNode.php.

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

Referenced by TYPO3\CMS\Install\FolderStructure\AbstractNode\fixPermission(), TYPO3\CMS\Install\FolderStructure\FileNode\getSelfStatus(), TYPO3\CMS\Install\FolderStructure\DirectoryNode\getSelfStatus(), and TYPO3\CMS\Install\FolderStructure\AbstractNode\isPermissionCorrect().

◆ isPermissionCorrect()

TYPO3\CMS\Install\FolderStructure\AbstractNode::isPermissionCorrect ( )
protected

Checks if current permission are identical to target permission

Returns
bool

Definition at line 171 of file AbstractNode.php.

References TYPO3\CMS\Install\FolderStructure\AbstractNode\getCurrentPermission(), TYPO3\CMS\Install\FolderStructure\AbstractNode\getTargetPermission(), and TYPO3\CMS\Install\FolderStructure\AbstractNode\isWindowsOs().

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

◆ isWindowsOs()

TYPO3\CMS\Install\FolderStructure\AbstractNode::isWindowsOs ( )
protected

Returns TRUE if OS is windows

Returns
bool TRUE on windows

Definition at line 199 of file AbstractNode.php.

Referenced by TYPO3\CMS\Install\FolderStructure\RootNode\__construct(), TYPO3\CMS\Install\FolderStructure\LinkNode\getStatus(), and TYPO3\CMS\Install\FolderStructure\AbstractNode\isPermissionCorrect().

◆ isWritable()

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

Current node is writable if parent is writable

Returns
bool TRUE if parent is writable

Definition at line 116 of file AbstractNode.php.

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

Referenced by TYPO3\CMS\Install\FolderStructure\FileNode\getSelfStatus().

◆ setTargetPermission()

TYPO3\CMS\Install\FolderStructure\AbstractNode::setTargetPermission (   $permission)
protected

Set target permission

Parameters
string$permissionPermissions as a 4 character octal string, i.e. 2775 or 0644
Returns
void

Definition at line 73 of file AbstractNode.php.

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

Member Data Documentation

◆ $children

TYPO3\CMS\Install\FolderStructure\AbstractNode::$children = []
protected

Definition at line 42 of file AbstractNode.php.

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

◆ $name

TYPO3\CMS\Install\FolderStructure\AbstractNode::$name = ''
protected

Definition at line 27 of file AbstractNode.php.

Referenced by TYPO3\CMS\Install\FolderStructure\RootNode\getAbsolutePath(), TYPO3\CMS\Install\FolderStructure\AbstractNode\getAbsolutePath(), TYPO3\CMS\Install\FolderStructure\AbstractNode\getName(), and TYPO3\CMS\Install\FolderStructure\DirectoryNode\isDirectory().

◆ $parent

TYPO3\CMS\Install\FolderStructure\AbstractNode::$parent = null
protected

Definition at line 37 of file AbstractNode.php.

Referenced by TYPO3\CMS\Install\FolderStructure\RootNode\__construct(), TYPO3\CMS\Install\FolderStructure\LinkNode\__construct(), TYPO3\CMS\Install\FolderStructure\DirectoryNode\__construct(), TYPO3\CMS\Install\FolderStructure\FileNode\__construct(), and TYPO3\CMS\Install\FolderStructure\AbstractNode\getParent().

◆ $targetPermission

TYPO3\CMS\Install\FolderStructure\AbstractNode::$targetPermission = null
protected

Definition at line 32 of file AbstractNode.php.

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