Page MenuHomePhorge
Diviner Tech Docs CelerityResourceMap

final class CelerityResourceMap
Phorge Technical Documentation (Celerity)

Interface to the static resource map, which is a graph of available resources, resource dependencies, and packaging information. You generally do not need to invoke it directly; instead, you call higher-level Celerity APIs and it uses the resource map to satisfy your requests.

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$keyName of the constant.
int|null$byte_limitMaximum number of bytes permitted in the value.
Return
stringValue of the constant.

public function __construct($resources)

This method is not documented.
Parameters
CelerityResources$resources
Return
this//Implicit.//

public static function getNamedInstance($name)

This method is not documented.
Parameters
$name
Return
wild

public function getNameMap()

This method is not documented.
Return
wild

public function getSymbolMap()

This method is not documented.
Return
wild

public function getRequiresMap()

This method is not documented.
Return
wild

public function getPackageMap()

This method is not documented.
Return
wild

public function getPackagedNamesForSymbols($symbols)

This method is not documented.
Parameters
array$symbols
Return
wild

private function resolveResources($symbols)

This method is not documented.
Parameters
array$symbols
Return
wild

private function resolveResource(&$map, $symbol)

This method is not documented.
Parameters
array&$map
$symbol
Return
wild

private function packageResources($resolved_map)

This method is not documented.
Parameters
array$resolved_map
Return
wild

public function getResourceDataForName($resource_name)

This method is not documented.
Parameters
$resource_name
Return
wild

public function getResourceNamesForPackageName($package_name)

This method is not documented.
Parameters
$package_name
Return
wild

public function getModifiedTimeForName($name)

Get the epoch timestamp of the last modification time of a symbol.

Parameters
string$nameResource symbol to lookup.
Return
intEpoch timestamp of last resource modification.

public function getURIForSymbol($symbol)

Return the absolute URI for the resource associated with a symbol. This method is fairly low-level and ignores packaging.

Parameters
string$symbolResource symbol to lookup.
Return
string|nullResource URI, or null if the symbol is unknown.

public function getURIForName($name)

Return the absolute URI for the resource associated with a resource name. This method is fairly low-level and ignores packaging.

Parameters
string$nameResource name to lookup.
Return
string|nullResource URI, or null if the name is unknown.

public function getHashForName($name)

This method is not documented.
Parameters
$name
Return
wild

private function getURIForHash($hash)

Return the absolute URI for a resource, identified by hash. This method is fairly low-level and ignores packaging.

Parameters
string$hashResource hash to lookup.
Return
string|nullResource URI, or null if the hash is unknown.

public function getRequiredSymbolsForName($name)

Return the resource symbols required by a named resource.

Parameters
string$nameResource name to lookup.
Return
list<string>|nullList of required symbols, or null if the name is unknown.

public function getResourceNameForSymbol($symbol)

Return the resource name for a given symbol.

Parameters
string$symbolResource symbol to lookup.
Return
string|nullResource name, or null if the symbol is unknown.

public function isPackageResource($name)

This method is not documented.
Parameters
$name
Return
wild

public function getResourceTypeForName($name)

This method is not documented.
Parameters
$name
Return
wild