Documentation

Node
in package
implements INode

Base node-class.

The node class implements the method used by both the File and the Directory classes

Tags
copyright

Copyright (C) fruux GmbH (https://fruux.com/)

author

Evert Pot (http://evertpot.com/)

license

http://sabre.io/license/ Modified BSD License

Interfaces, Classes and Traits

INode
The INode interface is the base interface, and the parent class of both ICollection and IFile.

Table of Contents

$overrideName  : string
The overridden name of the node.
$path  : string
The path to the current node.
__construct()  : mixed
Sets up the node, expects a full path name.
getLastModified()  : int
Returns the last modification time, as a unix timestamp.
getName()  : string
Returns the name of the node.
setName()  : mixed
Renames the node.

Properties

$overrideName

The overridden name of the node.

protected string $overrideName

$path

The path to the current node.

protected string $path

Methods

__construct()

Sets up the node, expects a full path name.

public __construct(string $path[, string $overrideName = null ]) : mixed

If $overrideName is set, this node shows up in the tree under a different name. In this case setName() will be disabled.

Parameters
$path : string
$overrideName : string = null
Return values
mixed

getLastModified()

Returns the last modification time, as a unix timestamp.

public getLastModified() : int
Return values
int

getName()

Returns the name of the node.

public getName() : string
Return values
string

setName()

Renames the node.

public setName(string $name) : mixed
Parameters
$name : string

The new name

Return values
mixed

Search results