Nextcloud Circles API

DeprecatedCircle extends BaseCircle
in package
implements JsonSerializable Uses TArrayTools

Interfaces, Classes, Traits and Enums

JsonSerializable

Table of Contents

CIRCLES_ALL  = 15
CIRCLES_CLOSED  = 4
CIRCLES_PERSONAL  = 1
CIRCLES_PUBLIC  = 8
CIRCLES_SECRET  = 2
CIRCLES_SETTINGS_DEFAULT  = ['password_enforcement' => 'false', 'password_single' => '', 'allow_links' => 'false', 'allow_links_auto' => 'false', 'allow_links_files' => 'false']
SHORT_UNIQUE_ID_LENGTH  = 14
$TYPE_ARRAY  : mixed
$TYPE_BOOLEAN  : mixed
$TYPE_INTEGER  : mixed
$TYPE_NULL  : mixed
$TYPE_SERIALIZABLE  : mixed
$TYPE_STRING  : mixed
$l10n  : IL10N
$altName  : string
$contactAddressBook  : int
$contactGroupName  : string
$creation  : string
$description  : string
$fullJson  : bool
$groups  : array<string|int, DeprecatedMember>
$id  : int
$lightJson  : bool
$links  : array<string|int, FederatedLink>
$members  : array<string|int, DeprecatedMember>
$name  : string
$owner  : DeprecatedMember
$passwordSingle  : string
$settings  : array<string|int, mixed>
$type  : int
$uniqueId  : string
$viewer  : DeprecatedMember
$viewerGroup  : DeprecatedMember
__construct()  : mixed
cantBePersonal()  : mixed
convertTypeToConfig()  : int
convert old type to new config (nc22)
fromArray()  : $this
set all infos from an Array.
fromJSON()  : DeprecatedCircle
generateUniqueId()  : mixed
getAltName()  : string
getArray()  : mixed
getContactAddressBook()  : int
getContactGroupName()  : string
getCreation()  : string
getDescription()  : string
getGroups()  : array<string|int, mixed>
getGroupViewer()  : DeprecatedMember
getHigherViewer()  : DeprecatedMember
getId()  : int
getInfo()  : mixed
getJson()  : mixed
getLinks()  : array<string|int, mixed>
getMembers()  : array<string|int, DeprecatedMember>
getName()  : string
getOwner()  : DeprecatedMember
getPasswordSingle()  : string
getSetting()  : string|null
getSettings()  : array<string|int, mixed>|string
getType()  : string
getTypeLongString()  : mixed
getTypeString()  : mixed
getUniqueId()  : string
getViewer()  : DeprecatedMember
hasToBeFederated()  : mixed
hasViewer()  : bool
jsonSerialize()  : mixed
setAltName()  : BaseCircle
setContactAddressBook()  : BaseCircle
setContactGroupName()  : BaseCircle
setCreation()  : BaseCircle
setDescription()  : BaseCircle
setFullJson()  : $this
setGroups()  : BaseCircle
setGroupViewer()  : BaseCircle
setId()  : BaseCircle
setLinks()  : BaseCircle
setMembers()  : BaseCircle
setName()  : BaseCircle
setOwner()  : BaseCircle
setPasswordSingle()  : void
setSetting()  : mixed
setSettings()  : $this
setType()  : BaseCircle
setUniqueId()  : $this
setViewer()  : BaseCircle
typeInt()  : int
typeLongString()  : string
typeOf()  : string
validKey()  : bool
cleanArray()  : mixed
extractArray()  : mixed
get()  : string
getBool()  : bool
getFloat()  : float
getInt()  : int
getList()  : array<string|int, mixed>
getObj()  : mixed
mustContains()  : mixed
getLinksFromArray()  : array<string|int, mixed>
getMemberFromArray()  : null|DeprecatedMember
getSettingsFromArray()  : array<string|int, mixed>

Constants

CIRCLES_PERSONAL

public mixed CIRCLES_PERSONAL = 1

CIRCLES_SETTINGS_DEFAULT

public mixed CIRCLES_SETTINGS_DEFAULT = ['password_enforcement' => 'false', 'password_single' => '', 'allow_links' => 'false', 'allow_links_auto' => 'false', 'allow_links_files' => 'false']

SHORT_UNIQUE_ID_LENGTH

public mixed SHORT_UNIQUE_ID_LENGTH = 14

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'

$contactAddressBook

private int $contactAddressBook = 0

$contactGroupName

private string $contactGroupName = ''

$passwordSingle

private string $passwordSingle = ''

$settings

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

Methods

__construct()

public __construct([mixed $type = -1 ][, mixed $name = '' ]) : mixed
Parameters
$type : mixed = -1
$name : mixed = ''
Return values
mixed —

convertTypeToConfig()

convert old type to new config (nc22)

public static convertTypeToConfig(int $type) : int
Parameters
$type : int
Return values
int —

fromArray()

set all infos from an Array.

public static fromArray( $arr[, bool $allSettings = false ]) : $this
Parameters
$arr :
$allSettings : bool = false
Return values
$this —

generateUniqueId()

public generateUniqueId() : mixed
Return values
mixed —

getAltName()

public getAltName() : string
Return values
string —

getArray()

public getArray([mixed $full = false ][, mixed $light = false ]) : mixed
Parameters
$full : mixed = false
$light : mixed = false
Return values
mixed —

getContactAddressBook()

public getContactAddressBook() : int
Return values
int —

getContactGroupName()

public getContactGroupName() : string
Return values
string —

getCreation()

public getCreation() : string
Return values
string —

getDescription()

public getDescription() : string
Return values
string —

getGroups()

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

getId()

public getId() : int
Return values
int —

getJson()

public getJson([mixed $full = false ][, mixed $light = false ]) : mixed
Parameters
$full : mixed = false
$light : mixed = false
Return values
mixed —

getLinks()

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

getName()

public getName([bool $real = false ]) : string
Parameters
$real : bool = false
Return values
string —

getPasswordSingle()

public getPasswordSingle() : string
Return values
string —

getSetting()

public getSetting(string $k) : string|null
Parameters
$k : string
Return values
string|null —

getSettings()

public getSettings([bool $json = false ]) : array<string|int, mixed>|string
Parameters
$json : bool = false
Return values
array<string|int, mixed>|string —

getType()

public getType() : string
Return values
string —

getTypeLongString()

public getTypeLongString() : mixed
Return values
mixed —

getUniqueId()

public getUniqueId([bool $full = false ]) : string
Parameters
$full : bool = false
Return values
string —

hasViewer()

public hasViewer() : bool
Return values
bool —

setContactAddressBook()

public setContactAddressBook(int $contactAddressBook) : BaseCircle
Parameters
$contactAddressBook : int
Return values
BaseCircle —

setContactGroupName()

public setContactGroupName(string $contactGroupName) : BaseCircle
Parameters
$contactGroupName : string
Return values
BaseCircle —

setFullJson()

public setFullJson(bool $fullJson) : $this
Parameters
$fullJson : bool
Return values
$this —

setGroups()

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

setLinks()

public setLinks(array<string|int, mixed> $links) : BaseCircle
Parameters
$links : array<string|int, mixed>
Return values
BaseCircle —

setMembers()

public setMembers(array<string|int, mixed> $members) : BaseCircle
Parameters
$members : array<string|int, mixed>
Return values
BaseCircle —

setPasswordSingle()

public setPasswordSingle(string $passwordSingle) : void
Parameters
$passwordSingle : string
Return values
void —

setSetting()

public setSetting(string $k, mixed $v) : mixed
Parameters
$k : string
$v : mixed
Return values
mixed —

setSettings()

public setSettings(string|array<string|int, mixed> $settings[, bool $all = false ]) : $this
Parameters
$settings : string|array<string|int, mixed>
$all : bool = false
Return values
$this —

setUniqueId()

public setUniqueId(string $uniqueId) : $this
Parameters
$uniqueId : string
Return values
$this —

typeInt()

public static typeInt(int|string $type) : int
Parameters
$type : int|string
Return values
int —

typeLongString()

public static typeLongString( $type) : string
Parameters
$type :
Return values
string —

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 —

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 —

getLinksFromArray()

private static getLinksFromArray(array<string|int, mixed> $arr) : array<string|int, mixed>
Parameters
$arr : array<string|int, mixed>
Return values
array<string|int, mixed> —

getMemberFromArray()

private static getMemberFromArray(array<string|int, mixed> $arr,  $key[, int $type = DeprecatedMember::TYPE_USER ]) : null|DeprecatedMember
Parameters
$arr : array<string|int, mixed>
$key :
$type : int = DeprecatedMember::TYPE_USER
Return values
null|DeprecatedMember —

getSettingsFromArray()

private static getSettingsFromArray(array<string|int, mixed> $arr) : array<string|int, mixed>
Parameters
$arr : array<string|int, mixed>
Return values
array<string|int, mixed> —

Search results