Enhancement: Add inline comments

zendframework · Feb 18, 2015 · 54167b9 · 54167b9
1 parent 17303a9
commit 54167b9
Showing 1 changed file with 13 additions and 2 deletions.
diff --git a/module/ZfModule/src/ZfModule/Mapper/Module.php b/module/ZfModule/src/ZfModule/Mapper/Module.php
@@ -3,7 +3,7 @@
 namespace ZfModule\Mapper;
 
 use Zend\Db\ResultSet\HydratingResultSet;
-use Zend\Db\Sql\Expression;
+use Zend\Db\Sql;
 use Zend\Paginator\Adapter\DbSelect;
 use Zend\Paginator\Paginator;
 use Zend\Stdlib\Hydrator\HydratorInterface;
@@ -32,10 +32,12 @@ public function pagination($page, $limit, $query = null, $orderBy = null, $sort
 
         if (null !== $query) {
             $spec = function ($where) use ($query) {
+                /* @var Sql\Where $where */
                 $where->like('name', '%' . $query . '%')->or->like('description', '%' . $query . '%');
             };
             $select->where($spec);
         }
+
         $resultSet = new HydratingResultSet($this->getHydrator(), $this->getEntityPrototype());
 
         $adapter = new DbSelect($select, $this->getSql(), $resultSet);
@@ -60,6 +62,7 @@ public function findAll($limit = null, $orderBy = null, $sort = 'ASC')
         }
 
         $entity = $this->select($select);
+
         $this->getEventManager()->trigger('find', $this, ['entity' => $entity]);
 
         return $entity;
@@ -78,11 +81,13 @@ public function findByLike($query, $limit = null, $orderBy = null, $sort = 'ASC'
         }
 
         $spec = function ($where) use ($query) {
+            /* @var Sql\Where $where */
             $where->like('name', '%' . $query . '%')->or->like('description', '%' . $query . '%');
         };
         $select->where($spec);
 
         $entity = $this->select($select);
+
         $this->getEventManager()->trigger('find', $this, ['entity' => $entity]);
 
         return $entity;
@@ -101,6 +106,7 @@ public function findByOwner($owner, $limit = null, $orderBy = null, $sort = 'ASC
         }
 
         $entity = $this->select($select);
+
         $this->getEventManager()->trigger('find', $this, ['entity' => $entity]);
 
         return $entity;
@@ -126,14 +132,17 @@ public function findBy($key, $value)
         $select->where([$key => $value]);
 
         $entity = $this->select($select)->current();
+
         $this->getEventManager()->trigger('find', $this, ['entity' => $entity]);
 
         return $entity;
     }
 
     public function insert($entity, $tableName = null, HydratorInterface $hydrator = null)
     {
+        /* @var Entity\Module $entity */
         $result = parent::insert($entity, $tableName, $hydrator);
+
         $entity->setId($result->getGeneratedValue());
 
         return $result;
@@ -142,6 +151,7 @@ public function insert($entity, $tableName = null, HydratorInterface $hydrator =
     public function update($entity, $where = null, $tableName = null, HydratorInterface $hydrator = null)
     {
         if (!$where) {
+            /* @var Entity\Module $entity */
             $where = ['module_id' => $entity->getId()];
         }
 
@@ -151,6 +161,7 @@ public function update($entity, $where = null, $tableName = null, HydratorInterf
     public function delete($entity, $where = null, $tableName = null)
     {
         if (!$where) {
+            /* @var Entity\Module $entity */
             $where = ['module_id' => $entity->getId()];
         }
 
@@ -160,7 +171,7 @@ public function delete($entity, $where = null, $tableName = null)
     public function getTotal()
     {
         $select = $this->getSelect();
-        $select->columns(['num' => new Expression('COUNT(*)')]);
+        $select->columns(['num' => new Sql\Expression('COUNT(*)')]);
 
         $stmt = $this->getSlaveSql()->prepareStatementForSqlObject($select);
         $row = $stmt->execute()->current();