Giancarlo Voci 7 years ago
parent
commit
7ffc4265fc

+ 12 - 2
src/OpenMind/FindBox/FindBoxCoreSystem.php

@@ -10,6 +10,7 @@
 
 
 namespace OpenMind\FindBox;
 namespace OpenMind\FindBox;
 
 
+use DOMDocument;
 use Exception;
 use Exception;
 use Generator;
 use Generator;
 use OpenMind\System\System;
 use OpenMind\System\System;
@@ -22,10 +23,19 @@ function array_filter_keys(array $array, array $keysToExtract)
 
 
 class FindBoxCoreSystem
 class FindBoxCoreSystem
 {
 {
+	/** @var string $Host */
 	private $Host;
 	private $Host;
+
+	/** @var int $Port */
 	private $Port;
 	private $Port;
+
+	/** @var string $Key */
 	private $Key;
 	private $Key;
+
+	/** @var string $Pass */
 	private $Pass;
 	private $Pass;
+
+	/** @var FALSE|mixed coreDetails */
 	private $coreDetails;
 	private $coreDetails;
 
 
 	/**
 	/**
@@ -325,7 +335,7 @@ class FindBoxCoreSystem
 	/**
 	/**
 	 * Retrieve the SVG file of template
 	 * Retrieve the SVG file of template
 	 *
 	 *
-	 * @param $templateID name or id of findbox tremplate
+	 * @param string|int $templateID name or id of findbox template
 	 * @return string|null
 	 * @return string|null
 	 */
 	 */
 	public function GetTemplateImage($templateID)
 	public function GetTemplateImage($templateID)
@@ -367,7 +377,7 @@ class FindBoxCoreSystem
 	{
 	{
 		global $f3;
 		global $f3;
 
 
-		$svgTemplate = new \DOMDocument();
+		$svgTemplate = new DOMDocument();
 		$svgTemplate->load($svgPath);
 		$svgTemplate->load($svgPath);
 		$xlink = $svgTemplate->getElementsByTagName('image');
 		$xlink = $svgTemplate->getElementsByTagName('image');
 		if ($xlink->length > 0) {
 		if ($xlink->length > 0) {

+ 4 - 0
src/OpenMind/FindBox/QueueCommand.php

@@ -20,6 +20,10 @@ class QueueCommand
 	public $description;
 	public $description;
 	public $params;
 	public $params;
 
 
+	/**
+	 * QueueCommand constructor.
+	 * @param array $labels
+	 */
 	public function __construct(array $labels)
 	public function __construct(array $labels)
 	{
 	{
 		$this->id = $labels;
 		$this->id = $labels;

+ 7 - 3
src/OpenMind/FindBox/SmartESL.php

@@ -11,8 +11,13 @@ use Generator;
 
 
 class SmartESL
 class SmartESL
 {
 {
+	/** @var FindBoxCoreSystem $core */
 	protected $core;
 	protected $core;
+
+	/** @var array $labels */
 	protected $labels;
 	protected $labels;
+
+	/** @var array $labelProperties */
 	protected $labelProperties;
 	protected $labelProperties;
 
 
 	public function __construct(FindBoxCoreSystem $coreL, array $LabelID)
 	public function __construct(FindBoxCoreSystem $coreL, array $LabelID)
@@ -60,7 +65,7 @@ class SmartESL
 
 
 
 
 	/**
 	/**
-	 * Blink the label with parameters. BlinkSpecial make use of getData() and check how many leds has to auto select the firmware version.
+	 * Blink the label with parameters.
 	 *
 	 *
 	 * @param int $pattern
 	 * @param int $pattern
 	 * @param int $repeat
 	 * @param int $repeat
@@ -95,7 +100,7 @@ class SmartESL
 	}
 	}
 
 
 	/**
 	/**
-	 * Blink the label with parameters. BlinkSpecial make use of getData() and check how many leds has to auto select the firmware version.
+	 * Blink the label with parameters.
 	 *
 	 *
 	 * @param int $pattern
 	 * @param int $pattern
 	 * @param int $repeat
 	 * @param int $repeat
@@ -106,7 +111,6 @@ class SmartESL
 	 */
 	 */
 	public function BlinkSpecial(int $pattern, int $repeat, int $iter_time, int $iterations, int $ledColor = 0)
 	public function BlinkSpecial(int $pattern, int $repeat, int $iter_time, int $iterations, int $ledColor = 0)
 	{
 	{
-
 		$uriParams = json_encode(array_merge(
 		$uriParams = json_encode(array_merge(
 			array($this->labels),
 			array($this->labels),
 			array($pattern, $ledColor, $repeat, $iter_time, $iterations, 1)));
 			array($pattern, $ledColor, $repeat, $iter_time, $iterations, 1)));