RootNodeInterface extends NodeInterface
Interface implemented by root node
Table of Contents
Methods
- __construct() : mixed
- Constructor gets structure and parent object defaulting to NULL
- fix() : FlashMessage[]
- Fix structure
- getAbsolutePath() : string
- Get absolute path of node
- getName() : string
- Get node name
- getStatus() : FlashMessage[]
- Get the status of the object tree, recursive for directory and root node
- isWritable() : bool
- Check if node is writable - can be created and permission can be fixed
Methods
__construct()
Constructor gets structure and parent object defaulting to NULL
public
__construct(array $structure[, NodeInterface $parent = null ]) : mixed
Parameters
- $structure : array
-
Structure
- $parent : NodeInterface = null
-
Parent
fix()
Fix structure
public
fix() : FlashMessage[]
If there is nothing to fix, returns an empty array
Return values
FlashMessage[]getAbsolutePath()
Get absolute path of node
public
getAbsolutePath() : string
Return values
string —Absolute path
getName()
Get node name
public
getName() : string
Return values
string —Node name
getStatus()
Get the status of the object tree, recursive for directory and root node
public
getStatus() : FlashMessage[]
Return values
FlashMessage[]isWritable()
Check if node is writable - can be created and permission can be fixed
public
isWritable() : bool
Return values
bool —TRUE if node is writable