blob: 1ac43967276029591ae393878eab396aeafd351a (
plain) (
tree)
|
|
<?php
namespace Sabre\DAV\Browser;
use Sabre\DAV\PropFind;
/**
* This class is used by the browser plugin to trick the system in returning
* every defined property.
*
* @copyright Copyright (C) fruux GmbH (https://fruux.com/)
* @author Evert Pot (http://evertpot.com/)
* @license http://sabre.io/license/ Modified BSD License
*/
class PropFindAll extends PropFind {
/**
* Creates the PROPFIND object
*
* @param string $path
*/
function __construct($path) {
parent::__construct($path, []);
}
/**
* Handles a specific property.
*
* This method checks wether 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
*
* @param string $propertyName
* @param mixed $valueOrCallBack
* @return void
*/
function handle($propertyName, $valueOrCallBack) {
if (is_callable($valueOrCallBack)) {
$value = $valueOrCallBack();
} else {
$value = $valueOrCallBack;
}
if (!is_null($value)) {
$this->result[$propertyName] = [200, $value];
}
}
/**
* 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.
*
* @param string $propertyName
* @param mixed $value
* @param int $status
* @return void
*/
function set($propertyName, $value, $status = null) {
if (is_null($status)) {
$status = is_null($value) ? 404 : 200;
}
$this->result[$propertyName] = [$status, $value];
}
/**
* Returns the current value for a property.
*
* @param string $propertyName
* @return mixed
*/
function get($propertyName) {
return isset($this->result[$propertyName]) ? $this->result[$propertyName][1] : null;
}
/**
* 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.
*
* @param string $propertyName
* @return int|null
*/
function getStatus($propertyName) {
return isset($this->result[$propertyName]) ? $this->result[$propertyName][0] : 404;
}
/**
* Returns all propertynames that have a 404 status, and thus don't have a
* value yet.
*
* @return array
*/
function get404Properties() {
$result = [];
foreach ($this->result as $propertyName => $stuff) {
if ($stuff[0] === 404) {
$result[] = $propertyName;
}
}
// If there's nothing in this list, we're adding one fictional item.
if (!$result) {
$result[] = '{http://sabredav.org/ns}idk';
}
return $result;
}
}
|
