FileClient object can read from or write content to a file. And you can handle file read process for every line as you like by passing a callback or a closure to walk() method. This method is intended for database manipulation. For example, you can insert or update record from a read line.
To install FileClient with Composer just add the following to your composer.json file:
// composer.json
{
// ...
require: {
// ...
"satooshi/file-client": "dev-master"
}
}Then, you can install the new dependencies by running Composer’s update command from the directory where your composer.json file is located:
# install
$ php composer.phar install
# update
$ php composer.phar update satooshi/file-client
# or you can simply execute composer command if you set composer command to
# your PATH environment variable
$ composer install
$ composer update satooshi/file-clientPackagist page for this library is https://packagist.org/packages/satooshi/file-client
Or you can use git clone
# HTTP
$ git clone https://github.com/satooshi/FileClient.git
# SSH
$ git clone [email protected]:satooshi/FileClient.git<?php
use Contrib\Component\File\Client\Plain\FileReader;
// construction
$path = '/path/to/file';
$client = new FileReader($path);<?php
use Contrib\Component\File\Client\Plain\FileReader;
// default options
$options = array(
'newLine' => PHP_EOL,
'throwException' => true, // throw exception on runtime error
'autoDetectLineEnding' => true, // better line ending handling on Mac
);
// construct with options
$client = new FileReader($path, $options);<?php
use Contrib\Component\File\Client\Plain\FileReader;
$path = '/path/to/file';
$client = new FileReader($path);
// read
$content = $client->read();
$lines = $client->readLines();<?php
use Contrib\Component\File\Client\Plain\FileWriter;
$path = '/path/to/file';
$client = new FileWriter($path);
// write
$content = 'hello world!';
$client->write($content);
$lines = array(
'line1',
'line2',
);
$client->writeLines($lines);<?php
use Contrib\Component\File\Client\Plain\FileAppender;
$path = '/path/to/file';
$client = new FileAppender($path);
// append
$content = 'hello world!';
$client->write($content);
$lines = array(
'line1',
'line2',
);
$client->writeLines($lines);FileReaderIterator object can walk through read file.
<?php
use Contrib\Component\File\Client\Plain\FileReaderIterator;
// construction
$path = '/path/to/file';
$client = new FileReaderIterator($path);<?php
use Contrib\Component\File\Client\Plain\FileReaderIterator;
// default options
$options = array(
'newLine' => PHP_EOL,
'throwException' => true, // throw exception on runtime error
'autoDetectLineEnding' => true, // better line ending handling on Mac
'skipEmptyCount' => true,
'limit' => 0,
'offset' => 0,
);
// construct with options
$client = new FileReaderIterator($path, $options);<?php
use Contrib\Component\File\Client\Plain\FileReaderIterator;
// construction
$path = '/path/to/file';
$client = new FileReaderIterator($path);
// walk
$client->walk(
funtion ($line, $numLine) {
if ($numLine === 1) {
// do something at line 1
}
}
);Currently support json, xml, ltsv file format. Object serialization is also supported by Symfony Serializer component.
<?php
use Contrib\Component\File\Client\Generic\GenericFileReader;
// construction
$path = '/path/to/file';
$client = new GenericFileReader($path);<?php
use Contrib\Component\File\Client\Generic\GenericFileReader;
// default options
$options = array(
'newLine' => PHP_EOL,
'throwException' => true, // throw exception on runtime error
'autoDetectLineEnding' => true, // better line ending handling on Mac
);
// construct with options
$client = new GenericFileReader($path, $options);<?php
use Contrib\Component\File\Client\Generic\GenericFileReader;
$path = '/path/to/file';
$client = new GenericFileReader($path);
// read as json
$content = $client->readAs('json');
$lines = $client->readLinesAs('ltsv');
// read as json to object
$content = $client->readAs('json', 'Entity');
$lines = $client->readLinesAs('ltsv', 'Entity');<?php
use Contrib\Component\File\Client\Generic\GenericFileWriter;
$path = '/path/to/file';
$client = new GenericFileWriter($path);
// write Entity
$content = new Entity();
$client->writeAs($content);
$lines = array(
new Entity(),
new Entity(),
);
$client->writeLinesAs($lines);<?php
use Contrib\Component\File\Client\Generic\GenericFileAppender;
$path = '/path/to/file';
$client = new GenericFileAppender($path);
// append Entity
$content = new Entity();
$client->writeAs($content);
$lines = array(
new Entity(),
new Entity(),
);
$client->writeLinesAs($lines);<?php
use Contrib\Component\File\Client\Plain\GenericFileReaderIterator;
// construction
$path = '/path/to/file';
$client = new GenericFileReaderIterator($path);<?php
use Contrib\Component\File\Client\Plain\GenericFileReaderIterator;
// default options
$options = array(
'newLine' => PHP_EOL,
'throwException' => true, // throw exception on runtime error
'autoDetectLineEnding' => true, // better line ending handling on Mac
'skipEmptyCount' => true,
'limit' => 0,
'offset' => 0,
);
// construct with options
$client = new GenericFileReaderIterator($path, $options);<?php
use Contrib\Component\File\Client\Plain\GenericFileReaderIterator;
// construction
$path = '/path/to/file';
$client = new GenericFileReaderIterator($path);
// walk as json
$client->walkAs(
funtion ($line, $numLine) {
if ($numLine === 1) {
// do something at line 1
}
},
'json'
);
// walk as json to object
$client->walkAs(
funtion ($line, $numLine) {
if ($numLine === 1) {
// do something at line 1
}
},
'json',
'Entity'
);