Documentation

PDO extends AbstractBackend
in package

Application

implements CreatePrincipalSupport

PDO principal backend.

This backend assumes all principals are in a single collection. The default collection is 'principals/', but this can be overridden.

Interfaces, Classes and Traits

CreatePrincipalSupport: Implement this interface to add support for creating new principals to your principal backend.

$groupMembersTableName : string: PDO table name for 'group members'.
$tableName : string: PDO table name for 'principals'.
$fieldMap : array<string|int, mixed>: A list of additional fields to support.
$pdo : PDO: pdo.
__construct() : mixed: Sets up the backend.
createPrincipal() : mixed: Creates a new principal.
findByUri() : string: Finds a principal by its URI.
getGroupMemberSet() : array<string|int, mixed>: Returns the list of members for a group-principal.
getGroupMembership() : array<string|int, mixed>: Returns the list of groups a principal is a member of.
getPrincipalByPath() : array<string|int, mixed>: Returns a specific principal, specified by it's path.
getPrincipalsByPrefix() : array<string|int, mixed>: Returns a list of principals based on a prefix.
searchPrincipals() : array<string|int, mixed>: This method is used to search for principals matching a set of properties.
setGroupMemberSet() : mixed: Updates the list of group members for a group principal.
updatePrincipal() : mixed: Updates one ore more webdav properties on a principal.

$groupMembersTableName

PDO table name for 'group members'.


    public
        string
    $groupMembersTableName
     = 'groupmembers'

$tableName

PDO table name for 'principals'.


    public
        string
    $tableName
     = 'principals'

$fieldMap

A list of additional fields to support.


    protected
        array<string|int, mixed>
    $fieldMap
     = [
    /*
     * This property can be used to display the users' real name.
     */
    '{DAV:}displayname' => ['dbField' => 'displayname'],
    /*
     * This is the users' primary email-address.
     */
    '{http://sabredav.org/ns}email-address' => ['dbField' => 'email'],
]

$pdo

pdo.


    protected
        PDO
    $pdo

__construct()

Sets up the backend.


    public
                __construct(PDO $pdo) : mixed

Parameters

$pdo : PDO

Return values

mixed —

createPrincipal()

Creates a new principal.


    public
                createPrincipal(string $path, MkCol $mkCol) : mixed

This method receives a full path for the new principal. The mkCol object contains any additional webdav properties specified during the creation of the principal.

Parameters

$path : string
$mkCol : MkCol

Return values

mixed —

findByUri()

Finds a principal by its URI.


    public
                findByUri(string $uri, string $principalPrefix) : string

This method may receive any type of uri, but mailto: addresses will be the most common.

Implementation of this API is optional. It is currently used by the CalDAV system to find principals based on their email addresses. If this API is not implemented, some features may not work correctly.

This method must return a relative principal path, or null, if the principal was not found or you refuse to find it.

Parameters

$uri : string
$principalPrefix : string

Return values

string —

getGroupMemberSet()

Returns the list of members for a group-principal.


    public
                getGroupMemberSet(string $principal) : array<string|int, mixed>

Parameters

$principal : string

Return values

array<string|int, mixed> —

getGroupMembership()

Returns the list of groups a principal is a member of.


    public
                getGroupMembership(string $principal) : array<string|int, mixed>

Parameters

$principal : string

Return values

array<string|int, mixed> —

getPrincipalByPath()

Returns a specific principal, specified by it's path.


    public
                getPrincipalByPath(string $path) : array<string|int, mixed>

The returned structure should be the exact same as from getPrincipalsByPrefix.

Parameters

$path : string

Return values

array<string|int, mixed> —

getPrincipalsByPrefix()

Returns a list of principals based on a prefix.


    public
                getPrincipalsByPrefix(string $prefixPath) : array<string|int, mixed>

This prefix will often contain something like 'principals'. You are only expected to return principals that are in this base path.

You are expected to return at least a 'uri' for every user, you can return any additional properties if you wish so. Common properties are: {DAV:}displayname {http://sabredav.org/ns}email-address - This is a custom SabreDAV field that's actualy injected in a number of other properties. If you have an email address, use this property.

Parameters

$prefixPath : string

Return values

array<string|int, mixed> —

searchPrincipals()

This method is used to search for principals matching a set of properties.


    public
                searchPrincipals(string $prefixPath, array<string|int, mixed> $searchProperties[, string $test = 'allof' ]) : array<string|int, mixed>

This search is specifically used by RFC3744's principal-property-search REPORT.

The actual search should be a unicode-non-case-sensitive search. The keys in searchProperties are the WebDAV property names, while the values are the property values to search on.

By default, if multiple properties are submitted to this method, the various properties should be combined with 'AND'. If $test is set to 'anyof', it should be combined using 'OR'.

This method should simply return an array with full principal uri's.

If somebody attempted to search on a property the backend does not support, you should simply return 0 results.

You can also just return 0 results if you choose to not support searching at all, but keep in mind that this may stop certain features from working.

Parameters

$prefixPath : string
$searchProperties : array<string|int, mixed>
$test : string = 'allof'

Return values

array<string|int, mixed> —

setGroupMemberSet()

Updates the list of group members for a group principal.


    public
                setGroupMemberSet(string $principal, array<string|int, mixed> $members) : mixed

The principals should be passed as a list of uri's.

Parameters

$principal : string
$members : array<string|int, mixed>

Return values

mixed —

updatePrincipal()

Updates one ore more webdav properties on a principal.


    public
                updatePrincipal(string $path, PropPatch $propPatch) : mixed

The list of mutations is stored in a Sabre\DAV\PropPatch object. To do the actual updates, you must tell this object which properties you're going to process with the handle() method.

Calling the handle method is like telling the PropPatch object "I promise I can handle updating this property".

Read the PropPatch documentation for more info and examples.

Parameters

$path : string
$propPatch : PropPatch

Return values

mixed —