class HTTPProvider implements PersistedQueryMappingProvider (View source)

Class HTTPProvider

Traits

Provides extensions to this object to integrate it with standard config API methods.

A class that can be instantiated or replaced via DI

Config options

timeout int

Timeout for the HTTP request

Properties

protected array $schemaToURL

Example:

SilverStripe\Core\Injector\Injector:
  SilverStripe\GraphQL\PersistedQuery\PersistedQueryMappingProvider:
    class :SilverStripe\GraphQL\PersistedQuery\HTTPProvider:
      properties:
        schemaMapping:
          default: 'http://example.com/mapping.json'
protected HTTPClient $client
protected array $responseCache

A cache of schema key to HTTP responses

Methods

public static 
config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).

public
mixed
stat(string $name) deprecated

Get inherited config value

public
mixed
uninherited(string $name)

Gets the uninherited value for the given config option

public
$this
set_stat(string $name, mixed $value) deprecated

Update the config value for a given property

public static 
create(mixed ...$args)

An implementation of the factory method, allows you to create an instance of a class

public static 
singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

public
__construct(HTTPClient|null $client = null)

HTTPProvider constructor.

public
array
getQueryMapping(string $schemaKey = 'default')

return a map from to

public
string|null
getByID(string $queryID, string $schemaKey = 'default')

return a query given an ID

public
setSchemaMapping(array $mapping)

Sets mapping of query mapping to schema keys

public
array
getSchemaMapping()

No description

public
setClient(HTTPClient $client)

No description

public
getClient()

No description

Details

static Config_ForClass config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).

Return Value

Config_ForClass

mixed stat(string $name) deprecated

deprecated 5.0 Use ->config()->get() instead

Get inherited config value

Parameters

string $name

Return Value

mixed

mixed uninherited(string $name)

Gets the uninherited value for the given config option

Parameters

string $name

Return Value

mixed

$this set_stat(string $name, mixed $value) deprecated

deprecated 5.0 Use ->config()->set() instead

Update the config value for a given property

Parameters

string $name
mixed $value

Return Value

$this

static Injectable create(mixed ...$args)

An implementation of the factory method, allows you to create an instance of a class

This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.

This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create(SiteTree::class); $list = SiteTree::get();

Parameters

mixed ...$args

Return Value

Injectable

static Injectable singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).

Parameters

string $class

Optional classname to create, if the called class should not be used

Return Value

Injectable

The singleton instance

__construct(HTTPClient|null $client = null)

HTTPProvider constructor.

Parameters

HTTPClient|null $client

array getQueryMapping(string $schemaKey = 'default')

return a map from to

Parameters

string $schemaKey

Return Value

array

string|null getByID(string $queryID, string $schemaKey = 'default')

return a query given an ID

Parameters

string $queryID
string $schemaKey

Return Value

string|null

PersistedQueryMappingProvider setSchemaMapping(array $mapping)

Sets mapping of query mapping to schema keys

Parameters

array $mapping

Return Value

PersistedQueryMappingProvider

array getSchemaMapping()

No description

Return Value

array

HTTPProvider setClient(HTTPClient $client)

No description

Parameters

HTTPClient $client

Return Value

HTTPProvider

HTTPClient getClient()

No description

Return Value

HTTPClient