soapbox/laravel-formatter

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

3.1.1 2018-06-27 14:37 UTC

Requires

• php: >=7.0.10
• illuminate/support: ~5.5
• league/csv: ~9.0
• mustangostang/spyc: ~0.6

Requires (Dev)

• phpunit/phpunit: ^5.7 || ^6.5

MIT

• Graham McCarthy
• Jaspaul Bola

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

README

• Update support for Laravel 6 & phpunit 8
• Update composer.json
• Upgrade to PSR-4
• add parameter newline, delimiter, enclosure, and escape to export csv
• When converting a XML to an array, convert @attributes to attribute
• add parameter encoding and formated to export xml
• JSON parse fix (Instead of only converting the first level to array, use the associative array parameter with true, so all levels will be decoded to array structure)
• Add support for laravel 5
• add package discovery for laravel 5
• add support delimiter to a csv

Formatter Bundle

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 soapbox/laravel-formatter

Through composer.json:

{
  "require": {
    "soapbox/laravel-formatter": "2.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 SoapBox\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());