Nextcloud Circles API

FederatedUserService
in package

OCA

Circles

Service

Uses TArrayTools, TStringTools, TNCLogger, TDeserialize

Class FederatedUserService

CACHE_SINGLE_CIRCLE = 'circles/singleCircle'
CACHE_SINGLE_CIRCLE_TTL = 900
CONFLICT_001 = 1
CONFLICT_002 = 2
CONFLICT_003 = 3
CONFLICT_004 = 4
CONFLICT_005 = 5
$ALERT : mixed
$CRITICAL : mixed
$DEBUG : mixed
$EMERGENCY : mixed
$ERROR : mixed
$INFO : mixed
$NOTICE : mixed
$TYPE_ARRAY : mixed
$TYPE_BOOLEAN : mixed
$TYPE_INTEGER : mixed
$TYPE_NULL : mixed
$TYPE_SERIALIZABLE : mixed
$TYPE_STRING : mixed
$WARNING : mixed
$bypass : bool
$cache : ICache
$circleRequest : CircleRequest
$configService : ConfigService
$contactService : ContactService
$currentApp : FederatedUser
$currentUser : FederatedUser
$federatedEventService : FederatedEventService
$groupManager : IGroupManager
$initiatedByAdmin : FederatedUser
$initiatedByOcc : bool
$interfaceService : InterfaceService
$memberRequest : MemberRequest
$membershipService : MembershipService
$remoteInstance : RemoteInstance
$remoteService : RemoteService
$remoteStreamService : RemoteStreamService
$userManager : IUserManager
$userSession : IUserSession
__construct() : mixed: FederatedUserService constructor.
alert() : void
bypassCurrentUserCondition() : void
canBypassCurrentUserCondition() : bool
commandLineInitiator() : void: some ./occ commands allows to add an Initiator, or force the PoV from the local circles' owner
confirmLocalSingleId() : void: Confirm that the singleId of a FederatedUser is unique and not used to any other member of the database.
confirmSingleIdUniqueness() : void: // TODO: implement this check in a maintenance background job
confirmSuperSession() : void
debug() : void
deleteFederatedUser() : void
deserialize() : IDeserializable
deserializeArray() : array<string|int, IDeserializable>
deserializeJson() : IDeserializable
deserializeList() : array<string|int, IDeserializable>
e() : void
emergency() : void
exception() : void
extractIdAndInstance() : array<string|int, mixed>: extract userID and instance from a federatedId
generateFederatedUser() : FederatedUser: Generate a FederatedUser based on local data.
generateRandomSentence() : string
generateRandomWord() : string
getAppInitiator() : FederatedUser: Get the full FederatedUser for a local user.
getCurrentApp() : FederatedUser|null
getCurrentEntity() : FederatedUser|null
getCurrentUser() : FederatedUser|null
getDateDiff() : string
getFederatedMember() : Member: Works like getFederatedUser, but returns a member.
getFederatedUser() : FederatedUser: get a valid FederatedUser, based on the federatedId (userId@instance) and its type.
getFederatedUser_Contact() : FederatedUser
getFederatedUser_Group() : FederatedUser
getFederatedUser_Mail() : FederatedUser
getFederatedUser_SingleId() : FederatedUser
getGroupCircle() : Circle
getInitiatedByAdmin() : FederatedUser
getLocalFederatedUser() : FederatedUser: Get the full FederatedUser for a local user.
getRemoteInstance() : RemoteInstance|null
hasCurrentApp() : bool
hasCurrentEntity() : bool
hasCurrentUser() : bool
hasRemoteInstance() : bool
humanReadable() : string
initCurrentUser() : void: specify $defaultUser in case a session is not opened but user needs to be emulated (ie. cron)
isInitiatedByAdmin() : bool
isInitiatedByOcc() : bool
log() : void
logger() : LoggerInterface
mustHaveCurrentUser() : void
notice() : void
serialize() : array<string|int, mixed>
serializeArray() : array<string|int, mixed>
setCurrentPatron() : void
setCurrentUser() : void: set a CurrentUser, based on a IFederatedUser.
setInitiatedByAdmin() : void
setInitiatedByOcc() : void
setLocalCurrentApp() : void
setLocalCurrentUser() : void
setLocalCurrentUserId() : void
setMemberPatron() : void
setOwnerAsCurrentUser() : void
setRemoteInstance() : void: set a RemoteInstance, mostly from a remote request (RemoteController) Used to limit rights in some request in the local database.
t() : void
throwable() : void
typeOf() : string
unsetCurrentUser() : void
validKey() : bool
warning() : void
cleanArray() : mixed
commonPart() : string
cut() : string
extractArray() : mixed
feedStringWithParams() : string
get() : string
getArray() : array<string|int, mixed>
getBool() : bool
getFloat() : float
getInt() : int
getList() : array<string|int, mixed>
getObj() : mixed
isUuid() : bool
mustContains() : mixed
token() : string
uuid() : string: Generate uuid: 2b5a7a87-8db1-445f-a17b-405790f91c80
cacheSingleCircle() : void
confirmFederatedUser() : void: Confirm that all field of a FederatedUser are filled.
fillSingleCircleId() : void
generateCacheKey() : string
getCachedSingleCircle() : Circle
getFederatedUser_User() : FederatedUser
getSingleCircle() : Circle: get the Single Circle from a local user
markConflict() : void

CACHE_SINGLE_CIRCLE


    public
        mixed
    CACHE_SINGLE_CIRCLE
    = 'circles/singleCircle'

CACHE_SINGLE_CIRCLE_TTL


    public
        mixed
    CACHE_SINGLE_CIRCLE_TTL
    = 900

CONFLICT_001


    public
        mixed
    CONFLICT_001
    = 1

CONFLICT_002


    public
        mixed
    CONFLICT_002
    = 2

CONFLICT_003


    public
        mixed
    CONFLICT_003
    = 3

CONFLICT_004


    public
        mixed
    CONFLICT_004
    = 4

CONFLICT_005


    public
        mixed
    CONFLICT_005
    = 5

$ALERT


    public
    static    mixed
    $ALERT
     = 3

$CRITICAL


    public
    static    mixed
    $CRITICAL
     = 3

$DEBUG


    public
    static    mixed
    $DEBUG
     = 0

$EMERGENCY


    public
    static    mixed
    $EMERGENCY
     = 4

$ERROR


    public
    static    mixed
    $ERROR
     = 3

$INFO


    public
    static    mixed
    $INFO
     = 1

$NOTICE


    public
    static    mixed
    $NOTICE
     = 1

$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_NULL


    public
    static    mixed
    $TYPE_NULL
     = 'Null'

$TYPE_SERIALIZABLE


    public
    static    mixed
    $TYPE_SERIALIZABLE
     = 'Serializable'

$TYPE_STRING


    public
    static    mixed
    $TYPE_STRING
     = 'String'

$WARNING


    public
    static    mixed
    $WARNING
     = 2

$bypass


    private
        bool
    $bypass
     = false

$cache


    private
        ICache
    $cache

$circleRequest


    private
        CircleRequest
    $circleRequest

$configService


    private
        ConfigService
    $configService

$contactService


    private
        ContactService
    $contactService

$currentApp


    private
        FederatedUser
    $currentApp
     = null

$currentUser


    private
        FederatedUser
    $currentUser
     = null

$federatedEventService


    private
        FederatedEventService
    $federatedEventService

$groupManager


    private
        IGroupManager
    $groupManager

$initiatedByAdmin


    private
        FederatedUser
    $initiatedByAdmin
     = null

$initiatedByOcc


    private
        bool
    $initiatedByOcc
     = false

$interfaceService


    private
        InterfaceService
    $interfaceService

$memberRequest


    private
        MemberRequest
    $memberRequest

$membershipService


    private
        MembershipService
    $membershipService

$remoteInstance


    private
        RemoteInstance
    $remoteInstance
     = null

$remoteService


    private
        RemoteService
    $remoteService

$remoteStreamService


    private
        RemoteStreamService
    $remoteStreamService

$userManager


    private
        IUserManager
    $userManager

$userSession


    private
        IUserSession
    $userSession

__construct()

FederatedUserService constructor.


    public
                    __construct(IUserSession $userSession, IUserManager $userManager, IGroupManager $groupManager, ICacheFactory $cacheFactory, FederatedEventService $federatedEventService, MembershipService $membershipService, CircleRequest $circleRequest, MemberRequest $memberRequest, RemoteService $remoteService, RemoteStreamService $remoteStreamService, ContactService $contactService, InterfaceService $interfaceService, ConfigService $configService) : mixed

Parameters

$userSession : IUserSession
$userManager : IUserManager
$groupManager : IGroupManager
$cacheFactory : ICacheFactory
$federatedEventService : FederatedEventService
$membershipService : MembershipService
$circleRequest : CircleRequest
$memberRequest : MemberRequest
$remoteService : RemoteService
$remoteStreamService : RemoteStreamService
$contactService : ContactService
$interfaceService : InterfaceService
$configService : ConfigService

Return values

mixed —

alert()


    public
                    alert(string $message[, bool $trace = false ][, array<string|int, mixed> $serializable = [] ]) : void

Parameters

$message : string
$trace : bool = false
$serializable : array<string|int, mixed> = []

Return values

void —

bypassCurrentUserCondition()


    public
                    bypassCurrentUserCondition(bool $bypass) : void

Parameters

$bypass : bool

Return values

void —

canBypassCurrentUserCondition()


    public
                    canBypassCurrentUserCondition() : bool

Return values

bool —

commandLineInitiator()

some ./occ commands allows to add an Initiator, or force the PoV from the local circles' owner


    public
                    commandLineInitiator(string $userId[, int $userType = Member::TYPE_SINGLE ][, string $circleId = '' ][, bool $bypass = false ]) : void

TODO: manage non-user type ?

Parameters

$userId : string
$userType : int = Member::TYPE_SINGLE
$circleId : string = ''
$bypass : bool = false

Return values

void —

confirmLocalSingleId()

Confirm that the singleId of a FederatedUser is unique and not used to any other member of the database.


    public
                    confirmLocalSingleId(FederatedUser $federatedUser) : void

Parameters

$federatedUser : FederatedUser

Return values

void —

confirmSingleIdUniqueness()

// TODO: implement this check in a maintenance background job


    public
                    confirmSingleIdUniqueness(IFederatedUser $federatedUser) : void

Parameters

$federatedUser : IFederatedUser

Return values

void —

confirmSuperSession()


    public
                    confirmSuperSession() : void

Return values

void —

debug()


    public
                    debug(string $message[, array<string|int, mixed> $serializable = [] ]) : void

Parameters

$message : string
$serializable : array<string|int, mixed> = []

Return values

void —

deleteFederatedUser()


    public
                    deleteFederatedUser(FederatedUser $federatedUser) : void

Parameters

$federatedUser : FederatedUser

Return values

void —

deserialize()


    public
                    deserialize(array<string|int, mixed> $data, string $class) : IDeserializable

Parameters

$data : array<string|int, mixed>
$class : string

Return values

IDeserializable —

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

deserializeJson()


    public
                    deserializeJson(string $json, string $class) : IDeserializable

Parameters

$json : string
$class : string

Return values

IDeserializable —

deserializeList()


    public
                    deserializeList(string $json, string $class) : array<string|int, IDeserializable>

Parameters

$json : string
$class : string

Return values

array<string|int, IDeserializable> —

e()


    public
                    e(Exception $e[, array<string|int, mixed> $serializable = [] ]) : void

Parameters

$e : Exception
$serializable : array<string|int, mixed> = []

Return values

void —

emergency()


    public
                    emergency(string $message[, bool $trace = false ][, array<string|int, mixed> $serializable = [] ]) : void

Parameters

$message : string
$trace : bool = false
$serializable : array<string|int, mixed> = []

Return values

void —

exception()


    public
                    exception(Exception $e[, int|array<string|int, mixed> $level = 3 ][, array<string|int, mixed> $serializable = [] ]) : void

Parameters

$e : Exception
$level : int|array<string|int, mixed> = 3
$serializable : array<string|int, mixed> = []

Return values

void —

extractIdAndInstance()

extract userID and instance from a federatedId


    public
                    extractIdAndInstance(string $federatedId) : array<string|int, mixed>

Parameters

$federatedId : string

Return values

array<string|int, mixed> —

generateFederatedUser()

Generate a FederatedUser based on local data.


    public
                    generateFederatedUser(string $federatedId, int $type) : FederatedUser

WARNING: There is no confirmation that the returned FederatedUser exists or is valid at this point. Use getFederatedUser() instead if a valid and confirmed FederatedUser is needed.

if $federatedId is a known SingleId, will returns data from the local database. if $federatedId is a local username, will returns data from the local database. Otherwise, the FederatedUser will not contains a SingleId.

Parameters

$federatedId : string
$type : int

Return values

FederatedUser —

generateRandomSentence()


    public
                    generateRandomSentence([int $words = 5 ]) : string

Parameters

$words : int = 5

Return values

string —

generateRandomWord()


    public
                    generateRandomWord([int $length = 8 ]) : string

Parameters

$length : int = 8

Return values

string —

getAppInitiator()

Get the full FederatedUser for a local user.


    public
                    getAppInitiator(string $appId, int $appNumber[, string $appDisplayName = '' ]) : FederatedUser

Will generate the SingleId if none exist

Parameters

$appId : string
$appNumber : int
$appDisplayName : string = ''

Return values

FederatedUser —

getCurrentApp()


    public
                    getCurrentApp() : FederatedUser|null

Return values

FederatedUser|null —

getCurrentEntity()


    public
                    getCurrentEntity() : FederatedUser|null

Return values

FederatedUser|null —

getCurrentUser()


    public
                    getCurrentUser() : FederatedUser|null

Return values

FederatedUser|null —

getDateDiff()


    public
                    getDateDiff(int $first, int $second[, bool $short = false ][, array<string|int, mixed> $words = [] ]) : string

Parameters

$first : int
$second : int
$short : bool = false
$words : array<string|int, mixed> = []

Return values

string —

getFederatedMember()

Works like getFederatedUser, but returns a member.


    public
                    getFederatedMember(string $userId[, int $level = Member::LEVEL_MEMBER ]) : Member

Allow to specify a level: handle@instance,level

Used for filters when searching for Circles TODO: Used outside of ./occ circles:manage:list ?

Parameters

$userId : string
$level : int = Member::LEVEL_MEMBER

Return values

Member —

getFederatedUser()

get a valid FederatedUser, based on the federatedId (userId@instance) and its type.


    public
                    getFederatedUser(string $federatedId[, int $type = Member::TYPE_SINGLE ]) : FederatedUser

If instance is local, get the local valid FederatedUser If instance is not local, get the remote valid FederatedUser

Parameters

$federatedId : string
$type : int = Member::TYPE_SINGLE

Return values

FederatedUser —

getFederatedUser_Contact()


    public
                    getFederatedUser_Contact(string $contactPath) : FederatedUser

Parameters

$contactPath : string

Return values

FederatedUser —

getFederatedUser_Group()


    public
                    getFederatedUser_Group(string $groupName, string $instance) : FederatedUser

Parameters

$groupName : string
$instance : string

Return values

FederatedUser —

getFederatedUser_Mail()


    public
                    getFederatedUser_Mail(string $mailAddress) : FederatedUser

Parameters

$mailAddress : string

Return values

FederatedUser —

getFederatedUser_SingleId()


    public
                    getFederatedUser_SingleId(string $singleId, string $instance) : FederatedUser

Parameters

$singleId : string
$instance : string

Return values

FederatedUser —

getGroupCircle()


    public
                    getGroupCircle(string $groupId) : Circle

Parameters

$groupId : string

Return values

Circle —

getInitiatedByAdmin()


    public
                    getInitiatedByAdmin() : FederatedUser

Return values

FederatedUser —

getLocalFederatedUser()

Get the full FederatedUser for a local user.


    public
                    getLocalFederatedUser(string $userId[, bool $check = true ]) : FederatedUser

Will generate the SingleId if none exist

Parameters

$userId : string
$check : bool = true

Return values

FederatedUser —

getRemoteInstance()


    public
                    getRemoteInstance() : RemoteInstance|null

Return values

RemoteInstance|null —

hasCurrentApp()


    public
                    hasCurrentApp() : bool

Return values

bool —

hasCurrentEntity()


    public
                    hasCurrentEntity() : bool

Return values

bool —

hasCurrentUser()


    public
                    hasCurrentUser() : bool

Return values

bool —

hasRemoteInstance()


    public
                    hasRemoteInstance() : bool

Return values

bool —

humanReadable()


    public
                    humanReadable(int $bytes) : string

Parameters

$bytes : int

Return values

string —

initCurrentUser()

specify $defaultUser in case a session is not opened but user needs to be emulated (ie. cron)


    public
                    initCurrentUser([string $defaultUser = '' ]) : void

Parameters

$defaultUser : string = ''

Return values

void —

isInitiatedByAdmin()


    public
                    isInitiatedByAdmin() : bool

Return values

bool —

isInitiatedByOcc()


    public
                    isInitiatedByOcc() : bool

Return values

bool —

log()


    public
                    log(int $level, string $message[, bool $trace = false ][, array<string|int, mixed> $serializable = [] ]) : void

Parameters

$level : int
$message : string
$trace : bool = false
$serializable : array<string|int, mixed> = []

Return values

void —

logger()


    public
                    logger() : LoggerInterface

Return values

LoggerInterface —

mustHaveCurrentUser()


    public
                    mustHaveCurrentUser() : void

Return values

void —

notice()


    public
                    notice(string $message[, bool $trace = false ][, array<string|int, mixed> $serializable = [] ]) : void

Parameters

$message : string
$trace : bool = false
$serializable : array<string|int, mixed> = []

Return values

void —

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

setCurrentPatron()


    public
                    setCurrentPatron(string $userId) : void

Parameters

$userId : string

Return values

void —

setCurrentUser()

set a CurrentUser, based on a IFederatedUser.


    public
                    setCurrentUser(IFederatedUser $federatedUser) : void

CurrentUser is mainly used to manage rights when requesting the database.

Parameters

$federatedUser : IFederatedUser

Return values

void —

setInitiatedByAdmin()


    public
                    setInitiatedByAdmin(FederatedUser $patron) : void

Parameters

$patron : FederatedUser

Return values

void —

setInitiatedByOcc()


    public
                    setInitiatedByOcc(bool $initiatedByOcc) : void

Parameters

$initiatedByOcc : bool

Return values

void —

setLocalCurrentApp()


    public
                    setLocalCurrentApp(string $appId, int $appNumber) : void

Parameters

$appId : string
$appNumber : int

Return values

void —

setLocalCurrentUser()


    public
                    setLocalCurrentUser(IUser|null $user) : void

Parameters

$user : IUser|null

Return values

void —

setLocalCurrentUserId()


    public
                    setLocalCurrentUserId(string $userId) : void

Parameters

$userId : string

Return values

void —

setMemberPatron()


    public
                    setMemberPatron(Member $member) : void

Parameters

$member : Member

Return values

void —

setOwnerAsCurrentUser()


    public
                    setOwnerAsCurrentUser(string $circleId) : void

Parameters

$circleId : string

Return values

void —

setRemoteInstance()

set a RemoteInstance, mostly from a remote request (RemoteController) Used to limit rights in some request in the local database.


    public
                    setRemoteInstance(RemoteInstance $remoteInstance) : void

Parameters

$remoteInstance : RemoteInstance

Return values

void —

t()


    public
                    t(Throwable $t[, array<string|int, mixed> $serializable = [] ]) : void

Parameters

$t : Throwable
$serializable : array<string|int, mixed> = []

Return values

void —

throwable()


    public
                    throwable(Throwable $t[, int $level = 3 ][, array<string|int, mixed> $serializable = [] ]) : void

Parameters

$t : Throwable
$level : int = 3
$serializable : array<string|int, mixed> = []

Return values

void —

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

Return values

string —

unsetCurrentUser()


    public
                    unsetCurrentUser() : void

Return values

void —

validKey()


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

Parameters

$k : string
$arr : array<string|int, mixed>

Return values

bool —

warning()


    public
                    warning(string $message[, bool $trace = false ][, array<string|int, mixed> $serializable = [] ]) : void

Parameters

$message : string
$trace : bool = false
$serializable : array<string|int, mixed> = []

Return values

void —

cleanArray()


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

Parameters

$arr : array<string|int, mixed>

Return values

mixed —

commonPart()


    protected
                    commonPart(string $str1, string $str2[, bool $cs = true ]) : string

Parameters

$str1 : string
$str2 : string
$cs : bool = true: case sensitive ?

Return values

string —

cut()


    protected
                    cut(string $line, int $length) : string

Parameters

$line : string
$length : int

Return values

string —

extractArray()


    protected
                    extractArray(string $k, string $value, array<string|int, mixed> $list) : mixed

Parameters

$k : string
$value : string
$list : array<string|int, mixed>

Return values

mixed —

feedStringWithParams()


    protected
                    feedStringWithParams(string $line, array<string|int, mixed> $params) : string

Parameters

$line : string
$params : array<string|int, mixed>

Return values

string —

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 —

isUuid()


    protected
                    isUuid(string $uuid) : bool

Parameters

$uuid : string

Return values

bool —

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>

Return values

mixed —

token()


    protected
                    token([int $length = 15 ]) : string

Parameters

$length : int = 15

Return values

string —

uuid()

Generate uuid: 2b5a7a87-8db1-445f-a17b-405790f91c80


    protected
                    uuid(int $length) : string

Parameters

$length : int

Return values

string —

cacheSingleCircle()


    private
                    cacheSingleCircle(FederatedUser $federatedUser, Circle $singleCircle) : void

Parameters

$federatedUser : FederatedUser
$singleCircle : Circle

Return values

void —

confirmFederatedUser()

Confirm that all field of a FederatedUser are filled.


    private
                    confirmFederatedUser(FederatedUser $federatedUser) : void

Parameters

$federatedUser : FederatedUser

Return values

void —

fillSingleCircleId()


    private
                    fillSingleCircleId(FederatedUser $federatedUser[, bool $generate = true ]) : void

Parameters

$federatedUser : FederatedUser
$generate : bool = true

Return values

void —

generateCacheKey()


    private
                    generateCacheKey(FederatedUser $federatedUser) : string

Parameters

$federatedUser : FederatedUser

Return values

string —

getCachedSingleCircle()


    private
                    getCachedSingleCircle(FederatedUser $federatedUser) : Circle

Parameters

$federatedUser : FederatedUser

Return values

Circle —

getFederatedUser_User()


    private
                    getFederatedUser_User(string $userId, string $instance) : FederatedUser

Parameters

$userId : string
$instance : string

Return values

FederatedUser —

getSingleCircle()

get the Single Circle from a local user


    private
                    getSingleCircle(FederatedUser $federatedUser[, bool $generate = true ]) : Circle

Parameters

$federatedUser : FederatedUser
$generate : bool = true

Return values

Circle —

markConflict()


    private
                    markConflict(IFederatedUser $federatedUser, Member $knownMember, int $conflict) : void

Parameters

$federatedUser : IFederatedUser
$knownMember : Member
$conflict : int

Return values

void —

FederatedUserService in package OCA Circles Service Uses TArrayTools, TStringTools, TNCLogger, TDeserialize

Table of Contents

Constants

CACHE_SINGLE_CIRCLE

CACHE_SINGLE_CIRCLE_TTL

CONFLICT_001

CONFLICT_002

CONFLICT_003

CONFLICT_004

CONFLICT_005

Properties

$ALERT

$CRITICAL

$DEBUG

$EMERGENCY

$ERROR

$INFO

$NOTICE

$TYPE_ARRAY

$TYPE_BOOLEAN

$TYPE_INTEGER

$TYPE_NULL

$TYPE_SERIALIZABLE

$TYPE_STRING

$WARNING

$bypass

$cache

$circleRequest

$configService

$contactService

$currentApp

$currentUser

$federatedEventService

$groupManager

$initiatedByAdmin

$initiatedByOcc

$interfaceService

$memberRequest

$membershipService

$remoteInstance

$remoteService

$remoteStreamService

$userManager

$userSession

Methods

__construct()

Parameters

Return values

alert()

Parameters

Return values

bypassCurrentUserCondition()

Parameters

Return values

canBypassCurrentUserCondition()

Return values

commandLineInitiator()

Parameters

Tags

Return values

confirmLocalSingleId()

Parameters

Tags

Return values

confirmSingleIdUniqueness()

Parameters

Tags

Return values

confirmSuperSession()

Tags

Return values

debug()

Parameters

Return values

deleteFederatedUser()

Parameters

Return values

deserialize()

Parameters

Tags

FederatedUserService
in package

OCA

Circles

Service

Uses TArrayTools, TStringTools, TNCLogger, TDeserialize