Class OpenSearch\Endpoints\AbstractEndpoint

`abstract`
`implements`	`EndpointInterface`

OpenSearch\Endpoints\AbstractEndpoint implements EndpointInterface

Located at OpenSearch/Endpoints/AbstractEndpoint.php

Methods


					abstract
	public

getParamWhitelist(): string[]

Get the whitelist of allowed parameters.

Implements

OpenSearch\EndpointInterface::getParamWhitelist()

Implemented by


					abstract
	public

getURI(): string

Get the URI.

Implements

OpenSearch\EndpointInterface::getURI()

Implemented by


					abstract
	public

getMethod(): string

Get the HTTP method.

Implements

OpenSearch\EndpointInterface::getMethod()

Implemented by


					
	public

setParams(mixed[] $params): $this

Set the parameters for this endpoint

Parameters

$params

Array of parameters

Implements

OpenSearch\EndpointInterface::setParams()


					
	public

getParams(): array

Get the query string parameters.

Implements

OpenSearch\EndpointInterface::getParams()


					
	public

getOptions(): array

Get the options.

Implements

OpenSearch\EndpointInterface::getOptions()


					
	public

getIndex(): ?string

Get the index.

Implements

OpenSearch\EndpointInterface::getIndex()


					
	public

setIndex(string|string[]|null $index): $this

Set the index.

Implements

OpenSearch\EndpointInterface::setIndex()


					
	public

setId(int|string|null $docID): static

Get the document ID.

Implements

OpenSearch\EndpointInterface::setId()


					
	public

getBody(): string|array|null

Get the body of the request.

Implements

OpenSearch\EndpointInterface::getBody()


					
	public

setBody(string|iterable|null $body): static

Set the body of the request.

Overriden by

Implements

OpenSearch\EndpointInterface::setBody()


					
	protected

getOptionalURI(string $endpoint): string


					
	protected

getParamDeprecation(): array<string, string|null>

This function returns all param deprecations also optional with a replacement field

Overriden by

Properties
`protected`	`array`	`$params = []`	#
`protected`	`string\|null`	`$index = null`	#
`protected`	`string\|int\|null`	`$id = null`	#
`protected`	`string\|null`	`$method = null`	#
`protected`	`string\|array\|null`	`$body = null`	#
`protected`	`SerializerInterface`	`$serializer`	#

Namespaces

Classes

Class OpenSearch\Endpoints\AbstractEndpoint

Implements

Implemented by

Implements

Implemented by

Implements

Implemented by

Parameters

Implements

Implements

Implements

Implements

Implements

Implements

Implements

Overriden by

Implements

Overriden by