nmfmcosta/laravel-formatter

A formatting library that converts data output between XML, CSV, JSON, TXT, YAML and a few others.

v1.3 2024-01-03 11:26 UTC

Requires

• php: ^7.2|^8.0
• illuminate/support: ^8.0|^9.0|^10.0
• league/csv: ~9.0
• mustangostang/spyc: ~0.6

Requires (Dev)

• phpunit/phpunit: ^9.0

MIT

• yaml
• xml
• data
• csv
• convert
• formatter
• laravel

README

This is a fork from https://github.com/soapbox/laravel-formatter updated to work on Laravel 8 and 9.

All credit goes to the original authors.

A formatter package that will help you to easily convert between various formats such as XML, JSON, CSV, etc...

Goals

The goals of this library are to allow the transfomation of data formats from one type to another. See Parsers and Formats to see supported input / output formats.

Installation

Through command line:

composer require nmfmcosta/laravel-formatter

Through composer.json:

{
  "require": {
    "nmfmcosta/laravel-formatter": "1.x"
  }
}

Parsers

All of the following are supported formats that the formatter can read from.

• Array
• CSV
• JSON
• XML
• YAML

Formats

All of the following are formats that are supported for output.

• Array
• CSV
• JSON
• XML
• YAML

General Usage

Including The Formatter

use LB\Formatter\Formatter;

Supported Types

Formatter::JSON; //json
Formatter::CSV;  //csv
Formatter::XML;  //xml
Formatter::ARR;  //array
Formatter::YAML; //yaml

Making Your First Formatter(s)

$formatter = Formatter::make($jsonString, Formatter::JSON);
$formatter = Formatter::make($yamlString, Formatter::YAML);
$formatter = Formatter::make($array, Formatter::ARR);
...

Outputting From Your Formatter

$csv   = $formatter->toCsv();
$json  = $formatter->toJson();
$xml   = $formatter->toXml();
$array = $formatter->toArray();
$yaml  = $formatter->toYaml();

Deprecated Functionality

The following have been deprecated from the library, however you can easily continue using them in your application

Serialized Array

$serialized = serialize($formatter->toArray());

PHP Export

$export = var_export($formatter->toArray());