1. class
  2. Google
  3. \
  4. ApiCore
  5. \
  6. ResourceTemplate
  7. \
  8. Segment

Segment

class Segment (View source)

Represents a segment in a resource template. This is used internally by RelativeResourceTemplate, but is not intended for public use and may change without notice.

Constants

LITERAL_SEGMENT

WILDCARD_SEGMENT

DOUBLE_WILDCARD_SEGMENT

VARIABLE_SEGMENT

Methods

__construct(int $segmentType, string|null $value = null, string|null $key = null, RelativeResourceTemplate $template = null, string $separator = '/')

Segment constructor.

string
__toString()

No description

bool
matches(string $value)

Checks if $value matches this Segment.

int
getSegmentType()

No description

string|null
getKey()

No description

string|null
getValue()

No description

RelativeResourceTemplate|null
getTemplate()

No description

string
getSeparator()

No description

Details

at line 76
__construct(int $segmentType, string|null $value = null, string|null $key = null, RelativeResourceTemplate $template = null, string $separator = '/')

Segment constructor.

Parameters

int $segmentType
string|null $value
string|null $key
RelativeResourceTemplate $template
string $separator The separator that belongs at the end of a segment. Ending segments should use '/'.

Exceptions

ValidationException

at line 112
string __toString()

Return Value

string A string representation of the segment.

at line 124
bool matches(string $value)

Checks if $value matches this Segment.

Parameters

string $value

Return Value

bool

Exceptions

ValidationException

at line 145
int getSegmentType()

Return Value

int

at line 153
string|null getKey()

Return Value

string|null

at line 161
string|null getValue()

Return Value

string|null

at line 169
RelativeResourceTemplate|null getTemplate()

Return Value

RelativeResourceTemplate|null

at line 177
string getSeparator()

Return Value

string