Giter VIP home page Giter VIP logo

csvtable's Introduction

Yourproject logo

CsvTable

GitHub Issues GitHub Pull Requests Test codecov GitHub release (latest by date) LICENSE Renovate


PHP class to work with CSV as a table and export it as Markdown.

Features

  • Single-file class to manipulate CSV table.
  • Renderers for CSV and text table.
  • Ability to provide custom renderer.

Installation

composer require alexskrypnyk/csvtable

Usage

Given a CSV file with the following content:

col11,col12,col13
col21,col22,col23
col31,col32,col33      

From string

$csv = file_get_contents($csv_file);
// Render using the default renderer.
print (new CsvTable($csv))->render();

will produce identical CSV content by default:

col11,col12,col13
col21,col22,col23
col31,col32,col33      

From file

print (CsvTable::fromFile($file))->render();

will produce identical CSV content by default:

col11,col12,col13
col21,col22,col23
col31,col32,col33

Using CsvTable::renderTextTable() renderer

print (CsvTable::fromFile($file))->render([CsvTable::class, 'renderTextTable']);

will produce table content:

col11|col12|col13
-----------------
col21|col22|col23
col31|col32|col33     

Using CsvTable::renderTextTable() renderer with disabled header

print (CsvTable::fromFile($file))->noHeader()->render([CsvTable::class, 'renderTextTable']);

will produce table content:

col11|col12|col13
col21|col22|col23
col31|col32|col33     

Custom renderer from class

print (CsvTable::fromFile($file))->render(Markdown::class);

will produce Markdown content:

| col11 | col12 | col13 |
|-------|-------|-------|
| col21 | col22 | col23 |
| col31 | col32 | col33 |     

Custom renderer as a callback

print (CsvTable::fromFile($file))->render(function ($header, $rows, $options) {
  if (count($header) > 0) {
    $header = implode('|', $header);
    $header = $header . "\n" . str_repeat('-', strlen($header)) . "\n";
  }
  else {
    $header = '';
  }

  return $header . implode("\n", array_map(function ($row) {
    return implode('|', $row);
  }, $rows));
});

will produce CSV content:

col11|col12|col13
-----------------
col21|col22|col23
col31|col32|col33     

Maintenance

composer install
composer lint
composer test

Repository created using https://getscaffold.dev/ project scaffold template

csvtable's People

Contributors

alexskrypnyk avatar renovate[bot] avatar tannguyen04 avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

Forkers

tannguyen04

csvtable's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

Detected dependencies

composer
composer.json
  • php >=8.1
  • drupal/coder ^8.3
  • phpmd/phpmd ^2.15
  • phpstan/phpstan ^1.10
  • phpunit/phpunit ^10.1
  • rector/rector ^1.0.0
github-actions
.github/workflows/assign-author.yml
  • toshimaru/auto-author-assign v2.1.0
.github/workflows/draft-release-notes.yml
  • release-drafter/release-drafter v6
.github/workflows/test-php.yml
  • actions/checkout v4
  • actions/cache v4
  • shivammathur/setup-php v2
  • actions/upload-artifact v4
  • codecov/codecov-action v4

  • Check this box to trigger a request for Renovate to run again on this repository

Update repo configs from https://getscaffold.dev/

Download the latest code from Scaffold repo (actual code, not the release).

  • Update composer.json with the structure from Scaffold. Preserve the values of the existing fields, but order the fields as per Scaffold's composer.json. Add missing fields.
  • Add Renovate config from Scaffold
  • Add/update all GitHub actions and configs to be per Scaffold. Note that the test GHA workflow should be used and CircleCI should be removed.
  • Update readme to use the structure from Scaffold, including the generated logo (circle). Transfer the usage examples into the readme structure from Scaffold
  • Add PHPStan config and fix all newly found violations
  • Reformat composer.json to have indents and sorting as per the Scaffold.

Make sure that CI passes.

Similar task for reference: AlexSkrypnyk/shellvar#17

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.