PHP Interface Neomerx\JsonApi\Contracts\Document\DocumentFactoryInterface

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

Public Methods

Method	Description
createDocument ( ) : Neomerx\JsonApi\Contracts\Document\DocumentInterface	Create document.
createError ( integer \| string \| null $idx = null, LinkInterface $aboutLink = null, string \| null $status = null, string \| null $code = null, string \| null $title = null, string \| null $detail = null, mixed \| null $source = null, array $meta = null ) : Neomerx\JsonApi\Contracts\Document\ErrorInterface	Create error instance.

Method Details

createDocument() public method

Create document.

public createDocument ( ) : Neomerx\JsonApi\Contracts\Document\DocumentInterface
return	Neomerx\JsonApi\Contracts\Document\DocumentInterface

createError() public method

Create error instance.

public createError ( integer \| string \| null $idx = null, LinkInterface $aboutLink = null, string \| null $status = null, string \| null $code = null, string \| null $title = null, string \| null $detail = null, mixed \| null $source = null, array $meta = null ) : Neomerx\JsonApi\Contracts\Document\ErrorInterface
$idx	integer \| string \| null
$aboutLink	LinkInterface
$status	string \| null
$code	string \| null
$title	string \| null
$detail	string \| null
$source	mixed \| null
$meta	array
return	Neomerx\JsonApi\Contracts\Document\ErrorInterface