PHPFUI/InstaDoc
 
Copied!

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.

  • internal
CloneableInstantiable
Constants
public Google\ApiCore\ResourceTemplate\Segment::DOUBLE_WILDCARD_SEGMENT = 2
public Google\ApiCore\ResourceTemplate\Segment::LITERAL_SEGMENT = 0
public Google\ApiCore\ResourceTemplate\Segment::VARIABLE_SEGMENT = 3
public Google\ApiCore\ResourceTemplate\Segment::WILDCARD_SEGMENT = 1
Methods
public __construct(int $segmentType, ?string $value = NULL, ?string $key = NULL, ?Google\ApiCore\ResourceTemplate\RelativeResourceTemplate $template = NULL, string $separator = '/')
 

Segment constructor.

  • param int $segmentType
  • param string|null $value
  • param string|null $key
  • param \RelativeResourceTemplate|null $template
  • param string $separator The separator that belongs at the end of a segment. Ending segments should use '/'.
  • throws \ValidationException
public __toString() : string
 
  • return string A string representation of the segment.
public getKey()
 
  • return string|null
public getSegmentType()
 
  • return int
public getSeparator()
 
  • return string
public getTemplate()
 
  • return \RelativeResourceTemplate|null
public getValue()
 
  • return string|null
public matches(string $value)
 

Checks if $value matches this Segment.

  • param string $value
  • return bool
  • throws \ValidationException
Properties
private ?string $key
private int $segmentType
private ?string $separator
private ?string $stringRepr
private ?Google\ApiCore\ResourceTemplate\RelativeResourceTemplate $template
private ?string $value
Methods
private static isValidBinding(string $binding)
 

Check if $binding is a valid segment binding. Segment bindings may contain any characters except a forward slash ('/'), and may not be empty.

  • param string $binding
  • return bool
private static isValidDoubleWildcardBinding(string $binding)
 

Check if $binding is a valid double wildcard binding. Segment bindings may contain any characters, but may not be empty.

  • param string $binding
  • return bool
Methods
private static isValidBinding(string $binding)
 

Check if $binding is a valid segment binding. Segment bindings may contain any characters except a forward slash ('/'), and may not be empty.

  • param string $binding
  • return bool
private static isValidDoubleWildcardBinding(string $binding)
 

Check if $binding is a valid double wildcard binding. Segment bindings may contain any characters, but may not be empty.

  • param string $binding
  • return bool
© 2026 Bruce Wells
Search Namespaces \ Classes
Configuration