From 18b9d8aaedfdd42b5060ea83c8d76df11db33f79 Mon Sep 17 00:00:00 2001 From: Ope Adeyomoye Date: Thu, 1 Dec 2022 23:26:12 +0100 Subject: [PATCH] Updated doc-block comments. --- src/Collection.php | 8 ++++---- src/CollectionConfiguration.php | 4 ++-- src/Concerns/HasCollectionResolver.php | 2 +- src/Concerns/HasConvenientWrites.php | 6 +++--- src/Concerns/HasRelationships.php | 2 +- src/Document.php | 4 ++-- src/Relations/BindMany.php | 2 +- 7 files changed, 14 insertions(+), 14 deletions(-) diff --git a/src/Collection.php b/src/Collection.php index 8dad36b..754d98f 100644 --- a/src/Collection.php +++ b/src/Collection.php @@ -44,7 +44,7 @@ public function __construct(Connection $connection, array $properties = []) * @param array $filter * @param array $options * - * @return Xenus\Cursor + * @return \Xenus\Cursor */ public function find($filter = [], array $options = []) { @@ -151,7 +151,7 @@ public function findOneAndReplace($filter, $replacement, array $options = []) * @param array|ObjectID $filter * @param array $options * - * @return MongoDB\DeleteResult + * @return \MongoDB\DeleteResult */ public function deleteOne($filter, array $options = []) { @@ -169,7 +169,7 @@ public function deleteOne($filter, array $options = []) * @param array|object $update * @param array $options * - * @return MongoDB\UpdateResult + * @return \MongoDB\UpdateResult */ public function updateOne($filter, $update, array $options = []) { @@ -187,7 +187,7 @@ public function updateOne($filter, $update, array $options = []) * @param array|object $replacement * @param array $options * - * @return MongoDB\UpdateResult + * @return \MongoDB\UpdateResult */ public function replaceOne($filter, $replacement, array $options = []) { diff --git a/src/CollectionConfiguration.php b/src/CollectionConfiguration.php index 549c036..c855e8e 100644 --- a/src/CollectionConfiguration.php +++ b/src/CollectionConfiguration.php @@ -50,7 +50,7 @@ public function has(string $property) { /** * Get the collection's options * - * @return Array + * @return array */ public function getCollectionOptions() { @@ -62,7 +62,7 @@ public function getCollectionOptions() /** * Get the collection's name * - * @return String|null + * @return string|null */ public function getCollectionName() { diff --git a/src/Concerns/HasCollectionResolver.php b/src/Concerns/HasCollectionResolver.php index 0171eaf..ae5148d 100644 --- a/src/Concerns/HasCollectionResolver.php +++ b/src/Concerns/HasCollectionResolver.php @@ -14,7 +14,7 @@ trait HasCollectionResolver * * @param string $collection * - * @return Collection + * @return \Xenus\Collection */ public function resolve(string $collection) { diff --git a/src/Concerns/HasConvenientWrites.php b/src/Concerns/HasConvenientWrites.php index 07bc0bf..09d1b9a 100644 --- a/src/Concerns/HasConvenientWrites.php +++ b/src/Concerns/HasConvenientWrites.php @@ -10,7 +10,7 @@ trait HasConvenientWrites * @param array|object $document * @param array $options * - * @return MongoDB\InsertOneResult + * @return \MongoDB\InsertOneResult */ public function insert($document, array $options = []) { @@ -33,7 +33,7 @@ public function insert($document, array $options = []) * @param array|object $document * @param array $options * - * @return MongoDB\DeleteResult + * @return \MongoDB\DeleteResult */ public function delete($document, array $options = []) { @@ -56,7 +56,7 @@ public function delete($document, array $options = []) * @param array|object $document * @param array $options * - * @return MongoDB\UpdateResult + * @return \MongoDB\UpdateResult */ public function update($document, array $options = []) { diff --git a/src/Concerns/HasRelationships.php b/src/Concerns/HasRelationships.php index 4e628ac..548051a 100644 --- a/src/Concerns/HasRelationships.php +++ b/src/Concerns/HasRelationships.php @@ -12,7 +12,7 @@ trait HasRelationships * * @param string $collection * - * @return Collection + * @return \Xenus\Collection */ protected function build(string $collection) { diff --git a/src/Document.php b/src/Document.php index 9fa3336..b895933 100644 --- a/src/Document.php +++ b/src/Document.php @@ -82,7 +82,7 @@ public function has(string $offset) * * @param array $fields The keys to keep * - * @return Xenus\Document + * @return \Xenus\Document */ public function with(array $fields) { @@ -103,7 +103,7 @@ public function with(array $fields) * * @param array $fields The keys to drop * - * @return Xenus\Document + * @return \Xenus\Document */ public function without(array $fields) { diff --git a/src/Relations/BindMany.php b/src/Relations/BindMany.php index 5b4c957..0206bb7 100644 --- a/src/Relations/BindMany.php +++ b/src/Relations/BindMany.php @@ -10,7 +10,7 @@ class BindMany extends AbstractRelation * @param array $filter * @param array $options * - * @return Cursor + * @return \Xenus\Cursor */ public function find($filter = [], array $options = []) {