Sabre\DAV\Mock\SharedNode Class Reference

Inheritance diagram for Sabre\DAV\Mock\SharedNode:

Collaboration diagram for Sabre\DAV\Mock\SharedNode:

Public Member Functions
	__construct ($name, $access)
	getName ()
	Returns the name of the node. More...
	getShareAccess ()
	Returns the 'access level' for the instance of this shared resource. More...
	getShareResourceUri ()
	This function must return a URI that uniquely identifies the shared resource. More...
	updateInvites (array $sharees)
	Updates the list of sharees. More...
	getInvites ()
	Returns the list of people whom this resource is shared with. More...
Public Member Functions inherited from Sabre\DAV\Node
	getLastModified ()
	Returns the last modification time as a unix timestamp. More...
	delete ()
	Deletes the current node. More...
	setName ($name)
	Renames the node. More...

Protected Attributes
	$name
	$access
	$invites = []

Detailed Description

Definition at line 8 of file SharedNode.php.

Constructor & Destructor Documentation

__construct()

Sabre\DAV\Mock\SharedNode::__construct	(		$name,
			$access
	)

Definition at line 14 of file SharedNode.php.

References Sabre\DAV\Mock\SharedNode\$access, and Sabre\DAV\Mock\SharedNode\$name.

                                         {

        $this->name = $name;
        $this->access = $access;

    }

Member Function Documentation

getInvites()

Sabre\DAV\Mock\SharedNode::getInvites

(

)

Returns the list of people whom this resource is shared with.

Every item in the returned array must be a Sharee object with at least the following properties set:

• $href
• $shareAccess
• $inviteStatus

and optionally:

• $properties

Returns

[]

Implements Sabre\DAV\Sharing\ISharedNode.

Definition at line 120 of file SharedNode.php.

References Sabre\DAV\Mock\SharedNode\$invites.

                          {

        return $this->invites;

    }

getName()

Sabre\DAV\Mock\SharedNode::getName

(

)

Returns the name of the node.

This is used to generate the url.

Returns

string

Implements Sabre\DAV\INode.

Definition at line 21 of file SharedNode.php.

References Sabre\DAV\Mock\SharedNode\$name.

                       {

        return $this->name;

    }

getShareAccess()

Sabre\DAV\Mock\SharedNode::getShareAccess

(

)

Returns the 'access level' for the instance of this shared resource.

The value should be one of the Sabre::ACCESS_ constants.

Returns

int

Implements Sabre\DAV\Sharing\ISharedNode.

Definition at line 35 of file SharedNode.php.

References Sabre\DAV\Mock\SharedNode\$access.

                              {

        return $this->access;

    }

getShareResourceUri()

Sabre\DAV\Mock\SharedNode::getShareResourceUri

(

)

This function must return a URI that uniquely identifies the shared resource.

This URI should be identical across instances, and is also used in several other XML bodies to connect invites to resources.

This may simply be a relative reference to the original shared instance, but it could also be a urn. As long as it's a valid URI and unique.

Returns

string

Implements Sabre\DAV\Sharing\ISharedNode.

Definition at line 52 of file SharedNode.php.

                                   {

        return 'urn:example:bar';

    }

updateInvites()

Sabre\DAV\Mock\SharedNode::updateInvites

(

array

$sharees

)

Updates the list of sharees.

Every item must be a Sharee object.

Parameters

Sharee[]

$sharees

Returns

void

Implements Sabre\DAV\Sharing\ISharedNode.

Definition at line 66 of file SharedNode.php.

References Sabre\DAV\Sharing\Plugin\INVITE_NORESPONSE.

                                           {

        foreach ($sharees as $sharee) {

            if ($sharee->access === \Sabre\DAV\Sharing\Plugin::ACCESS_NOACCESS) {
                // Removal
                foreach ($this->invites as $k => $invitee) {

                    if ($invitee->href = $sharee->href) {
                        unset($this->invites[$k]);
                    }

                }

            } else {
                foreach ($this->invites as $k => $invitee) {

                    if ($invitee->href = $sharee->href) {
                        if (!$sharee->inviteStatus) {
                            $sharee->inviteStatus = $invitee->inviteStatus;
                        }
                        // Overwriting an existing invitee
                        $this->invites[$k] = $sharee;
                        continue 2;
                    }

                }
                if (!$sharee->inviteStatus) {
                    $sharee->inviteStatus = \Sabre\DAV\Sharing\Plugin::INVITE_NORESPONSE;
                }
                // Adding a new invitee
                $this->invites[] = $sharee;
            }

        }

    }

Field Documentation

$access

Sabre\DAV\Mock\SharedNode::$access

protected

Definition at line 11 of file SharedNode.php.

Referenced by Sabre\DAV\Mock\SharedNode\__construct(), and Sabre\DAV\Mock\SharedNode\getShareAccess().

$invites

Sabre\DAV\Mock\SharedNode::$invites = []

protected

Definition at line 12 of file SharedNode.php.

Referenced by Sabre\DAV\Mock\SharedNode\getInvites().

$name

Sabre\DAV\Mock\SharedNode::$name

protected

Definition at line 10 of file SharedNode.php.

Referenced by Sabre\DAV\Mock\SharedNode\__construct(), and Sabre\DAV\Mock\SharedNode\getName().

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/sabre/dav/tests/Sabre/DAV/Mock/SharedNode.php