Nextcloud Circles API

Mount extends ManagedModel
in package
implements IDeserializable, IQueryRow, JsonSerializable Uses TArrayTools

Class Mount

Interfaces, Classes, Traits and Enums

IDeserializable
IQueryRow
Interface IQueryRow
JsonSerializable

Table of Contents

ID_LENGTH  = 31
$TYPE_ARRAY  : mixed
$TYPE_BOOLEAN  : mixed
$TYPE_INTEGER  : mixed
$TYPE_NULL  : mixed
$TYPE_SERIALIZABLE  : mixed
$TYPE_STRING  : mixed
$circleId  : string
$cloudIdManager  : ICloudIdManager
$httpClientService  : IClientService
$id  : int
$initiator  : Member
$modelManager  : ModelManager
$mountId  : string
$mountManager  : CircleMountManager
$mountPoint  : string
$mountPointHash  : string
$owner  : Member
$parent  : int
$password  : string
$storage  : string
$token  : string
__construct()  : mixed
Mount constructor.
fromShare()  : mixed
getCircleId()  : string
getCloudIdManager()  : ICloudIdManager
getHttpClientService()  : IClientService
getId()  : int
getInitiator()  : Member
getMountId()  : string
getMountManager()  : CircleMountManager
getMountPoint()  : string
getMountPointHash()  : string
getOwner()  : Member
getParent()  : int
getPassword()  : string
getToken()  : string
hasInitiator()  : bool
import()  : IDeserializable
importFromDatabase()  : Mount
import data to feed the model.
importFromIFederatedUser()  : void
jsonSerialize()  : array<string|int, mixed>
setCircleId()  : Mount
setCloudIdManager()  : Mount
setHttpClientService()  : Mount
setId()  : self
setInitiator()  : Mount
setMountId()  : Mount
setMountManager()  : Mount
setMountPoint()  : Mount
setMountPointHash()  : Mount
setOwner()  : Mount
setParent()  : Mount
setPassword()  : Mount
setToken()  : Mount
toMount()  : array<string|int, mixed>
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>
getManager()  : ModelManager
getObj()  : mixed
mustContains()  : mixed

Constants

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'

$circleId

private string $circleId = ''

$cloudIdManager

private ICloudIdManager $cloudIdManager

$httpClientService

private IClientService $httpClientService

$mountId

private string $mountId = ''

$mountManager

private CircleMountManager $mountManager

$mountPoint

private string $mountPoint = ''

$mountPointHash

private string $mountPointHash = ''

$parent

private int $parent = -1

$password

private string $password = ''

$storage

private string $storage

$token

private string $token = ''

Methods

__construct()

Mount constructor.

public __construct() : mixed
Return values
mixed

getCircleId()

public getCircleId() : string
Return values
string

getCloudIdManager()

public getCloudIdManager() : ICloudIdManager
Return values
ICloudIdManager

getHttpClientService()

public getHttpClientService() : IClientService
Return values
IClientService

getId()

public getId() : int
Return values
int

getMountId()

public getMountId() : string
Return values
string

getMountManager()

public getMountManager() : CircleMountManager
Return values
CircleMountManager

getMountPoint()

public getMountPoint([bool $raw = true ]) : string
Parameters
$raw : bool = true
Return values
string

getMountPointHash()

public getMountPointHash() : string
Return values
string

getParent()

public getParent() : int
Return values
int

getPassword()

public getPassword() : string
Return values
string

getToken()

public getToken() : string
Return values
string

hasInitiator()

public hasInitiator() : bool
Return values
bool

importFromDatabase()

import data to feed the model.

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

importFromIFederatedUser()

public importFromIFederatedUser(IFederatedUser $orig) : void
Parameters
$orig : IFederatedUser
Tags
noinspection

PhpPossiblePolymorphicInvocationInspection

Return values
void

jsonSerialize()

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

setCircleId()

public setCircleId(string $circleId) : Mount
Parameters
$circleId : string
Return values
Mount

setCloudIdManager()

public setCloudIdManager(ICloudIdManager $cloudIdManager) : Mount
Parameters
$cloudIdManager : ICloudIdManager
Return values
Mount

setHttpClientService()

public setHttpClientService(IClientService $httpClientService) : Mount
Parameters
$httpClientService : IClientService
Return values
Mount

setId()

public setId(int $id) : self
Parameters
$id : int
Return values
self

setMountId()

public setMountId(string $mountId) : Mount
Parameters
$mountId : string
Return values
Mount

setMountManager()

public setMountManager(CircleMountManager $mountManager) : Mount
Parameters
$mountManager : CircleMountManager
Return values
Mount

setMountPoint()

public setMountPoint(string $mountPoint) : Mount
Parameters
$mountPoint : string
Return values
Mount

setMountPointHash()

public setMountPointHash(string $mountPointHash) : Mount
Parameters
$mountPointHash : string
Return values
Mount

setParent()

public setParent(int $parent) : Mount
Parameters
$parent : int
Return values
Mount

setPassword()

public setPassword(string $password) : Mount
Parameters
$password : string
Return values
Mount

setToken()

public setToken(string $token) : Mount
Parameters
$token : string
Return values
Mount

toMount()

public toMount() : 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