TrapDirectorTable::titleOrder() - Code Metrics - Inspection of "issue #43" - patrickpr/trapdirector - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 395129...4a18b4 )

by Patrick

created 2020-09-04 18:11 UTC

TrapDirectorTable::titleOrder() A

↳ Parent: TrapDirectorTable

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	1
c	1
b	0
f	0
nc	1
nop	1
dl	0
loc	3
rs	10

<?php

namespace Icinga\Module\Trapdirector\Tables;


abstract class TrapDirectorTable
{
    /** @var array $titles table titles (name, display value) */
    protected $titles = null;

    /** @var array $content table content  (name, sb column name). name index must be the same as $titles*/
    protected $content = null;
    
    /** @var array $columnNames names of columns for filtering */
    protected $columnNames = array();
    
    /** @var mixed $dbConn connection to database  */
    protected $dbConn = null;
    
    /** Current view **/
    protected $view;
    
    protected $urlPath;
    
    // Database stuff
   /** @var array $table (db ref, name) */
    protected $table = array();
    
    /** @var mixed  $query Query in database; */
    protected $query = null;
    
    /** @var array $order : (db column, 'ASC' | 'DESC') */
    protected $order = array();
    protected $orderQuery = '';
    
    /********* Filter ********/
    /** @var string $filterString : string filter for db columns */
    protected $filterString = '';
    
    /** @var array $filterColumn : columns to apply filter to */
    protected $filterColumn = array();
    
    protected $filterQuery='';
    
    /*************** Paging *************/
    protected $maxPerPage = 25;
    
    protected $currentPage = 0;
    
    function __construct(array $table,array $titles, array $columns, array $columnNames, $dbConn , $view, $urlPath)
    {
        $this->table = $table;
        $this->titles = $titles;
        $this->content = $columns;
        $this->columnNames = $columnNames;
        $this->dbConn = $dbConn;
        
        $this->view = $view;
        $this->urlPath = $urlPath;
        
        return $this;
    }

    
    /************** GET variables and URLs *************/
    public function getParams(array $getVars)
    {
        $this->getFilterQuery($getVars);
        $this->getPagingQuery($getVars);
        $this->getOrderQuery($getVars);
    }
    
    public function getCurrentURL()
    {
        return '?';
    }
    
    protected function getCurrentURLAndQS(string $caller)
    {
        $actionURL = $this->getCurrentURL() . '?' ;
        $QSList=array();
        if ($caller != 'filter' && $this->curFilterQuery() != '')
            array_push($QSList , $this->curFilterQuery());
        
        if ($caller != 'paging' && $caller != 'filter' && $this->curPagingQuery() != '')
            array_push($QSList , $this->curPagingQuery());
 
        if ($caller != 'order' && $this->curOrderQuery() != '')
            array_push($QSList , $this->curOrderQuery());
        
        if (count($QSList) != 0)
            $actionURL .=  implode('&', $QSList);
        
        return $actionURL;
    }
    
    /************* DB queries ******************/
    /**
     * Get base query in $this->query
     * @return  TrapDirectorTable
     */
    public function getBaseQuery()
    {
        $this->query = $this->dbConn->select();
        $this->query = $this->query->from(
            $this->table,
            $this->content
            );
        
        return $this;
    }
    
    public function fullQuery()
    {
        $this->getBaseQuery()
        ->applyFilter()
        ->applyPaging()
        ->applyOrder();
        
        return $this->dbConn->fetchAll($this->query);
        //return $this->query->fetchAll();
    }
    
    
    /**************** Filtering ******************/
    
    public function applyFilter()
    {
        if ($this->filterString == '' || count($this->filterColumn) == 0)
        {
            return $this;
        }
        $filter='';
        foreach ($this->filterColumn as $column)
        {
            if ($filter != "") $filter.=' OR ';
            //$filter .= "'" . $column . "' LIKE '%" . $this->filterString. "%'";
            $filter .= $column  . " LIKE '%" . $this->filterString. "%'";
        }
        //echo $filter;
        
        $this->query=$this->query->where($filter);

        return $this;
    }

    public function setFilter(string $filter, array $filterCol)
    {
        $this->filterString = $filter;
        $this->filterColumn = $filterCol;
        return $this;
    }
   
    public function renderFilter()
    {
        
        $html=' <form id="genfilter" name="mainFilterGen"
			enctype="application/x-www-form-urlencoded"
			action="'.$this->getCurrentURLAndQS('filter').'"
			method="get">';
        $html.='<input type="text" name="f" title="Search is simple! Try to combine multiple words"
	placeholder="Search..."  value="'.$this->filterQuery.'">';

        $html.='</form>';
        return $html;
    }
 
    public function getFilterQuery(array $getVars)
    {
        if (isset($getVars['f']))
        {
            $this->filterQuery = $getVars['f'];
            $this->setFilter(html_entity_decode($getVars['f']), $this->columnNames);
        }
    }
    
    protected function curFilterQuery()
    {
        if ($this->filterQuery == '') return '';
        return 'f='.$this->filterQuery;
    }
    
    /***************** Ordering ********************/
    
    public function applyOrder()
    {
        if (count($this->order) == 0)
        {
            return $this;
        }
        $orderSQL='';
        foreach ($this->order as $column => $direction)
        {
            if ($orderSQL != "") $orderSQL.=',';
            
            $orderSQL .= $column . ' ' . $direction;
        }
        $this->query = $this->query->order($orderSQL);
        
        return $this;
    }
    
    public function setOrder(array $order)
    {
        $this->order = $order;
        return $this;
    }
    
    public function getOrderQuery(array $getVars)
    {
        if (isset($getVars['o']))
        {
            $this->orderQuery = $getVars['o'];
            $match = array();
            if (preg_match('/(.*)(ASC|DESC)$/', $this->orderQuery , $match))
            {
                $orderArray=array($match[1] => $match[2]);
                echo "$match[1] => $match[2]";
                $this->setOrder($orderArray);
            }
        }
    }
    
    protected function curOrderQuery()
    {
        if ($this->orderQuery == '') return '';
        return 'o='.$this->orderQuery;
    }
    
    /*****************  Paging and counting *********/
    
    public function countQuery()
    {
        $this->query = $this->dbConn->select();
        $this->query = $this->query
            ->from(
                $this->table,
                array('COUNT(*)')
                );
        $this->applyFilter();                   
    }
    
    public function count()
    {
        $this->countQuery();
        return $this->dbConn->fetchOne($this->query);
    }
    
    public function setMaxPerPage(int $max)
    {
        $this->maxPerPage = $max;
    }
    
    protected function getPagingQuery(array $getVars)
    {
        if (isset($getVars['page']))
        {
            $this->currentPage = $getVars['page'];
        }
    }

    protected function curPagingQuery()
    {
        if ($this->currentPage == '') return '';
        return 'page='.$this->currentPage;
    }
    
    public function renderPagingHeader()
    {
        $count = $this->count();
        if ($count <= $this->maxPerPage )
        {
            return  'count : ' . $this->count() . '<br>';
        }
        
        if ($this->currentPage == 0) $this->currentPage = 1;
        
        $numPages = intdiv($count , $this->maxPerPage);
        if ($count % $this->maxPerPage != 0 ) $numPages++;
        
        $html = '<div class="pagination-control" role="navigation">';
        $html .= '<ul class="nav tab-nav">';
        if ($this->currentPage <=1)
        {
            $html .= '
                <li class="nav-item disabled" aria-hidden="true">
                    <span class="previous-page">
                            <span class="sr-only">Previous page</span>
                            <i aria-hidden="true" class="icon-angle-double-left"></i>            
                     </span>
                </li>
               ';
        }
        else 
        {
            $html .= '
                <li class="nav-item">
                    <a href="'. $this->getCurrentURLAndQS('paging') .'&page='. ($this->currentPage - 1 ).'" class="previous-page" >
                            <i aria-hidden="true" class="icon-angle-double-left"></i>            
                     </a>
                </li>
            ';
        }
        
        for ($i=1; $i <= $numPages ; $i++)
        {
            $active = ($this->currentPage == $i) ? 'active' : '';
            $first = ($i-1)*$this->maxPerPage+1;
            $last = $i * $this->maxPerPage;
            if ($last > $count) $last = $count;
            $display = 'Show rows '. $first . ' to '. $last .' of '. $count;
            $html .= '<li class="' . $active . ' nav-item">
                    <a href="'. $this->getCurrentURLAndQS('paging') .'&page='. $i .'" title="' . $display . '" aria-label="' . $display . '">
                    '.$i.'                
                    </a>
                </li>';
        }
        
        if ($this->currentPage == $numPages)
        {
            $html .= '
                <li class="nav-item disabled" aria-hidden="true">
                    <span class="previous-page">
                            <span class="sr-only">Previous page</span>
                            <i aria-hidden="true" class="icon-angle-double-right"></i>
                     </span>
                </li>
               ';
        }
        else
        {
            $html .= '
                <li class="nav-item">
                    <a href="'. $this->getCurrentURLAndQS('paging') .'&page='. ($this->currentPage + 1 ).'" class="next-page">
                            <i aria-hidden="true" class="icon-angle-double-right"></i>
                     </a>
                </li>
            ';
        }
        
        $html .= '</ul> </div>';
        
        return $html;
    }
    
    public function applyPaging()
    {
        $this->query->limitPage($this->currentPage,$this->maxPerPage);
        return $this;
    }
    
    /*************** Rendering *************************/
    
    public function titleOrder($name)
    {
        return $this->content[$name];
    }
    
    public function renderTitles()
    {
        $html = "<thead>\n<tr>\n";
        foreach ($this->titles as $name => $values)
        {
            $titleOrder = $this->titleOrder($name);
            if ($titleOrder != NULL)
            {
                if (isset($this->order[$titleOrder]))
                {
                    if ($this->order[$titleOrder] == 'ASC')
                    {
                        $titleOrder.='DESC';
                    }
                    else
                    {
                        $titleOrder.='ASC';
                    }
                }
                else 
                {
                    $titleOrder.='ASC';
                }
                $actionURL = $this->getCurrentURLAndQS('order').'o='.$titleOrder;
                $html .= '<th><a href="'.$actionURL.'">' . $values . '</a></th>';
            }
            else 
            {
                $html .= '<th>' . $values . '</th>';
            }          
        }
        $html .= "</tr>\n</thead>\n";
        return $html;
    }
    
    public function renderLine( $value)
    {
        $html = '';
        $titleNames = array_keys($this->titles);
        foreach ($titleNames as $name )
        {
            $html .= '<td>';
            $html .= $value->$name;
            $html .= "</td>\n";
        }
        return $html;
    }
    
    public function renderTable(array $values)
    {
       $html = '<tbody id="obj_table_body">';
       foreach($values as $value)
       {
           $html .= "<tr>\n";
           $html .= $this->renderLine($value);
           $html .= "</tr>\n";
       }
       $html .= '</tbody>';
       return $html;
    }
    
    public function render()
    {
        $html = '';
        
        
        $values = $this->fullQuery();
        
        $html.="<table class='simple common-table table-row-selectable'>\n";
        
        $html .= $this->renderTitles();
        $html .= $this->renderTable($values);
        $html .= '</table>'; 
        

        return $html;
    }
    
}

1			<?php
2
3			namespace Icinga\Module\Trapdirector\Tables;
4
5
6			abstract class TrapDirectorTable
7			{
8			/** @var array $titles table titles (name, display value) */
9			protected $titles = null;
10
11			/** @var array $content table content (name, sb column name). name index must be the same as $titles*/
12			protected $content = null;
13
14			/** @var array $columnNames names of columns for filtering */
15			protected $columnNames = array();
16
17			/** @var mixed $dbConn connection to database */
18			protected $dbConn = null;
19
20			/ Current view /
21			protected $view;
22
23			protected $urlPath;
24
25			// Database stuff
26			/** @var array $table (db ref, name) */
27			protected $table = array();
28
29			/** @var mixed $query Query in database; */
30			protected $query = null;
31
32			/** @var array $order : (db column, 'ASC' \| 'DESC') */
33			protected $order = array();
34			protected $orderQuery = '';
35
36			/******* Filter ******/
37			/** @var string $filterString : string filter for db columns */
38			protected $filterString = '';
39
40			/** @var array $filterColumn : columns to apply filter to */
41			protected $filterColumn = array();
42
43			protected $filterQuery='';
44
45			/************* Paging ***********/
46			protected $maxPerPage = 25;
47
48			protected $currentPage = 0;
49
50			function __construct(array $table,array $titles, array $columns, array $columnNames, $dbConn , $view, $urlPath)
51			{
52			$this->table = $table;
53			$this->titles = $titles;
54			$this->content = $columns;
55			$this->columnNames = $columnNames;
56			$this->dbConn = $dbConn;
57
58			$this->view = $view;
59			$this->urlPath = $urlPath;
60
61			return $this;
62			}
63
64
65			/************ GET variables and URLs ***********/
66			public function getParams(array $getVars)
67			{
68			$this->getFilterQuery($getVars);
69			$this->getPagingQuery($getVars);
70			$this->getOrderQuery($getVars);
71			}
72
73			public function getCurrentURL()
74			{
75			return '?';
76			}
77
78			protected function getCurrentURLAndQS(string $caller)
79			{
80			$actionURL = $this->getCurrentURL() . '?' ;
81			$QSList=array();
82			if ($caller != 'filter' && $this->curFilterQuery() != '')
83			array_push($QSList , $this->curFilterQuery());
84
85			if ($caller != 'paging' && $caller != 'filter' && $this->curPagingQuery() != '')
86			array_push($QSList , $this->curPagingQuery());
87
88			if ($caller != 'order' && $this->curOrderQuery() != '')
89			array_push($QSList , $this->curOrderQuery());
90
91			if (count($QSList) != 0)
92			$actionURL .= implode('&', $QSList);
93
94			return $actionURL;
95			}
96
97			/*********** DB queries ****************/
98			/**
99			* Get base query in $this->query
100			* @return TrapDirectorTable
101			*/
102			public function getBaseQuery()
103			{
104			$this->query = $this->dbConn->select();
105			$this->query = $this->query->from(
106			$this->table,
107			$this->content
108			);
109
110			return $this;
111			}
112
113			public function fullQuery()
114			{
115			$this->getBaseQuery()
116			->applyFilter()
117			->applyPaging()
118			->applyOrder();
119
120			return $this->dbConn->fetchAll($this->query);
121			//return $this->query->fetchAll();
122			}
123
124
125			/************** Filtering ****************/
126
127			public function applyFilter()
128			{
129			if ($this->filterString == '' \|\| count($this->filterColumn) == 0)
130			{
131			return $this;
132			}
133			$filter='';
134			foreach ($this->filterColumn as $column)
135			{
136			if ($filter != "") $filter.=' OR ';
137			//$filter .= "'" . $column . "' LIKE '%" . $this->filterString. "%'";
138			$filter .= $column . " LIKE '%" . $this->filterString. "%'";
139			}
140			//echo $filter;
141
142			$this->query=$this->query->where($filter);
143
144			return $this;
145			}
146
147			public function setFilter(string $filter, array $filterCol)
148			{
149			$this->filterString = $filter;
150			$this->filterColumn = $filterCol;
151			return $this;
152			}
153
154			public function renderFilter()
155			{
156
157			$html=' <form id="genfilter" name="mainFilterGen"
158			enctype="application/x-www-form-urlencoded"
159			action="'.$this->getCurrentURLAndQS('filter').'"
160			method="get">';
161			$html.='<input type="text" name="f" title="Search is simple! Try to combine multiple words"
162			placeholder="Search..." value="'.$this->filterQuery.'">';
163
164			$html.='</form>';
165			return $html;
166			}
167
168			public function getFilterQuery(array $getVars)
169			{
170			if (isset($getVars['f']))
171			{
172			$this->filterQuery = $getVars['f'];
173			$this->setFilter(html_entity_decode($getVars['f']), $this->columnNames);
174			}
175			}
176
177			protected function curFilterQuery()
178			{
179			if ($this->filterQuery == '') return '';
180			return 'f='.$this->filterQuery;
181			}
182
183			/*************** Ordering ******************/
184
185			public function applyOrder()
186			{
187			if (count($this->order) == 0)
188			{
189			return $this;
190			}
191			$orderSQL='';
192			foreach ($this->order as $column => $direction)
193			{
194			if ($orderSQL != "") $orderSQL.=',';
195
196			$orderSQL .= $column . ' ' . $direction;
197			}
198			$this->query = $this->query->order($orderSQL);
199
200			return $this;
201			}
202
203			public function setOrder(array $order)
204			{
205			$this->order = $order;
206			return $this;
207			}
208
209			public function getOrderQuery(array $getVars)
210			{
211			if (isset($getVars['o']))
212			{
213			$this->orderQuery = $getVars['o'];
214			$match = array();
215			if (preg_match('/(.*)(ASC\|DESC)$/', $this->orderQuery , $match))
216			{
217			$orderArray=array($match[1] => $match[2]);
218			echo "$match[1] => $match[2]";
219			$this->setOrder($orderArray);
220			}
221			}
222			}
223
224			protected function curOrderQuery()
225			{
226			if ($this->orderQuery == '') return '';
227			return 'o='.$this->orderQuery;
228			}
229
230			/*************** Paging and counting *******/
231
232			public function countQuery()
233			{
234			$this->query = $this->dbConn->select();
235			$this->query = $this->query
236			->from(
237			$this->table,
238			array('COUNT(*)')
239			);
240			$this->applyFilter();
241			}
242
243			public function count()
244			{
245			$this->countQuery();
246			return $this->dbConn->fetchOne($this->query);
247			}
248
249			public function setMaxPerPage(int $max)
250			{
251			$this->maxPerPage = $max;
252			}
253
254			protected function getPagingQuery(array $getVars)
255			{
256			if (isset($getVars['page']))
257			{
258			$this->currentPage = $getVars['page'];
259			}
260			}
261
262			protected function curPagingQuery()
263			{
264			if ($this->currentPage == '') return '';
265			return 'page='.$this->currentPage;
266			}
267
268			public function renderPagingHeader()
269			{
270			$count = $this->count();
271			if ($count <= $this->maxPerPage )
272			{
273			return 'count : ' . $this->count() . '<br>';
274			}
275
276			if ($this->currentPage == 0) $this->currentPage = 1;
277
278			$numPages = intdiv($count , $this->maxPerPage);
279			if ($count % $this->maxPerPage != 0 ) $numPages++;
280
281			$html = '<div class="pagination-control" role="navigation">';
282			$html .= '<ul class="nav tab-nav">';
283			if ($this->currentPage <=1)
284			{
285			$html .= '
286			<li class="nav-item disabled" aria-hidden="true">
287			<span class="previous-page">
288			<span class="sr-only">Previous page</span>
289			<i aria-hidden="true" class="icon-angle-double-left"></i>
290			</span>
291			</li>
292			';
293			}
294			else
295			{
296			$html .= '
297			<li class="nav-item">
298			<a href="'. $this->getCurrentURLAndQS('paging') .'&page='. ($this->currentPage - 1 ).'" class="previous-page" >
299			<i aria-hidden="true" class="icon-angle-double-left"></i>
300			</a>
301			</li>
302			';
303			}
304
305			for ($i=1; $i <= $numPages ; $i++)
306			{
307			$active = ($this->currentPage == $i) ? 'active' : '';
308			$first = ($i-1)*$this->maxPerPage+1;
309			$last = $i * $this->maxPerPage;
310			if ($last > $count) $last = $count;
311			$display = 'Show rows '. $first . ' to '. $last .' of '. $count;
312			$html .= '<li class="' . $active . ' nav-item">
313			<a href="'. $this->getCurrentURLAndQS('paging') .'&page='. $i .'" title="' . $display . '" aria-label="' . $display . '">
314			'.$i.'
315			</a>
316			</li>';
317			}
318
319			if ($this->currentPage == $numPages)
320			{
321			$html .= '
322			<li class="nav-item disabled" aria-hidden="true">
323			<span class="previous-page">
324			<span class="sr-only">Previous page</span>
325			<i aria-hidden="true" class="icon-angle-double-right"></i>
326			</span>
327			</li>
328			';
329			}
330			else
331			{
332			$html .= '
333			<li class="nav-item">
334			<a href="'. $this->getCurrentURLAndQS('paging') .'&page='. ($this->currentPage + 1 ).'" class="next-page">
335			<i aria-hidden="true" class="icon-angle-double-right"></i>
336			</a>
337			</li>
338			';
339			}
340
341			$html .= '</ul> </div>';
342
343			return $html;
344			}
345
346			public function applyPaging()
347			{
348			$this->query->limitPage($this->currentPage,$this->maxPerPage);
349			return $this;
350			}
351
352			/************* Rendering ***********************/
353
354			public function titleOrder($name)
355			{
356			return $this->content[$name];
357			}
358
359			public function renderTitles()
360			{
361			$html = "<thead>\n<tr>\n";
362			foreach ($this->titles as $name => $values)
363			{
364			$titleOrder = $this->titleOrder($name);
365			if ($titleOrder != NULL)
366			{
367			if (isset($this->order[$titleOrder]))
368			{
369			if ($this->order[$titleOrder] == 'ASC')
370			{
371			$titleOrder.='DESC';
372			}
373			else
374			{
375			$titleOrder.='ASC';
376			}
377			}
378			else
379			{
380			$titleOrder.='ASC';
381			}
382			$actionURL = $this->getCurrentURLAndQS('order').'o='.$titleOrder;
383			$html .= '<th><a href="'.$actionURL.'">' . $values . '</a></th>';
384			}
385			else
386			{
387			$html .= '<th>' . $values . '</th>';
388			}
389			}
390			$html .= "</tr>\n</thead>\n";
391			return $html;
392			}
393
394			public function renderLine( $value)
395			{
396			$html = '';
397			$titleNames = array_keys($this->titles);
398			foreach ($titleNames as $name )
399			{
400			$html .= '<td>';
401			$html .= $value->$name;
402			$html .= "</td>\n";
403			}
404			return $html;
405			}
406
407			public function renderTable(array $values)
408			{
409			$html = '<tbody id="obj_table_body">';
410			foreach($values as $value)
411			{
412			$html .= "<tr>\n";
413			$html .= $this->renderLine($value);
414			$html .= "</tr>\n";
415			}
416			$html .= '</tbody>';
417			return $html;
418			}
419
420			public function render()
421			{
422			$html = '';
423
424
425			$values = $this->fullQuery();
426
427			$html.="<table class='simple common-table table-row-selectable'>\n";
428
429			$html .= $this->renderTitles();
430			$html .= $this->renderTable($values);
431			$html .= '</table>';
432
433
434			return $html;
435			}
436
437			}

patrickpr / trapdirector

Push — master ( 395129...4a18b4 )

TrapDirectorTable::titleOrder() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like