Nextcloud Circles API

ShareWrapper extends ManagedModel
in package
implements IDeserializable, IQueryRow, JsonSerializable Uses TArrayTools, TDeserialize

Class ShareWrapper

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
$childFileTarget  : string
$childId  : int
$childPermissions  : int
$circle  : Circle|null
$fileCache  : FileCacheWrapper|null
$fileSource  : int
$fileTarget  : string
$id  : string
$initiator  : Member|null
$itemSource  : int
$itemTarget  : string
$itemType  : string
$modelManager  : ModelManager
$owner  : Member|null
$permissions  : int
$providerId  : string
$sharedBy  : string
$sharedWith  : string
$shareOwner  : string
$shareTime  : DateTime
$shareToken  : ShareToken|null
$shareType  : int
$status  : int
$token  : string
__construct()  : mixed
deserialize()  : IDeserializable
deserializeArray()  : array<string|int, IDeserializable>
deserializeJson()  : IDeserializable
deserializeList()  : array<string|int, IDeserializable>
getChildFileTarget()  : string
getChildId()  : int
getChildPermissions()  : int
getCircle()  : Circle
getFileCache()  : FileCacheWrapper
getFileSource()  : int
getFileTarget()  : string
getId()  : string
getInitiator()  : Member
getItemSource()  : int
getItemTarget()  : string
getItemType()  : string
getOwner()  : Member
getPermissions()  : int
getProviderId()  : string
getShare()  : IShare|null
getSharedBy()  : string
getSharedWith()  : string
getShareOwner()  : string
getShareTime()  : DateTime
getShareToken()  : ShareToken
getShareType()  : int
getStatus()  : int
getToken()  : string
hasCircle()  : bool
hasFileCache()  : bool
hasInitiator()  : bool
hasOwner()  : bool
hasShareToken()  : bool
import()  : self
importFromDatabase()  : IQueryRow
import data to feed the model.
importFromIFederatedUser()  : void
jsonSerialize()  : array<string|int, mixed>
serialize()  : array<string|int, mixed>
serializeArray()  : array<string|int, mixed>
setChildFileTarget()  : self
setChildId()  : self
setChildPermissions()  : self
setCircle()  : self
setFileCache()  : self
setFileSource()  : self
setFileTarget()  : self
setId()  : self
setInitiator()  : self
setItemSource()  : self
setItemTarget()  : self
setItemType()  : self
setOwner()  : self
setPermissions()  : self
setProviderId()  : self
setSharedBy()  : self
setSharedWith()  : self
setShareOwner()  : self
setShareTime()  : self
setShareToken()  : self
setShareType()  : self
setStatus()  : self
setToken()  : self
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
setShareDisplay()  : void

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'

Methods

__construct()

public __construct() : mixed
Return values
mixed —

deserializeArray()

public deserializeArray(array<string|int, mixed> $data, string $class[, bool $associative = false ]) : array<string|int, IDeserializable>
Parameters
$data : array<string|int, mixed>
$class : string
$associative : bool = false
Return values
array<string|int, IDeserializable> —

getChildFileTarget()

public getChildFileTarget() : string
Return values
string —

getChildId()

public getChildId() : int
Return values
int —

getChildPermissions()

public getChildPermissions() : int
Return values
int —

getFileSource()

public getFileSource() : int
Return values
int —

getFileTarget()

public getFileTarget() : string
Return values
string —

getId()

public getId() : string
Return values
string —

getItemSource()

public getItemSource() : int
Return values
int —

getItemTarget()

public getItemTarget() : string
Return values
string —

getItemType()

public getItemType() : string
Return values
string —

getPermissions()

public getPermissions() : int
Return values
int —

getProviderId()

public getProviderId() : string
Return values
string —

getShare()

public getShare(IRootFolder $rootFolder, IUserManager $userManager, IURLGenerator $urlGenerator[, bool $nullOnMissingFileCache = false ]) : IShare|null
Parameters
$rootFolder : IRootFolder
$userManager : IUserManager
$urlGenerator : IURLGenerator
$nullOnMissingFileCache : bool = false
Tags
throws
IllegalIDChangeException
Return values
IShare|null —

getSharedBy()

public getSharedBy() : string
Return values
string —

getSharedWith()

public getSharedWith() : string
Return values
string —

getShareOwner()

public getShareOwner() : string
Return values
string —

getShareTime()

public getShareTime() : DateTime
Return values
DateTime —

getShareType()

public getShareType() : int
Return values
int —

getStatus()

public getStatus() : int
Return values
int —

getToken()

public getToken() : string
Return values
string —

hasCircle()

public hasCircle() : bool
Return values
bool —

hasFileCache()

public hasFileCache() : bool
Return values
bool —

hasInitiator()

public hasInitiator() : bool
Return values
bool —

hasOwner()

public hasOwner() : bool
Return values
bool —

hasShareToken()

public hasShareToken() : bool
Return values
bool —

import()

public import(array<string|int, mixed> $data) : self
Parameters
$data : array<string|int, mixed>
Tags
throws
InvalidItemException
Return values
self —

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 = ''
Return values
IQueryRow —

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> —

serialize()

public serialize(JsonSerializable $model) : array<string|int, mixed>
Parameters
$model : JsonSerializable
Return values
array<string|int, mixed> —

serializeArray()

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

setChildFileTarget()

public setChildFileTarget(string $childFileTarget) : self
Parameters
$childFileTarget : string
Return values
self —

setChildId()

public setChildId(int $childId) : self
Parameters
$childId : int
Return values
self —

setChildPermissions()

public setChildPermissions(int $childPermissions) : self
Parameters
$childPermissions : int
Return values
self —

setFileSource()

public setFileSource(int $fileSource) : self
Parameters
$fileSource : int
Return values
self —

setFileTarget()

public setFileTarget(string $fileTarget) : self
Parameters
$fileTarget : string
Return values
self —

setId()

public setId(string $id) : self
Parameters
$id : string
Return values
self —

setInitiator()

public setInitiator(Member $initiator) : self
Parameters
$initiator : Member
Return values
self —

setItemSource()

public setItemSource(int $itemSource) : self
Parameters
$itemSource : int
Return values
self —

setItemTarget()

public setItemTarget(string $itemTarget) : self
Parameters
$itemTarget : string
Return values
self —

setItemType()

public setItemType(string $itemType) : self
Parameters
$itemType : string
Return values
self —

setPermissions()

public setPermissions(int $permissions) : self
Parameters
$permissions : int
Return values
self —

setProviderId()

public setProviderId(string $providerId) : self
Parameters
$providerId : string
Return values
self —

setSharedBy()

public setSharedBy(string $sharedBy) : self
Parameters
$sharedBy : string
Return values
self —

setSharedWith()

public setSharedWith(string $sharedWith) : self
Parameters
$sharedWith : string
Return values
self —

setShareOwner()

public setShareOwner(string $shareOwner) : self
Parameters
$shareOwner : string
Return values
self —

setShareTime()

public setShareTime(DateTime $shareTime) : self
Parameters
$shareTime : DateTime
Return values
self —

setShareType()

public setShareType(int $shareType) : self
Parameters
$shareType : int
Return values
self —

setStatus()

public setStatus(int $status) : self
Parameters
$status : int
Return values
self —

setToken()

public setToken(string $token) : self
Parameters
$token : string
Return values
self —

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 —

setShareDisplay()

private setShareDisplay(IShare $share, IURLGenerator $urlGenerator) : void
Parameters
$share : IShare
$urlGenerator : IURLGenerator
Return values
void —

Search results