1. class
  2. Xpressengine
  3. Routing
  4. Repositories
  5. CacheDecorator

CacheDecorator

class CacheDecorator implements RouteRepository

Class CacheDecorator

Properties

protected RouteRepository $repo Repository instance
protected Repository $cache Cache instance
protected int $minutes expire time
protected string $prefix Prefix for cache key

Methods

__construct(RouteRepository $repo, Repository $cache, int $minutes = 60)

CacheDecorator constructor.

InstanceRoute[]
all()

Returns all route items

InstanceRoute|null
findByUrlAndSiteKey(string $url, string $siteKey)

Retrieve a route by url segment and site key

void
cachingItem(InstanceRoute $route)

Do caching a route item

InstanceRoute|null
findByInstanceId(string $instanceId)

Retrieve a route by instance identifier

InstanceRoute[]
fetchBySiteKey(string $siteKey)

Retrieve routes by site key

InstanceRoute[]
fetchByModule(string $module)

Retrieve routes by module name

InstanceRoute
create(array $input)

Save a new route item and return the instance

InstanceRoute
put(InstanceRoute $route)

Save the route item

bool|null
delete(InstanceRoute $route)

Delete the route item from the repository

string
getCacheKey(string $keyword)

String for cache key

Details

at line 68
__construct(RouteRepository $repo, Repository $cache, int $minutes = 60)

CacheDecorator constructor.

Parameters

RouteRepository $repo Repository instance
Repository $cache Cache instance
int $minutes expire time

at line 80
InstanceRoute[] all()

Returns all route items

Return Value

InstanceRoute[]

at line 103
InstanceRoute|null findByUrlAndSiteKey(string $url, string $siteKey)

Retrieve a route by url segment and site key

Parameters

string $url first segment of url
string $siteKey site key

Return Value

InstanceRoute|null

at line 124
protected void cachingItem(InstanceRoute $route)

Do caching a route item

Parameters

InstanceRoute $route route instance

Return Value

void

at line 136
InstanceRoute|null findByInstanceId(string $instanceId)

Retrieve a route by instance identifier

Parameters

string $instanceId instance identifier

Return Value

InstanceRoute|null

at line 157
InstanceRoute[] fetchBySiteKey(string $siteKey)

Retrieve routes by site key

Parameters

string $siteKey site key

Return Value

InstanceRoute[]

at line 179
InstanceRoute[] fetchByModule(string $module)

Retrieve routes by module name

Parameters

string $module module name

Return Value

InstanceRoute[]

at line 201
InstanceRoute create(array $input)

Save a new route item and return the instance

Parameters

array $input route item attributes

Return Value

InstanceRoute

at line 215
InstanceRoute put(InstanceRoute $route)

Save the route item

Parameters

InstanceRoute $route route instance

Return Value

InstanceRoute

at line 229
bool|null delete(InstanceRoute $route)

Delete the route item from the repository

Parameters

InstanceRoute $route route instance

Return Value

bool|null

at line 243
protected string getCacheKey(string $keyword)

String for cache key

Parameters

string $keyword keyword

Return Value

string