1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
namespace Maknz\Slack; |
4
|
|
|
|
5
|
|
|
class AttachmentField |
6
|
|
|
{ |
7
|
|
|
/** |
8
|
|
|
* The required title field of the field. |
9
|
|
|
* |
10
|
|
|
* @var string |
11
|
|
|
*/ |
12
|
|
|
protected $title; |
13
|
|
|
|
14
|
|
|
/** |
15
|
|
|
* The required value of the field. |
16
|
|
|
* |
17
|
|
|
* @var string |
18
|
|
|
*/ |
19
|
|
|
protected $value; |
20
|
|
|
|
21
|
|
|
/** |
22
|
|
|
* Whether the value is short enough to fit side by side with |
23
|
|
|
* other values. |
24
|
|
|
* |
25
|
|
|
* @var bool |
26
|
|
|
*/ |
27
|
|
|
protected $short = false; |
28
|
|
|
|
29
|
|
|
/** |
30
|
|
|
* Instantiate a new AttachmentField. |
31
|
|
|
* |
32
|
|
|
* @param array $attributes |
33
|
|
|
* @return void |
|
|
|
|
34
|
|
|
*/ |
35
|
|
|
public function __construct(array $attributes) |
36
|
|
|
{ |
37
|
|
|
if (isset($attributes['title'])) { |
38
|
|
|
$this->setTitle($attributes['title']); |
39
|
|
|
} |
40
|
|
|
|
41
|
|
|
if (isset($attributes['value'])) { |
42
|
|
|
$this->setValue($attributes['value']); |
43
|
|
|
} |
44
|
|
|
|
45
|
|
|
if (isset($attributes['short'])) { |
46
|
|
|
$this->setShort($attributes['short']); |
47
|
|
|
} |
48
|
|
|
} |
49
|
|
|
|
50
|
|
|
/** |
51
|
|
|
* Get the title of the field. |
52
|
|
|
* |
53
|
|
|
* @return string |
54
|
|
|
*/ |
55
|
|
|
public function getTitle() |
56
|
|
|
{ |
57
|
|
|
return $this->title; |
58
|
|
|
} |
59
|
|
|
|
60
|
|
|
/** |
61
|
|
|
* Set the title of the field. |
62
|
|
|
* |
63
|
|
|
* @param string $title |
64
|
|
|
* @return $this |
65
|
|
|
*/ |
66
|
|
|
public function setTitle($title) |
67
|
|
|
{ |
68
|
|
|
$this->title = $title; |
69
|
|
|
|
70
|
|
|
return $this; |
71
|
|
|
} |
72
|
|
|
|
73
|
|
|
/** |
74
|
|
|
* Get the value of the field. |
75
|
|
|
* |
76
|
|
|
* @return string |
77
|
|
|
*/ |
78
|
|
|
public function getValue() |
79
|
|
|
{ |
80
|
|
|
return $this->value; |
81
|
|
|
} |
82
|
|
|
|
83
|
|
|
/** |
84
|
|
|
* Set the value of the field. |
85
|
|
|
* |
86
|
|
|
* @param string $value |
87
|
|
|
* @return $this |
88
|
|
|
*/ |
89
|
|
|
public function setValue($value) |
90
|
|
|
{ |
91
|
|
|
$this->value = $value; |
92
|
|
|
|
93
|
|
|
return $this; |
94
|
|
|
} |
95
|
|
|
|
96
|
|
|
/** |
97
|
|
|
* Get whether this field is short enough for displaying |
98
|
|
|
* side-by-side with other fields. |
99
|
|
|
* |
100
|
|
|
* @return bool |
101
|
|
|
*/ |
102
|
|
|
public function getShort() |
103
|
|
|
{ |
104
|
|
|
return $this->short; |
105
|
|
|
} |
106
|
|
|
|
107
|
|
|
/** |
108
|
|
|
* Set whether this field is short enough for displaying |
109
|
|
|
* side-by-side with other fields. |
110
|
|
|
* |
111
|
|
|
* @param string $value |
112
|
|
|
* @return $this |
113
|
|
|
*/ |
114
|
|
|
public function setShort($value) |
115
|
|
|
{ |
116
|
|
|
$this->short = (bool) $value; |
117
|
|
|
|
118
|
|
|
return $this; |
119
|
|
|
} |
120
|
|
|
|
121
|
|
|
/** |
122
|
|
|
* Get the array representation of this attachment field. |
123
|
|
|
* |
124
|
|
|
* @return array |
125
|
|
|
*/ |
126
|
|
|
public function toArray() |
127
|
|
|
{ |
128
|
|
|
return [ |
129
|
|
|
'title' => $this->getTitle(), |
130
|
|
|
'value' => $this->getValue(), |
131
|
|
|
'short' => $this->getShort(), |
132
|
|
|
]; |
133
|
|
|
} |
134
|
|
|
} |
135
|
|
|
|
Adding a
@return
annotation to a constructor is not recommended, since a constructor does not have a meaningful return value.Please refer to the PHP core documentation on constructors.