Service
in package
Wrapper handling boilerplate code around the ARCHE microservice initialization
See the tests/config.yaml for the required config file structure.
Tags
Table of Contents
Properties
Methods
- __construct() : mixed
- getConfig() : object
- getLog() : Log
- getNoCache() : bool
- Provides a standardized way to determine if the cache should be invalidated
- processException() : ResponseCacheItem
- serveRequest() : ResponseCacheItem
- setCacheDb() : void
- setCallback() : void
- setCacheControlHeader() : void
Properties
$cacheDb
private
CachePdo
$cacheDb
$clbck
private
callable
$clbck
$config
private
object
$config
$log
private
Log
$log
Methods
__construct()
public
__construct(string $confFile) : mixed
Parameters
- $confFile : string
getConfig()
public
getConfig() : object
Return values
objectgetLog()
public
getLog() : Log
Return values
LoggetNoCache()
Provides a standardized way to determine if the cache should be invalidated
public
static getNoCache([bool $httpCacheControl = true ][, string $noCacheQueryParam = 'noCache' ]) : bool
Parameters
- $httpCacheControl : bool = true
- $noCacheQueryParam : string = 'noCache'
Return values
boolprocessException()
public
processException(Throwable $e) : ResponseCacheItem
Parameters
- $e : Throwable
Return values
ResponseCacheItemserveRequest()
public
serveRequest(string $id, array<string|int, mixed> $param[, bool|null $noCache = null ]) : ResponseCacheItem
Parameters
- $id : string
- $param : array<string|int, mixed>
- $noCache : bool|null = null
Return values
ResponseCacheItemsetCacheDb()
public
setCacheDb(CachePdo $cacheDb) : void
Parameters
- $cacheDb : CachePdo
setCallback()
public
setCallback(callable $clbck) : void
Parameters
- $clbck : callable
-
response cache miss handler with signature
fn(acdhOeaw\arche\lib\RepoResourceInterface $res, array $param)where the$paramwill passed from theserveRequest()method$paramparameter.
setCacheControlHeader()
private
setCacheControlHeader(ResponseCacheItem $response) : void
Parameters
- $response : ResponseCacheItem