Class HeaderParameter

This is a helper class for managing headers in REST API requests.

Gedcomx\Rs\Client\Options\HeaderParameter implements Gedcomx\Rs\Client\Options\StateTransitionOption

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

Methods summary

`public`	# `__construct( boolean $replace, string $name, string $value )` Constructs a header parameter with the specified values. Constructs a header parameter with the specified values. Parameters `$replace` `$name` `$value`
`public GuzzleHttp\Psr7\Request`	# `apply( GuzzleHttp\Psr7\Request $request )` This method adds the current header parameters to the REST API request. This method adds the current header parameters to the REST API request. Parameters `$request` Returns GuzzleHttp\Psr7\Request $request Implementation of `Gedcomx\Rs\Client\Options\StateTransitionOption::apply()`
`public static Gedcomx\Rs\Client\Options\HeaderParameter`	# `lang( string $value )` Creates an accept-language header parameter. Creates an accept-language header parameter. Parameters `$value` Returns `Gedcomx\Rs\Client\Options\HeaderParameter`
`public static Gedcomx\Rs\Client\Options\HeaderParameter`	# `locale( string $value )` Creates an accept-language header parameter. Creates an accept-language header parameter. Parameters `$value` Returns `Gedcomx\Rs\Client\Options\HeaderParameter`

`string`	`LANG` The accept language header The accept language header	# `"Accept-Language"`
`string`	`LOCALE` The locale header The locale header	# `Gedcomx\Rs\Client\Options\HeaderParameter::LANG`
`string`	`IF_NONE_MATCH` The if-none-match header The if-none-match header	# `"If-None-Match"`
`string`	`IF_MODIFIED_SINCE` The if-modified-since header The if-modified-since header	# `"If-Modified-Since"`
`string`	`IF_MATCH` The if-match header The if-match header	# `"If-Match"`
`string`	`IF_UNMODIFIED_SINCE` The if-unmodified-since header The if-unmodified-since header	# `"If-Unmodified-Since"`
`string`	`ETAG` The ETag (entity tag) header The ETag (entity tag) header	# `"ETag"`
`string`	`LAST_MODIFIED` The last-modified header The last-modified header	# `"Last-Modified"`