Method | Description | |
---|---|---|
createAcceptHeader ( Neomerx\JsonApi\Contracts\Http\Headers\AcceptMediaTypeInterface[] $unsortedMediaTypes ) : Neomerx\JsonApi\Contracts\Http\Headers\AcceptHeaderInterface | Create Accept HTTP header. | |
createAcceptMediaType ( integer $position, string $type, string $subType, string>\array |
Create media type for Accept HTTP header. | |
createHeaderParameters ( string $method, Neomerx\JsonApi\Contracts\Http\Headers\AcceptHeaderInterface $accept, Neomerx\JsonApi\Contracts\Http\Headers\HeaderInterface $contentType ) : Neomerx\JsonApi\Contracts\Http\Headers\HeaderParametersInterface | ||
createHeaderParametersParser ( ) : Neomerx\JsonApi\Contracts\Http\Headers\HeaderParametersParserInterface | Create parameters parser. | |
createHeadersChecker ( Neomerx\JsonApi\Contracts\Codec\CodecMatcherInterface $codecMatcher ) : Neomerx\JsonApi\Contracts\Http\Headers\HeadersCheckerInterface | Create header parameters checker. | |
createMediaType ( string $type, string $subType, string>\array |
Create media type. | |
createParametersAnalyzer ( Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface $parameters, Neomerx\JsonApi\Contracts\Schema\ContainerInterface $container ) : Neomerx\JsonApi\Contracts\Encoder\Parameters\ParametersAnalyzerInterface | Create parameter analyzer. | |
createQueryChecker ( boolean | false $allowUnrecognized = false, array $includePaths = null, array $fieldSetTypes = null, array $sortParameters = null, array $pagingParameters = null, array $filteringParameters = null ) : Neomerx\JsonApi\Contracts\Http\Query\QueryCheckerInterface | Create query parameters checker. | |
createQueryParameters ( string[] | null $includePaths = null, array $fieldSets = null, Neomerx\JsonApi\Contracts\Encoder\Parameters\SortParameterInterface[] | null $sortParameters = null, array $pagingParameters = null, array $filteringParameters = null, array $unrecognizedParams = null ) : Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface | Create parameters. | |
createQueryParametersParser ( ) : Neomerx\JsonApi\Contracts\Http\Query\QueryParametersParserInterface | Create parameters parser. | |
createSortParam ( string $sortField, boolean $isAscending ) : Neomerx\JsonApi\Contracts\Encoder\Parameters\SortParameterInterface | Create sort parameter. | |
createSupportedExtensions ( string $extensions = MediaTypeInterface::NO_EXT ) : Neomerx\JsonApi\Contracts\Http\Headers\SupportedExtensionsInterface | Create supported extensions. |
public createAcceptHeader ( Neomerx\JsonApi\Contracts\Http\Headers\AcceptMediaTypeInterface[] $unsortedMediaTypes ) : Neomerx\JsonApi\Contracts\Http\Headers\AcceptHeaderInterface | ||
$unsortedMediaTypes | Neomerx\JsonApi\Contracts\Http\Headers\AcceptMediaTypeInterface[] | |
return | Neomerx\JsonApi\Contracts\Http\Headers\AcceptHeaderInterface |
public createAcceptMediaType ( integer $position, string $type, string $subType, string>\array |
||
$position | integer | |
$type | string | |
$subType | string | |
$parameters | string>\array |
|
$quality | float | |
$extensions | string>\array |
|
return | Neomerx\JsonApi\Contracts\Http\Headers\AcceptMediaTypeInterface |
public createHeaderParameters ( string $method, Neomerx\JsonApi\Contracts\Http\Headers\AcceptHeaderInterface $accept, Neomerx\JsonApi\Contracts\Http\Headers\HeaderInterface $contentType ) : Neomerx\JsonApi\Contracts\Http\Headers\HeaderParametersInterface | ||
$method | string | |
$accept | Neomerx\JsonApi\Contracts\Http\Headers\AcceptHeaderInterface | |
$contentType | Neomerx\JsonApi\Contracts\Http\Headers\HeaderInterface | |
return | Neomerx\JsonApi\Contracts\Http\Headers\HeaderParametersInterface |
public createHeaderParametersParser ( ) : Neomerx\JsonApi\Contracts\Http\Headers\HeaderParametersParserInterface | ||
return | Neomerx\JsonApi\Contracts\Http\Headers\HeaderParametersParserInterface |
public createHeadersChecker ( Neomerx\JsonApi\Contracts\Codec\CodecMatcherInterface $codecMatcher ) : Neomerx\JsonApi\Contracts\Http\Headers\HeadersCheckerInterface | ||
$codecMatcher | Neomerx\JsonApi\Contracts\Codec\CodecMatcherInterface | |
return | Neomerx\JsonApi\Contracts\Http\Headers\HeadersCheckerInterface |
public createMediaType ( string $type, string $subType, string>\array |
||
$type | string | |
$subType | string | |
$parameters | string>\array |
|
return | Neomerx\JsonApi\Contracts\Http\Headers\MediaTypeInterface |
public createParametersAnalyzer ( Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface $parameters, Neomerx\JsonApi\Contracts\Schema\ContainerInterface $container ) : Neomerx\JsonApi\Contracts\Encoder\Parameters\ParametersAnalyzerInterface | ||
$parameters | Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface | |
$container | Neomerx\JsonApi\Contracts\Schema\ContainerInterface | |
return | Neomerx\JsonApi\Contracts\Encoder\Parameters\ParametersAnalyzerInterface |
public createQueryChecker ( boolean | false $allowUnrecognized = false, array $includePaths = null, array $fieldSetTypes = null, array $sortParameters = null, array $pagingParameters = null, array $filteringParameters = null ) : Neomerx\JsonApi\Contracts\Http\Query\QueryCheckerInterface | ||
$allowUnrecognized | boolean | false | |
$includePaths | array | |
$fieldSetTypes | array | |
$sortParameters | array | |
$pagingParameters | array | |
$filteringParameters | array | |
return | Neomerx\JsonApi\Contracts\Http\Query\QueryCheckerInterface |
public createQueryParameters ( string[] | null $includePaths = null, array $fieldSets = null, Neomerx\JsonApi\Contracts\Encoder\Parameters\SortParameterInterface[] | null $sortParameters = null, array $pagingParameters = null, array $filteringParameters = null, array $unrecognizedParams = null ) : Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface | ||
$includePaths | string[] | null | |
$fieldSets | array | |
$sortParameters | Neomerx\JsonApi\Contracts\Encoder\Parameters\SortParameterInterface[] | null | |
$pagingParameters | array | |
$filteringParameters | array | |
$unrecognizedParams | array | |
return | Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface |
public createQueryParametersParser ( ) : Neomerx\JsonApi\Contracts\Http\Query\QueryParametersParserInterface | ||
return | Neomerx\JsonApi\Contracts\Http\Query\QueryParametersParserInterface |
public createSortParam ( string $sortField, boolean $isAscending ) : Neomerx\JsonApi\Contracts\Encoder\Parameters\SortParameterInterface | ||
$sortField | string | |
$isAscending | boolean | |
return | Neomerx\JsonApi\Contracts\Encoder\Parameters\SortParameterInterface |
public createSupportedExtensions ( string $extensions = MediaTypeInterface::NO_EXT ) : Neomerx\JsonApi\Contracts\Http\Headers\SupportedExtensionsInterface | ||
$extensions | string | |
return | Neomerx\JsonApi\Contracts\Http\Headers\SupportedExtensionsInterface |