Page Menu
Home
Phabricator
Search
Configure Global Search
Log In
Files
F1821385
Subscription.php
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Mute Notifications
Size
6 KB
Subscribers
None
Subscription.php
View Options
<?php
namespace
Sabre\CalDAV\Subscriptions
;
use
Sabre\DAV\Collection
;
use
Sabre\DAV\Xml\Property\Href
;
use
Sabre\DAV\PropPatch
;
use
Sabre\DAV\Exception\MethodNotAllowed
;
use
Sabre\DAVACL\IACL
;
use
Sabre\CalDAV\Backend\SubscriptionSupport
;
/**
* Subscription Node
*
* This node represents a subscription.
*
* @copyright Copyright (C) 2007-2015 fruux GmbH (https://fruux.com/).
* @author Evert Pot (http://evertpot.com/)
* @license http://sabre.io/license/ Modified BSD License
*/
class
Subscription
extends
Collection
implements
ISubscription
,
IACL
{
/**
* caldavBackend
*
* @var SupportsSubscriptions
*/
protected
$caldavBackend
;
/**
* subscriptionInfo
*
* @var array
*/
protected
$subscriptionInfo
;
/**
* Constructor
*
* @param SubscriptionSupport $caldavBackend
* @param array $calendarInfo
*/
function
__construct
(
SubscriptionSupport
$caldavBackend
,
array
$subscriptionInfo
)
{
$this
->
caldavBackend
=
$caldavBackend
;
$this
->
subscriptionInfo
=
$subscriptionInfo
;
$required
=
[
'id'
,
'uri'
,
'principaluri'
,
'source'
,
];
foreach
(
$required
as
$r
)
{
if
(!
isset
(
$subscriptionInfo
[
$r
]))
{
throw
new
\InvalidArgumentException
(
'The '
.
$r
.
' field is required when creating a subscription node'
);
}
}
}
/**
* Returns the name of the node.
*
* This is used to generate the url.
*
* @return string
*/
function
getName
()
{
return
$this
->
subscriptionInfo
[
'uri'
];
}
/**
* Returns the last modification time
*
* @return int
*/
function
getLastModified
()
{
if
(
isset
(
$this
->
subscriptionInfo
[
'lastmodified'
]))
{
return
$this
->
subscriptionInfo
[
'lastmodified'
];
}
}
/**
* Deletes the current node
*
* @return void
*/
function
delete
()
{
$this
->
caldavBackend
->
deleteSubscription
(
$this
->
subscriptionInfo
[
'id'
]
);
}
/**
* Returns an array with all the child nodes
*
* @return DAV\INode[]
*/
function
getChildren
()
{
return
[];
}
/**
* Updates properties on this node.
*
* This method received a PropPatch object, which contains all the
* information about the update.
*
* To update specific properties, call the 'handle' method on this object.
* Read the PropPatch documentation for more information.
*
* @param PropPatch $propPatch
* @return void
*/
function
propPatch
(
PropPatch
$propPatch
)
{
return
$this
->
caldavBackend
->
updateSubscription
(
$this
->
subscriptionInfo
[
'id'
],
$propPatch
);
}
/**
* Returns a list of properties for this nodes.
*
* The properties list is a list of propertynames the client requested,
* encoded in clark-notation {xmlnamespace}tagname.
*
* If the array is empty, it means 'all properties' were requested.
*
* Note that it's fine to liberally give properties back, instead of
* conforming to the list of requested properties.
* The Server class will filter out the extra.
*
* @param array $properties
* @return void
*/
function
getProperties
(
$properties
)
{
$r
=
[];
foreach
(
$properties
as
$prop
)
{
switch
(
$prop
)
{
case
'{http://calendarserver.org/ns/}source'
:
$r
[
$prop
]
=
new
Href
(
$this
->
subscriptionInfo
[
'source'
],
false
);
break
;
default
:
if
(
array_key_exists
(
$prop
,
$this
->
subscriptionInfo
))
{
$r
[
$prop
]
=
$this
->
subscriptionInfo
[
$prop
];
}
break
;
}
}
return
$r
;
}
/**
* Returns the owner principal.
*
* This must be a url to a principal, or null if there's no owner
*
* @return string|null
*/
function
getOwner
()
{
return
$this
->
subscriptionInfo
[
'principaluri'
];
}
/**
* Returns a group principal.
*
* This must be a url to a principal, or null if there's no owner
*
* @return string|null
*/
function
getGroup
()
{
return
null
;
}
/**
* Returns a list of ACE's for this node.
*
* Each ACE has the following properties:
* * 'privilege', a string such as {DAV:}read or {DAV:}write. These are
* currently the only supported privileges
* * 'principal', a url to the principal who owns the node
* * 'protected' (optional), indicating that this ACE is not allowed to
* be updated.
*
* @return array
*/
function
getACL
()
{
return
[
[
'privilege'
=>
'{DAV:}read'
,
'principal'
=>
$this
->
getOwner
(),
'protected'
=>
true
,
],
[
'privilege'
=>
'{DAV:}write'
,
'principal'
=>
$this
->
getOwner
(),
'protected'
=>
true
,
],
[
'privilege'
=>
'{DAV:}read'
,
'principal'
=>
$this
->
getOwner
()
.
'/calendar-proxy-write'
,
'protected'
=>
true
,
],
[
'privilege'
=>
'{DAV:}write'
,
'principal'
=>
$this
->
getOwner
()
.
'/calendar-proxy-write'
,
'protected'
=>
true
,
],
[
'privilege'
=>
'{DAV:}read'
,
'principal'
=>
$this
->
getOwner
()
.
'/calendar-proxy-read'
,
'protected'
=>
true
,
]
];
}
/**
* Updates the ACL.
*
* This method will receive a list of new ACE's.
*
* @param array $acl
* @return void
*/
function
setACL
(
array
$acl
)
{
throw
new
MethodNotAllowed
(
'Changing ACL is not yet supported'
);
}
/**
* Returns the list of supported privileges for this node.
*
* The returned data structure is a list of nested privileges.
* See \Sabre\DAVACL\Plugin::getDefaultSupportedPrivilegeSet for a simple
* standard structure.
*
* If null is returned from this method, the default privilege set is used,
* which is fine for most common usecases.
*
* @return array|null
*/
function
getSupportedPrivilegeSet
()
{
return
null
;
}
}
File Metadata
Details
Attached
Mime Type
text/x-php
Expires
Mon, Dec 23, 9:10 PM (4 h, 20 m)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
913523
Default Alt Text
Subscription.php (6 KB)
Attached To
rDAVCAL DokuWiki DAVCal PlugIn
Event Timeline
Log In to Comment