kba-team/markdown-table

Create a markdown table string from an associative array.

v1.1.2 2022-05-18 15:23 UTC

This package is auto-updated.

Last update: 2022-07-18 15:56:55 UTC


README

License: MIT PHP Composer & PHPUnit Maintainability Test Coverage

Create a Markdown table containing your data.

Install

composer require kba-team/markdown-table

Usage

A simple example:

<?php
use kbATeam\MarkdownTable\Table;
use kbATeam\MarkdownTable\Column;
$data = [
  [
    'A' => 'markdown',
    'B' => 'is'
  ],
  [
    'A' => 'great',
    'B' => 'software',
  ]
];
$table = new Table();
$table->addColumn('A', new Column('Column A', Column::ALIGN_RIGHT));
$table->addColumn('B', new Column('another Column', Column::ALIGN_LEFT));
foreach ($table->generate($data) as $row) {
  printf('%s%s', $row, PHP_EOL);
}

Result:

 Column A | another Column 
 -------: | :------------- 
 markdown | is             
    great | software       

Testing

Get composer, and install the dependencies.

composer install

Call phpunit to run the tests available. You'll see not only the results of the tests but the code coverage too.

vendor/bin/phpunit

MIT License

Copyright (c) 2018 the-kbA-team

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.