From 28588d83cff5c73bafe7d06cb706bdae330cf185 Mon Sep 17 00:00:00 2001 From: Torsten Dittmann Date: Tue, 10 May 2022 14:31:20 +0200 Subject: [PATCH] docs: fix php docs in event classes --- src/Appwrite/Event/Build.php | 10 ++++------ src/Appwrite/Event/Certificate.php | 4 ++-- src/Appwrite/Event/Database.php | 8 ++++---- src/Appwrite/Event/Delete.php | 4 ++-- src/Appwrite/Event/Func.php | 8 ++++---- src/Appwrite/Event/Mail.php | 4 ++-- 6 files changed, 18 insertions(+), 20 deletions(-) diff --git a/src/Appwrite/Event/Build.php b/src/Appwrite/Event/Build.php index f6ba54dfd..970de8265 100644 --- a/src/Appwrite/Event/Build.php +++ b/src/Appwrite/Event/Build.php @@ -2,9 +2,7 @@ namespace Appwrite\Event; -use DateTime; use Resque; -use ResqueScheduler; use Utopia\Database\Document; class Build extends Event @@ -21,7 +19,7 @@ class Build extends Event /** * Sets resource document for the build event. * - * @param \Utopia\Database\Document $function + * @param Document $resource * @return self */ public function setResource(Document $resource): self @@ -34,7 +32,7 @@ class Build extends Event /** * Returns set resource document for the build event. * - * @return null|\Utopia\Database\Document + * @return null|Document */ public function getResource(): ?Document { @@ -44,7 +42,7 @@ class Build extends Event /** * Sets deployment for the build event. * - * @param \Utopia\Database\Document $execution + * @param Document $deployment * @return self */ public function setDeployment(Document $deployment): self @@ -57,7 +55,7 @@ class Build extends Event /** * Returns set deployment for the build event. * - * @return null|\Utopia\Database\Document + * @return null|Document */ public function getDeployment(): ?Document { diff --git a/src/Appwrite/Event/Certificate.php b/src/Appwrite/Event/Certificate.php index b01fa7198..59c2ce9a7 100644 --- a/src/Appwrite/Event/Certificate.php +++ b/src/Appwrite/Event/Certificate.php @@ -19,7 +19,7 @@ class Certificate extends Event /** * Set domain for this certificates event. * - * @param \Utopia\Database\Document $domain + * @param Document $domain * @return self */ public function setDomain(Document $domain): self @@ -32,7 +32,7 @@ class Certificate extends Event /** * Returns the set domain for this certificate event. * - * @return null|\Utopia\Database\Document + * @return null|Document */ public function getDomain(): ?Document { diff --git a/src/Appwrite/Event/Database.php b/src/Appwrite/Event/Database.php index 28123e8a0..5e5e68785 100644 --- a/src/Appwrite/Event/Database.php +++ b/src/Appwrite/Event/Database.php @@ -41,7 +41,7 @@ class Database extends Event /** * Set the collection for this database event. * - * @param \Utopia\Database\Document $collection + * @param Document $collection * @return self */ public function setCollection(Document $collection): self @@ -54,7 +54,7 @@ class Database extends Event /** * Returns set collection for this event. * - * @return null|\Utopia\Database\Document + * @return null|Document */ public function getCollection(): ?Document { @@ -64,7 +64,7 @@ class Database extends Event /** * Set the document for this database event. * - * @param \Utopia\Database\Document $document + * @param Document $document * @return self */ public function setDocument(Document $document): self @@ -76,7 +76,7 @@ class Database extends Event /** * Returns set document for this database event. - * @return null|\Utopia\Database\Document + * @return null|Document */ public function getDocument(): ?Document { diff --git a/src/Appwrite/Event/Delete.php b/src/Appwrite/Event/Delete.php index 742a759e0..a8255cf3f 100644 --- a/src/Appwrite/Event/Delete.php +++ b/src/Appwrite/Event/Delete.php @@ -65,7 +65,7 @@ class Delete extends Event /** * Sets the document for the delete event. * - * @param \Utopia\Database\Document $document + * @param Document $document * @return self */ public function setDocument(Document $document): self @@ -78,7 +78,7 @@ class Delete extends Event /** * Returns the set document for the delete event. * - * @return null|\Utopia\Database\Document + * @return null|Document */ public function getDocument(): ?Document { diff --git a/src/Appwrite/Event/Func.php b/src/Appwrite/Event/Func.php index 18f684c4a..98652431f 100644 --- a/src/Appwrite/Event/Func.php +++ b/src/Appwrite/Event/Func.php @@ -23,7 +23,7 @@ class Func extends Event /** * Sets function document for the function event. * - * @param \Utopia\Database\Document $function + * @param Document $function * @return self */ public function setFunction(Document $function): self @@ -36,7 +36,7 @@ class Func extends Event /** * Returns set function document for the function event. * - * @return null|\Utopia\Database\Document + * @return null|Document */ public function getFunction(): ?Document { @@ -46,7 +46,7 @@ class Func extends Event /** * Sets execution for the function event. * - * @param \Utopia\Database\Document $execution + * @param Document $execution * @return self */ public function setExecution(Document $execution): self @@ -59,7 +59,7 @@ class Func extends Event /** * Returns set execution for the function event. * - * @return null|\Utopia\Database\Document + * @return null|Document */ public function getExecution(): ?Document { diff --git a/src/Appwrite/Event/Mail.php b/src/Appwrite/Event/Mail.php index 28df2c6b8..b3325c00b 100644 --- a/src/Appwrite/Event/Mail.php +++ b/src/Appwrite/Event/Mail.php @@ -22,7 +22,7 @@ class Mail extends Event /** * Sets team for the mail event. * - * @param \Utopia\Database\Document $team + * @param Document $team * @return self */ public function setTeam(Document $team): self @@ -35,7 +35,7 @@ class Mail extends Event /** * Returns set team for the mail event. * - * @return null|\Utopia\Database\Document + * @return null|Document */ public function getTeam(): ?Document {