Docs For Class Gadget_Tree_FS

Description

Gadget_Tree_FS_Node

since: 1.0

Located in /Gadget/Tree/FS/Node.php (line 32)

Gadget_Tree_Node
   |
   --Gadget_Tree_FS_Node

Variable Summary

string $dirSep

bool $isDir

string $self

Method Summary

mixed &addChild (mixed &$child)

mixed addData (mixed $data)

mixed addMeta ()

mixed &addNewChild (mixed $name, [mixed $isDir = false])

string fullPath ()

int getHandle ()

bool isDir ()

mixed read (mixed $units)

array readDir (mixed $count)

mixed readFile (int $size)

mixed &setChild (mixed &$child, mixed $pos)

mixed setData (mixed $data)

mixed setMeta ()

mixed unlink ()

Variables

string $dirSep = DIRECTORY_SEPARATOR (line 59)

Directory Separator

bool $isDir = false (line 52)

isDir

Whether this filesystem node is a directory.

access: protected

string $self = __CLASS__ (line 42)

self

Contains the class name - used for addChild().

access: protected

Redefinition of:

Gadget_Tree_Node::$self: Name of Class

Inherited Variables

Inherited from Gadget_Tree_Node

Gadget_Tree_Node::$childs
Gadget_Tree_Node::$data
Gadget_Tree_Node::$following
Gadget_Tree_Node::$fullPath
Gadget_Tree_Node::$meta
Gadget_Tree_Node::$name
Gadget_Tree_Node::$parent
Gadget_Tree_Node::$preceding

Methods

addChild (line 164)

Add Child

access: public

mixed &addChild (mixed &$child)

Redefinition of:

Gadget_Tree_Node::addChild(): Add Child

addData (line 78)

Add Data

access: public

mixed addData (mixed $data)

Redefinition of:

Gadget_Tree_Node::addData(): Add Data

addMeta (line 136)

Add Meta

access: public

mixed addMeta ()

Redefinition of:

Gadget_Tree_Node::addMeta(): Add Meta

addNewChild (line 150)

Add New Child

access: public

mixed &addNewChild (mixed $name, [mixed $isDir = false])

Redefinition of:

Gadget_Tree_Node::addNewChild(): Add New Child

fullPath (line 193)

Full Path

Builds the full path of the filesystem node.

return: Returns the full path of the node.
access: public

string fullPath ()

Redefinition of:

Gadget_Tree_Node::fullPath(): Full Path

getHandle (line 232)

Get Handle

Returns a file (r+b) or directory handle.

return: Returns the resource of a file/directory handle.
access: public

int getHandle ()

isDir (line 67)

Is Dir

return: Returns true if node is a directory and false if not.
access: public

bool isDir ()

read (line 250)

Read

access: public

mixed read (mixed $units)

readDir (line 261)

Read Dir

access: public

array readDir (mixed $count)

readFile (line 281)

Read File

Requires PEAR::File.

access: public
see: File::read()

mixed readFile (int $size)

int $size: Bytes to read from the file. (0 reads all file)

setChild (line 204)

Set Child

access: public

mixed &setChild (mixed &$child, mixed $pos)

Redefinition of:

Gadget_Tree_Node::setChild(): Set Child

setData (line 100)

Set Data

access: public

mixed setData (mixed $data)

Redefinition of:

Gadget_Tree_Node::setData(): Set Data

setMeta (line 122)

Set Meta

access: public

mixed setMeta ()

Redefinition of:

Gadget_Tree_Node::setMeta(): Set Meta

unlink (line 218)

Unlink

access: public

mixed unlink ()

Inherited Methods

Inherited From Gadget_Tree_Node

Gadget_Tree_Node::Gadget_Tree_Node()
Gadget_Tree_Node::addChild()
Gadget_Tree_Node::addData()
Gadget_Tree_Node::addMeta()
Gadget_Tree_Node::addNewChild()
Gadget_Tree_Node::ancestor()
Gadget_Tree_Node::ancestorOrSelf()
Gadget_Tree_Node::child()
Gadget_Tree_Node::childAt()
Gadget_Tree_Node::count()
Gadget_Tree_Node::depth()
Gadget_Tree_Node::descendant()
Gadget_Tree_Node::descendantOrSelf()
Gadget_Tree_Node::firstChild()
Gadget_Tree_Node::following()
Gadget_Tree_Node::followingSibling()
Gadget_Tree_Node::fullPath()
Gadget_Tree_Node::getChildren()
Gadget_Tree_Node::getData()
Gadget_Tree_Node::getMeta()
Gadget_Tree_Node::getName()
Gadget_Tree_Node::insertChild()
Gadget_Tree_Node::lastChild()
Gadget_Tree_Node::linkFollowing()
Gadget_Tree_Node::linkPreceding()
Gadget_Tree_Node::parent()
Gadget_Tree_Node::position()
Gadget_Tree_Node::preceding()
Gadget_Tree_Node::precedingSibling()
Gadget_Tree_Node::removeChild()
Gadget_Tree_Node::replaceChild()
Gadget_Tree_Node::resetLinks()
Gadget_Tree_Node::setChild()
Gadget_Tree_Node::setData()
Gadget_Tree_Node::setMeta()
Gadget_Tree_Node::setParent()
Gadget_Tree_Node::toArray()

Class Gadget_Tree_FS_Node

Inherited Variables

Inherited Methods