-
Notifications
You must be signed in to change notification settings - Fork 7
/
DocumentInterface.php
89 lines (77 loc) · 2.67 KB
/
DocumentInterface.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
82
83
84
85
86
87
88
89
<?php
/**
* Copyright 2017 Cloud Creativity Limited
*
* 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.
*/
namespace CloudCreativity\JsonApi\Contracts\Object;
use CloudCreativity\JsonApi\Exceptions\RuntimeException;
use CloudCreativity\Utils\Object\StandardObjectInterface;
use Neomerx\JsonApi\Contracts\Document\DocumentInterface as NeomerxDocumentInterface;
use Neomerx\JsonApi\Exceptions\ErrorCollection;
/**
* Interface DocumentInterface
*
* @package CloudCreativity\JsonApi
*/
interface DocumentInterface extends StandardObjectInterface, MetaMemberInterface
{
const DATA = NeomerxDocumentInterface::KEYWORD_DATA;
const META = NeomerxDocumentInterface::KEYWORD_META;
const INCLUDED = NeomerxDocumentInterface::KEYWORD_INCLUDED;
const ERRORS = NeomerxDocumentInterface::KEYWORD_ERRORS;
/**
* Get the data member of the document as a standard object or array
*
* @return StandardObjectInterface|array|null
* @throws RuntimeException
* if the data member is not present, or is not an object, array or null.
*/
public function getData();
/**
* Get the data member as a resource object.
*
* @return ResourceObjectInterface
* @throws RuntimeException
* if the data member is not an object or is not present.
*/
public function getResource();
/**
* Get the data member as a resource object collection.
*
* @return ResourceObjectCollectionInterface
* @throws RuntimeException
* if the data member is not an array or is not present.
*/
public function getResources();
/**
* Get the document as a relationship.
*
* @return RelationshipInterface
*/
public function getRelationship();
/**
* Get the included member as a resource object collection.
*
* @return ResourceObjectCollectionInterface|null
* the resources or null if the included member is not present.
*/
public function getIncluded();
/**
* Get the errors member as an error collection.
*
* @return ErrorCollection|null
* the errors or null if the error member is not present.
*/
public function getErrors();
}