PHP Interface Neomerx\JsonApi\Contracts\Http\HttpFactoryInterface

Datei anzeigen Open project: neomerx/json-api Interface Usage Examples

Public Methods

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>\arraynull $parameters = null, float $quality = 1, string>\arraynull $extensions = null ) : Neomerx\JsonApi\Contracts\Http\Headers\AcceptMediaTypeInterface 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>\arraynull $parameters = null ) : Neomerx\JsonApi\Contracts\Http\Headers\MediaTypeInterface 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.

Method Details

createAcceptHeader() public method

Create Accept HTTP header.
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

createAcceptMediaType() public method

Create media type for Accept HTTP header.
public createAcceptMediaType ( integer $position, string $type, string $subType, string>\arraynull $parameters = null, float $quality = 1, string>\arraynull $extensions = null ) : Neomerx\JsonApi\Contracts\Http\Headers\AcceptMediaTypeInterface
$position integer
$type string
$subType string
$parameters string>\arraynull
$quality float
$extensions string>\arraynull
return Neomerx\JsonApi\Contracts\Http\Headers\AcceptMediaTypeInterface

createHeaderParameters() public method

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

createHeaderParametersParser() public method

Create parameters parser.
public createHeaderParametersParser ( ) : Neomerx\JsonApi\Contracts\Http\Headers\HeaderParametersParserInterface
return Neomerx\JsonApi\Contracts\Http\Headers\HeaderParametersParserInterface

createHeadersChecker() public method

Create header parameters checker.
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

createMediaType() public method

Create media type.
public createMediaType ( string $type, string $subType, string>\arraynull $parameters = null ) : Neomerx\JsonApi\Contracts\Http\Headers\MediaTypeInterface
$type string
$subType string
$parameters string>\arraynull
return Neomerx\JsonApi\Contracts\Http\Headers\MediaTypeInterface

createParametersAnalyzer() public method

Create parameter analyzer.
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

createQueryChecker() public method

Create query parameters checker.
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

createQueryParameters() public method

Create parameters.
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

createQueryParametersParser() public method

Create parameters parser.
public createQueryParametersParser ( ) : Neomerx\JsonApi\Contracts\Http\Query\QueryParametersParserInterface
return Neomerx\JsonApi\Contracts\Http\Query\QueryParametersParserInterface

createSortParam() public method

Create sort parameter.
public createSortParam ( string $sortField, boolean $isAscending ) : Neomerx\JsonApi\Contracts\Encoder\Parameters\SortParameterInterface
$sortField string
$isAscending boolean
return Neomerx\JsonApi\Contracts\Encoder\Parameters\SortParameterInterface

createSupportedExtensions() public method

Create supported extensions.
public createSupportedExtensions ( string $extensions = MediaTypeInterface::NO_EXT ) : Neomerx\JsonApi\Contracts\Http\Headers\SupportedExtensionsInterface
$extensions string
return Neomerx\JsonApi\Contracts\Http\Headers\SupportedExtensionsInterface