From 501654f9c9428db5fb47015342ae958a18567f3c Mon Sep 17 00:00:00 2001 From: Simon Vieille Date: Mon, 9 Mar 2015 20:29:21 +0100 Subject: [PATCH] README --- README.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) diff --git a/README.md b/README.md index 9d70e76..4600f7c 100644 --- a/README.md +++ b/README.md @@ -3,4 +3,59 @@ CSV parser/generator A simple PHP library to parse and generate CSV files. +## Examples +### Generator + +```php +use Deblan\Csv\Csv; +use Deblan\Csv\Exception\CsvInvalidParameterException; + +try { + $csv = new Csv(); + + $csv->addLine(array('Foo', '$1000')); + $csv->addLine(array('Bar', '$600')); + + $result = $csv->compile(); +} catch(CsvInvalidParameterException $e) { + +} +``` + +```php +use Deblan\Csv\Csv; +use Deblan\Csv\Exception\CsvInvalidParameterException; + +try { + $csv = new Csv(); + + $csv->setLegend(array('product name', 'price')); + $csv->addLine(array('Foo', '$1000')); + $csv->addLine(array('Bar', '$600')); + + $csv->compileToFile('products.csv'); +} catch(CsvInvalidParameterException $e) { + +} +``` + +### Parser + +```php +use Deblan\Csv\Exception\CsvParserInvalidParameterException; +use Deblan\Csv\Exception\CsvParserException; + +try { + $csv = new CsvParser('products.csv'); + $csv->setHasLegend(true); + $csv->parse(); + + $legend = $csv->getLegend(); + $products = $csv->getDatas(); +} catch(CsvParserException $e) { + +} catch(CsvParserInvalidParameterException $e) { + +} +```