MkCol

This class represents a MKCOL operation.

MKCOL creates a new collection. MKCOL comes in two flavours:

MKCOL with no body, signifies the creation of a simple collection.
MKCOL with a request body. This can create a collection with a specific resource type, and a set of properties that should be set on the new collection. This can be used to create caldav calendars, carddav address books, etc.

Property updates must always be atomic. This means that a property update must either completely succeed, or completely fail.

Full name: \Sabre\DAV\MkCol
Parent class: \Sabre\DAV\PropPatch

Properties

resourceType

A list of resource-types in clark-notation.

protected array $resourceType

Methods

__construct

Creates the MKCOL object.

public __construct(string[] $resourceType, array $mutations): mixed

Parameters:

Parameter	Type	Description
`$resourceType`	string[]	list of resourcetype values
`$mutations`	array	list of new properties values

getResourceType

Returns the resourcetype of the new collection.

public getResourceType(): string[]

hasResourceType

Returns true or false if the MKCOL operation has at least the specified resource type.

public hasResourceType(string|string[] $resourceType): bool

If the resourcetype is specified as an array, all resourcetypes are checked.

Parameters:

Parameter	Type	Description
`$resourceType`	string\|string[]

Inherited methods

__construct

Constructor.

public __construct(array $mutations): mixed

Parameters:

Parameter	Type	Description
`$mutations`	array	A list of updates

handle

Call this function if you wish to handle updating certain properties.

public handle(string|string[] $properties, callable $callback): mixed

For instance, your class may be responsible for handling updates for the {DAV:}displayname property.

In that case, call this method with the first argument "{DAV:}displayname" and a second argument that's a method that does the actual updating.

It's possible to specify more than one property as an array.

The callback must return a boolean or an it. If the result is true, the operation was considered successful. If it's false, it's consided failed.

If the result is an integer, we'll use that integer as the http status code associated with the operation.

Parameters:

Parameter	Type	Description
`$properties`	string\|string[]
`$callback`	callable

handleRemaining

Call this function if you wish to handle all properties that haven't been handled by anything else yet. Note that you effectively claim with this that you promise to process all properties that are coming in.

public handleRemaining(callable $callback): mixed

Parameters:

Parameter	Type	Description
`$callback`	callable

setResultCode

Sets the result code for one or more properties.

public setResultCode(string|string[] $properties, int $resultCode): mixed

Parameters:

Parameter	Type	Description
`$properties`	string\|string[]
`$resultCode`	int

setRemainingResultCode

Sets the result code for all properties that did not have a result yet.

public setRemainingResultCode(int $resultCode): mixed

Parameters:

Parameter	Type	Description
`$resultCode`	int

getRemainingMutations

Returns the list of properties that don't have a result code yet.

public getRemainingMutations(): string[]

This method returns a list of property names, but not its values.

getRemainingValues

Returns the list of properties that don't have a result code yet.

public getRemainingValues(): array

This method returns list of properties and their values.

commit

Performs the actual update, and calls all callbacks.

public commit(): bool

This method returns true or false depending on if the operation was successful.

doCallBackSingleProp

Executes a property callback with the single-property syntax.

private doCallBackSingleProp(string $propertyName, callable $callback): mixed

Parameters:

Parameter	Type	Description
`$propertyName`	string
`$callback`	callable

doCallBackMultiProp

Executes a property callback with the multi-property syntax.

private doCallBackMultiProp(array $propertyList, callable $callback): mixed

Parameters:

Parameter	Type	Description
`$propertyList`	array
`$callback`	callable

getResult

Returns the result of the operation.

public getResult(): array

getMutations

Returns the full list of mutations.

public getMutations(): array

Automatically generated on 2025-03-18