sokil / php-mongo

src/Client.php

Doc Comments +3 added lines

@@ -114,6 +114,9 @@
         return $this->dbVersion;
     }
     
+    /**
+     * @param string $dsn
+     */
     public function setDsn($dsn)
     {
         $this->dsn = $dsn;

src/Operator.php

Doc Comments +10 added lines, -1 removed lines

@@ -32,6 +32,9 @@ 
         return $this;
     }
     
+    /**
+     * @param string $fieldName
+     */
     public function push($fieldName, $value)
     {
         // value must be list, not dictionary
@@ -68,6 +71,9 @@ 
         return $this;
     }
     
+    /**
+     * @param string $fieldName
+     */
     public function pushEach($fieldName, array $values)
     {
         // value must be list, not dictionary
@@ -296,6 +302,9 @@ 
         return $this;
     }
     
+    /**
+     * @param string $operation
+     */
     public function get($operation, $fieldName = null)
     {
         if($fieldName) {
@@ -331,7 +340,7 @@ 
     /**
      * Transform operator in different formats to canonical array form
      *
-     * @param mixed $mixed
+     * @param callable $mixed
      * @return array
      * @throws \Sokil\Mongo\Exception
      */

src/Structure.php

Doc Comments +10 added lines, -1 removed lines

@@ -60,7 +60,7 @@ 
      *
      * @param string $selector
      * @param string|callable $className string class name or closure, which accept data and return string class name
-     * @return object representation of document with class, passed as argument
+     * @return null|Structure representation of document with class, passed as argument
      * @throws \Sokil\Mongo\Exception
      */
     public function getObject($selector, $className)
@@ -208,6 +208,9 @@ 
         return $this;
     }
 
+    /**
+     * @param string $selector
+     */
     public function has($selector)
     {
         $pointer = &$this->_data;
@@ -263,6 +266,9 @@ 
         return (array) $value;
     }
 
+    /**
+     * @param string $selector
+     */
     public function unsetField($selector)
     {
         // modify
@@ -331,6 +337,9 @@ 
         return $this;
     }
 
+    /**
+     * @param string $selector
+     */
     public function isModified($selector = null)
     {
         if(!$this->_modifiedFields) {

src/Pipeline.php

Unused Use Statements -1 removed lines

@@ -12,7 +12,6 @@
 namespace Sokil\Mongo;
 
 use Sokil\Mongo\Pipeline\GroupStage;
-
 use Sokil\Mongo\ArrayableInterface;
 
 class Pipeline implements

src/Collection.php

Doc Comments +3 added lines, -3 removed lines

@@ -441,7 +441,7 @@ 
     /**
      * Store document to pool
      *
-     * @param array $document
+     * @param Document $document
      * @return \Sokil\Mongo\Collection
      */
     public function addDocumentToDocumentPool(Document $document)
@@ -582,7 +582,7 @@ 
      * 
      * @param string|\MongoId $id
      * @param callable $callable cursor callable used to configure cursor
-     * @return \Sokil\Mongo\Document|array|null
+     * @return Document
      */
     public function getDocumentDirectly($id, $callable = null)
     {
@@ -602,7 +602,7 @@ 
      * Check if document belongs to collection
      *
      * @param \Sokil\Mongo\Document $document
-     * @return type
+     * @return boolean
      */
     public function hasDocument(Document $document)
     {

src/Expression.php

Doc Comments +3 added lines

@@ -172,6 +172,9 @@
         return $this->whereHasType($field, FieldType::NULL);
     }
 
+    /**
+     * @param string $condition
+     */
     public function whereJsCondition($condition)
     {
         return $this->where('$where', $condition);

src/Database.php

Doc Comments +4 added lines, -4 removed lines

@@ -54,7 +54,7 @@ 
 
     /**
      * @param Client $client
-     * @param \MongoDB|string $database
+     * @param string $database
      */
     public function __construct(Client $client, $database) {
         $this->client = $client;
@@ -153,7 +153,7 @@ 
     /**
      * Reset specified mapping
      *
-     * @return \Sokil\Mongo\Client
+     * @return Database
      */
     public function resetMapping()
     {
@@ -167,7 +167,7 @@ 
      *
      * @param string|array                  $name               collection name or array like [collectionName => collectionClass, ...]
      * @param string|array|Definition|null  $classDefinition    if $name is string, then full class name or array with parameters, else omitted
-     * @return \Sokil\Mongo\Client
+     * @return Database
      */
     public function map($name, $classDefinition = null)
     {
@@ -229,7 +229,7 @@ 
      * @param string        $name               name of collection
      * @param array         $defaultDefinition  definition used when no definition found for defined class
      * @throws Exception
-     * @return string|array                     name of class or array of class definition
+     * @return string                     name of class or array of class definition
      */
     private function getCollectionDefinition($name, array $defaultDefinition = null)
     {

src/Document.php

Doc Comments +6 added lines

@@ -132,11 +132,17 @@
         return $this->options;
     }
 
+    /**
+     * @param string $name
+     */
     public function getOption($name, $default = null)
     {
         return isset($this->options[$name]) ? $this->options[$name] : $default;
     }
 
+    /**
+     * @param string $name
+     */
     public function hasOption($name)
     {
         return isset($this->options[$name]);