1. class
  2. Neos
  3. \
  4. Flow
  5. \
  6. Mvc
  7. \
  8. Routing
  9. \
  10. Dto
  11. \
  12. UriConstraints

UriConstraints

final class UriConstraints (View source)

This class allows constraints to be applied to a given URI, transforming it accordingly as a result.

Example:

$exampleUri = new Uri('http://some-domain.tld/foo'); $uriConstraints = UriConstraints::create() ->withScheme('https') ->withHostPrefix('de.', ['en.', 'ch.']) ->withPort(8080) ->withPathPrefix('prefix/'); $resultingUri = $uriConstraints->applyTo($exampleUri); // https://de.some-domain.tld:8080/prefix/foo

Constants

CONSTRAINT_SCHEME

CONSTRAINT_HOST

CONSTRAINT_HOST_PREFIX

CONSTRAINT_HOST_SUFFIX

CONSTRAINT_PORT

CONSTRAINT_PATH

CONSTRAINT_PATH_PREFIX

CONSTRAINT_PATH_SUFFIX

CONSTRAINT_QUERY_STRING

HTTP_DEFAULT_HOST

Methods

static UriConstraints
create()

Create a new instance without any constraints

UriConstraints
merge(UriConstraints $uriConstraints)

Merge two instances of UriConstraints Constraints of the given $uriConstraints instance will overrule similar constraints of this instance

UriConstraints
withScheme(string $scheme)

Create a new instance with the scheme constraint added

UriConstraints
withHost(string $host)

Create a new instance with the host constraint added

UriConstraints
withHostPrefix(string $prefix, array $replacePrefixes = [])

Create a new instance with the host prefix constraint added

UriConstraints
withHostSuffix(string $suffix, array $replaceSuffixes = [])

Create a new instance with the host suffix constraint added

UriConstraints
withPort(int $port)

Create a new instance with the port constraint added

UriConstraints
withPath(string $path)

Create a new instance with the path constraint added

UriConstraints
withQueryString(string $queryString)

Create a new instance with the query string constraint added

UriConstraints
withPathPrefix(string $pathPrefix, bool $append = false)

Create a new instance with the path prefix constraint added This can be applied multiple times, later prefixes will be prepended to the start

UriConstraints
withPathSuffix(string $pathSuffix, bool $prepend = false)

Create a new instance with the path suffix constraint added This can be applied multiple times, later suffixes will be appended to the end

string|null
getPathConstraint()

Returns the URI path constraint, which consists of the path and query string parts, or NULL if none was set

UriInterface
applyTo(UriInterface $baseUri, bool $forceAbsoluteUri)

Applies all constraints of this instance to the given $templateUri and returns a new UriInterface instance satisfying all of the constraints (see example above)

Details

at line 67
static UriConstraints create()

Create a new instance without any constraints

Return Value

UriConstraints

at line 79
UriConstraints merge(UriConstraints $uriConstraints)

Merge two instances of UriConstraints Constraints of the given $uriConstraints instance will overrule similar constraints of this instance

Parameters

UriConstraints $uriConstraints

Return Value

UriConstraints

at line 91
UriConstraints withScheme(string $scheme)

Create a new instance with the scheme constraint added

Parameters

string $scheme

The URI scheme to force, usually "http" or "https"

Return Value

UriConstraints

at line 104
UriConstraints withHost(string $host)

Create a new instance with the host constraint added

Parameters

string $host

The URI host part to force, for example "neos.io"

Return Value

UriConstraints

at line 118
UriConstraints withHostPrefix(string $prefix, array $replacePrefixes = [])

Create a new instance with the host prefix constraint added

Parameters

string $prefix

The URI host prefix to force, for example "en."
array $replacePrefixes

a list of prefixes that should be replaced with the given prefix. if the list is empty or does not match the current host $prefix will be prepended as is

Return Value

UriConstraints

at line 135
UriConstraints withHostSuffix(string $suffix, array $replaceSuffixes = [])

Create a new instance with the host suffix constraint added

Parameters

string $suffix

The URI host suffix to force, for example ".com"
array $replaceSuffixes

a list of suffixes that should be replaced with the given suffix. if the list is empty or does not match, no replacement happens

Return Value

UriConstraints

at line 151
UriConstraints withPort(int $port)

Create a new instance with the port constraint added

Parameters

int $port

The URI port to force, for example 80

Return Value

UriConstraints

at line 164
UriConstraints withPath(string $path)

Create a new instance with the path constraint added

Parameters

string $path

The URI path to force, for example "some/path/"

Return Value

UriConstraints

at line 177
UriConstraints withQueryString(string $queryString)

Create a new instance with the query string constraint added

Parameters

string $queryString

Return Value

UriConstraints

at line 192
UriConstraints withPathPrefix(string $pathPrefix, bool $append = false)

Create a new instance with the path prefix constraint added This can be applied multiple times, later prefixes will be prepended to the start

Parameters

string $pathPrefix

The URI path prefix to force, for example "some-prefix/"
bool $append

If true the $pathPrefix will be added after previous path prefix constraints. By default prefixes are added before any existing prefix

Return Value

UriConstraints

at line 218
UriConstraints withPathSuffix(string $pathSuffix, bool $prepend = false)

Create a new instance with the path suffix constraint added This can be applied multiple times, later suffixes will be appended to the end

Parameters

string $pathSuffix

The URI path suffix to force, for example ".html"
bool $prepend

If true the $pathSuffix will be added before previous path suffix constraints. By default suffixes are added after any existing suffix

Return Value

UriConstraints

at line 233
string|null getPathConstraint()

Returns the URI path constraint, which consists of the path and query string parts, or NULL if none was set

Return Value

string|null

at line 251
UriInterface applyTo(UriInterface $baseUri, bool $forceAbsoluteUri)

Applies all constraints of this instance to the given $templateUri and returns a new UriInterface instance satisfying all of the constraints (see example above)

Parameters

UriInterface $baseUri

The base URI to transform, usually the current request's base URI
bool $forceAbsoluteUri

Whether or not to enforce the resulting URI to contain scheme and host (note: some of the constraints force an absolute URI by default)

Return Value

UriInterface

The transformed URI with all constraints applied