Skip to content

Commit 8ec32ce

Browse files
committed
doc fix
1 parent cd09287 commit 8ec32ce

File tree

6 files changed

+63
-56
lines changed

6 files changed

+63
-56
lines changed

src/Components/AbstractObject.php

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -216,24 +216,24 @@ protected function get($name)
216216
}
217217

218218
/**
219-
* {@inheritdoc}
220-
*/
219+
* {@inheritdoc}
220+
*/
221221
public function getLazarusObjectId()
222222
{
223223
return $this->lazarusObjectId;
224224
}
225225

226226
/**
227-
* {@inheritdoc}
228-
*/
227+
* {@inheritdoc}
228+
*/
229229
public function getLazarusClass()
230230
{
231231
return $this->lazarusClass;
232232
}
233233

234234
/**
235-
* {@inheritdoc}
236-
*/
235+
* {@inheritdoc}
236+
*/
237237
public function fire($eventName)
238238
{
239239
if (array_key_exists($eventName, $this->eventHandlers)) {
@@ -244,8 +244,8 @@ public function fire($eventName)
244244
}
245245

246246
/**
247-
* {@inheritdoc}
248-
*/
247+
* {@inheritdoc}
248+
*/
249249
public function on($eventName, callable $eventHandler)
250250
{
251251
$eventName = 'on' . $eventName;

src/Components/Calendar.php

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,7 @@ class Calendar extends VisualObject
3030
*/
3131
public function setValue($value)
3232
{
33-
/**
34-
* See explanation of P.O.G in self::getValue()
35-
*/
33+
// See explanation of P.O.G in self::getValue()
3634
$datetime1 = date_create('1900-01-01');
3735
$datetime2 = date_create_from_format('d/m/Y', $value);
3836
$interval = date_diff($datetime1, $datetime2, true);

src/Components/ContainerObject.php

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,16 @@ abstract class ContainerObject extends VisualObject implements ContainerObjectIn
1919
protected $children = [];
2020

2121
/**
22-
* {@inheritdoc}
23-
*/
22+
* {@inheritdoc}
23+
*/
2424
public function appendChild(VisualObjectInterface $object)
2525
{
2626
$this->children[$object->getLazarusObjectId()] = $object;
2727
}
2828

2929
/**
30-
* {@inheritdoc}
31-
*/
30+
* {@inheritdoc}
31+
*/
3232
public function getChild($lazarusObjectId)
3333
{
3434
if (!isset($this->children[$lazarusObjectId])) {
@@ -39,8 +39,8 @@ public function getChild($lazarusObjectId)
3939
}
4040

4141
/**
42-
* {@inheritdoc}
43-
*/
42+
* {@inheritdoc}
43+
*/
4444
public function getChildren()
4545
{
4646
return $this->children;

src/Components/InputPassword.php

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,7 @@ public function __construct(
3535
) {
3636
parent::__construct($defaultAttributes, $parent, $application);
3737

38-
/*
39-
* Required to configure the component as a password field.
40-
*/
38+
// Required to configure the component as a password field.
4139
$this->setEchoMode();
4240
}
4341

src/Components/VisualObject.php

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,16 @@
1313
abstract class VisualObject extends AbstractObject implements VisualObjectInterface
1414
{
1515
/**
16-
* {@inheritdoc}
17-
*/
16+
* {@inheritdoc}
17+
*/
1818
public function getAutoSize()
1919
{
2020
return $this->get('autosize');
2121
}
2222

2323
/**
24-
* {@inheritdoc}
25-
*/
24+
* {@inheritdoc}
25+
*/
2626
public function setAutoSize($autoSize)
2727
{
2828
$this->set('autosize', $autoSize);
@@ -31,16 +31,16 @@ public function setAutoSize($autoSize)
3131
}
3232

3333
/**
34-
* {@inheritdoc}
35-
*/
34+
* {@inheritdoc}
35+
*/
3636
public function getBackgroundColor()
3737
{
3838
return $this->get('color');
3939
}
4040

4141
/**
42-
* {@inheritdoc}
43-
*/
42+
* {@inheritdoc}
43+
*/
4444
public function setBackgroundColor($color)
4545
{
4646
$this->set('color', Color::toLazarus($color));
@@ -49,16 +49,16 @@ public function setBackgroundColor($color)
4949
}
5050

5151
/**
52-
* {@inheritdoc}
53-
*/
52+
* {@inheritdoc}
53+
*/
5454
public function getBottom()
5555
{
5656
return $this->get('bottom');
5757
}
5858

5959
/**
60-
* {@inheritdoc}
61-
*/
60+
* {@inheritdoc}
61+
*/
6262
public function setBottom($bottom)
6363
{
6464
$this->set('bottom', $bottom);
@@ -67,16 +67,16 @@ public function setBottom($bottom)
6767
}
6868

6969
/**
70-
* {@inheritdoc}
71-
*/
70+
* {@inheritdoc}
71+
*/
7272
public function getHeight()
7373
{
7474
return $this->get('height');
7575
}
7676

7777
/**
78-
* {@inheritdoc}
79-
*/
78+
* {@inheritdoc}
79+
*/
8080
public function setHeight($height)
8181
{
8282
$this->set('height', $height);
@@ -85,16 +85,16 @@ public function setHeight($height)
8585
}
8686

8787
/**
88-
* {@inheritdoc}
89-
*/
88+
* {@inheritdoc}
89+
*/
9090
public function getLeft()
9191
{
9292
return $this->get('left');
9393
}
9494

9595
/**
96-
* {@inheritdoc}
97-
*/
96+
* {@inheritdoc}
97+
*/
9898
public function setLeft($left)
9999
{
100100
$this->set('left', $left);
@@ -103,16 +103,16 @@ public function setLeft($left)
103103
}
104104

105105
/**
106-
* {@inheritdoc}
107-
*/
106+
* {@inheritdoc}
107+
*/
108108
public function getRight()
109109
{
110110
return $this->get('right');
111111
}
112112

113113
/**
114-
* {@inheritdoc}
115-
*/
114+
* {@inheritdoc}
115+
*/
116116
public function setRight($right)
117117
{
118118
$this->set('right', $right);
@@ -121,16 +121,16 @@ public function setRight($right)
121121
}
122122

123123
/**
124-
* {@inheritdoc}
125-
*/
124+
* {@inheritdoc}
125+
*/
126126
public function getTop()
127127
{
128128
return $this->get('top');
129129
}
130130

131131
/**
132-
* {@inheritdoc}
133-
*/
132+
* {@inheritdoc}
133+
*/
134134
public function setTop($top)
135135
{
136136
$this->set('top', $top);
@@ -139,16 +139,16 @@ public function setTop($top)
139139
}
140140

141141
/**
142-
* {@inheritdoc}
143-
*/
142+
* {@inheritdoc}
143+
*/
144144
public function getWidth()
145145
{
146146
return $this->get('width');
147147
}
148148

149149
/**
150-
* {@inheritdoc}
151-
*/
150+
* {@inheritdoc}
151+
*/
152152
public function setWidth($width)
153153
{
154154
$this->set('width', $width);
@@ -157,16 +157,16 @@ public function setWidth($width)
157157
}
158158

159159
/**
160-
* {@inheritdoc}
161-
*/
160+
* {@inheritdoc}
161+
*/
162162
public function getVisible()
163163
{
164164
return $this->get('visible');
165165
}
166166

167167
/**
168-
* {@inheritdoc}
169-
*/
168+
* {@inheritdoc}
169+
*/
170170
public function setVisible($visible)
171171
{
172172
$this->set('visible', $visible);

src/Exception/ComponentException.php

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,21 @@
1111
*/
1212
class ComponentException extends \RuntimeException
1313
{
14+
/**
15+
* ComponentException
16+
*
17+
* @param string $message
18+
* @param int $code
19+
* @param \Exception|null $previous
20+
*/
1421
public function __construct($message, $code = 0, \Exception $previous = null)
1522
{
1623
parent::__construct($message, $code, $previous);
1724
}
25+
26+
/**
27+
* Activated when casting to string
28+
*/
1829
public function __toString()
1930
{
2031
return __CLASS__ . ": [{$this->code}]: {$this->message}\n";

0 commit comments

Comments
 (0)