<?php declare(strict_types=1);
namespace Neomerx\JsonApi\Contracts\Representation;
/**
* Copyright 2015-2019 info@neomerx.com
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
use Neomerx\JsonApi\Contracts\Parser\IdentifierInterface;
use Neomerx\JsonApi\Contracts\Parser\ResourceInterface;
/**
* @package Neomerx\JsonApi
*/
interface DocumentWriterInterface extends BaseWriterInterface
{
/**
* @return self
*/
public function setNullToData(): self;
/**
* @param IdentifierInterface $identifier
*
* @return self
*/
public function addIdentifierToData(IdentifierInterface $identifier): self;
/**
* @param ResourceInterface $resource
* @param FieldSetFilterInterface $filter
*
* @return self
*/
public function addResourceToData(ResourceInterface $resource, FieldSetFilterInterface $filter): self;
/**
* @param ResourceInterface $resource
* @param FieldSetFilterInterface $filter
*
* @return self
*/
public function addResourceToIncluded(ResourceInterface $resource, FieldSetFilterInterface $filter): self;
}