Main changes in ZfcDatagrid\Datagrid for better code completion in IDE

added missing methods in `ZfcDatagrid\DataSource\DataSourceInterface` added php-doc in `ZfcDatagrid\DataSource\AbstractDataSource`
ThaDafinser · Apr 16, 2015 · bffe30a · bffe30a
1 parent bb39563
commit bffe30a
Show file tree

Hide file tree

Showing 3 changed files with 56 additions and 8 deletions.
diff --git a/src/ZfcDatagrid/DataSource/AbstractDataSource.php b/src/ZfcDatagrid/DataSource/AbstractDataSource.php
@@ -65,6 +65,9 @@ public function addSortCondition(Column\AbstractColumn $column, $sortDirection =
         ];
     }
 
+    /**
+     * @param array $sortConditions
+     */
     public function setSortConditions(array $sortConditions)
     {
         $this->sortConditions = $sortConditions;
@@ -89,6 +92,10 @@ public function addFilter(Filter $filter)
         $this->filters[] = $filter;
     }
 
+    /**
+     *
+     * @param array $filters
+     */
     public function setFilters(array $filters)
     {
         $this->filters = $filters;
@@ -103,6 +110,9 @@ public function getFilters()
         return $this->filters;
     }
 
+    /**
+     * @param PaginatorAdapterInterface $paginator
+     */
     public function setPaginatorAdapter(PaginatorAdapterInterface $paginator)
     {
         $this->paginatorAdapter = $paginator;

diff --git a/src/ZfcDatagrid/DataSource/DataSourceInterface.php b/src/ZfcDatagrid/DataSource/DataSourceInterface.php
@@ -1,6 +1,9 @@
 <?php
 namespace ZfcDatagrid\DataSource;
 
+use ZfcDatagrid\Column;
+use ZfcDatagrid\Filter;
+
 interface DataSourceInterface
 {
     /**
@@ -27,4 +30,31 @@ public function getData();
      * - with filters statements
      */
     public function execute();
+
+    /**
+     * Set the columns
+     *
+     * @param array $columns
+     */
+    public function setColumns(array $columns);
+
+    /**
+     * Set sort conditions
+     *
+     * @param Column\AbstractColumn $column
+     * @param string                $sortDirection
+     */
+    public function addSortCondition(Column\AbstractColumn $column, $sortDirection = 'ASC');
+
+    /**
+     *
+     * @param array $filters
+     */
+    public function addFilter(Filter $filter);
+
+    /**
+     *
+     * @return \Zend\Paginator\Adapter\AdapterInterface
+     */
+    public function getPaginatorAdapter();
 }
diff --git a/src/ZfcDatagrid/Datagrid.php b/src/ZfcDatagrid/Datagrid.php
@@ -78,7 +78,7 @@ class Datagrid implements ServiceLocatorAwareInterface
     /**
      * View or Response
      *
-     * @var \Zend\Http\Response\Stream \Zend\View\Model\ViewModel
+     * @var \Zend\Http\Response\Stream|\Zend\View\Model\ViewModel
      */
     protected $response;
 
@@ -647,7 +647,7 @@ private function createColumn($config)
         } elseif (class_exists('ZfcDatagrid\\Column\\' . $colType, true)) {
             $class = 'ZfcDatagrid\\Column\\' . $colType;
         } else {
-            throw new \InvalidArgumentException('Column type: "' . $colType . '" not found!');
+            throw new \InvalidArgumentException(sprintf('Column type: "%s" not found!', $colType));
         }
 
         if ('ZfcDatagrid\\Column\\Select' == $class) {
@@ -930,7 +930,7 @@ public function getRenderer()
 
                 $this->renderer = $renderer;
             } else {
-                throw new \Exception('Renderer service was not found, please register it: "' . $rendererName . '"');
+                throw new \Exception(sprintf('Renderer service was not found, please register it: "%s"', $rendererName));
             }
         }
 
@@ -1015,13 +1015,14 @@ public function loadData()
                 } elseif ($data instanceof ArrayIterator) {
                     $data = $data->getArrayCopy();
                 } else {
-                    $add = '';
                     if (is_object($data)) {
                         $add = get_class($data);
                     } else {
                         $add = '[no object]';
                     }
-                    throw new \Exception('The paginator returned an unknow result: ' . $add . ' (allowed: \ArrayIterator or a plain php array)');
+                    throw new \Exception(
+                        sprintf('The paginator returned an unknown result: %s (allowed: \ArrayIterator or a plain php array)', $add)
+                    );
                 }
             }
         }
@@ -1038,8 +1039,15 @@ public function loadData()
             ];
             $success = $this->getCache()->setItem($this->getCacheId(), $cacheData);
             if ($success !== true) {
+                /** @var \Zend\Cache\Storage\Adapter\FilesystemOptions $options */
                 $options = $this->getCache()->getOptions();
-                throw new \Exception('Could not save the datagrid cache. Does the directory "' . $options->getCacheDir() . '" exists and is writeable? CacheId: ' . $this->getCacheId());
+                throw new \Exception(
+                    sprintf(
+                        'Could not save the datagrid cache. Does the directory "%s" exists and is writeable? CacheId: %s',
+                        $options->getCacheDir(),
+                        $this->getCacheId()
+                    )
+                );
             }
         }
 
@@ -1141,7 +1149,7 @@ public function setToolbarTemplate($name)
      * Get the toolbar template name
      * Return null if nothing custom set
      *
-     * @return string null
+     * @return string|null
      */
     public function getToolbarTemplate()
     {
@@ -1197,7 +1205,7 @@ public function getViewModel()
 
     /**
      *
-     * @return Ambigous <\Zend\Stdlib\ResponseInterface, \Zend\Http\Response\Stream, \Zend\View\Model\ViewModel>
+     * @return \Zend\Stdlib\ResponseInterface|\Zend\Http\Response\Stream|\Zend\View\Model\ViewModel
      */
     public function getResponse()
     {