Skip to content

Instantly share code, notes, and snippets.

@csalzano
Forked from dapepe/TextTable.php
Last active December 20, 2023 20:51
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save csalzano/82b34bac7089f56963fa1d6e7d72c5c6 to your computer and use it in GitHub Desktop.
Save csalzano/82b34bac7089f56963fa1d6e7d72c5c6 to your computer and use it in GitHub Desktop.
Class to generate a Markdown-style table from a PHP array
<?php
/**
* Creates a markdown document based on the parsed documentation
*
* @author Peter-Christoph Haider <peter.haider@zeyon.net>
* @package Apidoc
* @version 1.00 (2014-04-04)
* @license GNU Lesser Public License
*/
class TextTable {
/** @var int The source path */
public $maxlen = 50;
/** @var array The source path */
private $data = array();
/** @var array The source path */
private $header = array();
/** @var array The source path */
private $len = array();
/** @var array The source path */
private $align = array(
'name' => 'L',
'type' => 'C'
);
/**
* @param array $header The header array [key => label, ...]
* @param array $content Content
* @param array $align Alignment optios [key => L|R|C, ...]
*/
public function __construct($header=null, $content=array(), $align=false) {
if ($header) {
$this->header = $header;
} elseif ($content) {
foreach ($content[0] as $key => $value)
$this->header[$key] = $key;
}
foreach ($this->header as $key => $label) {
$this->len[$key] = strlen($label);
}
if (is_array($align))
$this->setAlign($align);
$this->addData($content);
}
/**
* Overwrite the alignment array
*
* @param array $align Alignment optios [key => L|R|C, ...]
*/
public function setAlign($align) {
$this->align = $align;
}
/**
* Add data to the table
*
* @param array $content Content
*/
public function addData($content) {
foreach ($content as &$row) {
foreach ($this->header as $key => $value) {
if (!isset($row[$key])) {
$row[$key] = '-';
} elseif (strlen($row[$key]) > $this->maxlen) {
$this->len[$key] = $this->maxlen;
$row[$key] = substr($row[$key], 0, $this->maxlen-3).'...';
} elseif (strlen($row[$key]) > $this->len[$key]) {
$this->len[$key] = strlen($row[$key]);
}
}
}
$this->data = $this->data + $content;
return $this;
}
/**
* Add a delimiter
*
* @return string
*/
private function renderDelimiter() {
$res = '|';
foreach ($this->len as $key => $l)
$res .= (isset($this->align[$key]) && ($this->align[$key] == 'C' || $this->align[$key] == 'L') ? ':' : ' ')
.str_repeat('-', $l)
.(isset($this->align[$key]) && ($this->align[$key] == 'C' || $this->align[$key] == 'R') ? ':' : ' ')
.'|';
return $res."\r\n";
}
/**
* Render a single row
*
* @param array $row
* @return string
*/
private function renderRow($row) {
$res = '|';
foreach ($this->len as $key => $l) {
$res .= ' '.$row[$key].($l > strlen($row[$key]) ? str_repeat(' ', $l - strlen($row[$key])) : '').' |';
}
return $res."\r\n";
}
/**
* Render the table
*
* @param array $content Additional table content
* @return string
*/
public function render($content=array()) {
$this->addData($content);
$res = $this->renderRow($this->header)
.$this->renderDelimiter();
foreach ($this->data as $row)
$res .= $this->renderRow($row);
return $res;
}
}
@csalzano
Copy link
Author

Example

$columns = ['heading1','heading2','heading3'];
$rows = [
    ['a', 'b', 'c'],
    ['d', 'e', 'f']
];
$t = new TextTable($columns, $rows);
$t->addData(['extra1' => ['j','k','l']]);
echo $t->render(['extra2' => ['g','h','i']]);
$t->setAlgin(['L', 'C', 'R']);
echo \PHP_EOL;
echo $t->render();

Output

| heading1 | heading2 | heading3 |
| -------- | -------- | -------- |
| a        | b        | c        |
| d        | e        | f        |
| j        | k        | l        |
| g        | h        | i        |

| heading1 | heading2 | heading3 |
|:-------- |:--------:| --------:|
| a        | b        | c        |
| d        | e        | f        |
| j        | k        | l        |
| g        | h        | i        |

Demo

heading1 heading2 heading3
a b c
d e f
j k l
g h i
heading1 heading2 heading3
a b c
d e f
j k l
g h i

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment