class BackendPathEvaluator (View source)

Methods

evaluate(HostPath $path)

Evaluate will check to see if the provided host path contains a path alias. If it does, the alias will be resolved, and the result of the resolution will be injected into the HostPath, replacing the alias.

string
resolve(HostPath $path)

Resolve will check to see if the provided host path contains a path alias. If it does, the alias will be resolved, and the result of the resolution will be returned.

string
lookup(SiteAlias $aliasRecord, $pathAlias)

Lookup will use the provided alias record to look up and return the value of a path alias.

string
request(SiteAlias $aliasRecord, string $pathAlias)

Request the value of the path alias from the site associated with the alias record.

Details

evaluate(HostPath $path)

Evaluate will check to see if the provided host path contains a path alias. If it does, the alias will be resolved, and the result of the resolution will be injected into the HostPath, replacing the alias.

Parameters

HostPath $path

The host and path to evaluate aliases on.

string resolve(HostPath $path)

Resolve will check to see if the provided host path contains a path alias. If it does, the alias will be resolved, and the result of the resolution will be returned.

Parameters

HostPath $path

The host and path to resolve aliases on.

Return Value

string

string lookup(SiteAlias $aliasRecord, $pathAlias)

Lookup will use the provided alias record to look up and return the value of a path alias.

Parameters

SiteAlias $aliasRecord

the host to use for lookups

$pathAlias

the alias to look up (files, not %files)

Return Value

string

string request(SiteAlias $aliasRecord, string $pathAlias)

Request the value of the path alias from the site associated with the alias record.

Parameters

SiteAlias $aliasRecord

the host to use for lookups

string $pathAlias

the alias to look up (files, not %files)

Return Value

string