Ctable::setHeaders() - Code Metrics - Inspection of "add scrutiniser link" - Vesihiisi/CTable - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Branch — master (d7f510)

by Alicia

created 2016-02-17 14:58 UTC

Ctable::setHeaders() A

↳ Parent: Ctable

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	4
ccs	3
cts	3
cp	1
rs	10
cc	1
eloc	2
nc	1
nop	1
crap	1

<?php

/**
 * Class that generates a table in HTML from array data.
 *
 * @author Alicia Fagerving <[email protected]>
 */

namespace Vesihiisi\Ctable;

class Ctable
{
    private $headers;
    private $footers;
    private $rows;
    private $caption;
    private $class;
    private $id;

    /**
     * Output an html representation of a table row.
     * 
     * @param  array $row the values that are supposed to be in the row
     * @return string $html      the html code representing the row
     */
    private function generateTableRow($row)
    {
        $html = '';
        $html .= "<tr>";
        foreach ($row as $rowItem) {
            $html .= "<td>$rowItem</td>";
        }
        $html .= "</tr>";
        return $html;
    }

    /**
     * Output an html representation of a table header.
     * 
     * @param  array $headers the values that are supposed to be in the header row
     * @return string $html          the html code representing the header
     */
    private function generateTableHead($headers)
    {
        $html = '';
        $html .= "<thead>";
        $html .= $this->generateTableRow($headers);
        $html .= "</thead>";
        return $html;
    }

    /**
     * Output an html representation of a table footer.
     * @param  array $footers the values that are supposed to be in the footer row
     * @return string $html          the html code representing the footer
     */
    private function generateTableFoot($footers)
    {
        $html = "";
        $html .= "<tfoot>";
        $html .= $this->generateTableRow($footers);
        $html .= "</tfoot>";
        return $html;
    }

    /**
     * Output an html representation of a table body,
     * contained within <tbody> tags and containing a number
     * of rows.
     * @param  array $rows the rows that are supposed to be contained by the table body
     * @return string $html the html code representing the table body
     */
    private function generateTableBody($rows)
    {
        $html = '';
        $html .= '<tbody>';
        foreach ($rows as $row) {
            $html .= $this->generateTableRow($row);
        }
        $html .= '</tbody>';
        return $html;
    }

    /**
     * Output an html representation
     * of a table caption.
     * @param  string $text the string that is supposed to be the table caption
     * @return string       the html code representing the table caption
     */
    private function generateTableCaption($text)
    {
        return "<caption>$text</caption>";
    }

    /**
     * Output the opening <table> tag to initate a table.
     * It can look in different ways depending on whether there are any
     * class or id attributes.
     * @return string the html code representing the opening <table> tag
     */
    private function openTable()
    {
        $addons = array();
        if (count($this->class) == 0 && empty($this->id)) {
            return "<table>";
        }
        if (count($this->class) > 0) {
            $classes = implode(" ", $this->class);
            $addons[] = "class = '$classes'";
        }
        if (!empty($this->id) && strlen($this->id) > 0) {
            $id = $this->id;
            $addons[] = "id = '$id'";
        }
        $addonsString = implode(" ", $addons);
        return "<table $addonsString>";
    }

    /**
     * Output the html code that represents a table
     * consisting of a body and a header as well as, optionally, a footer and/or
     * a caption.
     * @return string $html the html representation of a table
     */
    private function generateTable()
    {
        $html = '';
        $html .= $this->openTable();
        if ($this->caption != null) {
            $html .= $this->generateTableCaption($this->caption);
        }
        $html .= $this->generateTableHead($this->headers);
        $html .= $this->generateTableBody($this->rows);
        if (!empty($this->footers) && count($this->footers) > 0) {
            $html .= $this->generateTableFoot($this->footers);
        }
        $html .= "</table>";
        return $html;
    }

    /**
     * Initiate the object and save the data as inside parameters of the class.
     * @param array $data the array containing the data that are needed
     * to create the table
     */
    public function __construct($data)
    {
        $this->setRows($data['rows']);
        if (!empty($data['headers'])) {
            $this->setHeaders($data['headers']);
        } else {
            $this->setHeaders($data['rows'][0]);
            array_shift($this->rows);
        }
        if (!empty($data['footers'])) {
            $this->setFooters($data['footers']);
        }
        if (!empty($data['caption'])) {
            $this->caption = $data['caption'];
        }
        if (!empty($data['class'])) {
            $this->setClass($data['class']);
        }
        if (!empty($data['id'])) {
            $this->setId($data['id']);
        }
        if (!empty($data['caption'])) {
            $this->setCaption($data['caption']);
        }
    }

    /**
     * Save an array with rows as a property of the class.
     * @param array $array an array containing rows
     */
    public function setRows($array)
    {
        $this->rows = $array;
    }

    /**
     * Save an array with headers as a property of the class.
     * @param array $array an array containing table headers
     */
    public function setHeaders($array)
    {
        $this->headers = $array;
    }

    /**
     * Save an array with footers as a property of the class.
     * @param array $array an array containing table footers
     */
    public function setFooters($array)
    {
        $this->footers = $array;
    }

    /**
     * Save a table caption as a property of the class.
     * @param string $string a value that is supposed to be used as the table caption
     */
    public function setCaption($string)
    {
        $this->caption = $string;
    }

    /**
     * Save some CSS classes that are supposed to be assigned to the table
     * as a property of the class.
     * @param array $array an array that is a list of CSS classes
     */
    public function setClass($array)
    {
        $this->class = $array;
    }

    /**
     * Save a CSS id that is supposed to be assigned to the table
     * as a property of the class.
     * @param string $text a CSS id that is supposed to be assigned
     */
    public function setId($text)
    {
        $this->id = $text;
    }

    /**
     * Add one row of data to the existing array of
     * rows of data that is a property of the class.
     * @param array $data a row of data values
     */
    public function addRow($data)
    {
        $this->rows[] = $data;
    }

    /**
     * Tell me how many rows of data this table has.
     * @return integer a number representing how many rows of data this table has
     */
    public function getNumberOfRows()
    {
        return count($this->rows);
    }

    /**
     * Output the generated html table.
     * @return string complete HTML code representing a table
     */
    public function View()
    {
        return $this->generateTable();
    }
}


1		<?php
2
3		/**
4		* Class that generates a table in HTML from array data.
5		*
6		* @author Alicia Fagerving <[email protected]>
7		*/
8
9		namespace Vesihiisi\Ctable;
10
11		class Ctable
12		{
13		private $headers;
14		private $footers;
15		private $rows;
16		private $caption;
17		private $class;
18		private $id;
19
20		/**
21		* Output an html representation of a table row.
22		*
23		* @param array $row the values that are supposed to be in the row
24		* @return string $html the html code representing the row
25		*/
26		private function generateTableRow($row)
27		{
28		$html = '';
29		$html .= "<tr>";
30		foreach ($row as $rowItem) {
31		$html .= "<td>$rowItem</td>";
32		}
33		$html .= "</tr>";
34		return $html;
35		}
36
37		/**
38		* Output an html representation of a table header.
39		*
40		* @param array $headers the values that are supposed to be in the header row
41		* @return string $html the html code representing the header
42		*/
43	8	private function generateTableHead($headers)
44		{
45	8	$html = '';
46	8	$html .= "<thead>";
47		$html .= $this->generateTableRow($headers);
48	8	$html .= "</thead>";
49	8	return $html;
50		}
51
52		/**
53		* Output an html representation of a table footer.
54		* @param array $footers the values that are supposed to be in the footer row
55		* @return string $html the html code representing the footer
56		*/
57	1	private function generateTableFoot($footers)
58		{
59	1	$html = "";
60	1	$html .= "<tfoot>";
61		$html .= $this->generateTableRow($footers);
62	1	$html .= "</tfoot>";
63	1	return $html;
64		}
65
66		/**
67		* Output an html representation of a table body,
68		* contained within <tbody> tags and containing a number
69		* of rows.
70		* @param array $rows the rows that are supposed to be contained by the table body
71		* @return string $html the html code representing the table body
72		*/
73	8	private function generateTableBody($rows)
74		{
75	8	$html = '';
76	8	$html .= '<tbody>';
77		foreach ($rows as $row) {
78		$html .= $this->generateTableRow($row);
79		}
80	8	$html .= '</tbody>';
81	8	return $html;
82		}
83
84		/**
85		* Output an html representation
86		* of a table caption.
87		* @param string $text the string that is supposed to be the table caption
88		* @return string the html code representing the table caption
89		*/
90	1	private function generateTableCaption($text)
91		{
92	1	return "<caption>$text</caption>";
93		}
94
95		/**
96		* Output the opening <table> tag to initate a table.
97		* It can look in different ways depending on whether there are any
98		* class or id attributes.
99		* @return string the html code representing the opening <table> tag
100		*/
101	8	private function openTable()
102		{
103	8	$addons = array();
104		if (count($this->class) == 0 && empty($this->id)) {
105	5	return "<table>";
106		}
107		if (count($this->class) > 0) {
108		$classes = implode(" ", $this->class);
109	2	$addons[] = "class = '$classes'";
110		}
111	1	if (!empty($this->id) && strlen($this->id) > 0) {
112	2	$id = $this->id;
113	2	$addons[] = "id = '$id'";
114		}
115		$addonsString = implode(" ", $addons);
116	3	return "<table $addonsString>";
117		}
118
119		/**
120		* Output the html code that represents a table
121		* consisting of a body and a header as well as, optionally, a footer and/or
122		* a caption.
123		* @return string $html the html representation of a table
124		*/
125	8	private function generateTable()
126		{
127	8	$html = '';
128		$html .= $this->openTable();
129	8	if ($this->caption != null) {
130		$html .= $this->generateTableCaption($this->caption);
131		}
132		$html .= $this->generateTableHead($this->headers);
133		$html .= $this->generateTableBody($this->rows);
134	7	if (!empty($this->footers) && count($this->footers) > 0) {
135		$html .= $this->generateTableFoot($this->footers);
136		}
137	8	$html .= "</table>";
138	8	return $html;
139		}
140
141		/**
142		* Initiate the object and save the data as inside parameters of the class.
143		* @param array $data the array containing the data that are needed
144		* to create the table
145		*/
146	9	public function __construct($data)
147		{
148		$this->setRows($data['rows']);
149	9	if (!empty($data['headers'])) {
150		$this->setHeaders($data['headers']);
151		} else {
152		$this->setHeaders($data['rows'][0]);
153		array_shift($this->rows);
154	8	}
155	9	if (!empty($data['footers'])) {
156		$this->setFooters($data['footers']);
157		}
158	9	if (!empty($data['caption'])) {
159	1	$this->caption = $data['caption'];
160		}
161	9	if (!empty($data['class'])) {
162		$this->setClass($data['class']);
163		}
164	9	if (!empty($data['id'])) {
165		$this->setId($data['id']);
166		}
167	9	if (!empty($data['caption'])) {
168		$this->setCaption($data['caption']);
169		}
170	9	}
171
172		/**
173		* Save an array with rows as a property of the class.
174		* @param array $array an array containing rows
175		*/
176	9	public function setRows($array)
177		{
178	9	$this->rows = $array;
179	9	}
180
181		/**
182		* Save an array with headers as a property of the class.
183		* @param array $array an array containing table headers
184		*/
185	9	public function setHeaders($array)
186		{
187	9	$this->headers = $array;
188	9	}
189
190		/**
191		* Save an array with footers as a property of the class.
192		* @param array $array an array containing table footers
193		*/
194	1	public function setFooters($array)
195		{
196	1	$this->footers = $array;
197	1	}
198
199		/**
200		* Save a table caption as a property of the class.
201		* @param string $string a value that is supposed to be used as the table caption
202		*/
203	1	public function setCaption($string)
204		{
205	1	$this->caption = $string;
206	1	}
207
208		/**
209		* Save some CSS classes that are supposed to be assigned to the table
210		* as a property of the class.
211		* @param array $array an array that is a list of CSS classes
212		*/
213	2	public function setClass($array)
214		{
215	2	$this->class = $array;
216	2	}
217
218		/**
219		* Save a CSS id that is supposed to be assigned to the table
220		* as a property of the class.
221		* @param string $text a CSS id that is supposed to be assigned
222		*/
223	2	public function setId($text)
224		{
225	2	$this->id = $text;
226	2	}
227
228		/**
229		* Add one row of data to the existing array of
230		* rows of data that is a property of the class.
231		* @param array $data a row of data values
232		*/
233	1	public function addRow($data)
234		{
235	1	$this->rows[] = $data;
236	1	}
237
238		/**
239		* Tell me how many rows of data this table has.
240		* @return integer a number representing how many rows of data this table has
241		*/
242		public function getNumberOfRows()
243		{
244		return count($this->rows);
245		}
246
247		/**
248		* Output the generated html table.
249		* @return string complete HTML code representing a table
250		*/
251		public function View()
252		{
253		return $this->generateTable();
254		}
255		}
256

Vesihiisi / CTable

Branch — master (d7f510)

Ctable::setHeaders() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like