Skip to content

SchedulingObject

The SchedulingObject represents a scheduling object in the Inbox collection.

Methods

__construct

Constructor.

public __construct(\Sabre\CalDAV\Backend\SchedulingSupport $caldavBackend, array $objectData): mixed

The following properties may be passed within $objectData:

  • uri - A unique uri. Only the 'basename' must be passed.
  • principaluri - the principal that owns the object.
  • calendardata (optional) - The iCalendar data
  • etag - (optional) The etag for this object, MUST be encloded with double-quotes.
  • size - (optional) The size of the data in bytes.
  • lastmodified - (optional) format as a unix timestamp.
  • acl - (optional) Use this to override the default ACL for the node.

Parameters:

Parameter Type Description
$caldavBackend \Sabre\CalDAV\Backend\SchedulingSupport
$objectData array

get

Returns the ICalendar-formatted object.

public get(): string

put

Updates the ICalendar-formatted object.

public put(string|resource $calendarData): string

Parameters:

Parameter Type Description
$calendarData string|resource

delete

Deletes the scheduling message.

public delete(): mixed

getOwner

Returns the owner principal.

public getOwner(): string|null

This must be a url to a principal, or null if there's no owner

getACL

Returns a list of ACE's for this node.

public getACL(): array

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.

Inherited methods

getLastModified

Returns the last modification date as a unix timestamp.

public getLastModified(): int

delete

Deletes the calendar object.

public delete(): mixed

setName

Renames the node.

public setName(string $name): mixed

Parameters:

Parameter Type Description
$name string The new name

Throws:

put

Updates the ICalendar-formatted object.

public put(string|resource $calendarData): string

Parameters:

Parameter Type Description
$calendarData string|resource

get

Returns the ICalendar-formatted object.

public get(): string

getSize

Returns the size of this object in bytes.

public getSize(): int

getETag

Returns an ETag for this object.

public getETag(): string

The ETag is an arbitrary string, but MUST be surrounded by double-quotes.

getContentType

Returns the mime content-type.

public getContentType(): string

getOwner

Returns the owner principal.

public getOwner(): string|null

This must be a url to a principal, or null if there's no owner

getGroup

Returns a group principal.

public getGroup(): string|null

This must be a url to a principal, or null if there's no owner

getACL

Returns a list of ACE's for this node.

public getACL(): array

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.

setACL

Updates the ACL.

public setACL(array $acl): mixed

This method will receive a list of new ACE's as an array argument.

Parameters:

Parameter Type Description
$acl array

getSupportedPrivilegeSet

Returns the list of supported privileges for this node.

public getSupportedPrivilegeSet(): array|null

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.

__construct

Constructor.

public __construct(\Sabre\CalDAV\Backend\BackendInterface $caldavBackend, array $calendarInfo, array $objectData): mixed

The following properties may be passed within $objectData:

  • calendarid - This must refer to a calendarid from a caldavBackend
  • uri - A unique uri. Only the 'basename' must be passed.
  • calendardata (optional) - The iCalendar data
  • etag - (optional) The etag for this object, MUST be encloded with double-quotes.
  • size - (optional) The size of the data in bytes.
  • lastmodified - (optional) format as a unix timestamp.
  • acl - (optional) Use this to override the default ACL for the node.

Parameters:

Parameter Type Description
$caldavBackend \Sabre\CalDAV\Backend\BackendInterface
$calendarInfo array
$objectData array

getName

Returns the uri for this object.

public getName(): string

Automatically generated on 2025-03-18