Documentation

MockSyncCollection extends SimpleCollection
in package

Application

implements ISyncCollection

This mocks a ISyncCollection, for unittesting.

This object behaves the same as SimpleCollection. Call addChange to update the 'changelog' that this class uses for the collection.

Interfaces, Classes and Traits

ISyncCollection: If a class extends ISyncCollection, it supports WebDAV-sync.

$changeLog : mixed
$token : mixed
$children : array<string|int, INode>: List of childnodes.
$name : string: Name of this resource.
__construct() : mixed: Creates this node.
addChange() : mixed
addChild() : mixed: Adds a new childnode to this collection.
childExists() : bool: Checks is a child-node exists.
createDirectory() : mixed: Creates a new subdirectory.
createFile() : string|null: Creates a new file in the directory.
delete() : mixed: Deletes the current node.
getChanges() : array<string|int, mixed>: The getChanges method returns all the changes that have happened, since the specified syncToken and the current collection.
getChild() : INode: Returns a child object, by its name.
getChildren() : array<string|int, INode>: Returns a list of children for this collection.
getLastModified() : int: Returns the last modification time as a unix timestamp.
getName() : string: Returns the name of the collection.
getSyncToken() : string|null: This method returns the current sync-token for this collection.
setName() : mixed: Renames the node.

$changeLog


    public
        mixed
    $changeLog
     = []

$token


    public
        mixed
    $token
     = null

$children

List of childnodes.


    protected
        array<string|int, INode>
    $children
     = []

$name

Name of this resource.


    protected
        string
    $name

__construct()

Creates this node.


    public
                __construct(string $name[, array<string|int, INode> $children = [] ]) : mixed

The name of the node must be passed, child nodes can also be passed. This nodes must be instances of INode

Parameters

$name : string
$children : array<string|int, INode> = []

Return values

mixed —

addChange()


    public
                addChange(array<string|int, mixed> $added, array<string|int, mixed> $modified, array<string|int, mixed> $deleted) : mixed

Parameters

$added : array<string|int, mixed>
$modified : array<string|int, mixed>
$deleted : array<string|int, mixed>

Return values

mixed —

addChild()

Adds a new childnode to this collection.


    public
                addChild(INode $child) : mixed

Parameters

$child : INode

Return values

mixed —

childExists()

Checks is a child-node exists.


    public
                childExists(string $name) : bool

It is generally a good idea to try and override this. Usually it can be optimized.

Parameters

$name : string

Return values

bool —

createDirectory()

Creates a new subdirectory.


    public
                createDirectory(string $name) : mixed

Parameters

$name : string

Return values

mixed —

createFile()

Creates a new file in the directory.


    public
                createFile(string $name[, resource|string $data = null ]) : string|null

Data will either be supplied as a stream resource, or in certain cases as a string. Keep in mind that you may have to support either.

After successful creation of the file, you may choose to return the ETag of the new file here.

The returned ETag must be surrounded by double-quotes (The quotes should be part of the actual string).

If you cannot accurately determine the ETag, you should not return it. If you don't store the file exactly as-is (you're transforming it somehow) you should also not return an ETag.

This means that if a subsequent GET to this new file does not exactly return the same contents of what was submitted here, you are strongly recommended to omit the ETag.

Parameters

$name : string: Name of the file
$data : resource|string = null: Initial payload

Return values

string|null —

delete()

Deletes the current node.


    public
                delete() : mixed

Return values

mixed —

getChanges()

The getChanges method returns all the changes that have happened, since the specified syncToken and the current collection.


    public
                getChanges(string $syncToken, int $syncLevel[, int $limit = null ]) : array<string|int, mixed>

This function should return an array, such as the following:

array( 'syncToken' => 'The current synctoken', 'modified' => array( 'new.txt', ), 'deleted' => array( 'foo.php.bak', 'old.txt' ) );

The syncToken property should reflect the current syncToken of the collection, as reported getSyncToken(). This is needed here too, to ensure the operation is atomic.

If the syncToken is specified as null, this is an initial sync, and all members should be reported.

The modified property is an array of nodenames that have changed since the last token.

The deleted property is an array with nodenames, that have been deleted from collection.

The second argument is basically the 'depth' of the report. If it's 1, you only have to report changes that happened only directly in immediate descendants. If it's 2, it should also include changes from the nodes below the child collections. (grandchildren)

The third (optional) argument allows a client to specify how many results should be returned at most. If the limit is not specified, it should be treated as infinite.

If the limit (infinite or not) is higher than you're willing to return, you should throw a Sabre\DAV\Exception\TooMuchMatches() exception.

If the syncToken is expired (due to data cleanup) or unknown, you must return null.

The limit is 'suggestive'. You are free to ignore it.

Parameters

$syncToken : string
$syncLevel : int
$limit : int = null

Return values

array<string|int, mixed> —

getChild()

Returns a child object, by its name.


    public
                getChild(string $name) : INode

This method makes use of the getChildren method to grab all the child nodes, and compares the name. Generally its wise to override this, as this can usually be optimized

This method must throw Sabre\DAV\Exception\NotFound if the node does not exist.

Parameters

$name : string

Return values

INode —

getChildren()

Returns a list of children for this collection.


    public
                getChildren() : array<string|int, INode>

Return values

array<string|int, INode> —

getLastModified()

Returns the last modification time as a unix timestamp.


    public
                getLastModified() : int

If the information is not available, return null.

Return values

int —

getName()

Returns the name of the collection.


    public
                getName() : string

Return values

string —

getSyncToken()

This method returns the current sync-token for this collection.


    public
                getSyncToken() : string|null

This can be any string.

If null is returned from this function, the plugin assumes there's no sync information available.

Return values

string|null —

setName()

Renames the node.


    public
                setName(string $name) : mixed

Parameters

$name : string: The new name

Return values

mixed —