/
BaseWriterInterface.php
81 lines (71 loc) · 1.74 KB
/
BaseWriterInterface.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
<?php declare(strict_types=1);
namespace Neomerx\JsonApi\Contracts\Representation;
/**
* Copyright 2015-2020 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.
*/
/**
* @package Neomerx\JsonApi
*/
interface BaseWriterInterface
{
/**
* Get final document.
*
* @return array
*/
public function getDocument(): array;
/**
* Main data section will be an array of resources or identifiers.
*
* @return self
*/
public function setDataAsArray(): self;
/**
* @param mixed $meta
*
* @return self
*/
public function setMeta($meta): self;
/**
* @param string $version
*
* @return self
*/
public function setJsonApiVersion(string $version): self;
/**
* @param mixed $meta
*
* @return self
*/
public function setJsonApiMeta($meta): self;
/**
* @param string $prefix
*
* @return self
*/
public function setUrlPrefix(string $prefix): self;
/**
* @param iterable $links
*
* @return self
*/
public function setLinks(iterable $links): self;
/**
* @param iterable $links
*
* @return self
*/
public function setProfile(iterable $links): self;
}