IManager
extends
IProvider
in
Tags
Table of Contents
Methods
- canAccessCollection() : bool
- Can a user/guest access the collection
- canAccessResource() : bool
- Can a user/guest access the collection
- createResource() : IResource
- getCollection() : ICollection
- getCollectionForUser() : ICollection
- getResourceForUser() : IResource
- getResourceRichObject() : array<string|int, mixed>
- Get the rich object data of a resource
- getType() : string
- Get the resource type of the provider
- invalidateAccessCacheForProvider() : void
- invalidateAccessCacheForProviderByUser() : void
- invalidateAccessCacheForResource() : void
- invalidateAccessCacheForResourceByUser() : void
- invalidateAccessCacheForUser() : void
- newCollection() : ICollection
- registerResourceProvider() : void
Methods
canAccessCollection()
Can a user/guest access the collection
public
canAccessCollection(ICollection $collection, IUser|null $user) : bool
Parameters
- $collection : ICollection
- $user : IUser|null
Tags
Return values
boolcanAccessResource()
Can a user/guest access the collection
public
canAccessResource(IResource $resource, IUser|null $user) : bool
Parameters
Tags
Return values
boolcreateResource()
public
createResource(string $type, string $id) : IResource
Parameters
- $type : string
- $id : string
Tags
Return values
IResourcegetCollection()
public
getCollection(int $id) : ICollection
Parameters
- $id : int
Tags
Return values
ICollectiongetCollectionForUser()
public
getCollectionForUser(int $id, IUser|null $user) : ICollection
Parameters
- $id : int
- $user : IUser|null
Tags
Return values
ICollectiongetResourceForUser()
public
getResourceForUser(string $type, string $id, IUser|null $user) : IResource
Parameters
- $type : string
- $id : string
- $user : IUser|null
Tags
Return values
IResourcegetResourceRichObject()
Get the rich object data of a resource
public
getResourceRichObject(IResource $resource) : array<string|int, mixed>
Parameters
- $resource : IResource
Tags
Return values
array<string|int, mixed>getType()
Get the resource type of the provider
public
getType() : string
Tags
Return values
stringinvalidateAccessCacheForProvider()
public
invalidateAccessCacheForProvider(IProvider $provider) : void
Parameters
- $provider : IProvider
Tags
invalidateAccessCacheForProviderByUser()
public
invalidateAccessCacheForProviderByUser(IProvider $provider, IUser|null $user) : void
Parameters
Tags
invalidateAccessCacheForResource()
public
invalidateAccessCacheForResource(IResource $resource) : void
Parameters
- $resource : IResource
Tags
invalidateAccessCacheForResourceByUser()
public
invalidateAccessCacheForResourceByUser(IResource $resource, IUser|null $user) : void
Parameters
Tags
invalidateAccessCacheForUser()
public
invalidateAccessCacheForUser(IUser|null $user) : void
Parameters
- $user : IUser|null
Tags
newCollection()
public
newCollection(string $name) : ICollection
Parameters
- $name : string
Tags
Return values
ICollectionregisterResourceProvider()
public
registerResourceProvider(string $provider) : void
Parameters
- $provider : string