Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.

(no description)

File Size: 302 lines (8 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

CacheEntry:: (17 methods):
  __construct()
  getResponse()
  getOriginalResponse()
  getOriginalRequest()
  isVaryEquals()
  getVaryHeaders()
  getStaleAt()
  isFresh()
  isStale()
  getStaleAge()
  serveStaleIfError()
  staleWhileValidate()
  hasValidationInformation()
  getTTL()
  getAge()
  __sleep()
  __wakeup()


Class: CacheEntry  - X-Ref

__construct(RequestInterface $request,ResponseInterface $response,\DateTime $staleAt,\DateTime $staleIfErrorTo = null,\DateTime $staleWhileRevalidateTo = null)   X-Ref

param: RequestInterface $request
param: ResponseInterface $response
param: \DateTime $staleAt
param: \DateTime|null $staleIfErrorTo if null, detected with the headers (RFC 5861)
param: \DateTime|null $staleWhileRevalidateTo

getResponse()   X-Ref

return: ResponseInterface

getOriginalResponse()   X-Ref

return: ResponseInterface

getOriginalRequest()   X-Ref

return: RequestInterface

isVaryEquals(RequestInterface $request)   X-Ref

param: RequestInterface $request
return: bool

getVaryHeaders()   X-Ref
Get the vary headers that should be honoured by the cache.

return: KeyValueHttpHeader

getStaleAt()   X-Ref

return: \DateTime

isFresh()   X-Ref

return: bool

isStale()   X-Ref

return: bool

getStaleAge()   X-Ref

return: int positive value equal staled

serveStaleIfError()   X-Ref

return: bool

staleWhileValidate()   X-Ref

return: bool

hasValidationInformation()   X-Ref

return: bool

getTTL()   X-Ref
Time in seconds how long the entry should be kept in the cache

This will not give the time (in seconds) that the response will still be fresh for
from the HTTP point of view, but an upper bound on how long it is necessary and
reasonable to keep the response in a cache (to re-use it or re-validate it later on).

return: int TTL in seconds (0 = infinite)

getAge()   X-Ref

return: int Age in seconds

__sleep()   X-Ref
No description

__wakeup()   X-Ref
No description