phplucidframe/console-table

ConsoleTable helps you to display tabular data in a terminal/shell/console

What is PHPLucidFrame?

PHPLucidFrame (a.k.a. LucidFrame) is an application development framework for PHP developers. It provides logical structure and several helper utilities for web application development. It uses a functional architecture to simplify complex application development. It is especially designed for PHP, MySQL and Apache. It is simple, fast, lightweight and easy to install.

Almost zero configuration - just configure your database setting and you are ready to go. No complex JSON, XML, YAML or vHost configuration.

No template engine to eliminate overhead of template processing and to save your storage from template cache files.

It supports a wide range of web application development features:

• Database access API
• Security control
• URL routing
• Validation helpers
• Internationalization & Localization
• User authentication & authorization API
• Schema Manager
• Database Seeding
• Query Builder
• Shell & Console Tool
• Ajax

Prerequisites

• Web Server (Apache with mod_rewrite enabled)
• PHP version 5.6 or newer is recommended, but we strongly advise you to use one of the currently supported versions.
• MySQL 5.0 or newer

Installation

• Extract the downloaded archive in your local webserver document root, and you will get a folder named phplucidframe-x.y.z where x.y.z would be your downloaded version.
• Rename it as phplucidframe.
• Open your terminal or command line and CD to your project root, and then run php lucidframe secret:generate. For more about the PHPLucidFrame console, read the documentation section "The LucidFrame Console".
• Check http://localhost/phplucidframe in your browser.

Note:

• If you have your own project folder name other than phplucidframe in your development environment, you have to change the value of baseURL in /inc/parameter/development.php in accordance with your project name.
• If you use a virtual host for your project, you have to leave an empty string for the value of baseURL in /inc/parameter/development.php.

Alternate Installation with Composer

You can install PHPLucidFrame alternatively using Composer. Open your terminal and CD to your webserver document root, and then run

composer create-project --prefer-dist phplucidframe/phplucidframe [your-project-name]

Note: You have to change the value of baseURL in /inc/parameter/development.php according to [your-project-name].

Furthermore on Installation

Based URL : There are two situations you will have to leave the configuration baseURL empty in /inc/parameter/xxx.php files:

1. when you have a virtual host for your application in your development environment.
2. when your application in production environment where you upload the framework files directly to your web server document root.

Routing : You can define custom routes in /inc/route.config.php. The following routing for home page maps to /app/home/index.php.

route('lc_home')->map('/', '/home');

PHPLucidFrame encourages a structured page organization. You can check the recommended structure in the sample page folders and codes /app/home/ and /app/example/ of the release.

Additional Site Settings : You can also configure the other settings in /inc/config.php and /app/inc/site.config.php according to your requirement.

CSS Template : PHPLucidFrame provides you a default site CSS template /assets/css/base.css. To make your site easily upgradable in the future, create your own file in /app/assets/css with whatever name you like and update your /app/inc/tpl/layout.php by including <?php _css('yourfilename.css'); ?>. Then you can override the rules of /assets/css/base.css in your CSS file.

Documentation

• PDF Documentation - The complete PDF documentation is available to download.
• API Documentation - API documentation of every version is available and generated by ApiGen and phpDocumentor.
• Code Samples - The quick reference and coding samples are also available in the release.
• Sample Administration Module - The configuration guideline for sample administration module.

Support & Resources

• Stackoverflow
• GitHub issues

Run Tests

Prerequisites:

composer install

php lucidframe env test

Create a test database and setup in inc/parameter/test.php. By default, the database name lucid_blog_test is set up under sample namespace. Then you can create a new database lucid_blog_test and run schema:load sample.

php lucidframe schema:load sample

From Command Line,

# to run all tests
php tests/tests.php

# to run tests/lib/db_helper.test.php only
php tests/tests.php --file=db_helper

# to run tests/lib/validation_helper.test.php only
php tests/tests.php -f=validation_helper
# or
php tests/tests.php -f validation_helper

# to run tests/lib/db_helper.test.php and query_builer.test.php
php tests/tests.php --file=db_helper,query_builder

Note: You can also use the short-form option name f instead of file.

From Browser,

# to run all tests
http://[site_url]/tests/tests.php

# to run tests/lib/db_helper.test.php only
http://[site_url]/tests/tests.php?file=db_helper

# to run tests/lib/db_helper.test.php and query_builer.test.php
http://[site_url]/tests/tests.php?file=db_helper,query_builder

Note: You can also use the query string parameter f instead of file.

console-table's Issues

Wrong spacing with emojis

Hi !
Thanks you for this library but there is an issue with emojis in general 😄📚.

Code that breaks

<?php
require_once __DIR__ . "/../vendor/autoload.php";

$table = new LucidFrame\Console\ConsoleTable();
$table = $table
  ->addHeader("A")
  ->addHeader("B")
  ->addRow()
    ->addColumn("📚")
    ->addColumn("Hello")
  ->addRow()
    ->addColumn("X")
    ->addColumn("Foo Bared")
  ->display();

Expected behavior:

Actual behavior:

Environment

Shell: fish 3.3.1
PHP 8.0.12 (cli)
phplucidframe/console-table: ^1.2

Tag new release with latest features

Anyway we could get a new release with some of the features mentioned in master/README.md? Like addBorderLine()?

Provide addHeaders() and addHorizontalLine() methods

It would be great to have a wrapper for adHeader() method to accept an array of headers.
Also having a the functionality to draw a line at any row can be useful.

how to set column size

i need to occupy a demarcated space and to occupy all the space i need to be able to set the column size

Issue with non-autoresizing headers

Actual behavior

+----+------+-----+--------+------------+---+
| ID | Name | Key | Status | Page count |
+----+------+-----+--------+------------+---+
| 12345689  | Kategória szövege sok-sok betű | CK         | 12365478  | global | CURRENT 
+----+------+-----+--------+------------+---+

As you see, the header fixes to the size of the header string and does not autosize to the content. It contains utf8 characters but I had an issue with strings without multibyte characters, but even if it would handle multibyte strings badly the name column should wider than 5 chars.

Code:

  $ctable = new LucidFrame\Console\ConsoleTable();
  $ctable = $ctable->setHeaders(['ID', 'Name', 'Key', 'Status', 'Page count']);
  foreach($spaces as $row) {
    $ctable->addRow($row);
  }

  $ctable->display();

phplucidframe/console-table dev-master a973d91 Console Table

Cell width problem on multibyte characters

Hi!

First of all this package is awesome, i really like it so thanks for it!

I found an error on multibyte characters. I've listed records from a database table and there was some Hungarian names.

I fixed this with mb_strlen() and a new strPadUnicode method.
Here is the new method with the two fixed methods.

  /**
    * Calculate maximum width of each column
    *
    * @return array
    */
   private function calculateColumnWidth()
   {
       foreach ($this->data as $y => $row) {
           if (is_array($row)) {
               foreach ($row as $x => $col) {
                   $content = preg_replace('#\x1b[[][^A-Za-z]*[A-Za-z]#', '', $col);
                   if (!isset($this->columnWidths[$x])) {
                       $this->columnWidths[$x] = mb_strlen($content, 'UTF-8');
                   } else {
                       if (mb_strlen($content, 'UTF-8') > $this->columnWidths[$x]) {
                           $this->columnWidths[$x] = mb_strlen($content, 'UTF-8');
                       }
                   }
               }
           }
       }

       return $this->columnWidths;
   }

   /**
    * Get the printable cell content
    *
    * @param integer $index The column index
    * @param array   $row   The table row
    * @return string
    */
   private function getCellOutput($index, $row = null)
   {
       $cell = $row ? $row[$index] : '-';
       $width = $this->columnWidths[$index];
       $pad = $row ? $width - mb_strlen($cell, 'UTF-8') : $width;
       $padding = str_repeat($row ? ' ' : '-', $this->padding);

       $output = '';

       if ($index === 0) {
           $output .= str_repeat(' ', $this->indent);
       }

       if ($this->border) {
           $output .= $row ? '|' : '+';
       }

       $output .= $padding; # left padding
       $cell = trim(preg_replace('/\s+/', ' ', $cell)); # remove line breaks
       $content = preg_replace('#\x1b[[][^A-Za-z]*[A-Za-z]#', '', $cell);
       $delta = mb_strlen($cell, 'UTF-8') - mb_strlen($content, 'UTF-8');
       $output .= $this->strPadUnicode($cell, $width + $delta, $row ? ' ' : '-'); # cell content
       $output .= $padding; # right padding
       if ($row && $index == count($row) - 1 && $this->border) {
           $output .= $row ? '|' : '+';
       }

       return $output;
   }

   /**
    * Multibyte version of str_pad() function
    * @source http://php.net/manual/en/function.str-pad.php
    */
   private function strPadUnicode($str, $padLength, $padString = ' ', $dir = STR_PAD_RIGHT)
   {
       $strLen = mb_strlen($str, 'UTF-8');
       $padStrLen = mb_strlen($padString, 'UTF-8');
       if (!$strLen && ($dir == STR_PAD_RIGHT || $dir == STR_PAD_LEFT)) {
           $strLen = 1;
       }
       if (!$padLength || !$padStrLen || $padLength <= $strLen) {
           return $str;
       }

       $result = null;
       $repeat = ceil($strLen - $padStrLen + $padLength);
       if ($dir == STR_PAD_RIGHT) {
           $result = $str . str_repeat($padString, $repeat);
           $result = mb_substr($result, 0, $padLength, 'UTF-8');
       } else if ($dir == STR_PAD_LEFT) {
           $result = str_repeat($padString, $repeat) . $str;
           $result = mb_substr($result, -$padLength, null, 'UTF-8');
       } else if ($dir == STR_PAD_BOTH) {
           $length = ($padLength - $strLen) / 2;
           $repeat = ceil($length / $padStrLen);
           $result = mb_substr(str_repeat($padString, $repeat), 0, floor($length), 'UTF-8')
               . $str
               . mb_substr(str_repeat($padString, $repeat), 0, ceil($length), 'UTF-8');
       }

       return $result;
   }

With this fix everything is work great for me!

Thanks,
Frank Szklenár

Add support for newlines inside cells

Request: One line array to table wrapper function

Any chance we could put something akin to this as a function?

function table_me($table_data ) {
	$table = new LucidFrame\Console\ConsoleTable();
	$table->addHeader(array_keys($table_data[0]));
	foreach ($table_data as $row) { 
		$table->addRow(@array_values($row));
	}
	$table->display();
}

That could give an one-liner method to produce a table form an associative array.

Using terminal colors ( \033[0m ) breaks alignment

Hi,
First, thank you for this code !
If you use terminal colors / text decoration
for example:

echo "\033[44m\033[7mHi\033[0m";

the table alignment is broken
This is probably due to strlen($col) in calculateColumnWidth function, counting everything in the string, wich end up not printed on cli.

You should remove every extra caracters before counting string lengh,
with for example

$test = preg_replace('#\x1b[[][^A-Za-z]*[A-Za-z]#', '', $test);

(found here: https://stackoverflow.com/questions/40731273/php-remove-terminal-codes-from-string)

Does not support line feed

      ->addRow()
      ->addColumn("asdfasddasfdasf\nasdfsadfasdfasd\n")
      ->addColumn('12312312');

yields

| Original                         | Proposed |
+----------------------------------+----------+
| asdfasddasfdasf
asdfsadfasdfasd
 | 12312312 |
| asdfasddasfdasf
asdfsadfasdfasd
 | 12312312 |
| asdfasddasfdasf
asdfsadfasdfasd

Warnings on empty table

if no rows :

PHP Notice:  Undefined offset: 0 in /home/david/dev/projects/search-engine/vendor/phplucidframe/console-table/src/LucidFrame/Console/ConsoleTable.php on line 238
PHP Warning:  count(): Parameter must be an array or an object that implements Countable in /home/david/dev/projects/search-engine/vendor/phplucidframe/console-table/src/LucidFrame/Console/ConsoleTable.php on line 238
PHP Notice:  Undefined offset: 0 in /home/david/dev/projects/search-engine/vendor/phplucidframe/console-table/src/LucidFrame/Console/ConsoleTable.php on line 238
PHP Warning:  count(): Parameter must be an array or an object that implements Countable in /home/david/dev/projects/search-engine/vendor/phplucidframe/console-table/src/LucidFrame/Console/ConsoleTable.php on line 238
PHP Notice:  Undefined offset: 0 in /home/david/dev/projects/search-engine/vendor/phplucidframe/console-table/src/LucidFrame/Console/ConsoleTable.php on line 238
PHP Warning:  count(): Parameter must be an array or an object that implements Countable in /home/david/dev/projects/search-engine/vendor/phplucidframe/console-table/src/LucidFrame/Console/ConsoleTable.php on line 238