1
0
Fork 0
mirror of synced 2024-06-29 19:50:26 +12:00

docs: fix php docs in event classes

This commit is contained in:
Torsten Dittmann 2022-05-10 14:31:20 +02:00
parent 54dd808232
commit 28588d83cf
6 changed files with 18 additions and 20 deletions

View file

@ -2,9 +2,7 @@
namespace Appwrite\Event; namespace Appwrite\Event;
use DateTime;
use Resque; use Resque;
use ResqueScheduler;
use Utopia\Database\Document; use Utopia\Database\Document;
class Build extends Event class Build extends Event
@ -21,7 +19,7 @@ class Build extends Event
/** /**
* Sets resource document for the build event. * Sets resource document for the build event.
* *
* @param \Utopia\Database\Document $function * @param Document $resource
* @return self * @return self
*/ */
public function setResource(Document $resource): self public function setResource(Document $resource): self
@ -34,7 +32,7 @@ class Build extends Event
/** /**
* Returns set resource document for the build event. * Returns set resource document for the build event.
* *
* @return null|\Utopia\Database\Document * @return null|Document
*/ */
public function getResource(): ?Document public function getResource(): ?Document
{ {
@ -44,7 +42,7 @@ class Build extends Event
/** /**
* Sets deployment for the build event. * Sets deployment for the build event.
* *
* @param \Utopia\Database\Document $execution * @param Document $deployment
* @return self * @return self
*/ */
public function setDeployment(Document $deployment): self public function setDeployment(Document $deployment): self
@ -57,7 +55,7 @@ class Build extends Event
/** /**
* Returns set deployment for the build event. * Returns set deployment for the build event.
* *
* @return null|\Utopia\Database\Document * @return null|Document
*/ */
public function getDeployment(): ?Document public function getDeployment(): ?Document
{ {

View file

@ -19,7 +19,7 @@ class Certificate extends Event
/** /**
* Set domain for this certificates event. * Set domain for this certificates event.
* *
* @param \Utopia\Database\Document $domain * @param Document $domain
* @return self * @return self
*/ */
public function setDomain(Document $domain): self public function setDomain(Document $domain): self
@ -32,7 +32,7 @@ class Certificate extends Event
/** /**
* Returns the set domain for this certificate event. * Returns the set domain for this certificate event.
* *
* @return null|\Utopia\Database\Document * @return null|Document
*/ */
public function getDomain(): ?Document public function getDomain(): ?Document
{ {

View file

@ -41,7 +41,7 @@ class Database extends Event
/** /**
* Set the collection for this database event. * Set the collection for this database event.
* *
* @param \Utopia\Database\Document $collection * @param Document $collection
* @return self * @return self
*/ */
public function setCollection(Document $collection): self public function setCollection(Document $collection): self
@ -54,7 +54,7 @@ class Database extends Event
/** /**
* Returns set collection for this event. * Returns set collection for this event.
* *
* @return null|\Utopia\Database\Document * @return null|Document
*/ */
public function getCollection(): ?Document public function getCollection(): ?Document
{ {
@ -64,7 +64,7 @@ class Database extends Event
/** /**
* Set the document for this database event. * Set the document for this database event.
* *
* @param \Utopia\Database\Document $document * @param Document $document
* @return self * @return self
*/ */
public function setDocument(Document $document): self public function setDocument(Document $document): self
@ -76,7 +76,7 @@ class Database extends Event
/** /**
* Returns set document for this database event. * Returns set document for this database event.
* @return null|\Utopia\Database\Document * @return null|Document
*/ */
public function getDocument(): ?Document public function getDocument(): ?Document
{ {

View file

@ -65,7 +65,7 @@ class Delete extends Event
/** /**
* Sets the document for the delete event. * Sets the document for the delete event.
* *
* @param \Utopia\Database\Document $document * @param Document $document
* @return self * @return self
*/ */
public function setDocument(Document $document): self public function setDocument(Document $document): self
@ -78,7 +78,7 @@ class Delete extends Event
/** /**
* Returns the set document for the delete event. * Returns the set document for the delete event.
* *
* @return null|\Utopia\Database\Document * @return null|Document
*/ */
public function getDocument(): ?Document public function getDocument(): ?Document
{ {

View file

@ -23,7 +23,7 @@ class Func extends Event
/** /**
* Sets function document for the function event. * Sets function document for the function event.
* *
* @param \Utopia\Database\Document $function * @param Document $function
* @return self * @return self
*/ */
public function setFunction(Document $function): self public function setFunction(Document $function): self
@ -36,7 +36,7 @@ class Func extends Event
/** /**
* Returns set function document for the function event. * Returns set function document for the function event.
* *
* @return null|\Utopia\Database\Document * @return null|Document
*/ */
public function getFunction(): ?Document public function getFunction(): ?Document
{ {
@ -46,7 +46,7 @@ class Func extends Event
/** /**
* Sets execution for the function event. * Sets execution for the function event.
* *
* @param \Utopia\Database\Document $execution * @param Document $execution
* @return self * @return self
*/ */
public function setExecution(Document $execution): self public function setExecution(Document $execution): self
@ -59,7 +59,7 @@ class Func extends Event
/** /**
* Returns set execution for the function event. * Returns set execution for the function event.
* *
* @return null|\Utopia\Database\Document * @return null|Document
*/ */
public function getExecution(): ?Document public function getExecution(): ?Document
{ {

View file

@ -22,7 +22,7 @@ class Mail extends Event
/** /**
* Sets team for the mail event. * Sets team for the mail event.
* *
* @param \Utopia\Database\Document $team * @param Document $team
* @return self * @return self
*/ */
public function setTeam(Document $team): self public function setTeam(Document $team): self
@ -35,7 +35,7 @@ class Mail extends Event
/** /**
* Returns set team for the mail event. * Returns set team for the mail event.
* *
* @return null|\Utopia\Database\Document * @return null|Document
*/ */
public function getTeam(): ?Document public function getTeam(): ?Document
{ {