raivieira / base-api-php

src/Doctrine/Common/Interfaces/BaseRepositoryInterface.php

Doc Comments +12 added lines

@@ -4,12 +4,18 @@ 
 
 interface BaseRepositoryInterface
 {
+    /**
+     * @return boolean|null
+     */
     public function validate(BaseEntityInterface $entity);
 
     public function getEntityName();
 
     public function query();
 
+    /**
+     * @return \Bludata\Doctrine\ORM\Repositories\QueryWorker
+     */
     public function findAll();
 
     public function findOneBy(array $filters, $abort = true);
@@ -32,7 +38,13 @@ 
 
     public function createEntity();
 
+    /**
+     * @return \Bludata\Doctrine\ORM\Repositories\QueryWorker
+     */
     public function createQueryWorker();
 
+    /**
+     * @return string
+     */
     public function getMessageNotFound();
 }

src/Doctrine/ODM/MongoDB/Repositories/BaseRepository.php

Doc Comments +8 added lines, -2 removed lines

@@ -12,6 +12,9 @@ 
 {
     abstract public function preSave(BaseEntityInterface $entity);
 
+    /**
+     * @return string
+     */
     abstract public function getMessageNotFound();
 
     public function validate(BaseEntityInterface $entity)
@@ -40,6 +43,9 @@ 
         return parent::getClassMetadata();
     }
 
+    /**
+     * @return string|null
+     */
     public function getEntityName()
     {
         return parent::getDocumentName();
@@ -137,7 +143,7 @@ 
     }
 
     /**
-     * @param Bludata\Entities\BaseEntityInterface $entity
+     * @param BaseEntityInterface $entity
      *
      * @return Bludata\Repositories\QueryWorker
      */
@@ -149,7 +155,7 @@ 
     }
 
     /**
-     * @param Bludata\Entities\BaseEntityInterface $entity
+     * @param BaseEntityInterface $entity
      *
      * @return Bludata\Repositories\QueryWorker
      */

src/Doctrine/Common/Interfaces/BaseEntityInterface.php

Doc Comments +19 added lines

@@ -6,18 +6,36 @@ 
 {
     public function getId();
 
+    /**
+     * @return \Bludata\Doctrine\ORM\Entities\BaseEntity
+     */
     public function save($flush = false);
 
+    /**
+     * @return \Bludata\Doctrine\ORM\Entities\BaseEntity
+     */
     public function remove();
 
+    /**
+     * @return \Bludata\Doctrine\ORM\Entities\BaseEntity
+     */
     public function flush($all = true);
 
     public function getRepository();
 
+    /**
+     * @return \Bludata\Doctrine\ORM\Entities\BaseEntity
+     */
     public function forcePersist();
 
+    /**
+     * @return void
+     */
     public function prePersist();
 
+    /**
+     * @return void
+     */
     public function preUpdate();
 
     /**
@@ -44,6 +62,7 @@ 
      * Set all attributes of the Entity with the values in $data.
      *
      * @param array $data Key value pair to set attributes
+     * @return \Bludata\Doctrine\ORM\Entities\BaseEntity
      */
     public function setPropertiesEntity(array $data);