1. interface
  2. Google
  3. \
  4. ApiCore
  5. \
  6. ResourceTemplate
  7. \
  8. ResourceTemplateInterface

ResourceTemplateInterface

interface ResourceTemplateInterface (View source)

Represents a resource template that may or may not contain a leading slash, and if a leading slash is present may contain a trailing verb (":"). (Note that a trailing verb without a leading slash is not permitted).

Examples: projects /projects foo/{bar=}/fizz/* /foo/{bar=}/fizz/*:action

Templates use the syntax of the API platform; see https://github.com/googleapis/api-common-protos/blob/master/google/api/http.proto for details. A template consists of a sequence of literals, wildcards, and variable bindings, where each binding can have a sub-path. A string representation can be parsed into an instance of AbsoluteResourceTemplate, which can then be used to perform matching and instantiation.

Methods

string
__toString()

No description

string
render(array $bindings)

Renders a resource template using the provided bindings.

bool
matches(string $path)

Check if $path matches a resource string.

array
match(string $path)

Matches a given $path to a resource template, and returns an array of bindings between wildcards / variables in the template and values in the path. If $path does not match the template, then a ValidationException is thrown.

Details

at line 59
string __toString()

Return Value

string A string representation of the resource template

at line 69
string render(array $bindings)

Renders a resource template using the provided bindings.

Parameters

array $bindings An array matching var names to binding strings.

Return Value

string A rendered representation of this resource template.

Exceptions

ValidationException If $bindings does not contain all required keys or if a sub-template can't be parsed.

at line 77
bool matches(string $path)

Check if $path matches a resource string.

Parameters

string $path A resource string.

Return Value

bool

at line 88
array match(string $path)

Matches a given $path to a resource template, and returns an array of bindings between wildcards / variables in the template and values in the path. If $path does not match the template, then a ValidationException is thrown.

Parameters

string $path A resource string.

Return Value

array Array matching var names to binding values.

Exceptions

ValidationException if path can't be matched to the template.