fix: imrprove php-doc comments

Author: divine

src/Auth/PasswordResetServiceProvider.php

@@ -8,6 +8,7 @@ class PasswordResetServiceProvider extends BasePasswordResetServiceProvider
 {
     /**
      * Register the token repository implementation.
+     *
      * @return void
      */
     protected function registerTokenRepository()

src/Collection.php

@@ -10,12 +10,14 @@ class Collection
 {
     /**
      * The connection instance.
+     *
      * @var Connection
      */
     protected $connection;
 
     /**
-     * The MongoCollection instance..
+     * The MongoCollection instance.
+     *
      * @var MongoCollection
      */
     protected $collection;
@@ -32,6 +34,7 @@ public function __construct(Connection $connection, MongoCollection $collection)
 
     /**
      * Handle dynamic method calls.
+     *
      * @param string $method
      * @param array $parameters
      * @return mixed

src/Connection.php

@@ -11,18 +11,21 @@ class Connection extends BaseConnection
 {
     /**
      * The MongoDB database handler.
+     *
      * @var \MongoDB\Database
      */
     protected $db;
 
     /**
      * The MongoDB connection handler.
+     *
      * @var \MongoDB\Client
      */
     protected $connection;
 
     /**
      * Create a new database connection instance.
+     *
      * @param array $config
      */
     public function __construct(array $config)
@@ -53,6 +56,7 @@ public function __construct(array $config)
 
     /**
      * Begin a fluent query against a database collection.
+     *
      * @param string $collection
      * @return Query\Builder
      */
@@ -65,6 +69,7 @@ public function collection($collection)
 
     /**
      * Begin a fluent query against a database collection.
+     *
      * @param string $table
      * @param string|null $as
      * @return Query\Builder
@@ -76,6 +81,7 @@ public function table($table, $as = null)
 
     /**
      * Get a MongoDB collection.
+     *
      * @param string $name
      * @return Collection
      */
@@ -94,6 +100,7 @@ public function getSchemaBuilder()
 
     /**
      * Get the MongoDB database object.
+     *
      * @return \MongoDB\Database
      */
     public function getMongoDB()
@@ -103,6 +110,7 @@ public function getMongoDB()
 
     /**
      * return MongoDB object.
+     *
      * @return \MongoDB\Client
      */
     public function getMongoClient()
@@ -120,6 +128,7 @@ public function getDatabaseName()
 
     /**
      * Get the name of the default database based on db config or try to detect it from dsn.
+     *
      * @param string $dsn
      * @param array $config
      * @return string
@@ -140,6 +149,7 @@ protected function getDefaultDatabaseName($dsn, $config)
 
     /**
      * Create a new MongoDB connection.
+     *
      * @param string $dsn
      * @param array $config
      * @param array $options
@@ -175,6 +185,7 @@ public function disconnect()
 
     /**
      * Determine if the given configuration array has a dsn string.
+     *
      * @param array $config
      * @return bool
      */
@@ -185,6 +196,7 @@ protected function hasDsnString(array $config)
 
     /**
      * Get the DSN string form configuration.
+     *
      * @param array $config
      * @return string
      */
@@ -195,6 +207,7 @@ protected function getDsnString(array $config)
 
     /**
      * Get the DSN string for a host / port configuration.
+     *
      * @param array $config
      * @return string
      */
@@ -218,6 +231,7 @@ protected function getHostDsn(array $config)
 
     /**
      * Create a DSN string from a configuration.
+     *
      * @param array $config
      * @return string
      */
@@ -270,6 +284,7 @@ protected function getDefaultSchemaGrammar()
 
     /**
      * Set database.
+     *
      * @param \MongoDB\Database $db
      */
     public function setDatabase(\MongoDB\Database $db)
@@ -279,6 +294,7 @@ public function setDatabase(\MongoDB\Database $db)
 
     /**
      * Dynamically pass methods to the connection.
+     *
      * @param string $method
      * @param array $parameters
      * @return mixed

src/Eloquent/Builder.php

@@ -13,6 +13,7 @@ class Builder extends EloquentBuilder
 
     /**
      * The methods that should be returned from query builder.
+     *
      * @var array
      */
     protected $passthru = [

src/Eloquent/EmbedsRelations.php

@@ -10,6 +10,7 @@ trait EmbedsRelations
 {
     /**
      * Define an embedded one-to-many relationship.
+     *
      * @param string $related
      * @param string $localKey
      * @param string $foreignKey
@@ -44,6 +45,7 @@ protected function embedsMany($related, $localKey = null, $foreignKey = null, $r
 
     /**
      * Define an embedded one-to-many relationship.
+     *
      * @param string $related
      * @param string $localKey
      * @param string $foreignKey

src/Eloquent/HybridRelations.php

@@ -16,6 +16,7 @@ trait HybridRelations
 {
     /**
      * Define a one-to-one relationship.
+     *
      * @param string $related
      * @param string $foreignKey
      * @param string $localKey
@@ -39,6 +40,7 @@ public function hasOne($related, $foreignKey = null, $localKey = null)
 
     /**
      * Define a polymorphic one-to-one relationship.
+     *
      * @param string $related
      * @param string $name
      * @param string $type
@@ -64,6 +66,7 @@ public function morphOne($related, $name, $type = null, $id = null, $localKey =
 
     /**
      * Define a one-to-many relationship.
+     *
      * @param string $related
      * @param string $foreignKey
      * @param string $localKey
@@ -87,6 +90,7 @@ public function hasMany($related, $foreignKey = null, $localKey = null)
 
     /**
      * Define a polymorphic one-to-many relationship.
+     *
      * @param string $related
      * @param string $name
      * @param string $type
@@ -117,6 +121,7 @@ public function morphMany($related, $name, $type = null, $id = null, $localKey =
 
     /**
      * Define an inverse one-to-one or many relationship.
+     *
      * @param string $related
      * @param string $foreignKey
      * @param string $otherKey
@@ -160,6 +165,7 @@ public function belongsTo($related, $foreignKey = null, $otherKey = null, $relat
 
     /**
      * Define a polymorphic, inverse one-to-one or many relationship.
+     *
      * @param string $name
      * @param string $type
      * @param string $id
@@ -204,6 +210,7 @@ public function morphTo($name = null, $type = null, $id = null, $ownerKey = null
 
     /**
      * Define a many-to-many relationship.
+     *
      * @param string $related
      * @param string $collection
      * @param string $foreignKey
@@ -277,6 +284,7 @@ public function belongsToMany(
 
     /**
      * Get the relationship name of the belongs to many.
+     *
      * @return string
      */
     protected function guessBelongsToManyRelation()

src/Eloquent/Model.php

@@ -21,30 +21,35 @@ abstract class Model extends BaseModel
 
     /**
      * The collection associated with the model.
+     *
      * @var string
      */
     protected $collection;
 
     /**
      * The primary key for the model.
+     *
      * @var string
      */
     protected $primaryKey = '_id';
 
     /**
      * The primary key type.
+     *
      * @var string
      */
     protected $keyType = 'string';
 
     /**
      * The parent relation instance.
+     *
      * @var Relation
      */
     protected $parentRelation;
 
     /**
      * Custom accessor for the model's id.
+     *
      * @param mixed $value
      * @return mixed
      */
@@ -269,6 +274,7 @@ public function originalIsEquivalent($key)
 
     /**
      * Remove one or more fields.
+     *
      * @param mixed $columns
      * @return int
      */
@@ -314,6 +320,7 @@ public function push()
 
     /**
      * Remove one or more values from an array.
+     *
      * @param string $column
      * @param mixed $values
      * @return mixed
@@ -332,6 +339,7 @@ public function pull($column, $values)
 
     /**
      * Append one or more values to the underlying attribute value and sync with original.
+     *
      * @param string $column
      * @param array $values
      * @param bool $unique
@@ -356,6 +364,7 @@ protected function pushAttributeValues($column, array $values, $unique = false)
 
     /**
      * Remove one or more values to the underlying attribute value and sync with original.
+     *
      * @param string $column
      * @param array $values
      */
@@ -388,6 +397,7 @@ public function getForeignKey()
 
     /**
      * Set the parent relation.
+     *
      * @param \Illuminate\Database\Eloquent\Relations\Relation $relation
      */
     public function setParentRelation(Relation $relation)
@@ -397,6 +407,7 @@ public function setParentRelation(Relation $relation)
 
     /**
      * Get the parent relation.
+     *
      * @return \Illuminate\Database\Eloquent\Relations\Relation
      */
     public function getParentRelation()
@@ -432,6 +443,7 @@ protected function removeTableFromKey($key)
 
     /**
      * Get the queueable relationships for the entity.
+     *
      * @return array
      */
     public function getQueueableRelations()
@@ -461,6 +473,7 @@ public function getQueueableRelations()
 
     /**
      * Get loaded relations for the instance without parent.
+     *
      * @return array
      */
     protected function getRelationsWithoutParent()
@@ -477,6 +490,7 @@ protected function getRelationsWithoutParent()
     /**
      * Checks if column exists on a table.  As this is a document model, just return true.  This also
      * prevents calls to non-existent function Grammar::compileColumnListing().
+     *
      * @param string $key
      * @return bool
      */

src/Helpers/QueriesRelationships.php

@@ -15,12 +15,14 @@ trait QueriesRelationships
 {
     /**
      * Add a relationship count / exists condition to the query.
+     *
      * @param Relation|string $relation
      * @param string $operator
      * @param int $count
      * @param string $boolean
      * @param Closure|null $callback
      * @return Builder|static
+     * @throws Exception
      */
     public function has($relation, $operator = '>=', $count = 1, $boolean = 'and', Closure $callback = null)
     {
@@ -72,6 +74,7 @@ protected function isAcrossConnections(Relation $relation)
 
     /**
      * Compare across databases.
+     *
      * @param Relation $relation
      * @param string $operator
      * @param int $count
@@ -150,6 +153,7 @@ protected function getConstrainedRelatedIds($relations, $operator, $count)
 
     /**
      * Returns key we are constraining this parent model's query with.
+     *
      * @param Relation $relation
      * @return string
      * @throws Exception