Skip to content
This repository was archived by the owner on May 22, 2024. It is now read-only.

Latest commit

History

19 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

CLI Table Output for PHP

Example

  • Nice table output of data rows
  • Columns adjust to data size
  • Data manipulators for fields, formats raw data to a nice display output
  • Colors! When specifying a color, choose from these strings: blue, red, green, yellow, black, magenta, cyan, white, grey
  • Support for multi-line values.

Installing via Composer

# Install Composer
curl -sS https://getcomposer.org/installer | php

Next, run the Composer command to install the latest stable version:

composer.phar require jc21/clitable

After installing, you need to require Composer's autoloader:

require'vendor/autoload.php';

Using

Class documentation

See the tests folder for some examples, but basically here's how to use it:

usejc21\CliTable;
// $data used below is an array of rows with fields. See tests/data.php for an example.$table = newCliTable;
$table->setTableColor('blue');
$table->setHeaderColor('cyan');
$table->addField('First Name', 'firstName', false, 'white');
$table->addField('Last Name', 'lastName', false, 'white');
$table->addField('DOB', 'dobTime', newCliTableManipulator('datelong'));
$table->addField('Admin', 'isAdmin', newCliTableManipulator('yesno'), 'yellow');
$table->addField('Last Seen', 'lastSeenTime', newCliTableManipulator('nicetime'), 'red');
$table->addField('Expires', 'expires', newCliTableManipulator('duetime'), 'green');
$table->injectData($data);
$table->display();

Manipulators

These are the manipulators provided in the package:

  • dollar: Formats 12300.23 to $12,300.23
  • date: Formats unix timestamp 1372132121 to AU date 25-06-2013 (because I'm an Aussie mate)
  • datelong: Formats unix timestamp 1372132121 to 25th June 2013
  • time: Formats unix timestamp 1372132121 to 1:48 pm
  • datetime: Formats unix timestamp 1372132121 to 25th June 2013, 1:48 pm
  • nicetime: Formats unix timestamp 1372132121 to one of the following, depending if it falls on Today or Yesterday or earlier:
    • Today, 1:48 pm
    • Yesterday, 1:48 pm
    • 25th June 2013, 1:48 pm
  • duetime: Formats unix timestamp to x years x days x hours x minutes x seconds
  • nicenumber: Formats 123456 to 123,456
  • month: Formats unix timestamp 1372132121 to June
  • year: Formats unix timestamp 1372132121 to 2013
  • monthyear: Formats unix timestamp 1372132121 to June 2013
  • percent: Formats 54 to 54%
  • yesno: Formats a boolean value to Yes or No
  • text: Strips HTML from the value before returning

If you want to create your own manipulators:

class MyManipulator extends CliTableManipulator {
publicfunctionchucknorris($value)
{
return'Chuck norris said: ' . $value;
}
}
$table = newCliTable;
$table->setTableColor('blue');
$table->setHeaderColor('cyan');
$table->addField('First Name', 'firstName', false, 'white');
$table->addField('Last Name', 'lastName', false, 'white');
$table->addField('DOB', 'dobTime', newCliTableManipulator('datelong'));
$table->addField('Admin', 'isAdmin', newMyManipulator('chucknorris'), 'yellow');
$table->addField('Last Seen', 'lastSeenTime', newCliTableManipulator('nicetime'), 'red');
$table->addField('Expires', 'expires', newCliTableManipulator('duetime'), 'green');
$table->injectData($data);
$table->display();

About

CLI Table Output for PHP

Resources

Stars

60 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages