|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
/* |
|
4
|
|
|
* This file is part of the xAPI package. |
|
5
|
|
|
* |
|
6
|
|
|
* (c) Christian Flothmann <[email protected]> |
|
7
|
|
|
* |
|
8
|
|
|
* For the full copyright and license information, please view the LICENSE |
|
9
|
|
|
* file that was distributed with this source code. |
|
10
|
|
|
*/ |
|
11
|
|
|
|
|
12
|
|
|
namespace Xabbuh\XApi\Model; |
|
13
|
|
|
|
|
14
|
|
|
/** |
|
15
|
|
|
* The verb in a {@link Statement}. |
|
16
|
|
|
* |
|
17
|
|
|
* @author Christian Flothmann <[email protected]> |
|
18
|
|
|
*/ |
|
19
|
|
|
final class Verb |
|
20
|
|
|
{ |
|
21
|
|
|
/** |
|
22
|
|
|
* Reference to the verb definition |
|
23
|
|
|
* @var string |
|
24
|
|
|
*/ |
|
25
|
|
|
private $id; |
|
26
|
|
|
|
|
27
|
|
|
/** |
|
28
|
|
|
* Human readable representation of the verb in one or more languages |
|
29
|
|
|
* @var array|null |
|
30
|
|
|
*/ |
|
31
|
|
|
private $display; |
|
32
|
|
|
|
|
33
|
|
|
/** |
|
34
|
|
|
* @param string $id |
|
35
|
|
|
* @param array $display |
|
36
|
|
|
*/ |
|
37
|
13 |
|
public function __construct($id, array $display = null) |
|
38
|
|
|
{ |
|
39
|
13 |
|
$this->id = $id; |
|
40
|
13 |
|
$this->display = $display; |
|
41
|
13 |
|
} |
|
42
|
|
|
|
|
43
|
|
|
/** |
|
44
|
|
|
* Returns the verb definition reference. |
|
45
|
|
|
* |
|
46
|
|
|
* @return string The reference |
|
47
|
|
|
*/ |
|
48
|
9 |
|
public function getId() |
|
49
|
|
|
{ |
|
50
|
9 |
|
return $this->id; |
|
51
|
|
|
} |
|
52
|
|
|
|
|
53
|
|
|
/** |
|
54
|
|
|
* Returns the human readable representation of the Verb in one or more languages. |
|
55
|
|
|
* |
|
56
|
|
|
* @return array|null The language map |
|
57
|
|
|
*/ |
|
58
|
6 |
|
public function getDisplay() |
|
59
|
|
|
{ |
|
60
|
6 |
|
return $this->display; |
|
61
|
|
|
} |
|
62
|
|
|
|
|
63
|
|
|
/** |
|
64
|
|
|
* Checks if another verb is equal. |
|
65
|
|
|
* |
|
66
|
|
|
* Two verbs are equal if and only if all of their properties are equal. |
|
67
|
|
|
* |
|
68
|
|
|
* @param Verb $verb The verb to compare with |
|
69
|
|
|
* |
|
70
|
|
|
* @return bool True if the verbs are equal, false otherwise |
|
71
|
|
|
*/ |
|
72
|
7 |
|
public function equals(Verb $verb) |
|
73
|
|
|
{ |
|
74
|
7 |
|
if ($this->id !== $verb->getId()) { |
|
75
|
1 |
|
return false; |
|
76
|
|
|
} |
|
77
|
|
|
|
|
78
|
6 |
|
if (!is_array($this->display) xor !is_array($verb->display)) { |
|
79
|
1 |
|
return false; |
|
80
|
|
|
} |
|
81
|
|
|
|
|
82
|
5 |
|
if (count($this->display) !== count($verb->getDisplay())) { |
|
83
|
5 |
|
return false; |
|
84
|
1 |
|
} |
|
85
|
|
|
|
|
86
|
|
|
if (is_array($this->display)) { |
|
87
|
4 |
|
foreach ($this->display as $language => $value) { |
|
88
|
4 |
|
if (!isset($verb->display[$language])) { |
|
89
|
|
|
return false; |
|
90
|
|
|
} |
|
91
|
|
|
|
|
92
|
3 |
|
if ($value !== $verb->display[$language]) { |
|
93
|
|
|
return false; |
|
94
|
|
|
} |
|
95
|
|
|
} |
|
96
|
|
|
} |
|
97
|
|
|
|
|
98
|
|
|
return true; |
|
99
|
|
|
} |
|
100
|
3 |
|
|
|
101
|
|
|
/** |
|
102
|
3 |
|
* Tests if the Verb can be used to void a Statement. |
|
103
|
|
|
* |
|
104
|
|
|
* @return bool True, if the Verb is a void Verb, false otherwise |
|
105
|
|
|
*/ |
|
106
|
|
|
public function isVoidVerb() |
|
107
|
|
|
{ |
|
108
|
|
|
return 'http://adlnet.gov/expapi/verbs/voided' === $this->id; |
|
109
|
|
|
} |
|
110
|
2 |
|
|
|
111
|
|
|
/** |
|
112
|
2 |
|
* Creates a Verb that can be used to void a {@link Statement}. |
|
113
|
|
|
* |
|
114
|
2 |
|
* @return Verb |
|
115
|
|
|
*/ |
|
116
|
|
|
public static function createVoidVerb() |
|
117
|
|
|
{ |
|
118
|
|
|
$verb = new Verb('http://adlnet.gov/expapi/verbs/voided'); |
|
119
|
|
|
|
|
120
|
|
|
return $verb; |
|
121
|
|
|
} |
|
122
|
|
|
} |
|
123
|
|
|
|
php-xapi /
model
