Diviner Tech Docs AphrontRoutingMap

final class AphrontRoutingMap
Phorge Technical Documentation (Aphront)

Collection of routes on a site for an application.

Tasks

Map Information

No methods for this task.

Routing

public function routePath($path) — Find the route matching a path, if one exists.
private function tryRoute($route, $value, $path) — Test a sub-map to see if any routes match a path.
private function newRoutingResult() — Build a new routing result for this map.

Other Methods

public function __get($name)
public function __set($name, $value)
public function current()
public function key()
public function next()
public function rewind()
public function valid()
private function throwOnAttemptedIteration()
public function getPhobjectClassConstant($key, $byte_limit) — Read the value of a class constant.
public function setSite($site)
public function getSite()
public function setApplication($application)
public function getApplication()
public function setRoutes($routes)
public function getRoutes()

Methods

public function __get($name)
Inherited

This method is not documented.

Parameters

$name

Return

wild

public function __set($name, $value)
Inherited

This method is not documented.

Parameters

	$name
	$value

Return

wild

public function current()
Inherited

This method is not documented.

Return

wild

public function key()
Inherited

This method is not documented.

Return

wild

public function next()
Inherited

This method is not documented.

Return

wild

public function rewind()
Inherited

This method is not documented.

Return

wild

public function valid()
Inherited

This method is not documented.

Return

wild

private function throwOnAttemptedIteration()
Inherited

This method is not documented.

Return

wild

public function getPhobjectClassConstant($key, $byte_limit)
Inherited

Phobject

Read the value of a class constant.

This is the same as just typing self::CONSTANTNAME, but throws a more useful message if the constant is not defined and allows the constant to be limited to a maximum length.

Parameters

string	$key	Name of the constant.
int\|null	$byte_limit	Maximum number of bytes permitted in the value.

Return

string

Value of the constant.

public function setSite($site)

This method is not documented.

Parameters

AphrontSite

$site

Return

wild

public function getSite()

This method is not documented.

Return

wild

public function setApplication($application)

This method is not documented.

Parameters

PhabricatorApplication

$application

Return

wild

public function getApplication()

This method is not documented.

Return

wild

public function setRoutes($routes)

This method is not documented.

Parameters

array

$routes

Return

wild

public function getRoutes()

This method is not documented.

Return

wild

public function routePath($path)

Find the route matching a path, if one exists.

Parameters

string

$path

Path to route.

Return

AphrontRoutingResult|null

Routing result, if path matches map.

private function tryRoute($route, $value, $path)

Test a sub-map to see if any routes match a path.

Parameters

string	$route	Path to route.
string	$value	Pattern from the map.
string	$path	Value from the map.

Return

dict<string, wild>|null

Match details, if path matches sub-map.

private function newRoutingResult()

Build a new routing result for this map.

Return

AphrontRoutingResult

New, empty routing result.

Defined: src/aphront/site/AphrontRoutingMap.php:9
Extends: Phobject

final class AphrontRoutingMapPhorge Technical Documentation (Aphront)

Tasks

Map Information

Routing

Other Methods

Methods

public function __get($name)Inherited

public function __set($name, $value)Inherited

public function current()Inherited

public function key()Inherited

public function next()Inherited

public function rewind()Inherited

public function valid()Inherited

private function throwOnAttemptedIteration()Inherited

public function getPhobjectClassConstant($key, $byte_limit)Inherited

public function setSite($site)

public function getSite()

public function setApplication($application)

public function getApplication()

public function setRoutes($routes)

public function getRoutes()

public function routePath($path)

private function tryRoute($route, $value, $path)

private function newRoutingResult()

final class AphrontRoutingMap
Phorge Technical Documentation (Aphront)

public function __get($name)
Inherited

public function __set($name, $value)
Inherited

public function current()
Inherited

public function key()
Inherited

public function next()
Inherited

public function rewind()
Inherited

public function valid()
Inherited

private function throwOnAttemptedIteration()
Inherited

public function getPhobjectClassConstant($key, $byte_limit)
Inherited