Classes | Functions | Variables
wcmf\lib\presentation\format\impl Namespace Reference

Classes

class  AbstractFormat
 
class  DefaultFormatter
 
class  DownloadFormat
 
class  GenericFormat
 
class  HierarchicalFormat
 
class  HtmlFormat
 
class  JsonFormat
 
class  NullFormat
 
class  SoapFormat
 

Functions

 isCached (Response $response)
 
 getCacheDate (Response $response)
 
 getBaseCacheSection ()
 
 getCacheSection (Response $response)
 
 isCaching (Response $response)
 
 putInCache (Response $response, $payload)
 
 getFromCache (Response $response)
 

Variables

trait CacheTrait
 

Function Documentation

◆ isCached()

wcmf\lib\presentation\format\impl\isCached ( Response  $response)
See also
Format::isCached()

Definition at line 32 of file CacheTrait.php.

◆ getCacheDate()

wcmf\lib\presentation\format\impl\getCacheDate ( Response  $response)
See also
Format::getCacheDate()

Definition at line 40 of file CacheTrait.php.

◆ getBaseCacheSection()

wcmf\lib\presentation\format\impl\getBaseCacheSection ( )
protected

Get the cache base section for the concreate format.

Note
Sublcasses override this to define custom base cache sections
Returns
String

Definition at line 50 of file CacheTrait.php.

◆ getCacheSection()

wcmf\lib\presentation\format\impl\getCacheSection ( Response  $response)
protected

Get the cache section for a response.

Parameters
Response$response
Returns
String

Definition at line 59 of file CacheTrait.php.

◆ isCaching()

wcmf\lib\presentation\format\impl\isCaching ( Response  $response)
protected

Check if the response should be cached.

Parameters
$response
Boolean

Definition at line 69 of file CacheTrait.php.

◆ putInCache()

wcmf\lib\presentation\format\impl\putInCache ( Response  $response,
  $payload 
)
protected

Store the payload of the response in the cache.

Parameters
$response
$payloadString

Definition at line 78 of file CacheTrait.php.

◆ getFromCache()

wcmf\lib\presentation\format\impl\getFromCache ( Response  $response)
protected

Load the payload of the response from the cache.

Parameters
$response
Returns
String

Definition at line 87 of file CacheTrait.php.

Variable Documentation

◆ CacheTrait

trait CacheTrait
Initial value:
{
protected abstract function getCache()

CacheTrait adds support for cached responses.

Author
ingo herwig ingo@.nosp@m.wemo.nosp@m.ve.co.nosp@m.m

Definition at line 21 of file CacheTrait.php.