andsalves / doctrine-elastic

src/Elastic/ElasticQuery.php

Doc Comments +3 added lines

@@ -69,6 +69,9 @@
         return $this->_dql;
     }
 
+    /**
+     * @param string $dql
+     */
     public function setDQL($dql) {
         $this->_dql = $dql;
     }

src/Persister/AbstractEntityPersister.php

Doc Comments +2 added lines, -2 removed lines

@@ -187,7 +187,7 @@ 
      *
      * @param object $entity The entity to delete.
      *
-     * @return bool TRUE if the entity got deleted in the database, FALSE otherwise.
+     * @return boolean|null TRUE if the entity got deleted in the database, FALSE otherwise.
      */
     public function delete($entity) {
         // TODO: Implement delete() method.
@@ -385,7 +385,7 @@ 
      * @param object $entity
      * @param Criteria|null $extraConditions
      *
-     * @return boolean TRUE if the entity exists in the database, FALSE otherwise.
+     * @return boolean|null TRUE if the entity exists in the database, FALSE otherwise.
      */
     public function exists($entity, Criteria $extraConditions = null) {
         // TODO: Implement exists() method.

src/Query/ElasticWalker.php

Doc Comments +4 added lines, -1 removed lines

@@ -39,6 +39,9 @@ 
     /** @var SelectStatement */
     private $_ast;
 
+    /**
+     * @param string $className
+     */
     public function __construct(ElasticQuery $query, SelectStatement $AST, $className) {
         $this->query = $query;
         $this->walkerHelper = new WalkerHelper();
@@ -126,7 +129,7 @@ 
     }
 
     /**
-     * @param $className
+     * @param string $className
      * @return Type
      */
     private function getEntityElasticType($className) {

src/Query/Walker/WhereWalker.php

Doc Comments +9 added lines

@@ -44,6 +44,9 @@ 
 
     private $fieldAnnotations = [];
 
+    /**
+     * @param string $className
+     */
     public function __construct(ElasticQuery $query, $className, WalkerHelper $walkerHelper) {
         $this->query = $query;
         $this->className = $className;
@@ -96,6 +99,9 @@ 
         $this->walkTermsAndFactors($termsAndFactors, $searchParams);
     }
 
+    /**
+     * @param SearchParams $searchParams
+     */
     private function walkTermsAndFactors(array $termsAndFactors, $searchParams) {
         foreach ($termsAndFactors['factors'] as $factor) {
             $this->walkANDFactor($factor, $searchParams);
@@ -251,6 +257,9 @@ 
         $this->addBodyStatement($field, $operator, null, $searchParams);
     }
 
+    /**
+     * @param string $field
+     */
     private function addBodyStatement($field, $operator, $value, SearchParams $searchParams) {
         $body = $searchParams->getBody();
         $this->walkerHelper->addBodyStatement($field, $operator, $value, $body);

src/Connection/ElasticConnection.php

Doc Comments +1 added lines, -1 removed lines

@@ -249,7 +249,7 @@
      * @param string $_id
      * @param array $mergeParams
      * @param array|null $return
-     * @return array|null
+     * @return null|callable
      */
     public function get($index, $type, $_id, array $mergeParams = [], array &$return = null) {
         if (!$this->indexExists($index)) {

src/Persister/ElasticEntityPersister.php

Doc Comments +3 added lines

@@ -47,6 +47,9 @@
         $this->validateEntity($classMetadata->name);
     }
 
+    /**
+     * @param string $className
+     */
     private function validateEntity($className) {
         $type = $this->annotationReader->getClassAnnotation($this->class->getReflectionClass(), Type::class);