GunnarEriksson / chtmltable

webroot/not-specified-table.php

Spacing +1 added lines, -1 removed lines

@@ -41,7 +41,7 @@
 	],
 ];
 
-$table = $table->create([], $data, []);
+$table = $table->create([ ], $data, [ ]);
 
 ?>
 

webroot/table-anax-mvc.php

Spacing +3 added lines, -3 removed lines

@@ -18,7 +18,7 @@ 
  */
 
  // Get environment & autoloader.
- require __DIR__.'/config.php';
+ require __DIR__ . '/config.php';
 
  // Create services and inject into the app.
  $di  = new \Anax\DI\CDIFactoryDefault();
@@ -74,13 +74,13 @@ 
          'column4' => [
              'title'    => 'Table Header 4',
              'function'	=> function($link) {
-                 return '<a href="'. $link . '">' . "Google" . '</a>';
+                 return '<a href="' . $link . '">' . "Google" . '</a>';
              }
          ],
          'column6' => [
              'title'    => 'Table Header 6',
              'function' => function($isPresent) {
-                 return empty($isPresent) ? 'Not present' :  'Present';
+                 return empty($isPresent) ? 'Not present' : 'Present';
         	}
          ],
          'tablefoot1' => [

Indentation +87 added lines, -87 removed lines

@@ -39,93 +39,93 @@
 
  // Home route
  $app->router->add('', function() use ($app) {
-     $app->theme->addStylesheet('css/html-table.css');
-     $app->theme->setTitle("Using CHTMLTable in ANAX-MVC");
-
-     // Create data objects.
-     $row0 = new stdClass();
-     $row0->column1 = "Table Cell 1";
-     $row0->column2 = "Table Cell 2";
-     $row0->column3 = "Table Cell 3";
-     $row0->column4 = "https://www.google.se";
-     $row0->column5 = "Table Cell 5";
-     $row0->column6 = "Table Cell 6";
-
-     $row1 = new stdClass();
-     $row1->column1 = "Table Cell 7";
-     $row1->column2 = "Table Cell 8";
-     $row1->column3 = "Table Cell 9";
-     $row1->column4 = "https://www.google.se";
-     $row1->column5 = "Table Cell 11";
-     $row1->column6 = "";
-
-     $row2 = new stdClass();
-     $row2->column1 = "Table Cell 13";
-     $row2->column2 = "Table Cell 14";
-     $row2->column3 = "Table Cell 15";
-     $row2->column4 = "https://www.google.se";
-     $row2->column5 = "Table Cell 17";
-     $row2->column6 = "Table Cell 18";
-
-     // Create table data, which is an array of data objects.
-     $data = [
-     	0 => $row0,
-     	1 => $row1,
-     	2 => $row2,
-     ];
-
-     // Create table specifiation.
-     $tableSpecification = [
-     	//'id'        => 'test-table',
-     	//'class'	  => 'test-table',
-     	'caption'	=> 'The table'
-     ];
-
-     $table = new \Guer\HTMLTable\CHTMLTable();
-
-     // Create table with table specification, table data and the column
-     // specification.
-     $table = $table->create($tableSpecification, $data, [
-         'column1' => [
-             'title' => 'Table Header 1',
-         ],
-         'object1' => [
-     		'title'     => 'Table Header 2',
-     		'function'	=> function($object) {
-     			return $object->column2;
-     		}
-         ],
-         'column4' => [
-             'title'    => 'Table Header 4',
-             'function'	=> function($link) {
-                 return '<a href="'. $link . '">' . "Google" . '</a>';
-             }
-         ],
-         'column6' => [
-             'title'    => 'Table Header 6',
-             'function' => function($isPresent) {
-                 return empty($isPresent) ? 'Not present' :  'Present';
-        	}
-         ],
-         'tablefoot1' => [
-             'type'     => 'footer',
-             'colspan'  => '2',
-             'value'	=> 'Footer Cell 1',
-         ],
-         'tablefoot2' => [
-             'type'      => 'footer',
-             'colspan'    => 2,
-             'function'   => function() {
-                 return '<a href="https://www.google.se">Link</a>';
-        	}
-         ],
-     ]);
-
-
-     $app->views->add('default/page', [
-         'title'        => "Example on using specified HTML table with CHTMLTable",
-         'content'      => $table->getHTMLTable(),
-     ]);
+	 $app->theme->addStylesheet('css/html-table.css');
+	 $app->theme->setTitle("Using CHTMLTable in ANAX-MVC");
+
+	 // Create data objects.
+	 $row0 = new stdClass();
+	 $row0->column1 = "Table Cell 1";
+	 $row0->column2 = "Table Cell 2";
+	 $row0->column3 = "Table Cell 3";
+	 $row0->column4 = "https://www.google.se";
+	 $row0->column5 = "Table Cell 5";
+	 $row0->column6 = "Table Cell 6";
+
+	 $row1 = new stdClass();
+	 $row1->column1 = "Table Cell 7";
+	 $row1->column2 = "Table Cell 8";
+	 $row1->column3 = "Table Cell 9";
+	 $row1->column4 = "https://www.google.se";
+	 $row1->column5 = "Table Cell 11";
+	 $row1->column6 = "";
+
+	 $row2 = new stdClass();
+	 $row2->column1 = "Table Cell 13";
+	 $row2->column2 = "Table Cell 14";
+	 $row2->column3 = "Table Cell 15";
+	 $row2->column4 = "https://www.google.se";
+	 $row2->column5 = "Table Cell 17";
+	 $row2->column6 = "Table Cell 18";
+
+	 // Create table data, which is an array of data objects.
+	 $data = [
+	 	0 => $row0,
+	 	1 => $row1,
+	 	2 => $row2,
+	 ];
+
+	 // Create table specifiation.
+	 $tableSpecification = [
+	 	//'id'        => 'test-table',
+	 	//'class'	  => 'test-table',
+	 	'caption'	=> 'The table'
+	 ];
+
+	 $table = new \Guer\HTMLTable\CHTMLTable();
+
+	 // Create table with table specification, table data and the column
+	 // specification.
+	 $table = $table->create($tableSpecification, $data, [
+		 'column1' => [
+			 'title' => 'Table Header 1',
+		 ],
+		 'object1' => [
+	 		'title'     => 'Table Header 2',
+	 		'function'	=> function($object) {
+	 			return $object->column2;
+	 		}
+		 ],
+		 'column4' => [
+			 'title'    => 'Table Header 4',
+			 'function'	=> function($link) {
+				 return '<a href="'. $link . '">' . "Google" . '</a>';
+			 }
+		 ],
+		 'column6' => [
+			 'title'    => 'Table Header 6',
+			 'function' => function($isPresent) {
+				 return empty($isPresent) ? 'Not present' :  'Present';
+			}
+		 ],
+		 'tablefoot1' => [
+			 'type'     => 'footer',
+			 'colspan'  => '2',
+			 'value'	=> 'Footer Cell 1',
+		 ],
+		 'tablefoot2' => [
+			 'type'      => 'footer',
+			 'colspan'    => 2,
+			 'function'   => function() {
+				 return '<a href="https://www.google.se">Link</a>';
+			}
+		 ],
+	 ]);
+
+
+	 $app->views->add('default/page', [
+		 'title'        => "Example on using specified HTML table with CHTMLTable",
+		 'content'      => $table->getHTMLTable(),
+	 ]);
  });
 
 

webroot/specified-table.php

Indentation +14 added lines, -14 removed lines

@@ -55,34 +55,34 @@
 
 $table = $table->create($tableSpecification, $data, [
 	'column1' => [
-        'title' => 'Table Header 1',
-    ],
+		'title' => 'Table Header 1',
+	],
 	'column2' => [
-    ],
-    'column4' => [
-        'title'     => 'Table Header 4',
+	],
+	'column4' => [
+		'title'     => 'Table Header 4',
 		'function'	=> function($link) {
 			return '<a href="'. $link . '">' . "Google" . '</a>';
 		}
-    ],
+	],
 	'column6' => [
-        'title'    	=> 'Table Header 6',
+		'title'    	=> 'Table Header 6',
 		'function' 	=> function($tableCell6) {
-        	return empty($tableCell6) ? 'Not present' :  'Present';
+			return empty($tableCell6) ? 'Not present' :  'Present';
    		}
-    ],
+	],
 	'tablefoot1' => [
-        'type'      => 'footer',
+		'type'      => 'footer',
 		'colspan'  	=> '2',
 		'value'		=> 'Footer Cell 1',
-    ],
+	],
 	'tablefoot2' => [
-        'type'      => 'footer',
+		'type'      => 'footer',
 		'colspan'  	=> 2,
 		'function'	=> function() {
-        	return '<a href="https://www.google.se">Link</a>';
+			return '<a href="https://www.google.se">Link</a>';
    		}
-    ],
+	],
 ]);
 
 ?>

Spacing +2 added lines, -2 removed lines

@@ -62,13 +62,13 @@
     'column4' => [
         'title'     => 'Table Header 4',
 		'function'	=> function($link) {
-			return '<a href="'. $link . '">' . "Google" . '</a>';
+			return '<a href="' . $link . '">' . "Google" . '</a>';
 		}
     ],
 	'column6' => [
         'title'    	=> 'Table Header 6',
 		'function' 	=> function($tableCell6) {
-        	return empty($tableCell6) ? 'Not present' :  'Present';
+        	return empty($tableCell6) ? 'Not present' : 'Present';
    		}
     ],
 	'tablefoot1' => [

autoloader.php

Indentation +23 added lines, -23 removed lines

@@ -12,33 +12,33 @@
  * @return void
  */
 spl_autoload_register(
-    function ($class) {
+	function ($class) {
 
-        // project-specific namespace prefix
-        //$prefix = 'Foo\\Bar\\';
-        $prefix = 'Guer\\';
+		// project-specific namespace prefix
+		//$prefix = 'Foo\\Bar\\';
+		$prefix = 'Guer\\';
 
-        // base directory for the namespace prefix
-        $base_dir = __DIR__ . '/src/';
+		// base directory for the namespace prefix
+		$base_dir = __DIR__ . '/src/';
 
-        // does the class use the namespace prefix?
-        $len = strlen($prefix);
-        if (strncmp($prefix, $class, $len) !== 0) {
-            // no, move to the next registered autoloader
-            return;
-        }
+		// does the class use the namespace prefix?
+		$len = strlen($prefix);
+		if (strncmp($prefix, $class, $len) !== 0) {
+			// no, move to the next registered autoloader
+			return;
+		}
 
-        // get the relative class name
-        $relative_class = substr($class, $len);
+		// get the relative class name
+		$relative_class = substr($class, $len);
 
-        // replace the namespace prefix with the base directory, replace namespace
-        // separators with directory separators in the relative class name, append
-        // with .php
-        $file = $base_dir . str_replace('\\', '/', $relative_class) . '.php';
+		// replace the namespace prefix with the base directory, replace namespace
+		// separators with directory separators in the relative class name, append
+		// with .php
+		$file = $base_dir . str_replace('\\', '/', $relative_class) . '.php';
 
-        // if the file exists, require it
-        if (file_exists($file)) {
-            include $file;
-        }
-    }
+		// if the file exists, require it
+		if (file_exists($file)) {
+			include $file;
+		}
+	}
 );

Spacing +1 added lines, -1 removed lines

@@ -12,7 +12,7 @@
  * @return void
  */
 spl_autoload_register(
-    function ($class) {
+    function($class) {
 
         // project-specific namespace prefix
         //$prefix = 'Foo\\Bar\\';

src/HTMLTable/CHTMLTable.php

Doc Comments +2 added lines, -2 removed lines

@@ -51,7 +51,7 @@ 
      * @param mixed[] $data         table cell data.
      * @param mixed[] $columnSpecs  table columns cell settings.
      *
-     * @return object the html table object.
+     * @return CHTMLTable the html table object.
      */
     public function create($tableSpecs = [], $data = [], $columnSpecs = [])
     {
@@ -455,7 +455,7 @@ 
      *
      * Gets the table with table data.
      *
-     * @return html     the table with table data.
+     * @return string     the table with table data.
      */
     public function getHTMLTable()
     {

Indentation +479 added lines, -479 removed lines

@@ -16,483 +16,483 @@
  */
 class CHTMLTable
 {
-    const FOOTER = 'footer';
-
-    private $tableSpec;
-    private $tableHead;
-    private $tableBody;
-    private $tableFoot;
-
-    /**
-     * Constructor
-     *
-     * Creates a table with table head, table body and if specified, a table
-     * footer. It is possible to specify the table and the tabel cells settings
-     * per column.
-     *
-     * @param string[] $tableSpecs  table settings.
-     * @param mixed[] $data         table cell data.
-     * @param mixed[] $columnSpecs  table columns cell settings.
-     */
-    public function __construct($tableSpecs = [], $data = [], $columnSpecs = [])
-    {
-        $this->create($tableSpecs, $data, $columnSpecs);
-    }
-
-    /**
-     * Creates a table with cell data.
-     *
-     * Creates a table with table head, table body with table data and if
-     * specified, a table footer. It is possible to specify the table and the
-     * tabel cells settings per column.
-     *
-     * @param string[] $tableSpecs  table settings.
-     * @param mixed[] $data         table cell data.
-     * @param mixed[] $columnSpecs  table columns cell settings.
-     *
-     * @return object the html table object.
-     */
-    public function create($tableSpecs = [], $data = [], $columnSpecs = [])
-    {
-        $this->resetTableTags();
-        $this->setTableSpecifications($tableSpecs);
-
-        $this->createTableHead($data, $columnSpecs);
-        $this->createTableBody($data, $columnSpecs);
-        $this->createTableFooter($columnSpecs);
-
-        return $this;
-    }
-
-    /**
-     * Helper method to reset main parts of table tags.
-     *
-     * Sets the table head, table body and table foot tag to null.
-     *
-     * @return void
-     */
-    private function resetTableTags()
-    {
-        $this->tableHead = null;
-        $this->tableBody = null;
-        $this->tableFoot = null;
-    }
-
-    /**
-     * Helper method to set the table specifications.
-     *
-     * Merges the table specifications with the default specifications.
-     * Default table CSS id is html-table.
-     *
-     * @param  string[] $tableSpec the table specification.
-     *
-     * @return void
-     */
-    private function setTableSpecifications($tableSpec)
-    {
-        $defaults = [
-            // Always have a id for the form
-            'id' => 'html-table',
-        ];
-
-        if ($this->isClassPresent($tableSpec)) {
-            $tableSpec = $this->removeId($tableSpec);
-        }
-
-        $this->tableSpec = array_merge($defaults, $tableSpec);
-    }
-
-    /**
-     * Helper method to check if a CSS class tag is present
-     *
-     * Checks if a CSS class tag is present in the table specification.
-     *
-     * @param  string[] $tableSpec the table specification.
-     *
-     * @return boolean  true if class is present in the table specification,
-     *                  false otherwise.
-     */
-    private function isClassPresent($tableSpec)
-    {
-        return isset($tableSpec['class']) ? true : false;
-    }
-
-    /**
-     * Helper method to reset the id tag.
-     *
-     * Sets the CSS id tag to null.
-     *
-     * @param  string[] $tableSpec the table specification.
-     *
-     * @return string[] the table specification without the CSS id tag.
-     */
-    private function removeId($tableSpec) {
-        $tableSpec['id'] = null;
-
-        return $tableSpec;
-    }
-
-    /**
-     * Helper method to create the table head.
-     *
-     * Creates the table head. The title of the columns are set according to
-     * the table tag in the column specifications. Otherwise, the title is set
-     * to the keys name in the table cell data array.
-     *
-     * @param  mixed[]  $data        table cell data.
-     * @param  mixed[]  $columnSpecs table columns cell settings.
-     *
-     * @return void
-     */
-    private function createTableHead($data, $columnSpecs)
-    {
-        $this->tableHead = "\n<thead>";
-        $this->tableHead .= "\n<tr>";
-
-        if (empty($columnSpecs))
-        {
-            $this->setColumnTitlesFromData($data);
-        } else {
-            $this->setColumnTitlesFromColumnSpecifications($columnSpecs);
-        }
-
-        $this->tableHead .= "\n</tr>";
-        $this->tableHead .= "\n</thead>";
-    }
-
-    /**
-     * Helper method to set the column titles from the data array.
-     *
-     * Uses the first row in the table cell data array to set the titles of
-     * the columns. The name of the columns are the key name for the objects in
-     * the array containing data for the table.
-     *
-     * @param  mixed[]  $data   table cell data.
-     *
-     * @return void
-     */
-    private function setColumnTitlesFromData($data)
-    {
-        $firstRow = isset($data[0]) ? $data[0] : [];
-        foreach ($firstRow as $key => $value) {
-            $this->tableHead .= "\n<th>";
-            $this->tableHead .= $key;
-            $this->tableHead .= "</th>";
-        }
-    }
-
-    /**
-     * Helper method to set the column titles from column specifications.
-     *
-     * Uses column specifications to set the name of the columns in the table
-     * head.
-     *
-     * @param  mixed[]  $columnSpecs    table columns cell settings
-     *
-     * @return void
-     */
-    private function setColumnTitlesFromColumnSpecifications($columnSpecs)
-    {
-        foreach ($columnSpecs as $key => $columnSpec) {
-            if (!$this->isTableFooter($columnSpec)) {
-                $this->tableHead .= "\n<th>";
-                $this->tableHead .= $this->getTitle($key, $columnSpec);
-                $this->tableHead .= "</th>";
-            }
-        }
-    }
-
-    /**
-     * Helper method to check if the column cell belongs to the footer.
-     *
-     * Checks the type tag, in the column specification for one column, if the
-     * tag is present and set to footer.
-     *
-     * @param  mixed[]  $columnSpec cell settings for one column.
-     *
-     * @return boolean true if the cell type belongs to the footer, false otherwise.
-     */
-    private function isTableFooter($columnSpec)
-    {
-        $isFooter = false;
-        if (isset($columnSpec['type'])) {
-            if (strcmp($columnSpec['type'], self::FOOTER) === 0) {
-                $isFooter = true;
-            }
-        }
-
-        return $isFooter;
-    }
-
-    /**
-     * Helper method to get title from a column specification, if specified.
-     *
-     * Uses the title tag in the column specification for one column to get
-     * the title. If the title tag is not set, the title is the key for the
-     * objects int the array containing data for the table.
-     *
-     * @param  array<integer,string>    $key        the name of the key for the
-     *                                              table cell data.
-     * @param  mixed[]                  $columnSpec cell settings for one column.
-     *
-     * @return string[] the name from the title tag in the cell specification.
-     *                  Otherwise, the table cell data key name.
-     */
-    private function getTitle($key, $columnSpec)
-    {
-        return isset($columnSpec['title']) ? $columnSpec['title'] : $key;
-    }
-
-    /**
-     * Helper method to create the table body with table cell data.
-     *
-     * Sets the table cell data in the table body.
-     *
-     * @param  mixed[] $data        table cell data.
-     * @param  mixed[] $columnSpecs table columns cell settings.
-     *
-     * @return void
-     */
-    private function createTableBody($data, $columnSpecs)
-    {
-        $this->setTableData($data, $columnSpecs);
-        if (isset($this->tableBody)) {
-            $this->tableBody = "\n<tbody>" . $this->tableBody . "\n</tbody>";
-        }
-    }
-
-    /**
-     * Helper method to set table data in table body.
-     *
-     * Sets table data according to the column specifications, if it is
-     * specified. Otherwise it sets the data as it is stored in the data array.
-     *
-     * @param  mixed[] $data        table cell data.
-     * @param  mixed[] $columnSpecs table columns cell settings.
-     *
-     * @return void
-     */
-    private function setTableData($data, $columnSpecs)
-    {
-        if (empty($columnSpecs)) {
-            $this->setTableDataFromData($data);
-        } else {
-            $this->setTableDataAsSpecified($data, $columnSpecs);
-        }
-    }
-
-    /**
-     * Helper method to set table data from the data array.
-     *
-     * Sets table data from the data array.
-     *
-     * @param  mixed[]  $data   table cell data.
-     *
-     * @return void
-     */
-    private function setTableDataFromData($data)
-    {
-        foreach ($data as $row) {
-            $this->tableBody .= "\n<tr>";
-            foreach ($row as $value) {
-                $this->tableBody .= "\n<td>";
-                $this->tableBody .= $value;
-                $this->tableBody .= "</td>";
-            }
-            $this->tableBody .= "\n</tr>";
-        }
-    }
-
-    /**
-     * Helper method to set table data according to the column specifications.
-     *
-     * Sets the table data according to the column specifications, if the cell
-     * does not belong to the footer. Adds a colspan tag, if it is specified
-     * for the cell in the column.
-     *
-     * @param  mixed[] $data         table cell data.
-     * @param  mixed[] $columnSpecs  table columns cell settings.
-     *
-     * @return void
-     */
-    private function setTableDataAsSpecified($data, $columnSpecs)
-    {
-        foreach ($data as $row) {
-            $this->tableBody .= "\n<tr>";
-            foreach ($columnSpecs as $key => $columnSpec) {
-                if (!$this->isTableFooter($columnSpec)) {
-                    $colspan = $this->getColspan($columnSpec);
-                    $this->tableBody .= "\n<td{$colspan}>";
-                    $this->tableBody .= $this->getValue($row, $key, $columnSpec);
-                    $this->tableBody .= "</td>";
-                }
-            }
-            $this->tableBody .= "\n</tr>";
-        }
-    }
-
-    /**
-     * Helper method to get the colspan value, if specified in the column
-     * specification for the cell.
-     *
-     * @param  mixed[]  $columnSpec cell settings for one column.
-     *
-     * @return int the colspan value if specified. Otherwise null.
-     */
-    private function getColspan($columnSpec)
-    {
-        return isset($columnSpec['colspan']) ? " colspan='{$columnSpec['colspan']}'" : null;
-    }
-
-    /**
-     * Helper method to get the value for a specific position in one row in
-     * the data array.
-     *
-     * Gets the data from a specific position in one row in the data array.
-     * If a function is specified for the cell in the column, the data is
-     * runned through the function before it is returned.If the object key is
-     * specified to object, the reference to the object is fetched from the
-     * array of objects.
-     *
-     * @param  object   $row        one row of in the array of table data.
-     * @param  string   $key        the name of the key in the associative data array.
-     * @param  mixed[]  $columnSpec cell settings for one column.
-     */
-    private function getValue($row, $key, $columnSpec)
-    {
-        if ($this->isFunctionSpecified($columnSpec)) {
-            if ($this->isObjectSpecifiedAsKey($key)) {
-                $dataValue = isset($row) ? $row : "";
-            } else {
-                $dataValue = isset($row->$key) ? $row->$key : "";
-            }
-
-            return $this->getValueThroughFunction($columnSpec, $dataValue);
-        } else {
-            return isset($row->$key) ? $row->$key : "";
-        }
-    }
-
-    /**
-     * Helper method t check if the function tag is specified for the cells in
-     * one column.
-     *
-     * Checks if the function tag is set for the cell in one column.
-     *
-     * @param  mixed[]  $columnSpec     cell settings for one column.
-     *
-     * @return boolean true if a function is connected to the cell, false otherwise.
-     */
-    private function isFunctionSpecified($columnSpec)
-    {
-        return isset($columnSpec['function']) ? true : false;
-    }
-
-    /**
-     * Helper method to check if the object key is specified to object.
-     *
-     * Checks if the object key starts with object. The check is case insensitive.
-     *
-     * @param  string  $key the name of the key for the object.
-     *
-     * @return boolean true if the key starts with object, false otherwise.
-     */
-    private function isObjectSpecifiedAsKey($key)
-    {
-        $keyRest = substr($key, 0, 6);
-
-        return strcasecmp($keyRest, "object") === 0 ? true : false;
-    }
-
-    /**
-     * Helper method to run the value through a function before it is returned.
-     *
-     * Runs the value through a function, if a function is connected to the cell
-     * in the column. If not function is connected to the cell through the
-     * column specification, the value is returned as it is.
-     *
-     * @param mixed[]   $columnSpec     cell settings for one column
-     * @param mixed     $dataValue      the value to run through function, if specified.
-     *
-     * @return the value.
-     */
-    private function getValueThroughFunction($columnSpec, $dataValue)
-    {
-        if (!empty($columnSpec['function'])) {
-            return call_user_func($columnSpec['function'], $dataValue);
-        } else {
-            return $dataValue;
-        }
-    }
-
-    /**
-     * Helper method to create table footer with data.
-     *
-     * Creates table footer if the cell settings for the column is set to
-     * footer in the column specifications.
-     * Adds a colspan tag, if it is specified for the cell in the column.
-     *
-     * @param  mixed[] $columnSpecs table columns cell settings.
-     *
-     * @return void
-     */
-    private function createTableFooter($columnSpecs)
-    {
-        foreach ($columnSpecs as $columnSpec) {
-            if ($this->isTableFooter($columnSpec)) {
-                $colspan = $this->getColspan($columnSpec);
-                $this->tableFoot .= "\n<td{$colspan}>";
-                $this->tableFoot .= $this->getFooterData($columnSpec);
-                $this->tableFoot .= "</td>";
-            }
-        }
-
-        if (isset($this->tableFoot)) {
-            $this->tableFoot = "\n<tfoot>\n<tr>" . $this->tableFoot . "\n</tr>\n</tfoot>";
-        }
-    }
-
-    /**
-     * Helper method to get table footer data.
-     *
-     * Gets table footer data from the column specification. Checks if the
-     * value should be fetched from a function or from the value tag.
-     * If either the function or the value specified, an empty string is
-     * returned.
-     *
-     * @param  mixed[] $columnSpec  cell settings for one column.
-     *
-     * @return mixed    the cell data value.
-     */
-    private function getFooterData($columnSpec)
-    {
-        if ($this->isFunctionSpecified($columnSpec)) {
-            return call_user_func($columnSpec['function']);
-        } else {
-            return isset($columnSpec['value']) ? $columnSpec['value'] : "";
-        }
-    }
-
-    /**
-     * Gets the table.
-     *
-     * Gets the table with table data.
-     *
-     * @return html     the table with table data.
-     */
-    public function getHTMLTable()
-    {
-        $id = isset($this->tableSpec['id']) ? " id='{$this->tableSpec['id']}'" : null;
-        $class = isset($this->tableSpec['class']) ? " class='{$this->tableSpec['class']}'" : null;
-        $caption = isset($this->tableSpec['caption']) ? "<caption>{$this->tableSpec['caption']}</caption>" : null;
-
-        $htmlTable = "<table{$id}{$class}>";
-        $htmlTable .= $caption;
-        $htmlTable .= $this->tableHead;
-        $htmlTable .= $this->tableBody;
-        $htmlTable .= $this->tableFoot;
-        $htmlTable .= "\n</table>";
-
-        return $htmlTable;
-    }
+	const FOOTER = 'footer';
+
+	private $tableSpec;
+	private $tableHead;
+	private $tableBody;
+	private $tableFoot;
+
+	/**
+	 * Constructor
+	 *
+	 * Creates a table with table head, table body and if specified, a table
+	 * footer. It is possible to specify the table and the tabel cells settings
+	 * per column.
+	 *
+	 * @param string[] $tableSpecs  table settings.
+	 * @param mixed[] $data         table cell data.
+	 * @param mixed[] $columnSpecs  table columns cell settings.
+	 */
+	public function __construct($tableSpecs = [], $data = [], $columnSpecs = [])
+	{
+		$this->create($tableSpecs, $data, $columnSpecs);
+	}
+
+	/**
+	 * Creates a table with cell data.
+	 *
+	 * Creates a table with table head, table body with table data and if
+	 * specified, a table footer. It is possible to specify the table and the
+	 * tabel cells settings per column.
+	 *
+	 * @param string[] $tableSpecs  table settings.
+	 * @param mixed[] $data         table cell data.
+	 * @param mixed[] $columnSpecs  table columns cell settings.
+	 *
+	 * @return object the html table object.
+	 */
+	public function create($tableSpecs = [], $data = [], $columnSpecs = [])
+	{
+		$this->resetTableTags();
+		$this->setTableSpecifications($tableSpecs);
+
+		$this->createTableHead($data, $columnSpecs);
+		$this->createTableBody($data, $columnSpecs);
+		$this->createTableFooter($columnSpecs);
+
+		return $this;
+	}
+
+	/**
+	 * Helper method to reset main parts of table tags.
+	 *
+	 * Sets the table head, table body and table foot tag to null.
+	 *
+	 * @return void
+	 */
+	private function resetTableTags()
+	{
+		$this->tableHead = null;
+		$this->tableBody = null;
+		$this->tableFoot = null;
+	}
+
+	/**
+	 * Helper method to set the table specifications.
+	 *
+	 * Merges the table specifications with the default specifications.
+	 * Default table CSS id is html-table.
+	 *
+	 * @param  string[] $tableSpec the table specification.
+	 *
+	 * @return void
+	 */
+	private function setTableSpecifications($tableSpec)
+	{
+		$defaults = [
+			// Always have a id for the form
+			'id' => 'html-table',
+		];
+
+		if ($this->isClassPresent($tableSpec)) {
+			$tableSpec = $this->removeId($tableSpec);
+		}
+
+		$this->tableSpec = array_merge($defaults, $tableSpec);
+	}
+
+	/**
+	 * Helper method to check if a CSS class tag is present
+	 *
+	 * Checks if a CSS class tag is present in the table specification.
+	 *
+	 * @param  string[] $tableSpec the table specification.
+	 *
+	 * @return boolean  true if class is present in the table specification,
+	 *                  false otherwise.
+	 */
+	private function isClassPresent($tableSpec)
+	{
+		return isset($tableSpec['class']) ? true : false;
+	}
+
+	/**
+	 * Helper method to reset the id tag.
+	 *
+	 * Sets the CSS id tag to null.
+	 *
+	 * @param  string[] $tableSpec the table specification.
+	 *
+	 * @return string[] the table specification without the CSS id tag.
+	 */
+	private function removeId($tableSpec) {
+		$tableSpec['id'] = null;
+
+		return $tableSpec;
+	}
+
+	/**
+	 * Helper method to create the table head.
+	 *
+	 * Creates the table head. The title of the columns are set according to
+	 * the table tag in the column specifications. Otherwise, the title is set
+	 * to the keys name in the table cell data array.
+	 *
+	 * @param  mixed[]  $data        table cell data.
+	 * @param  mixed[]  $columnSpecs table columns cell settings.
+	 *
+	 * @return void
+	 */
+	private function createTableHead($data, $columnSpecs)
+	{
+		$this->tableHead = "\n<thead>";
+		$this->tableHead .= "\n<tr>";
+
+		if (empty($columnSpecs))
+		{
+			$this->setColumnTitlesFromData($data);
+		} else {
+			$this->setColumnTitlesFromColumnSpecifications($columnSpecs);
+		}
+
+		$this->tableHead .= "\n</tr>";
+		$this->tableHead .= "\n</thead>";
+	}
+
+	/**
+	 * Helper method to set the column titles from the data array.
+	 *
+	 * Uses the first row in the table cell data array to set the titles of
+	 * the columns. The name of the columns are the key name for the objects in
+	 * the array containing data for the table.
+	 *
+	 * @param  mixed[]  $data   table cell data.
+	 *
+	 * @return void
+	 */
+	private function setColumnTitlesFromData($data)
+	{
+		$firstRow = isset($data[0]) ? $data[0] : [];
+		foreach ($firstRow as $key => $value) {
+			$this->tableHead .= "\n<th>";
+			$this->tableHead .= $key;
+			$this->tableHead .= "</th>";
+		}
+	}
+
+	/**
+	 * Helper method to set the column titles from column specifications.
+	 *
+	 * Uses column specifications to set the name of the columns in the table
+	 * head.
+	 *
+	 * @param  mixed[]  $columnSpecs    table columns cell settings
+	 *
+	 * @return void
+	 */
+	private function setColumnTitlesFromColumnSpecifications($columnSpecs)
+	{
+		foreach ($columnSpecs as $key => $columnSpec) {
+			if (!$this->isTableFooter($columnSpec)) {
+				$this->tableHead .= "\n<th>";
+				$this->tableHead .= $this->getTitle($key, $columnSpec);
+				$this->tableHead .= "</th>";
+			}
+		}
+	}
+
+	/**
+	 * Helper method to check if the column cell belongs to the footer.
+	 *
+	 * Checks the type tag, in the column specification for one column, if the
+	 * tag is present and set to footer.
+	 *
+	 * @param  mixed[]  $columnSpec cell settings for one column.
+	 *
+	 * @return boolean true if the cell type belongs to the footer, false otherwise.
+	 */
+	private function isTableFooter($columnSpec)
+	{
+		$isFooter = false;
+		if (isset($columnSpec['type'])) {
+			if (strcmp($columnSpec['type'], self::FOOTER) === 0) {
+				$isFooter = true;
+			}
+		}
+
+		return $isFooter;
+	}
+
+	/**
+	 * Helper method to get title from a column specification, if specified.
+	 *
+	 * Uses the title tag in the column specification for one column to get
+	 * the title. If the title tag is not set, the title is the key for the
+	 * objects int the array containing data for the table.
+	 *
+	 * @param  array<integer,string>    $key        the name of the key for the
+	 *                                              table cell data.
+	 * @param  mixed[]                  $columnSpec cell settings for one column.
+	 *
+	 * @return string[] the name from the title tag in the cell specification.
+	 *                  Otherwise, the table cell data key name.
+	 */
+	private function getTitle($key, $columnSpec)
+	{
+		return isset($columnSpec['title']) ? $columnSpec['title'] : $key;
+	}
+
+	/**
+	 * Helper method to create the table body with table cell data.
+	 *
+	 * Sets the table cell data in the table body.
+	 *
+	 * @param  mixed[] $data        table cell data.
+	 * @param  mixed[] $columnSpecs table columns cell settings.
+	 *
+	 * @return void
+	 */
+	private function createTableBody($data, $columnSpecs)
+	{
+		$this->setTableData($data, $columnSpecs);
+		if (isset($this->tableBody)) {
+			$this->tableBody = "\n<tbody>" . $this->tableBody . "\n</tbody>";
+		}
+	}
+
+	/**
+	 * Helper method to set table data in table body.
+	 *
+	 * Sets table data according to the column specifications, if it is
+	 * specified. Otherwise it sets the data as it is stored in the data array.
+	 *
+	 * @param  mixed[] $data        table cell data.
+	 * @param  mixed[] $columnSpecs table columns cell settings.
+	 *
+	 * @return void
+	 */
+	private function setTableData($data, $columnSpecs)
+	{
+		if (empty($columnSpecs)) {
+			$this->setTableDataFromData($data);
+		} else {
+			$this->setTableDataAsSpecified($data, $columnSpecs);
+		}
+	}
+
+	/**
+	 * Helper method to set table data from the data array.
+	 *
+	 * Sets table data from the data array.
+	 *
+	 * @param  mixed[]  $data   table cell data.
+	 *
+	 * @return void
+	 */
+	private function setTableDataFromData($data)
+	{
+		foreach ($data as $row) {
+			$this->tableBody .= "\n<tr>";
+			foreach ($row as $value) {
+				$this->tableBody .= "\n<td>";
+				$this->tableBody .= $value;
+				$this->tableBody .= "</td>";
+			}
+			$this->tableBody .= "\n</tr>";
+		}
+	}
+
+	/**
+	 * Helper method to set table data according to the column specifications.
+	 *
+	 * Sets the table data according to the column specifications, if the cell
+	 * does not belong to the footer. Adds a colspan tag, if it is specified
+	 * for the cell in the column.
+	 *
+	 * @param  mixed[] $data         table cell data.
+	 * @param  mixed[] $columnSpecs  table columns cell settings.
+	 *
+	 * @return void
+	 */
+	private function setTableDataAsSpecified($data, $columnSpecs)
+	{
+		foreach ($data as $row) {
+			$this->tableBody .= "\n<tr>";
+			foreach ($columnSpecs as $key => $columnSpec) {
+				if (!$this->isTableFooter($columnSpec)) {
+					$colspan = $this->getColspan($columnSpec);
+					$this->tableBody .= "\n<td{$colspan}>";
+					$this->tableBody .= $this->getValue($row, $key, $columnSpec);
+					$this->tableBody .= "</td>";
+				}
+			}
+			$this->tableBody .= "\n</tr>";
+		}
+	}
+
+	/**
+	 * Helper method to get the colspan value, if specified in the column
+	 * specification for the cell.
+	 *
+	 * @param  mixed[]  $columnSpec cell settings for one column.
+	 *
+	 * @return int the colspan value if specified. Otherwise null.
+	 */
+	private function getColspan($columnSpec)
+	{
+		return isset($columnSpec['colspan']) ? " colspan='{$columnSpec['colspan']}'" : null;
+	}
+
+	/**
+	 * Helper method to get the value for a specific position in one row in
+	 * the data array.
+	 *
+	 * Gets the data from a specific position in one row in the data array.
+	 * If a function is specified for the cell in the column, the data is
+	 * runned through the function before it is returned.If the object key is
+	 * specified to object, the reference to the object is fetched from the
+	 * array of objects.
+	 *
+	 * @param  object   $row        one row of in the array of table data.
+	 * @param  string   $key        the name of the key in the associative data array.
+	 * @param  mixed[]  $columnSpec cell settings for one column.
+	 */
+	private function getValue($row, $key, $columnSpec)
+	{
+		if ($this->isFunctionSpecified($columnSpec)) {
+			if ($this->isObjectSpecifiedAsKey($key)) {
+				$dataValue = isset($row) ? $row : "";
+			} else {
+				$dataValue = isset($row->$key) ? $row->$key : "";
+			}
+
+			return $this->getValueThroughFunction($columnSpec, $dataValue);
+		} else {
+			return isset($row->$key) ? $row->$key : "";
+		}
+	}
+
+	/**
+	 * Helper method t check if the function tag is specified for the cells in
+	 * one column.
+	 *
+	 * Checks if the function tag is set for the cell in one column.
+	 *
+	 * @param  mixed[]  $columnSpec     cell settings for one column.
+	 *
+	 * @return boolean true if a function is connected to the cell, false otherwise.
+	 */
+	private function isFunctionSpecified($columnSpec)
+	{
+		return isset($columnSpec['function']) ? true : false;
+	}
+
+	/**
+	 * Helper method to check if the object key is specified to object.
+	 *
+	 * Checks if the object key starts with object. The check is case insensitive.
+	 *
+	 * @param  string  $key the name of the key for the object.
+	 *
+	 * @return boolean true if the key starts with object, false otherwise.
+	 */
+	private function isObjectSpecifiedAsKey($key)
+	{
+		$keyRest = substr($key, 0, 6);
+
+		return strcasecmp($keyRest, "object") === 0 ? true : false;
+	}
+
+	/**
+	 * Helper method to run the value through a function before it is returned.
+	 *
+	 * Runs the value through a function, if a function is connected to the cell
+	 * in the column. If not function is connected to the cell through the
+	 * column specification, the value is returned as it is.
+	 *
+	 * @param mixed[]   $columnSpec     cell settings for one column
+	 * @param mixed     $dataValue      the value to run through function, if specified.
+	 *
+	 * @return the value.
+	 */
+	private function getValueThroughFunction($columnSpec, $dataValue)
+	{
+		if (!empty($columnSpec['function'])) {
+			return call_user_func($columnSpec['function'], $dataValue);
+		} else {
+			return $dataValue;
+		}
+	}
+
+	/**
+	 * Helper method to create table footer with data.
+	 *
+	 * Creates table footer if the cell settings for the column is set to
+	 * footer in the column specifications.
+	 * Adds a colspan tag, if it is specified for the cell in the column.
+	 *
+	 * @param  mixed[] $columnSpecs table columns cell settings.
+	 *
+	 * @return void
+	 */
+	private function createTableFooter($columnSpecs)
+	{
+		foreach ($columnSpecs as $columnSpec) {
+			if ($this->isTableFooter($columnSpec)) {
+				$colspan = $this->getColspan($columnSpec);
+				$this->tableFoot .= "\n<td{$colspan}>";
+				$this->tableFoot .= $this->getFooterData($columnSpec);
+				$this->tableFoot .= "</td>";
+			}
+		}
+
+		if (isset($this->tableFoot)) {
+			$this->tableFoot = "\n<tfoot>\n<tr>" . $this->tableFoot . "\n</tr>\n</tfoot>";
+		}
+	}
+
+	/**
+	 * Helper method to get table footer data.
+	 *
+	 * Gets table footer data from the column specification. Checks if the
+	 * value should be fetched from a function or from the value tag.
+	 * If either the function or the value specified, an empty string is
+	 * returned.
+	 *
+	 * @param  mixed[] $columnSpec  cell settings for one column.
+	 *
+	 * @return mixed    the cell data value.
+	 */
+	private function getFooterData($columnSpec)
+	{
+		if ($this->isFunctionSpecified($columnSpec)) {
+			return call_user_func($columnSpec['function']);
+		} else {
+			return isset($columnSpec['value']) ? $columnSpec['value'] : "";
+		}
+	}
+
+	/**
+	 * Gets the table.
+	 *
+	 * Gets the table with table data.
+	 *
+	 * @return html     the table with table data.
+	 */
+	public function getHTMLTable()
+	{
+		$id = isset($this->tableSpec['id']) ? " id='{$this->tableSpec['id']}'" : null;
+		$class = isset($this->tableSpec['class']) ? " class='{$this->tableSpec['class']}'" : null;
+		$caption = isset($this->tableSpec['caption']) ? "<caption>{$this->tableSpec['caption']}</caption>" : null;
+
+		$htmlTable = "<table{$id}{$class}>";
+		$htmlTable .= $caption;
+		$htmlTable .= $this->tableHead;
+		$htmlTable .= $this->tableBody;
+		$htmlTable .= $this->tableFoot;
+		$htmlTable .= "\n</table>";
+
+		return $htmlTable;
+	}
 }

Spacing +17 added lines, -17 removed lines

@@ -34,7 +34,7 @@ 
      * @param mixed[] $data         table cell data.
      * @param mixed[] $columnSpecs  table columns cell settings.
      */
-    public function __construct($tableSpecs = [], $data = [], $columnSpecs = [])
+    public function __construct($tableSpecs = [ ], $data = [ ], $columnSpecs = [ ])
     {
         $this->create($tableSpecs, $data, $columnSpecs);
     }
@@ -52,7 +52,7 @@ 
      *
      * @return object the html table object.
      */
-    public function create($tableSpecs = [], $data = [], $columnSpecs = [])
+    public function create($tableSpecs = [ ], $data = [ ], $columnSpecs = [ ])
     {
         $this->resetTableTags();
         $this->setTableSpecifications($tableSpecs);
@@ -114,7 +114,7 @@ 
      */
     private function isClassPresent($tableSpec)
     {
-        return isset($tableSpec['class']) ? true : false;
+        return isset($tableSpec[ 'class' ]) ? true : false;
     }
 
     /**
@@ -127,7 +127,7 @@ 
      * @return string[] the table specification without the CSS id tag.
      */
     private function removeId($tableSpec) {
-        $tableSpec['id'] = null;
+        $tableSpec[ 'id' ] = null;
 
         return $tableSpec;
     }
@@ -173,7 +173,7 @@ 
      */
     private function setColumnTitlesFromData($data)
     {
-        $firstRow = isset($data[0]) ? $data[0] : [];
+        $firstRow = isset($data[ 0 ]) ? $data[ 0 ] : [ ];
         foreach ($firstRow as $key => $value) {
             $this->tableHead .= "\n<th>";
             $this->tableHead .= $key;
@@ -215,8 +215,8 @@ 
     private function isTableFooter($columnSpec)
     {
         $isFooter = false;
-        if (isset($columnSpec['type'])) {
-            if (strcmp($columnSpec['type'], self::FOOTER) === 0) {
+        if (isset($columnSpec[ 'type' ])) {
+            if (strcmp($columnSpec[ 'type' ], self::FOOTER) === 0) {
                 $isFooter = true;
             }
         }
@@ -240,7 +240,7 @@ 
      */
     private function getTitle($key, $columnSpec)
     {
-        return isset($columnSpec['title']) ? $columnSpec['title'] : $key;
+        return isset($columnSpec[ 'title' ]) ? $columnSpec[ 'title' ] : $key;
     }
 
     /**
@@ -341,7 +341,7 @@ 
      */
     private function getColspan($columnSpec)
     {
-        return isset($columnSpec['colspan']) ? " colspan='{$columnSpec['colspan']}'" : null;
+        return isset($columnSpec[ 'colspan' ]) ? " colspan='{$columnSpec[ 'colspan' ]}'" : null;
     }
 
     /**
@@ -385,7 +385,7 @@ 
      */
     private function isFunctionSpecified($columnSpec)
     {
-        return isset($columnSpec['function']) ? true : false;
+        return isset($columnSpec[ 'function' ]) ? true : false;
     }
 
     /**
@@ -418,8 +418,8 @@ 
      */
     private function getValueThroughFunction($columnSpec, $dataValue)
     {
-        if (!empty($columnSpec['function'])) {
-            return call_user_func($columnSpec['function'], $dataValue);
+        if (!empty($columnSpec[ 'function' ])) {
+            return call_user_func($columnSpec[ 'function' ], $dataValue);
         } else {
             return $dataValue;
         }
@@ -467,9 +467,9 @@ 
     private function getFooterData($columnSpec)
     {
         if ($this->isFunctionSpecified($columnSpec)) {
-            return call_user_func($columnSpec['function']);
+            return call_user_func($columnSpec[ 'function' ]);
         } else {
-            return isset($columnSpec['value']) ? $columnSpec['value'] : "";
+            return isset($columnSpec[ 'value' ]) ? $columnSpec[ 'value' ] : "";
         }
     }
 
@@ -482,9 +482,9 @@ 
      */
     public function getHTMLTable()
     {
-        $id = isset($this->tableSpec['id']) ? " id='{$this->tableSpec['id']}'" : null;
-        $class = isset($this->tableSpec['class']) ? " class='{$this->tableSpec['class']}'" : null;
-        $caption = isset($this->tableSpec['caption']) ? "<caption>{$this->tableSpec['caption']}</caption>" : null;
+        $id = isset($this->tableSpec[ 'id' ]) ? " id='{$this->tableSpec[ 'id' ]}'" : null;
+        $class = isset($this->tableSpec[ 'class' ]) ? " class='{$this->tableSpec[ 'class' ]}'" : null;
+        $caption = isset($this->tableSpec[ 'caption' ]) ? "<caption>{$this->tableSpec[ 'caption' ]}</caption>" : null;
 
         $htmlTable = "<table{$id}{$class}>";
         $htmlTable .= $caption;