AgelxNash / DocLister

assets/snippets/DocLister/lib/DLpaginate.class.php

Doc Comments +6 added lines, -6 removed lines

@@ -53,7 +53,7 @@ 
     private $pagination;
 
     /**
-     * @param $mode
+     * @param string $mode
      * @param array $config
      * @return $this
      */
@@ -68,7 +68,7 @@ 
     /**
      * Total items
      *
-     * @param $value
+     * @param integer $value
      * @return $this
      */
     public function items($value)
@@ -107,7 +107,7 @@ 
     /**
      * Current page
      *
-     * @param $value
+     * @param integer $value
      * @return $this
      */
     public function currentPage($value)
@@ -282,7 +282,7 @@ 
 
     /**
      * @param $id
-     * @return mixed|string
+     * @return string
      */
     public function get_pagenum_link($id)
     {
@@ -415,8 +415,8 @@ 
     }
 
     /**
-     * @param $tpl
-     * @param $num
+     * @param string $tpl
+     * @param integer $num
      * @return mixed
      */
     protected function renderItemTPL($tpl, $num)

Braces +75 added lines, -73 removed lines

@@ -3,8 +3,8 @@ 
 /**
  * Class DLpaginate
  */
-class DLpaginate
-{
+class DLpaginate

+{

     /**
      * Script Name: *Digg Style Paginator Class
      * Script URI: http://www.mis-algoritmos.com/2007/05/27/digg-style-pagination-class/
@@ -57,8 +57,8 @@ 
      * @param array $config
      * @return $this
      */
-    public function setMode($mode, array $config = array())
-    {
+    public function setMode($mode, array $config = array())

+    {

         $this->mode = $mode;
         $this->modeConfig = $config;
 
@@ -71,8 +71,8 @@ 
      * @param $value
      * @return $this
      */
-    public function items($value)
-    {
+    public function items($value)

+    {

         $this->total_pages = (int)$value;
 
         return $this;
@@ -84,8 +84,8 @@ 
      * @param $value
      * @return $this
      */
-    public function limit($value)
-    {
+    public function limit($value)

+    {

         $this->limit = (int)$value;
 
         return $this;
@@ -97,8 +97,8 @@ 
      * @param $value
      * @return $this
      */
-    public function target($value)
-    {
+    public function target($value)

+    {

         $this->target = $value;
 
         return $this;
@@ -110,8 +110,8 @@ 
      * @param $value
      * @return $this
      */
-    public function currentPage($value)
-    {
+    public function currentPage($value)

+    {

         $this->page = (int)$value;
 
         return $this;
@@ -123,8 +123,8 @@ 
      * @param $value
      * @return $this
      */
-    public function adjacents($value)
-    {
+    public function adjacents($value)

+    {

         $this->adjacents = (int)$value;
 
         return $this;
@@ -136,8 +136,8 @@ 
      * @param string $value
      * @return $this
      */
-    public function showCounter($value = "")
-    {
+    public function showCounter($value = "")

+    {

         $this->showCounter = ($value === true) ? true : false;
 
         return $this;
@@ -149,8 +149,8 @@ 
      * @param string $value
      * @return $this
      */
-    public function changeClass($value = "")
-    {
+    public function changeClass($value = "")

+    {

         $this->className = $value;
 
         return $this;
@@ -160,8 +160,8 @@ 
      * @param $value
      * @return $this
      */
-    public function mainTpl($value)
-    {
+    public function mainTpl($value)

+    {

         $this->mainTpl = $value;
 
         return $this;
@@ -171,8 +171,8 @@ 
      * @param $value
      * @return $this
      */
-    public function nextLabel($value)
-    {
+    public function nextLabel($value)

+    {

         $this->nextT = $value;
 
         return $this;
@@ -182,8 +182,8 @@ 
      * @param $value
      * @return $this
      */
-    public function nextIcon($value)
-    {
+    public function nextIcon($value)

+    {

         $this->nextI = $value;
 
         return $this;
@@ -193,8 +193,8 @@ 
      * @param $value
      * @return $this
      */
-    public function prevLabel($value)
-    {
+    public function prevLabel($value)

+    {

         $this->prevT = $value;
 
         return $this;
@@ -204,8 +204,8 @@ 
      * @param $value
      * @return $this
      */
-    public function prevIcon($value)
-    {
+    public function prevIcon($value)

+    {

         $this->prevI = $value;
 
         return $this;
@@ -217,8 +217,8 @@ 
      * @param string $value
      * @return $this
      */
-    public function parameterName($value = "")
-    {
+    public function parameterName($value = "")

+    {

         $this->parameterName = $value;
 
         return $this;
@@ -230,9 +230,9 @@ 
      * @param string $value
      * @return $this
      */
-    public function urlFriendly($value = "%")
-    {
-        if (preg_match('/^\s/', $value)) {
+    public function urlFriendly($value = "%")

+    {

+        if (preg_match('/^\s/', $value)) {

             $this->urlF = false;
         }
         $this->urlF = $value;
@@ -240,18 +240,18 @@ 
         return $this;
     }
 
-    public function show()
-    {
+    public function show()

+    {

         echo $this->getOutput();
     }
 
     /**
      * @return string
      */
-    public function getOutput()
-    {
+    public function getOutput()

+    {

         $out = '';
-        if (!$this->calculate && $this->calculate() && !empty($this->pagination)) {
+        if (!$this->calculate && $this->calculate() && !empty($this->pagination)) {

             $out = str_replace(array("[+class+]", "[+wrap+]"), array($this->className, $this->pagination),
                     $this->mainTpl) . "\n";
         }
@@ -263,9 +263,9 @@ 
      * @param $page
      * @return int|mixed
      */
-    protected function getPageQuery($page)
-    {
-        switch ($this->mode) {
+    protected function getPageQuery($page)

+    {

+        switch ($this->mode) {

             case 'offset':
                 $display = isset($this->modeConfig['display']) ? $this->modeConfig['display'] : 0;
                 $out = $display * ($page - 1);
@@ -284,15 +284,15 @@ 
      * @param $id
      * @return mixed|string
      */
-    public function get_pagenum_link($id)
-    {
+    public function get_pagenum_link($id)

+    {

         $flag = (strpos($this->target, '?') === false);
         $value = $this->getPageQuery($id);
-        if ($flag && !empty($this->urlF)) {
+        if ($flag && !empty($this->urlF)) {

             $out = str_replace($this->urlF, $value, $this->target);
-        } else {
+        } else {

             $out = $this->target;
-            if ($id > 1) {
+            if ($id > 1) {

                 $out .= ($flag ? "?" : "&") . $this->parameterName . "=" . $value;
             }
         }
@@ -303,30 +303,30 @@ 
     /**
      * @return bool
      */
-    public function calculate()
-    {
+    public function calculate()

+    {

         $this->pagination = "";
         $this->calculate = true;
         $error = false;
 
         if (!empty($this->urlF) && is_scalar($this->urlF) && $this->urlF != '%' && strpos($this->target,
                 $this->urlF) === false
-        ) {
+        ) {

             //Es necesario especificar el comodin para sustituir
             $error = true;
         } elseif (!empty($this->urlF) && is_scalar($this->urlF) && $this->urlF == '%' && strpos($this->target,
                 $this->urlF) === false
-        ) {
+        ) {

             $error = true;
         }
 
-        if ($this->total_pages < 0) {
+        if ($this->total_pages < 0) {

             $error = true;
         }
-        if (!is_int($this->limit)) {
+        if (!is_int($this->limit)) {

             $error = true;
         }
-        if ($error) {
+        if ($error) {

             return false;
         }
 
@@ -336,7 +336,7 @@ 
         $prev = ($this->page <= 1) ? 0 : $this->page - 1; //previous page is page - 1
         $next = (($this->page == $this->total_pages) ? 0 : ($this->page + 1)); //next page is page + 1
         $lastpage = $this->total_pages;
-        if ($this->limit > 1 && $lastpage > $this->limit) {
+        if ($this->limit > 1 && $lastpage > $this->limit) {

             $lastpage = $this->limit;
         }
         $lpm1 = $lastpage - 1; //last page minus 1
@@ -345,26 +345,28 @@ 
                 Now we apply our rules and draw the pagination object.
                 We're actually saving the code to a variable in case we want to draw it more than once.
         */
-        if ($lastpage > 1) {
-            if ($this->page) {
-                if ($this->page > 1) {
+        if ($lastpage > 1) {

+            if ($this->page) {

+                if ($this->page > 1) {

                     $this->pagination .= $this->firstT ? $this->renderItemTPL($this->firstT, 0) : '';
                     $this->pagination .= $this->prevT ? $this->renderItemTPL($this->prevT, $prev) : '';
-                } else {
+                } else {

                     $this->pagination .= $this->firstI ? $this->renderItemTPL($this->firstI, 0) : '';
                     $this->pagination .= $this->prevI ? $this->renderItemTPL($this->prevI, $prev) : '';
                 }
             }
             //pages
-            if ($lastpage < 7 + ($this->adjacents * 2)) { //not enough pages to bother breaking it up
-                for ($counter = 1; $counter <= $lastpage; $counter++) {
+            if ($lastpage < 7 + ($this->adjacents * 2)) {

+//not enough pages to bother breaking it up
+                for ($counter = 1; $counter <= $lastpage; $counter++) {

                     $tpl = ($counter == $this->page) ? $this->currentT : $this->numberT;
                     $this->pagination .= $this->renderItemTPL($tpl, $counter);
                 }
-            } elseif ($lastpage > 5 + ($this->adjacents * 2)) { //enough pages to hide some
+            } elseif ($lastpage > 5 + ($this->adjacents * 2)) {

+//enough pages to hide some
                 //close to beginning; only hide later pages
-                if ($this->page <= 2 + ($this->adjacents * 2)) {
-                    for ($counter = 1; $counter < 4 + ($this->adjacents * 2); $counter++) {
+                if ($this->page <= 2 + ($this->adjacents * 2)) {

+                    for ($counter = 1; $counter < 4 + ($this->adjacents * 2); $counter++) {

                         $tpl = ($counter == $this->page) ? $this->currentT : $this->numberT;
                         $this->pagination .= $this->renderItemTPL($tpl, $counter);
                     }
@@ -372,12 +374,12 @@ 
                     $this->pagination .= $this->renderItemTPL($this->numberT, $lpm1);
                     $this->pagination .= $this->renderItemTPL($this->numberT, $lastpage);
                 } //in middle; hide some front and some back
-                elseif ($lastpage - ($this->adjacents * 2) > $this->page && $this->page > ($this->adjacents * 2)) {
+                elseif ($lastpage - ($this->adjacents * 2) > $this->page && $this->page > ($this->adjacents * 2)) {

                     $this->pagination .= $this->renderItemTPL($this->numberT, 1);
                     $this->pagination .= $this->renderItemTPL($this->numberT, 2);
                     $this->pagination .= $this->renderItemTPL($this->dotsT, 3);
 
-                    for ($counter = $this->page - $this->adjacents; $counter <= $this->page + $this->adjacents; $counter++) {
+                    for ($counter = $this->page - $this->adjacents; $counter <= $this->page + $this->adjacents; $counter++) {

                         $tpl = ($counter == $this->page) ? $this->currentT : $this->numberT;
                         $this->pagination .= $this->renderItemTPL($tpl, $counter);
                     }
@@ -385,27 +387,27 @@ 
                     $this->pagination .= $this->renderItemTPL($this->numberT, $lpm1);
                     $this->pagination .= $this->renderItemTPL($this->numberT, $lastpage);
                 } //close to end; only hide early pages
-                else {
+                else {

                     $this->pagination .= $this->renderItemTPL($this->numberT, 1);
                     $this->pagination .= $this->renderItemTPL($this->numberT, 2);
                     $this->pagination .= $this->renderItemTPL($this->dotsT, 3);
 
-                    for ($counter = $lastpage - (2 + ($this->adjacents * 2)); $counter <= $lastpage; $counter++) {
+                    for ($counter = $lastpage - (2 + ($this->adjacents * 2)); $counter <= $lastpage; $counter++) {

                         $tpl = ($counter == $this->page) ? $this->currentT : $this->numberT;
                         $this->pagination .= $this->renderItemTPL($tpl, $counter);
                     }
                 }
             }
-            if ($this->page) {
-                if ($this->page < $counter - 1) {
+            if ($this->page) {

+                if ($this->page < $counter - 1) {

                     $this->pagination .= $this->nextT ? $this->renderItemTPL($this->nextT, $next) : '';
                     $this->pagination .= $this->lastT ? $this->renderItemTPL($this->lastT, $lastpage) : '';
-                } else {
+                } else {

                     $this->pagination .= $this->nextI ? $this->renderItemTPL($this->nextI, $next) : '';
                     $this->pagination .= $this->lastI ? $this->renderItemTPL($this->lastI, $lastpage) : '';
                 }
 
-                if ($this->showCounter) {
+                if ($this->showCounter) {

                     $this->pagination .= "<div class=\"pagination_data\">($this->total_pages Pages)</div>";
                 }
             }
@@ -419,8 +421,8 @@ 
      * @param $num
      * @return mixed
      */
-    protected function renderItemTPL($tpl, $num)
-    {
+    protected function renderItemTPL($tpl, $num)

+    {

         return str_replace(array('[+num+]', '[+link+]'), array($num, $this->get_pagenum_link($num)), $tpl);
     }
 }