diff options
| author | Ignace Nyamagana Butera <nyamsprod@gmail.com> | 2013-12-03 11:01:28 +0100 |
|---|---|---|
| committer | Ignace Nyamagana Butera <nyamsprod@gmail.com> | 2013-12-03 11:01:28 +0100 |
| commit | a6111a2375defaa8a8f5c76b4f3fe8b4a7ce6bbe (patch) | |
| tree | b9290e2284165810a99925b6b676fab728e46ac4 | |
| parent | 8546e8edcf4422b78dec99f7b8bec1c67ecddb67 (diff) | |
| download | csv-a6111a2375defaa8a8f5c76b4f3fe8b4a7ce6bbe.zip csv-a6111a2375defaa8a8f5c76b4f3fe8b4a7ce6bbe.tar.gz csv-a6111a2375defaa8a8f5c76b4f3fe8b4a7ce6bbe.tar.bz2 | |
Update Documentation
| -rw-r--r-- | README.md | 8 |
1 files changed, 5 insertions, 3 deletions
@@ -26,7 +26,7 @@ You may install the Bakame Url package with Composer (recommended) or manually. System Requirements ------- -You need **PHP >= 5.4.0** to use Bakame Csv but the latest stable version of PHP is recommended. +You need **PHP >= 5.4.0** and the `mbstring` extension to use `Bakame\Csv` but the latest stable version of PHP is recommended. Instantiation ------- @@ -36,7 +36,8 @@ The easiest way to get started is to add `'/path/to/Bakame/Csv/src'` to your PSR Usage ------- -The wrapper serves 2 main functions, loading and saving data in CSV formats. To do that, the wrapper will always returns a SplFileObject instance with flags set to SplFileObject::READ_CSV so that you can use it to further manipulate your data. +The wrapper serves 2 main functions loading and saving data in CSV formats. To do that, the wrapper always returns a `SplFileObject` instance with flags set to `SplFileObject::READ_CSV` so that you can use it to further manipulate your data. +Of course, since a `SplFileObject` is returned you are free to modify the flags to satisfy your application needs. ```php <?php @@ -64,8 +65,9 @@ The method accepts: The path to where the data must saved can be given as: * a simple string -* an splFileInfo instance +* an `SplFileInfo` instance +If for any reason the ```php |