[modules] Added support to stringify entity to track possible errors …

…(#121)
FastyBird · May 11, 2023 · 2311c75 · 2311c75
1 parent d7cab51
commit 2311c75
Show file tree

Hide file tree

Showing 9 changed files with 92 additions and 0 deletions.
diff --git a/src/Entities/Channels/Channel.php b/src/Entities/Channels/Channel.php
@@ -23,6 +23,7 @@
 use IPub\DoctrineCrud\Mapping\Annotation as IPubDoctrine;
 use IPub\DoctrineDynamicDiscriminatorMap\Entities as DoctrineDynamicDiscriminatorMapEntities;
 use IPub\DoctrineTimestampable;
+use Nette\Utils;
 use Ramsey\Uuid;
 
 /**
@@ -282,4 +283,12 @@ public function getDiscriminatorName(): string
 		return 'channel';
 	}
 
+	/**
+	 * @throws Utils\JsonException
+	 */
+	public function __toString(): string
+	{
+		return Utils\Json::encode($this->toArray());
+	}
+
 }
diff --git a/src/Entities/Channels/Controls/Control.php b/src/Entities/Channels/Controls/Control.php
@@ -20,6 +20,7 @@
 use FastyBird\Module\Devices\Entities;
 use IPub\DoctrineCrud\Mapping\Annotation as IPubDoctrine;
 use IPub\DoctrineTimestampable;
+use Nette\Utils;
 use Ramsey\Uuid;
 
 /**
@@ -107,4 +108,12 @@ public function getSource(): MetadataTypes\ModuleSource
 		return MetadataTypes\ModuleSource::get(MetadataTypes\ModuleSource::SOURCE_MODULE_DEVICES);
 	}
 
+	/**
+	 * @throws Utils\JsonException
+	 */
+	public function __toString(): string
+	{
+		return Utils\Json::encode($this->toArray());
+	}
+
 }
diff --git a/src/Entities/Channels/Properties/Property.php b/src/Entities/Channels/Properties/Property.php
@@ -24,6 +24,7 @@
 use FastyBird\Module\Devices\Entities;
 use FastyBird\Module\Devices\Exceptions;
 use IPub\DoctrineCrud\Mapping\Annotation as IPubDoctrine;
+use Nette\Utils;
 use Ramsey\Uuid;
 use function array_merge;
 
@@ -376,4 +377,15 @@ public function toArray(): array
 		]);
 	}
 
+	/**
+	 * @throws Exceptions\InvalidState
+	 * @throws MetadataExceptions\InvalidArgument
+	 * @throws MetadataExceptions\InvalidState
+	 * @throws Utils\JsonException
+	 */
+	public function __toString(): string
+	{
+		return Utils\Json::encode($this->toArray());
+	}
+
 }
diff --git a/src/Entities/Connectors/Connector.php b/src/Entities/Connectors/Connector.php
@@ -24,6 +24,7 @@
 use IPub\DoctrineCrud\Mapping\Annotation as IPubDoctrine;
 use IPub\DoctrineDynamicDiscriminatorMap\Entities as DoctrineDynamicDiscriminatorMapEntities;
 use IPub\DoctrineTimestampable;
+use Nette\Utils;
 use Ramsey\Uuid;
 
 /**
@@ -309,4 +310,12 @@ public function getSource(): MetadataTypes\ModuleSource|MetadataTypes\PluginSour
 		return MetadataTypes\ModuleSource::get(MetadataTypes\ModuleSource::SOURCE_MODULE_DEVICES);
 	}
 
+	/**
+	 * @throws Utils\JsonException
+	 */
+	public function __toString(): string
+	{
+		return Utils\Json::encode($this->toArray());
+	}
+
 }
diff --git a/src/Entities/Connectors/Controls/Control.php b/src/Entities/Connectors/Controls/Control.php
@@ -20,6 +20,7 @@
 use FastyBird\Module\Devices\Entities;
 use IPub\DoctrineCrud\Mapping\Annotation as IPubDoctrine;
 use IPub\DoctrineTimestampable;
+use Nette\Utils;
 use Ramsey\Uuid;
 
 /**
@@ -107,4 +108,12 @@ public function getSource(): MetadataTypes\ModuleSource
 		return MetadataTypes\ModuleSource::get(MetadataTypes\ModuleSource::SOURCE_MODULE_DEVICES);
 	}
 
+	/**
+	 * @throws Utils\JsonException
+	 */
+	public function __toString(): string
+	{
+		return Utils\Json::encode($this->toArray());
+	}
+
 }
diff --git a/src/Entities/Connectors/Properties/Property.php b/src/Entities/Connectors/Properties/Property.php
@@ -16,8 +16,11 @@
 namespace FastyBird\Module\Devices\Entities\Connectors\Properties;
 
 use Doctrine\ORM\Mapping as ORM;
+use FastyBird\Library\Metadata\Exceptions as MetadataExceptions;
 use FastyBird\Module\Devices\Entities;
+use FastyBird\Module\Devices\Exceptions;
 use IPub\DoctrineCrud\Mapping\Annotation as IPubDoctrine;
+use Nette\Utils;
 use Ramsey\Uuid;
 use function array_merge;
 
@@ -87,4 +90,15 @@ public function toArray(): array
 		]);
 	}
 
+	/**
+	 * @throws Exceptions\InvalidState
+	 * @throws MetadataExceptions\InvalidArgument
+	 * @throws MetadataExceptions\InvalidState
+	 * @throws Utils\JsonException
+	 */
+	public function __toString(): string
+	{
+		return Utils\Json::encode($this->toArray());
+	}
+
 }
diff --git a/src/Entities/Devices/Controls/Control.php b/src/Entities/Devices/Controls/Control.php
@@ -20,6 +20,7 @@
 use FastyBird\Module\Devices\Entities;
 use IPub\DoctrineCrud\Mapping\Annotation as IPubDoctrine;
 use IPub\DoctrineTimestampable;
+use Nette\Utils;
 use Ramsey\Uuid;
 
 /**
@@ -107,4 +108,12 @@ public function getSource(): MetadataTypes\ModuleSource
 		return MetadataTypes\ModuleSource::get(MetadataTypes\ModuleSource::SOURCE_MODULE_DEVICES);
 	}
 
+	/**
+	 * @throws Utils\JsonException
+	 */
+	public function __toString(): string
+	{
+		return Utils\Json::encode($this->toArray());
+	}
+
 }
diff --git a/src/Entities/Devices/Device.php b/src/Entities/Devices/Device.php
@@ -24,6 +24,7 @@
 use IPub\DoctrineCrud\Mapping\Annotation as IPubDoctrine;
 use IPub\DoctrineDynamicDiscriminatorMap\Entities as DoctrineDynamicDiscriminatorMapEntities;
 use IPub\DoctrineTimestampable;
+use Nette\Utils;
 use Ramsey\Uuid;
 use function strval;
 
@@ -420,4 +421,12 @@ public function getSource(): MetadataTypes\ModuleSource|MetadataTypes\PluginSour
 		return MetadataTypes\ModuleSource::get(MetadataTypes\ModuleSource::SOURCE_MODULE_DEVICES);
 	}
 
+	/**
+	 * @throws Utils\JsonException
+	 */
+	public function __toString(): string
+	{
+		return Utils\Json::encode($this->toArray());
+	}
+
 }
diff --git a/src/Entities/Devices/Properties/Property.php b/src/Entities/Devices/Properties/Property.php
@@ -24,6 +24,7 @@
 use FastyBird\Module\Devices\Entities;
 use FastyBird\Module\Devices\Exceptions;
 use IPub\DoctrineCrud\Mapping\Annotation as IPubDoctrine;
+use Nette\Utils;
 use Ramsey\Uuid;
 use function array_merge;
 
@@ -374,4 +375,15 @@ public function toArray(): array
 		]);
 	}
 
+	/**
+	 * @throws Exceptions\InvalidState
+	 * @throws MetadataExceptions\InvalidArgument
+	 * @throws MetadataExceptions\InvalidState
+	 * @throws Utils\JsonException
+	 */
+	public function __toString(): string
+	{
+		return Utils\Json::encode($this->toArray());
+	}
+
 }