This class holds all the information about a PROPFIND request. More...

Inheritance diagram for Sabre\DAV\PropFind:

Collaboration diagram for Sabre\DAV\PropFind:

Public Member Functions
	__construct ($path, array $properties, $depth=0, $requestType=self::NORMAL)
	Creates the PROPFIND object. More...

	handle ($propertyName, $valueOrCallBack)
	Handles a specific property. More...

	set ($propertyName, $value, $status=null)
	Sets the value of the property. More...

	get ($propertyName)
	Returns the current value for a property. More...

	getStatus ($propertyName)
	Returns the current status code for a property name. More...

	setPath ($path)
	Updates the path for this PROPFIND. More...

	getPath ()
	Returns the path this PROPFIND request is for. More...

	getDepth ()
	Returns the depth of this propfind request. More...

	setDepth ($depth)
	Updates the depth of this propfind request. More...

	get404Properties ()
	Returns all propertynames that have a 404 status, and thus don't have a value yet. More...

	getRequestedProperties ()
	Returns the full list of requested properties. More...

	isAllProps ()
	Returns true if this was an '{DAV:}allprops' request. More...

	getResultForMultiStatus ()
	Returns a result array that's often used in multistatus responses. More...

Data Fields
const	NORMAL = 0
	A normal propfind. More...

const	ALLPROPS = 1
	An allprops request. More...

const	PROPNAME = 2
	A propname request. More...

Protected Attributes
	$path

	$depth = 0

	$requestType
	The type of request. More...

	$properties = []

	$result = []

	$itemsLeft

Detailed Description

This class holds all the information about a PROPFIND request.

It contains the type of PROPFIND request, which properties were requested and also the returned items.

Definition at line 11 of file PropFind.php.

Constructor & Destructor Documentation

◆ __construct()

Sabre\DAV\PropFind::__construct	(		$path,
		array	$properties,
			$depth = `0`,
			$requestType = `self::NORMAL`
	)

Creates the PROPFIND object.

Parameters

string	$path
array	$properties
int	$depth
int	$requestType

Definition at line 43 of file PropFind.php.

                                                                                          {
 
        $this->path = $path;
        $this->properties = $properties;
        $this->depth = $depth;
        $this->requestType = $requestType;
 
        if ($requestType === self::ALLPROPS) {
            $this->properties = [
                '{DAV:}getlastmodified',
                '{DAV:}getcontentlength',
                '{DAV:}resourcetype',
                '{DAV:}quota-used-bytes',
                '{DAV:}quota-available-bytes',
                '{DAV:}getetag',
                '{DAV:}getcontenttype',
            ];
        }
 
        foreach ($this->properties as $propertyName) {
 
            // Seeding properties with 404's.
            $this->result[$propertyName] = [404, null];
 
        }
        $this->itemsLeft = count($this->result);
 
    }

References Sabre\DAV\PropFind\$depth, Sabre\DAV\PropFind\$path, Sabre\DAV\PropFind\$properties, and Sabre\DAV\PropFind\$requestType.

Member Function Documentation

◆ get()

Sabre\DAV\PropFind::get ( $propertyName )

Returns the current value for a property.

Parameters

string $propertyName

Returns: mixed

Reimplemented in Sabre\DAV\Browser\PropFindAll.

Definition at line 149 of file PropFind.php.

                                {
 
        return isset($this->result[$propertyName]) ? $this->result[$propertyName][1] : null;
 
    }

Referenced by Sabre\DAV\CorePlugin\propFindLate().

Here is the caller graph for this function:

◆ get404Properties()

Sabre\DAV\PropFind::get404Properties ( )

Returns all propertynames that have a 404 status, and thus don't have a value yet.

Returns: array

Reimplemented in Sabre\DAV\Browser\PropFindAll.

Definition at line 222 of file PropFind.php.

                                {
 
        if ($this->itemsLeft === 0) {
            return [];
        }
        $result = [];
        foreach ($this->result as $propertyName => $stuff) {
            if ($stuff[0] === 404) {
                $result[] = $propertyName;
            }
        }
        return $result;
 
    }

References Sabre\DAV\PropFind\$result.

Referenced by Sabre\DAV\PropertyStorage\Backend\PDO\propFind(), and Sabre\DAV\CorePlugin\propFindNode().

Here is the caller graph for this function:

◆ getDepth()

Sabre\DAV\PropFind::getDepth ( )

Returns the depth of this propfind request.

Returns: int

Definition at line 198 of file PropFind.php.

                        {
 
        return $this->depth;
 
    }

References Sabre\DAV\PropFind\$depth.

Referenced by Sabre\DAV\Server\generatePathNodes().

Here is the caller graph for this function:

◆ getPath()

Sabre\DAV\PropFind::getPath ( )

Returns the path this PROPFIND request is for.

Returns: string

Definition at line 187 of file PropFind.php.

                       {
 
        return $this->path;
 
    }

References Sabre\DAV\PropFind\$path.

Referenced by Sabre\DAV\Server\generatePathNodes(), Sabre\CalDAV\Schedule\Plugin\propFind(), Sabre\DAV\Browser\GuessContentType\propFind(), Sabre\DAV\CorePlugin\propFind(), Sabre\DAV\PropertyStorage\Plugin\propFind(), and Sabre\DAV\CorePlugin\propFindLate().

Here is the caller graph for this function:

◆ getRequestedProperties()

Sabre\DAV\PropFind::getRequestedProperties ( )

Returns the full list of requested properties.

This returns just their names, not a status or value.

Returns: array

Definition at line 244 of file PropFind.php.

                                      {
 
        return $this->properties;
 
    }

References Sabre\DAV\PropFind\$properties.

◆ getResultForMultiStatus()

Sabre\DAV\PropFind::getResultForMultiStatus ( )

Returns a result array that's often used in multistatus responses.

The array uses status codes as keys, and property names and value pairs as the value of the top array.. such as :

[ 200 => [ '{DAV:}displayname' => 'foo' ], ]

Returns: array

Definition at line 273 of file PropFind.php.

                                       {
 
        $r = [
            200 => [],
            404 => [],
        ];
        foreach ($this->result as $propertyName => $info) {
            if (!isset($r[$info[0]])) {
                $r[$info[0]] = [$propertyName => $info[1]];
            } else {
                $r[$info[0]][$propertyName] = $info[1];
            }
        }
        // Removing the 404's for multi-status requests.
        if ($this->requestType === self::ALLPROPS) unset($r[404]);
        return $r;
 
    }

References $info, and $r.

◆ getStatus()

Sabre\DAV\PropFind::getStatus ( $propertyName )

Returns the current status code for a property name.

If the property does not appear in the list of requested properties, null will be returned.

Parameters

string $propertyName

Returns: int|null

Reimplemented in Sabre\DAV\Browser\PropFindAll.

Definition at line 164 of file PropFind.php.

                                      {
 
        return isset($this->result[$propertyName]) ? $this->result[$propertyName][0] : null;
 
    }

Referenced by Sabre\CalDAV\Subscriptions\Plugin\propFind().

Here is the caller graph for this function:

◆ handle()

Sabre\DAV\PropFind::handle	(	$propertyName,
		$valueOrCallBack
	)

Handles a specific property.

This method checks whether the specified property was requested in this PROPFIND request, and if so, it will call the callback and use the return value for it's value.

Example:

$propFind->handle('{DAV:}displayname', function() { return 'hello'; });

Note that handle will only work the first time. If null is returned, the value is ignored.

It's also possible to not pass a callback, but immediately pass a value

Parameters

string	$propertyName
mixed	$valueOrCallBack

Returns: void

Reimplemented in Sabre\DAV\Browser\PropFindAll.

Definition at line 94 of file PropFind.php.

                                                     {
 
        if ($this->itemsLeft && isset($this->result[$propertyName]) && $this->result[$propertyName][0] === 404) {
            if (is_callable($valueOrCallBack)) {
                $value = $valueOrCallBack();
            } else {
                $value = $valueOrCallBack;
            }
            if (!is_null($value)) {
                $this->itemsLeft--;
                $this->result[$propertyName] = [200, $value];
            }
        }
 
    }

Referenced by Sabre\CalDAV\Notifications\Plugin\propFind(), Sabre\CalDAV\Schedule\Plugin\propFind(), Sabre\DAV\Browser\GuessContentType\propFind(), Sabre\DAV\CorePlugin\propFind(), Sabre\DAV\Sharing\Plugin\propFind(), and Sabre\DAV\CorePlugin\propFindLate().

Here is the caller graph for this function:

◆ isAllProps()

Sabre\DAV\PropFind::isAllProps ( )

Returns true if this was an '{DAV:}allprops' request.

Returns: bool

Definition at line 255 of file PropFind.php.

                          {
 
        return $this->requestType === self::ALLPROPS;
 
    }

References Sabre\DAV\PropFind\ALLPROPS.

Referenced by Sabre\DAV\PropertyStorage\Backend\PDO\propFind().

Here is the caller graph for this function:

◆ set()

Sabre\DAV\PropFind::set	(	$propertyName,
		$value,
		$status = `null`
	)

Sets the value of the property.

If status is not supplied, the status will default to 200 for non-null properties, and 404 for null properties.

Parameters

string	$propertyName
mixed	$value
int	$status

Returns: void

Reimplemented in Sabre\DAV\Browser\PropFindAll.

Definition at line 121 of file PropFind.php.

                                                        {
 
        if (is_null($status)) {
            $status = is_null($value) ? 404 : 200;
        }
        // If this is an ALLPROPS request and the property is
        // unknown, add it to the result; else ignore it:
        if (!isset($this->result[$propertyName])) {
            if ($this->requestType === self::ALLPROPS) {
                $this->result[$propertyName] = [$status, $value];
            }
            return;
        }
        if ($status !== 404 && $this->result[$propertyName][0] === 404) {
            $this->itemsLeft--;
        } elseif ($status === 404 && $this->result[$propertyName][0] !== 404) {
            $this->itemsLeft++;
        }
        $this->result[$propertyName] = [$status, $value];
 
    }

Referenced by Sabre\DAV\PropertyStorage\Backend\PDO\propFind(), Sabre\DAV\PropertyStorage\Backend\Mock\propFind(), Sabre\CalDAV\Schedule\Plugin\propFind(), Sabre\CalDAV\Subscriptions\Plugin\propFind(), and Sabre\DAV\CorePlugin\propFindNode().

Here is the caller graph for this function:

◆ setDepth()

Sabre\DAV\PropFind::setDepth ( $depth )

Updates the depth of this propfind request.

Parameters

int $depth

Returns: void

Definition at line 210 of file PropFind.php.

                              {
 
        $this->depth = $depth;
 
    }

References Sabre\DAV\PropFind\$depth.

Referenced by Sabre\DAV\Server\generatePathNodes().

Here is the caller graph for this function:

◆ setPath()

Sabre\DAV\PropFind::setPath ( $path )

Updates the path for this PROPFIND.

Parameters

string $path

Returns: void

Definition at line 176 of file PropFind.php.

                            {
 
        $this->path = $path;
 
    }

References Sabre\DAV\PropFind\$path.

Field Documentation

◆ $depth

Sabre\DAV\PropFind::$depth = 0

protected

Definition at line 307 of file PropFind.php.

Referenced by Sabre\DAV\PropFind\__construct(), Sabre\DAV\PropFind\getDepth(), and Sabre\DAV\PropFind\setDepth().

◆ $itemsLeft

Sabre\DAV\PropFind::$itemsLeft

protected

Definition at line 345 of file PropFind.php.

◆ $path

Sabre\DAV\PropFind::$path

protected

Definition at line 297 of file PropFind.php.

Referenced by Sabre\DAV\Browser\PropFindAll\__construct(), Sabre\DAV\PropFind\__construct(), Sabre\DAV\PropFind\getPath(), and Sabre\DAV\PropFind\setPath().

◆ $properties

Sabre\DAV\PropFind::$properties = []

protected

Definition at line 319 of file PropFind.php.

Referenced by Sabre\DAV\PropFind\__construct(), and Sabre\DAV\PropFind\getRequestedProperties().

◆ $requestType

Sabre\DAV\PropFind::$requestType

protected

The type of request.

See the TYPE constants

Definition at line 312 of file PropFind.php.

Referenced by Sabre\DAV\PropFind\__construct().

◆ $result

Sabre\DAV\PropFind::$result = []

protected

Definition at line 337 of file PropFind.php.

Referenced by Sabre\DAV\Browser\PropFindAll\get404Properties(), and Sabre\DAV\PropFind\get404Properties().

◆ ALLPROPS

const Sabre\DAV\PropFind::ALLPROPS = 1

An allprops request.

While this was originally intended for instructing the server to really fetch every property, because it was used so often and it's so heavy this turned into a small list of default properties after a while.

So 'all properties' now means a hardcoded list.

Definition at line 27 of file PropFind.php.

Referenced by Sabre\DAV\Server\getPropertiesIteratorForPath(), Sabre\DAV\PropFind\isAllProps(), Sabre\DAV\PropFindTest\testAllPropDefaults(), and Sabre\DAV\PropFindTest\testSetAllpropCustom().

◆ NORMAL

const Sabre\DAV\PropFind::NORMAL = 0

A normal propfind.

Definition at line 16 of file PropFind.php.

Referenced by Sabre\DAV\Server\getPropertiesIteratorForPath().

◆ PROPNAME

const Sabre\DAV\PropFind::PROPNAME = 2

A propname request.

This just returns a list of properties that are defined on a node, without their values.

Definition at line 33 of file PropFind.php.

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

libs/composer/vendor/sabre/dav/lib/DAV/PropFind.php

Public Member Functions

Data Fields

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ get()

◆ get404Properties()

◆ getDepth()

◆ getPath()

◆ getRequestedProperties()

◆ getResultForMultiStatus()

◆ getStatus()

◆ handle()

◆ isAllProps()

◆ set()

◆ setDepth()

◆ setPath()

Field Documentation

◆ $depth

◆ $itemsLeft

◆ $path

◆ $properties

◆ $requestType

◆ $result

◆ ALLPROPS

◆ NORMAL

◆ PROPNAME