SDK for PHP V3

EndpointDefinitionProvider
in package

Provides Endpoint-related artifacts used for endpoint resolution and testing.

Table of Contents

Methods

getEndpointBdd()  : mixed
Returns the parsed endpoint BDD for a service, or null when `$throwIfMissing` is false and no BDD file is packaged.
getEndpointRuleset()  : mixed
getEndpointTests()  : mixed
getParsedRuleset()  : Ruleset|BddRuleset
Returns a parsed ruleset for the service — either a {@see BddRuleset} if a compiled BDD is shipped, or a {@see Ruleset} otherwise. Selection is driven by which file is packaged, so callers get a typed object rather than having to inspect the raw array.
getPartitions()  : mixed

Methods

getEndpointBdd()

Returns the parsed endpoint BDD for a service, or null when `$throwIfMissing` is false and no BDD file is packaged.

public static getEndpointBdd(mixed $service, mixed $apiVersion[, mixed $baseDir = null ][, mixed $throwIfMissing = true ]) : mixed
Parameters
$service : mixed
$apiVersion : mixed
$baseDir : mixed = null
$throwIfMissing : mixed = true

getEndpointRuleset()

public static getEndpointRuleset(mixed $service, mixed $apiVersion[, mixed $baseDir = null ]) : mixed
Parameters
$service : mixed
$apiVersion : mixed
$baseDir : mixed = null

getEndpointTests()

public static getEndpointTests(mixed $service, mixed $apiVersion[, mixed $baseDir = null ]) : mixed
Parameters
$service : mixed
$apiVersion : mixed
$baseDir : mixed = null

getParsedRuleset()

Returns a parsed ruleset for the service — either a {@see BddRuleset} if a compiled BDD is shipped, or a {@see Ruleset} otherwise. Selection is driven by which file is packaged, so callers get a typed object rather than having to inspect the raw array.

public static getParsedRuleset( $service,  $apiVersion, array<string|int, mixed> $partitions[, null $baseDir = null ]) : Ruleset|BddRuleset
Parameters
$service :
$apiVersion :
$partitions : array<string|int, mixed>
$baseDir : null = null
Return values
Ruleset|BddRuleset

getPartitions()

public static getPartitions() : mixed
<-- modeled_exceptions -->
On this page