Skip to content

Commit

Permalink
doc fix
Browse files Browse the repository at this point in the history
  • Loading branch information
reisraff committed Jan 18, 2019
1 parent cd09287 commit 8ec32ce
Show file tree
Hide file tree
Showing 6 changed files with 63 additions and 56 deletions.
16 changes: 8 additions & 8 deletions src/Components/AbstractObject.php
Original file line number Diff line number Diff line change
Expand Up @@ -216,24 +216,24 @@ protected function get($name)
}

/**
* {@inheritdoc}
*/
* {@inheritdoc}
*/
public function getLazarusObjectId()
{
return $this->lazarusObjectId;
}

/**
* {@inheritdoc}
*/
* {@inheritdoc}
*/
public function getLazarusClass()
{
return $this->lazarusClass;
}

/**
* {@inheritdoc}
*/
* {@inheritdoc}
*/
public function fire($eventName)
{
if (array_key_exists($eventName, $this->eventHandlers)) {
Expand All @@ -244,8 +244,8 @@ public function fire($eventName)
}

/**
* {@inheritdoc}
*/
* {@inheritdoc}
*/
public function on($eventName, callable $eventHandler)
{
$eventName = 'on' . $eventName;
Expand Down
4 changes: 1 addition & 3 deletions src/Components/Calendar.php
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,7 @@ class Calendar extends VisualObject
*/
public function setValue($value)
{
/**
* See explanation of P.O.G in self::getValue()
*/
// See explanation of P.O.G in self::getValue()
$datetime1 = date_create('1900-01-01');
$datetime2 = date_create_from_format('d/m/Y', $value);
$interval = date_diff($datetime1, $datetime2, true);
Expand Down
12 changes: 6 additions & 6 deletions src/Components/ContainerObject.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,16 @@ abstract class ContainerObject extends VisualObject implements ContainerObjectIn
protected $children = [];

/**
* {@inheritdoc}
*/
* {@inheritdoc}
*/
public function appendChild(VisualObjectInterface $object)
{
$this->children[$object->getLazarusObjectId()] = $object;
}

/**
* {@inheritdoc}
*/
* {@inheritdoc}
*/
public function getChild($lazarusObjectId)
{
if (!isset($this->children[$lazarusObjectId])) {
Expand All @@ -39,8 +39,8 @@ public function getChild($lazarusObjectId)
}

/**
* {@inheritdoc}
*/
* {@inheritdoc}
*/
public function getChildren()
{
return $this->children;
Expand Down
4 changes: 1 addition & 3 deletions src/Components/InputPassword.php
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,7 @@ public function __construct(
) {
parent::__construct($defaultAttributes, $parent, $application);

/*
* Required to configure the component as a password field.
*/
// Required to configure the component as a password field.
$this->setEchoMode();
}

Expand Down
72 changes: 36 additions & 36 deletions src/Components/VisualObject.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,16 @@
abstract class VisualObject extends AbstractObject implements VisualObjectInterface
{
/**
* {@inheritdoc}
*/
* {@inheritdoc}
*/
public function getAutoSize()
{
return $this->get('autosize');
}

/**
* {@inheritdoc}
*/
* {@inheritdoc}
*/
public function setAutoSize($autoSize)
{
$this->set('autosize', $autoSize);
Expand All @@ -31,16 +31,16 @@ public function setAutoSize($autoSize)
}

/**
* {@inheritdoc}
*/
* {@inheritdoc}
*/
public function getBackgroundColor()
{
return $this->get('color');
}

/**
* {@inheritdoc}
*/
* {@inheritdoc}
*/
public function setBackgroundColor($color)
{
$this->set('color', Color::toLazarus($color));
Expand All @@ -49,16 +49,16 @@ public function setBackgroundColor($color)
}

/**
* {@inheritdoc}
*/
* {@inheritdoc}
*/
public function getBottom()
{
return $this->get('bottom');
}

/**
* {@inheritdoc}
*/
* {@inheritdoc}
*/
public function setBottom($bottom)
{
$this->set('bottom', $bottom);
Expand All @@ -67,16 +67,16 @@ public function setBottom($bottom)
}

/**
* {@inheritdoc}
*/
* {@inheritdoc}
*/
public function getHeight()
{
return $this->get('height');
}

/**
* {@inheritdoc}
*/
* {@inheritdoc}
*/
public function setHeight($height)
{
$this->set('height', $height);
Expand All @@ -85,16 +85,16 @@ public function setHeight($height)
}

/**
* {@inheritdoc}
*/
* {@inheritdoc}
*/
public function getLeft()
{
return $this->get('left');
}

/**
* {@inheritdoc}
*/
* {@inheritdoc}
*/
public function setLeft($left)
{
$this->set('left', $left);
Expand All @@ -103,16 +103,16 @@ public function setLeft($left)
}

/**
* {@inheritdoc}
*/
* {@inheritdoc}
*/
public function getRight()
{
return $this->get('right');
}

/**
* {@inheritdoc}
*/
* {@inheritdoc}
*/
public function setRight($right)
{
$this->set('right', $right);
Expand All @@ -121,16 +121,16 @@ public function setRight($right)
}

/**
* {@inheritdoc}
*/
* {@inheritdoc}
*/
public function getTop()
{
return $this->get('top');
}

/**
* {@inheritdoc}
*/
* {@inheritdoc}
*/
public function setTop($top)
{
$this->set('top', $top);
Expand All @@ -139,16 +139,16 @@ public function setTop($top)
}

/**
* {@inheritdoc}
*/
* {@inheritdoc}
*/
public function getWidth()
{
return $this->get('width');
}

/**
* {@inheritdoc}
*/
* {@inheritdoc}
*/
public function setWidth($width)
{
$this->set('width', $width);
Expand All @@ -157,16 +157,16 @@ public function setWidth($width)
}

/**
* {@inheritdoc}
*/
* {@inheritdoc}
*/
public function getVisible()
{
return $this->get('visible');
}

/**
* {@inheritdoc}
*/
* {@inheritdoc}
*/
public function setVisible($visible)
{
$this->set('visible', $visible);
Expand Down
11 changes: 11 additions & 0 deletions src/Exception/ComponentException.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,21 @@
*/
class ComponentException extends \RuntimeException
{
/**
* ComponentException
*
* @param string $message
* @param int $code
* @param \Exception|null $previous
*/
public function __construct($message, $code = 0, \Exception $previous = null)
{
parent::__construct($message, $code, $previous);
}

/**
* Activated when casting to string
*/
public function __toString()
{
return __CLASS__ . ": [{$this->code}]: {$this->message}\n";
Expand Down

0 comments on commit 8ec32ce

Please sign in to comment.