1. interface
  2. Xpressengine
  3. Routing
  4. RouteRepository

RouteRepository

interface RouteRepository

Interface RouteRepository

Methods

InstanceRoute[]
all()

Returns all route items

InstanceRoute
findByUrlAndSiteKey(string $url, string $siteKey)

Retrieve a route by url segment and site key

InstanceRoute
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

Details

at line 34
InstanceRoute[] all()

Returns all route items

Return Value

InstanceRoute[]

at line 43
InstanceRoute 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

at line 51
InstanceRoute findByInstanceId(string $instanceId)

Retrieve a route by instance identifier

Parameters

string $instanceId instance identifier

Return Value

InstanceRoute

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

Retrieve routes by site key

Parameters

string $siteKey site key

Return Value

InstanceRoute[]

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

Retrieve routes by module name

Parameters

string $module module name

Return Value

InstanceRoute[]

at line 75
InstanceRoute create(array $input)

Save a new route item and return the instance

Parameters

array $input route item attributes

Return Value

InstanceRoute

at line 83
InstanceRoute put(InstanceRoute $route)

Save the route item

Parameters

InstanceRoute $route route instance

Return Value

InstanceRoute

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

Delete the route item from the repository

Parameters

InstanceRoute $route route instance

Return Value

bool|null