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/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);

Unused Use Statements -1 removed lines

@@ -15,7 +15,6 @@
 use Doctrine\ORM\Query\AST\Node;
 use Doctrine\ORM\Query\AST\NullComparisonExpression;
 use Doctrine\ORM\Query\AST\PathExpression;
-use Doctrine\ORM\Query\AST\SimpleArithmeticExpression;
 use Doctrine\ORM\Query\AST\WhereClause;
 use DoctrineElastic\Elastic\ElasticQuery;
 use DoctrineElastic\Elastic\SearchParams;

src/Connection/ElasticConnection.php

Spacing +1 added lines, -1 removed lines

@@ -210,7 +210,7 @@
         );
 
         $params = array_merge_recursive($defaultParams, $mergeParams);
-        $existsParams = array_filter($params, function ($key) {
+        $existsParams = array_filter($params, function($key) {
             return in_array($key, ['id', 'index', 'type', 'refresh']);
         }, ARRAY_FILTER_USE_KEY);
 

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/ElasticUnitOfWork.php

Spacing +1 added lines, -1 removed lines

@@ -337,7 +337,7 @@
     }
 
     public function delete($entity) {
-        if(!is_object($entity)){
+        if (!is_object($entity)) {
             throw new InvalidArgumentException('Trying to schedule a non object to delete');
         }
 

Doc Comments +9 added lines

@@ -241,6 +241,9 @@ 
         $this->clear($entity);
     }
 
+    /**
+     * @param string $className
+     */
     public function executeInserts($className) {
         $persister = $this->getEntityPersister($className);
 
@@ -256,6 +259,9 @@ 
         $persister->executeInserts();
     }
 
+    /**
+     * @param string $className
+     */
     public function executeUpdates($className) {
         $persister = $this->getEntityPersister($className);
 
@@ -269,6 +275,9 @@ 
         }
     }
 
+    /**
+     * @param string $className
+     */
     public function executeDeletions($className) {
         $persister = $this->getEntityPersister($className);
 

src/Persister/ElasticEntityPersister.php

Doc Comments +9 added lines

@@ -45,6 +45,9 @@ 
     /** @var \ReflectionClass */
     private $reflectionClass;
 
+    /**
+     * @param string $className
+     */
     public function __construct(ElasticEntityManager $em, $className) {
         $this->className = $className;
         $this->annotationReader = new AnnotationReader();
@@ -85,6 +88,9 @@ 
         }
     }
 
+    /**
+     * @param integer $offset
+     */
     public function loadAll(array $criteria = [], array $orderBy = null, $limit = null, $offset = null) {
         $type = $this->getEntityType();
         $sort = $must = [];
@@ -297,6 +303,9 @@ 
         }
     }
 
+    /**
+     * @param integer $limit
+     */
     public function load(
         array $criteria, $entity = null, $assoc = null, array $hints = [],
         $lockMode = null, $limit = null, array $orderBy = null

src/Query/ElasticWalker.php

Doc Comments +4 added lines, -1 removed lines

@@ -36,6 +36,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 $propertyName
-     * @param $className
+     * @param string $className
      * @return Field
      */
     private function getEntityElasticField($propertyName, $className) {

Spacing +1 added lines, -1 removed lines

@@ -133,6 +133,6 @@
         /** @var Field[] $fields */
         $fields = (new AnnotationEntityHydrator())->extractSpecAnnotations($className, Field::class);
 
-        return isset($fields[$propertyName]) ? $fields[$propertyName]: null;
+        return isset($fields[$propertyName]) ? $fields[$propertyName] : null;
     }
 }

src/Query/QueryParser.php

Doc Comments +2 added lines, -2 removed lines

@@ -1143,7 +1143,7 @@ 
      * accessible is "FROM", prohibiting an easy implementation without larger
      * changes.}
      *
-     * @return \Doctrine\ORM\Query\AST\SubselectIdentificationVariableDeclaration |
+     * @return AST\IdentificationVariableDeclaration |
      *         \Doctrine\ORM\Query\AST\IdentificationVariableDeclaration
      */
     public function SubselectIdentificationVariableDeclaration() {
@@ -1279,7 +1279,7 @@ 
      * PartialObjectExpression ::= "PARTIAL" IdentificationVariable "." PartialFieldSet
      * PartialFieldSet ::= "{" SimpleStateField {"," SimpleStateField}* "}"
      *
-     * @return array
+     * @return AST\PartialObjectExpression
      */
     public function PartialObjectExpression() {
         $this->match(Lexer::T_PARTIAL);