IReferenceProvider
in
Tags
Table of Contents
Methods
- getCacheKey() : string|null
- Return a custom cache key to be used for caching the metadata This could be for example the current user id if the reference access permissions are different for each user
- getCachePrefix() : string
- Return true if the reference metadata can be globally cached
- matchReference() : bool
- Validate that a given reference identifier matches the current provider
- resolveReference() : IReference|null
- Return a reference with its metadata for a given reference identifier
Methods
getCacheKey()
Return a custom cache key to be used for caching the metadata This could be for example the current user id if the reference access permissions are different for each user
public
getCacheKey(string $referenceId) : string|null
Should return null, if the cache is only related to the reference id and has no further dependency
Parameters
- $referenceId : string
Tags
Return values
string|nullgetCachePrefix()
Return true if the reference metadata can be globally cached
public
getCachePrefix(string $referenceId) : string
Parameters
- $referenceId : string
Tags
Return values
stringmatchReference()
Validate that a given reference identifier matches the current provider
public
matchReference(string $referenceText) : bool
Parameters
- $referenceText : string
Tags
Return values
boolresolveReference()
Return a reference with its metadata for a given reference identifier
public
resolveReference(string $referenceText) : IReference|null
Parameters
- $referenceText : string