|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
namespace alsvanzelf\jsonapi\helpers; |
|
4
|
|
|
|
|
5
|
|
|
use alsvanzelf\jsonapi\objects\LinkObject; |
|
6
|
|
|
use alsvanzelf\jsonapi\objects\LinksArray; |
|
7
|
|
|
use alsvanzelf\jsonapi\objects\LinksObject; |
|
8
|
|
|
|
|
9
|
|
|
trait LinksManager { |
|
|
|
|
|
|
10
|
|
|
/** @var LinksObject */ |
|
11
|
|
|
protected $links; |
|
12
|
|
|
|
|
13
|
|
|
/** |
|
14
|
|
|
* human api |
|
15
|
|
|
*/ |
|
16
|
|
|
|
|
17
|
|
|
/** |
|
18
|
|
|
* set a key containing a link |
|
19
|
|
|
* |
|
20
|
|
|
* @param string $key |
|
|
|
|
|
|
21
|
|
|
* @param string $href |
|
|
|
|
|
|
22
|
|
|
* @param array $meta optional, if given a LinkObject is added, otherwise a link string is added |
|
23
|
|
|
*/ |
|
|
|
|
|
|
24
|
|
|
public function addLink($key, $href, array $meta=[]) { |
|
25
|
|
|
$this->ensureLinksObject(); |
|
26
|
|
|
$this->links->add($key, $href, $meta); |
|
27
|
|
|
} |
|
28
|
|
|
|
|
29
|
|
|
/** |
|
30
|
|
|
* append a link to a key with an array of links |
|
31
|
|
|
* |
|
32
|
|
|
* @param string $key |
|
|
|
|
|
|
33
|
|
|
* @param string $href |
|
|
|
|
|
|
34
|
|
|
* @param array $meta optional, if given a LinkObject is added, otherwise a link string is added |
|
35
|
|
|
*/ |
|
|
|
|
|
|
36
|
|
|
public function appendLink($key, $href, array $meta=[]) { |
|
37
|
|
|
$this->ensureLinksObject(); |
|
38
|
|
|
$this->links->append($key, $href, $meta); |
|
39
|
|
|
} |
|
40
|
|
|
|
|
41
|
|
|
/** |
|
42
|
|
|
* spec api |
|
43
|
|
|
*/ |
|
44
|
|
|
|
|
45
|
|
|
/** |
|
46
|
|
|
* set a key containing a LinkObject |
|
47
|
|
|
* |
|
48
|
|
|
* @param string $key |
|
|
|
|
|
|
49
|
|
|
* @param LinkObject $linkObject |
|
|
|
|
|
|
50
|
|
|
*/ |
|
|
|
|
|
|
51
|
|
|
public function addLinkObject($key, LinkObject $linkObject) { |
|
52
|
|
|
$this->ensureLinksObject(); |
|
53
|
|
|
$this->links->addLinkObject($key, $linkObject); |
|
54
|
|
|
} |
|
55
|
|
|
|
|
56
|
|
|
/** |
|
57
|
|
|
* set a key containing a LinksArray |
|
58
|
|
|
* |
|
59
|
|
|
* @param string $key |
|
|
|
|
|
|
60
|
|
|
* @param LinksArray $linksArray |
|
|
|
|
|
|
61
|
|
|
*/ |
|
|
|
|
|
|
62
|
|
|
public function addLinksArray($key, LinksArray $linksArray) { |
|
63
|
|
|
$this->ensureLinksObject(); |
|
64
|
|
|
$this->links->addLinksArray($key, $linksArray); |
|
65
|
|
|
} |
|
66
|
|
|
|
|
67
|
|
|
/** |
|
68
|
|
|
* append a LinkObject to a key with a LinksArray |
|
69
|
|
|
* |
|
70
|
|
|
* @param string $key |
|
|
|
|
|
|
71
|
|
|
* @param LinkObject $linkObject |
|
|
|
|
|
|
72
|
|
|
*/ |
|
|
|
|
|
|
73
|
|
|
public function appendLinkObject($key, LinkObject $linkObject) { |
|
74
|
|
|
$this->ensureLinksObject(); |
|
75
|
|
|
$this->links->appendLinkObject($key, $linkObject); |
|
76
|
|
|
} |
|
77
|
|
|
|
|
78
|
|
|
/** |
|
79
|
|
|
* set a LinksObject containing all links |
|
80
|
|
|
* |
|
81
|
|
|
* @param LinksObject $linksObject |
|
|
|
|
|
|
82
|
|
|
*/ |
|
|
|
|
|
|
83
|
|
|
public function setLinksObject(LinksObject $linksObject) { |
|
84
|
|
|
$this->links = $linksObject; |
|
85
|
|
|
} |
|
86
|
|
|
|
|
87
|
|
|
/** |
|
88
|
|
|
* internal api |
|
89
|
|
|
*/ |
|
90
|
|
|
|
|
91
|
|
|
/** |
|
92
|
|
|
* @internal |
|
93
|
|
|
*/ |
|
|
|
|
|
|
94
|
|
|
private function ensureLinksObject() { |
|
95
|
|
|
if ($this->links === null) { |
|
96
|
|
|
$this->setLinksObject(new LinksObject()); |
|
97
|
|
|
} |
|
98
|
|
|
} |
|
99
|
|
|
} |
|
100
|
|
|
|
lode /
jsonapi
Loading history...