Nextcloud Circles API

ShareToken
in package
implements IDeserializable, IQueryRow, JsonSerializable Uses TArrayTools

Interfaces, Classes, Traits and Enums

IDeserializable
IQueryRow
Interface IQueryRow
JsonSerializable

Table of Contents

$TYPE_ARRAY  : mixed
$TYPE_BOOLEAN  : mixed
$TYPE_INTEGER  : mixed
$TYPE_NULL  : mixed
$TYPE_SERIALIZABLE  : mixed
$TYPE_STRING  : mixed
$accepted  : int
$circleId  : string
$dbId  : int
$link  : string
$memberId  : string
$password  : string
$shareId  : int
$singleId  : string
$token  : string
__construct()  : mixed
ShareToken constructor.
getAccepted()  : int
getCircleId()  : string
getDbId()  : int
getLink()  : string
getMemberId()  : string
getPassword()  : string
getShareId()  : int
getSingleId()  : string
getToken()  : string
import()  : ShareToken
importFromDatabase()  : IQueryRow
import data to feed the model.
jsonSerialize()  : array<string|int, mixed>
setAccepted()  : ShareToken
setCircleId()  : ShareToken
setDbId()  : ShareToken
setLink()  : ShareToken
setMemberId()  : ShareToken
setPassword()  : ShareToken
setShareId()  : ShareToken
setSingleId()  : ShareToken
setToken()  : ShareToken
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

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'

$accepted

private int $accepted = \OCP\Share\IShare::STATUS_PENDING

Methods

__construct()

ShareToken constructor.

public __construct() : mixed
Return values
mixed

getAccepted()

public getAccepted() : int
Return values
int

getCircleId()

public getCircleId() : string
Return values
string

getDbId()

public getDbId() : int
Return values
int
public getLink() : string
Return values
string

getMemberId()

public getMemberId() : string
Return values
string

getPassword()

public getPassword() : string
Return values
string

getShareId()

public getShareId() : int
Return values
int

getSingleId()

public getSingleId() : string
Return values
string

getToken()

public getToken() : string
Return values
string

importFromDatabase()

import data to feed the model.

public importFromDatabase(array<string|int, mixed> $data[, string $prefix = '' ]) : IQueryRow
Parameters
$data : array<string|int, mixed>
$prefix : string = ''
Tags
throws
ShareTokenNotFoundException
Return values
IQueryRow

jsonSerialize()

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

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

Search results