Class QueryParameter

Represents a generic query string parameter to use in REST API requests.

Gedcomx\Rs\Client\Options\QueryParameter implements Gedcomx\Rs\Client\Options\StateTransitionOption

Namespace: Gedcomx\Rs\Client\Options
Package: Gedcomx\Rs\Client\Options
Located at Rs/Client/Options/QueryParameter.php

Methods summary

`public`	# `__construct( boolean $replace, string $name, string $value )` Constructs a new generic query parameter using the specified values. Constructs a new generic query parameter using the specified values. Parameters `$replace` `$name` `$value`
`public GuzzleHttp\Psr7\Request`	# `apply( GuzzleHttp\Psr7\Request $request )` This method adds the current parameter to the specified REST API request. This method adds the current parameter to the specified REST API request. Parameters `$request` Returns GuzzleHttp\Psr7\Request Implementation of `Gedcomx\Rs\Client\Options\StateTransitionOption::apply()`
`public static Gedcomx\Rs\Client\Options\QueryParameter`	# `accessToken( string $value )` Creates an access token query string parameter. Creates an access token query string parameter. Parameters `$value` Returns `Gedcomx\Rs\Client\Options\QueryParameter`
`public static Gedcomx\Rs\Client\Options\QueryParameter`	# `count( string $value )` Creates a count query string parameter. Creates a count query string parameter. Parameters `$value` Returns `Gedcomx\Rs\Client\Options\QueryParameter`
`public static Gedcomx\Rs\Client\Options\QueryParameter`	# `generations( string $value )` Creates a generations query string parameter. Creates a generations query string parameter. Parameters `$value` Returns `Gedcomx\Rs\Client\Options\QueryParameter`
`public static Gedcomx\Rs\Client\Options\QueryParameter`	# `searchQuery( string $value )` Creates a search query string parameter. Creates a search query string parameter. Parameters `$value` Returns `Gedcomx\Rs\Client\Options\QueryParameter`
`public static Gedcomx\Rs\Client\Options\QueryParameter`	# `start( string $value )` Creates a start query string parameter. Creates a start query string parameter. Parameters `$value` Returns `Gedcomx\Rs\Client\Options\QueryParameter`

Constants summary

`string`	`ACCESS_TOKEN` The access token query parameter. The access token query parameter.	# `"access_token"`
`string`	`COUNT` The count query parameter. The count query parameter.	# `"count"`
`string`	`GENERATIONS` The generations query parameter. The generations query parameter.	# `"generations"`
`string`	`SEARCH_QUERY` The search query parameter. The search query parameter.	# `"q"`
`string`	`START` The start query parameter. The start query parameter.	# `"start"`

Namespaces

Classes

Interfaces

Class QueryParameter

Methods summary

Parameters

Parameters

Returns

Implementation of

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Constants summary