Nextcloud Circles API

DavCard
in package
implements JsonSerializable Uses TArrayTools

Class DavCard

Interfaces, Classes, Traits and Enums

JsonSerializable

Table of Contents

TYPE_CONTACT  = 1
TYPE_LOCAL  = 2
$TYPE_ARRAY  : mixed
$TYPE_BOOLEAN  : mixed
$TYPE_INTEGER  : mixed
$TYPE_NULL  : mixed
$TYPE_SERIALIZABLE  : mixed
$TYPE_STRING  : mixed
$addressBookId  : int
$cardUri  : string
$circles  : array<string|int, DeprecatedCircle>
$clouds  : array<string|int, mixed>
$contactId  : string
$emails  : array<string|int, mixed>
$fn  : string
$groups  : array<string|int, mixed>
$owner  : string
$userId  : string
__construct()  : mixed
addCircle()  : $this
getAddressBookId()  : int
getCardUri()  : string
getCircles()  : array<string|int, DeprecatedCircle>
getClouds()  : array<string|int, mixed>
getContactId()  : string
getEmails()  : array<string|int, mixed>
getFn()  : string
getGroups()  : array<string|int, mixed>
getOwner()  : string
getUniqueId()  : string
getUserId()  : string
import()  : mixed
importFromDav()  : mixed
jsonSerialize()  : array<string|int, mixed>
setAddressBookId()  : DavCard
setCardUri()  : DavCard
setCircles()  : DavCard
setClouds()  : DavCard
setContactId()  : DavCard
setEmails()  : DavCard
setFn()  : DavCard
setGroups()  : DavCard
setOwner()  : DavCard
setUserId()  : DavCard
typeOf()  : string
validKey()  : bool
cleanArray()  : mixed
extractArray()  : mixed
get()  : string
getArray()  : array<string|int, mixed>
getBool()  : bool
getFloat()  : float
getInt()  : int
getList()  : array<string|int, mixed>
getObj()  : mixed
mustContains()  : mixed
parseDav()  : array<string|int, mixed>
get essential data from the dav content (also don't think we need regex)

Constants

TYPE_CONTACT

public mixed TYPE_CONTACT = 1

TYPE_LOCAL

public mixed TYPE_LOCAL = 2

Properties

$TYPE_ARRAY

public static mixed $TYPE_ARRAY = 'Array'

$TYPE_BOOLEAN

public static mixed $TYPE_BOOLEAN = 'Boolean'

$TYPE_INTEGER

public static mixed $TYPE_INTEGER = 'Integer'

$TYPE_SERIALIZABLE

public static mixed $TYPE_SERIALIZABLE = 'Serializable'

$TYPE_STRING

public static mixed $TYPE_STRING = 'String'

$addressBookId

private int $addressBookId = 0

$cardUri

private string $cardUri = ''

$clouds

private array<string|int, mixed> $clouds = []

$contactId

private string $contactId = ''

$emails

private array<string|int, mixed> $emails = []

$groups

private array<string|int, mixed> $groups = []

Methods

__construct()

public __construct() : mixed
Return values
mixed

getAddressBookId()

public getAddressBookId() : int
Return values
int

getCardUri()

public getCardUri() : string
Return values
string

getClouds()

public getClouds() : array<string|int, mixed>
Return values
array<string|int, mixed>

getContactId()

public getContactId() : string
Return values
string

getEmails()

public getEmails() : array<string|int, mixed>
Return values
array<string|int, mixed>

getFn()

public getFn() : string
Return values
string

getGroups()

public getGroups() : array<string|int, mixed>
Return values
array<string|int, mixed>

getOwner()

public getOwner() : string
Return values
string

getUniqueId()

public getUniqueId() : string
Return values
string

getUserId()

public getUserId() : string
Return values
string

import()

public import(array<string|int, mixed> $data) : mixed
Parameters
$data : array<string|int, mixed>
Return values
mixed

importFromDav()

public importFromDav(string $dav) : mixed
Parameters
$dav : string
Return values
mixed

jsonSerialize()

public jsonSerialize() : array<string|int, mixed>
Return values
array<string|int, mixed>

setAddressBookId()

public setAddressBookId(int $addressBookId) : DavCard
Parameters
$addressBookId : int
Return values
DavCard

setCardUri()

public setCardUri(string $cardUri) : DavCard
Parameters
$cardUri : string
Return values
DavCard

setCircles()

public setCircles(array<string|int, mixed> $circles) : DavCard
Parameters
$circles : array<string|int, mixed>
Return values
DavCard

setClouds()

public setClouds(array<string|int, mixed> $clouds) : DavCard
Parameters
$clouds : array<string|int, mixed>
Return values
DavCard

setContactId()

public setContactId(string $contactId) : DavCard
Parameters
$contactId : string
Return values
DavCard

setEmails()

public setEmails(array<string|int, mixed> $emails) : DavCard
Parameters
$emails : array<string|int, mixed>
Return values
DavCard

setGroups()

public setGroups(array<string|int, mixed> $groups) : DavCard
Parameters
$groups : array<string|int, mixed>
Return values
DavCard

setOwner()

public setOwner(string $owner) : DavCard
Parameters
$owner : string
Return values
DavCard

setUserId()

public setUserId(string $userId) : DavCard
Parameters
$userId : string
Return values
DavCard

typeOf()

public typeOf(string $key, array<string|int, mixed> $arr[, bool $root = true ]) : string
Parameters
$key : string
$arr : array<string|int, mixed>
$root : bool = true
Tags
throws
ItemNotFoundException
throws
UnknownTypeException
Return values
string

validKey()

public validKey(string $k, array<string|int, mixed> $arr) : bool
Parameters
$k : string
$arr : array<string|int, mixed>
Return values
bool

cleanArray()

protected cleanArray(array<string|int, mixed> &$arr) : mixed
Parameters
$arr : array<string|int, mixed>
Return values
mixed

extractArray()

protected extractArray(string $k, string $value, array<string|int, mixed> $list) : mixed
Parameters
$k : string
$value : string
$list : array<string|int, mixed>
Tags
throws
ArrayNotFoundException
Return values
mixed

get()

protected get(string $k, array<string|int, mixed> $arr[, string $default = '' ]) : string
Parameters
$k : string
$arr : array<string|int, mixed>
$default : string = ''
Return values
string

getArray()

protected getArray(string $k, array<string|int, mixed> $arr[, array<string|int, mixed> $default = [] ]) : array<string|int, mixed>
Parameters
$k : string
$arr : array<string|int, mixed>
$default : array<string|int, mixed> = []
Return values
array<string|int, mixed>

getBool()

protected getBool(string $k, array<string|int, mixed> $arr[, bool $default = false ]) : bool
Parameters
$k : string
$arr : array<string|int, mixed>
$default : bool = false
Return values
bool

getFloat()

protected getFloat(string $k, array<string|int, mixed> $arr, float $default) : float
Parameters
$k : string
$arr : array<string|int, mixed>
$default : float
Return values
float

getInt()

protected getInt(string $k, array<string|int, mixed> $arr, int $default) : int
Parameters
$k : string
$arr : array<string|int, mixed>
$default : int
Return values
int

getList()

protected getList(string $k, array<string|int, mixed> $arr, array<string|int, mixed> $import[, array<string|int, mixed> $default = [] ]) : array<string|int, mixed>
Parameters
$k : string
$arr : array<string|int, mixed>
$import : array<string|int, mixed>
$default : array<string|int, mixed> = []
Return values
array<string|int, mixed>

getObj()

protected getObj(string $k, array<string|int, mixed> $arr[, JsonSerializable|null $default = null ]) : mixed
Parameters
$k : string
$arr : array<string|int, mixed>
$default : JsonSerializable|null = null
Return values
mixed

mustContains()

protected mustContains(array<string|int, mixed> $keys, array<string|int, mixed> $arr) : mixed
Parameters
$keys : array<string|int, mixed>
$arr : array<string|int, mixed>
Tags
throws
MalformedArrayException
Return values
mixed

parseDav()

get essential data from the dav content (also don't think we need regex)

private parseDav(string $dav) : array<string|int, mixed>
Parameters
$dav : string
Return values
array<string|int, mixed>

Search results