CsvIterator

Many websites must read csv files, to import customer data, to read some custom settings, etc…

We will expand this class later to set the csv options from an xml config file or a database, but for now see examples below.

To read data from a csv file, we need a csv file first. We store the below data into the file “example.csv”.

HeadFoo,HeadBar,HeadIgnoreMe,HeadQuz
"somefoo here","some bar here","do not show me",42
"more foo","more bar","more to ignore",88

HeadFoo,HeadBar,HeadIgnoreMe,HeadQuz

"somefoo here","some bar here","do not show me",42

"more foo","more bar","more to ignore",88

The standard csv options are:

$length    = 0
$delimiter = ","
$enclosure = '"'
$escape    = "\\"
$headline  = true

$length = 0

$delimiter = ","

$enclosure = '"'

$escape = "\\"

$headline = true

Now we can read the data from the “example.csv”. Here are two examples to get the csv data from the file:
1. Foreach

&lt;?php $file = "example.csv"; $csvArray = array(); $csvIterator = new CsvIterator($file); foreach ($csvIterator as $key =&gt; $value) {
    $csvArray[$key] = $value;
}
var_dump($csvArray);

<?php $file = "example.csv"; $csvArray = array(); $csvIterator = new CsvIterator($file); foreach ($csvIterator as $key => $value) {

$csvArray[$key] = $value;

}

var_dump($csvArray);

Here is the ouput from the code above:

array(2) {
  [1]=&gt;
  array(4) {
    [0]=&gt;
    string(12) "somefoo here"
    [1]=&gt;
    string(13) "some bar here"
    [2]=&gt;
    string(14) "do not show me"
    [3]=&gt;
    string(2) "42"
  }
  [2]=&gt;
  array(4) {
    [0]=&gt;
    string(8) "more foo"
    [1]=&gt;
    string(8) "more bar"
    [2]=&gt;
    string(14) "more to ignore"
    [3]=&gt;
    string(2) "88"
  }
}

array(2) {

[1]=>

array(4) {

[0]=>

string(12) "somefoo here"

[1]=>

string(13) "some bar here"

[2]=>

string(14) "do not show me"

[3]=>

string(2) "42"

}

[2]=>

array(4) {

[0]=>

string(8) "more foo"

[1]=>

string(8) "more bar"

[2]=>

string(14) "more to ignore"

[3]=>

string(2) "88"

}

2. Get combined array

&lt;?php $file = "example.csv"; $structure = array('FOO', 'BAR', 'XXXX', 'QUZ'); $csvIterator = new CsvIterator($file); $csvIterator-&gt;setStructure($structure);
var_dump($csvIterator-&gt;getCombinedData());

1 2	<?php $file = "example.csv"; $structure = array('FOO', 'BAR', 'XXXX', 'QUZ'); $csvIterator = new CsvIterator($file); $csvIterator->setStructure($structure); var_dump($csvIterator->getCombinedData());

The output:

array(2) {
  [1]=&gt;
  array(3) {
    ["FOO"]=&gt;
    string(12) "somefoo here"
    ["BAR"]=&gt;
    string(13) "some bar here"
    ["QUZ"]=&gt;
    string(2) "42"
  }
  [2]=&gt;
  array(3) {
    ["FOO"]=&gt;
    string(8) "more foo"
    ["BAR"]=&gt;
    string(8) "more bar"
    ["QUZ"]=&gt;
    string(2) "88"
  }
}

array(2) {

[1]=>

array(3) {

["FOO"]=>

string(12) "somefoo here"

["BAR"]=>

string(13) "some bar here"

["QUZ"]=>

string(2) "42"

}

[2]=>

array(3) {

["FOO"]=>

string(8) "more foo"

["BAR"]=>

string(8) "more bar"

["QUZ"]=>

string(2) "88"

}

Demo

PROJECT_ROOT/vendor/PHPluz/CsvIterator.php

&lt;?php namespace PHPluz; use Iterator; use Monolog\Logger; /** * CsvIterator * * Simple class to read csv files * * Example standard: * $file = "example.csv"; * $csvArray = array(); * $csvIterator = new CsvIterator($file); * foreach ($csvIterator as $key =&gt; $value) {
 *          $csvArray[$key] = $value;
 *      }
 *      var_dump($csvArray);
 * Example with array combine:
 *      $file        = "example.csv";
 *      $structure   = array('FOO', 'BAR', 'XXXX', 'QUZ');
 *      $csvIterator = new CsvIterator($file);
 *      $csvIterator-&gt;setStructure($structure);
 *      var_dump($csvIterator-&gt;getCombinedData());
 *
 * @package    PHPluz
 *
 * @author     Janis Jekabsons &lt;php@pluz.de&gt;
 * @copyright  2016 Janis Jekabsons
 * @license    https://opensource.org/licenses/MIT (MIT)
 * @version    1.0
 */
class CsvIterator implements Iterator
{
    /** @var int $length */
    private $length;
    /** @var string $delimiter */
    private $delimiter;
    /** @var string $enclosure */
    private $enclosure;
    /** @var string $escape */
    private $escape;
    /** @var bool $headline */
    private $headline;
    /** @var \Monolog\Logger $logger */
    private $logger;
    /** @var array $structure */
    private $structure;
    /** @var resource $filePointer fopen handler */
    protected $filePointer;
    /** @var int $key Current row in file */
    protected $key = 0;
    /** @var mixed $current Data row */
    protected $current;

    /**
     * CsvFileIterator constructor.
     * Initialize variables, checks file exist and permission
     * and opens the file.
     *
     * @param string $file Full path to file
     */
    public function __construct($file)
    {
        $this-&gt;logger = new Logger("CsvIterator");
        $this-&gt;logger-&gt;pushHandler(Functions::getLoggerStreamHandler());
        // remove BOM when exists
        if (! Functions::removeBOM($file, $this-&gt;logger)) {
            // throw exception or do what ever you want ;)
        }
        $this-&gt;setStandardCsvOptions();
        // open file
        $this-&gt;filePointer = fopen($file, 'r');
        // get file info
        $fileInfo = pathinfo($file);
        $this-&gt;logger-&gt;addDebug("The file ({$fileInfo['basename']}) was opened.");
    }

    /**
     * Destructor to close file
     */
    public function __destruct()
    {
        fclose($this-&gt;filePointer);
        $this-&gt;logger-&gt;addDebug("The file was closed.");
    }

    /**
     * Return the current element
     *
     * @link  http://php.net/manual/en/iterator.current.php
     * @since 5.0.0
     *
     * @return mixed Can return any type.
     */
    public function current()
    {
        if ($this-&gt;checkHeadline()) {
            $this-&gt;next();
        }
        $this-&gt;logger-&gt;addDebug("Returns the current element.");

        return $this-&gt;current;
    }

    /**
     * Move forward to next element
     *
     * @link  http://php.net/manual/en/iterator.next.php
     * @since 5.0.0
     *
     * @return void Any returned value is ignored.
     */
    public function next()
    {
        $this-&gt;logger-&gt;addDebug("Move forward to next element.");
        $this-&gt;current = fgetcsv($this-&gt;filePointer, $this-&gt;length, $this-&gt;delimiter, $this-&gt;enclosure, $this-&gt;escape);
        $this-&gt;key++;
    }

    /**
     * Return the key of the current element
     *
     * @link  http://php.net/manual/en/iterator.key.php
     * @since 5.0.0
     *
     * @return mixed scalar on success, or null on failure.
     */
    public function key()
    {
        $this-&gt;logger-&gt;addDebug("Returns the key of the current element.");

        return $this-&gt;key;
    }

    /**
     * Checks if current position is valid
     *
     * @link  http://php.net/manual/en/iterator.valid.php
     * @since 5.0.0
     *
     * @return bool The return value will be casted to bool and then evaluated.
     *                 Returns true on success or false on failure.
     */
    public function valid()
    {
        $this-&gt;logger-&gt;addDebug("Checks if the current position is allowed.");

        return ! feof($this-&gt;filePointer);
    }

    /**
     * Rewind the Iterator to the first element
     *
     * @link  http://php.net/manual/en/iterator.rewind.php
     * @since 5.0.0
     *
     * @return void Any returned value is ignored.
     */
    public function rewind()
    {
        $this-&gt;logger-&gt;addDebug("Rewind the Iterator to the first element.");
        rewind($this-&gt;filePointer);
        $this-&gt;current = fgetcsv($this-&gt;filePointer, $this-&gt;length, $this-&gt;delimiter, $this-&gt;enclosure, $this-&gt;escape);
        $this-&gt;key     = 0;
    }

    /**
     * Function setCsvOptions
     *
     * When no parameters given then standard values are assigned.
     *
     * Possible options:
     *      int    $length    = 0
     *      string $delimiter = ","
     *      string $enclosure = '"'
     *      string $escape    = "\\"
     *      bool   $headline  = true
     *
     * Example:
     *      $file        = "example.csv";
     *      $csvIterator = new CsvIterator($file);
     *      $csvIterator-&gt;setCsvOptions(array(
     *          'length'    =&gt; 1024,
     *          'delimiter' =&gt; ';',
     *          'enclosure' =&gt; '"',
     *          'escape'    =&gt; '\\',
     *          'headline'  =&gt; false
     *      ));
     */
    public function setCsvOptions()
    {
        $this-&gt;logger-&gt;addDebug("Set custom csv options:");
        if (func_num_args() === 1) {
            $options = func_get_args();
            if (! empty($options[0]['length'])) {
                $this-&gt;length = (int)$options[0]['length'];
                $this-&gt;logger-&gt;addDebug("length = {$this-&gt;length}");
            }
            if (! empty($options[0]['delimiter'])) {
                $this-&gt;delimiter = $options[0]['delimiter'];
                $this-&gt;logger-&gt;addDebug("delimiter = {$this-&gt;delimiter}");
            }
            if (! empty($options[0]['enclosure'])) {
                $this-&gt;enclosure = $options[0]['enclosure'];
                $this-&gt;logger-&gt;addDebug("enclosure = {$this-&gt;enclosure}");
            }
            if (! empty($options[0]['escape'])) {
                $this-&gt;escape = $options[0]['escape'];
                $this-&gt;logger-&gt;addDebug("escape = {$this-&gt;escape}");
            }
            if (! empty($options[0]['headline'])) {
                $this-&gt;headline = (bool)$options[0]['headline'];
                $this-&gt;logger-&gt;addDebug("headline = {$this-&gt;headline}");
            }
        }
    }

    /**
     * Function setStandardCsvOptions
     */
    private function setStandardCsvOptions()
    {
        $this-&gt;logger-&gt;addDebug("Set standard csv options:");
        $this-&gt;length = 0;
        $this-&gt;logger-&gt;addDebug("length = {$this-&gt;length}");
        $this-&gt;delimiter = ",";
        $this-&gt;logger-&gt;addDebug("delimiter = {$this-&gt;delimiter}");
        $this-&gt;enclosure = '"';
        $this-&gt;logger-&gt;addDebug("enclosure = {$this-&gt;enclosure}");
        $this-&gt;escape = "\\";
        $this-&gt;logger-&gt;addDebug("escape = {$this-&gt;escape}");
        $this-&gt;headline = true;
        $this-&gt;logger-&gt;addDebug("headline = {$this-&gt;headline}");
    }

    /**
     * Set a the structure for the csv. Needed when you want to combine
     * the structure with the csv values.
     *
     * @param array $structure Structure of the csv data
     */
    public function setStructure(array $structure)
    {
        $this-&gt;logger-&gt;addDebug("Set csv structure.");
        $this-&gt;structure = $structure;
    }

    /**
     * Function getCombinedCsvData
     * Combines specified structure (key) and data structure (value)
     *
     * you can ignore columns when you set them to 'XXXX' in the structure
     *
     * Example:
     *      Specified: array('FOO', 'BAR', 'XXXX', 'QUZ')
     *      Data:      array('some foo', 'some bar', 'whatever', 'some quz')
     *      Combined:  array('FOO' =&gt; 'some foo', 'BAR' =&gt; 'some bar', 'QUZ' =&gt; 'some quz')
     *
     * @param bool $removeEmpty When true empty values are removed from the array
     *
     * @return array Combined array
     */
    public function getCombinedData($removeEmpty = false)
    {
        $response = array();
        $this-&gt;logger-&gt;addDebug("Start combine data and structure.");
        foreach ($this as $row =&gt; $data) {
            if ($this-&gt;checkHeadline()) {
                continue;
            }
            $countCsv  = count($this-&gt;structure);
            $countData = count($data);
            if ($countCsv !== $countData) {
                $this-&gt;logger-&gt;addWarning("Structure at row ({$this-&gt;key}) not equal specified structure, row will be skipped. Expected ({$countCsv}) got ({$countData}) elements.");
                continue;
            }
            $response[$this-&gt;key] = array_combine($this-&gt;structure, $data);
            $removeEmpty ? $response[$this-&gt;key] = Functions::removeEmpty($response[$this-&gt;key]) : null;
            unset($response[$this-&gt;key]['XXXX']);
        }
        $this-&gt;logger-&gt;addDebug("Finished combine data and structure.");

        return $response;
    }

    /**
     * When headline is set to true and we are at the first line (headline)
     * then return true so you can skip the headline.
     *
     * @return bool
     */
    private function checkHeadline()
    {
        if ($this-&gt;key === 0 &amp;&amp; $this-&gt;headline === true) {
            $this-&gt;logger-&gt;addDebug("Headline skipped.");
            return true;
        }

        return false;
    }
}

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

<?php namespace PHPluz; use Iterator; use Monolog\Logger; /** * CsvIterator * * Simple class to read csv files * * Example standard: * $file = "example.csv"; * $csvArray = array(); * $csvIterator = new CsvIterator($file); * foreach ($csvIterator as $key => $value) {

* $csvArray[$key] = $value;

* }

* var_dump($csvArray);

* Example with array combine:

* $file = "example.csv";

* $structure = array('FOO', 'BAR', 'XXXX', 'QUZ');

* $csvIterator = new CsvIterator($file);

* $csvIterator->setStructure($structure);

* var_dump($csvIterator->getCombinedData());

* @package PHPluz

* @author Janis Jekabsons <php@pluz.de>

* @license https://opensource.org/licenses/MIT (MIT)

* @version 1.0

class CsvIterator implements Iterator

{

/** @var int $length */

private $length;

/** @var string $delimiter */

private $delimiter;

/** @var string $enclosure */

private $enclosure;

/** @var string $escape */

private $escape;

/** @var bool $headline */

private $headline;

/** @var \Monolog\Logger $logger */

private $logger;

/** @var array $structure */

private $structure;

/** @var resource $filePointer fopen handler */

protected $filePointer;

/** @var int $key Current row in file */

protected $key = 0;

/** @var mixed $current Data row */

protected $current;

/**

* CsvFileIterator constructor.

* Initialize variables, checks file exist and permission

* and opens the file.

* @param string $file Full path to file

public function __construct($file)

{

$this->logger = new Logger("CsvIterator");

$this->logger->pushHandler(Functions::getLoggerStreamHandler());

// remove BOM when exists

if (! Functions::removeBOM($file, $this->logger)) {

// throw exception or do what ever you want ;)

}

$this->setStandardCsvOptions();

// open file

$this->filePointer = fopen($file, 'r');

// get file info

$fileInfo = pathinfo($file);

$this->logger->addDebug("The file ({$fileInfo['basename']}) was opened.");

}

/**

* Destructor to close file

public function __destruct()

{

fclose($this->filePointer);

$this->logger->addDebug("The file was closed.");

}

/**

* Return the current element

* @link http://php.net/manual/en/iterator.current.php

* @since 5.0.0

* @return mixed Can return any type.

public function current()

{

if ($this->checkHeadline()) {

$this->next();

}

$this->logger->addDebug("Returns the current element.");

return $this->current;

}

/**

* Move forward to next element

* @link http://php.net/manual/en/iterator.next.php

* @since 5.0.0

* @return void Any returned value is ignored.

public function next()

{

$this->logger->addDebug("Move forward to next element.");

$this->current = fgetcsv($this->filePointer, $this->length, $this->delimiter, $this->enclosure, $this->escape);

$this->key++;

}

/**

* Return the key of the current element

* @link http://php.net/manual/en/iterator.key.php

* @since 5.0.0

* @return mixed scalar on success, or null on failure.

public function key()

{

$this->logger->addDebug("Returns the key of the current element.");

return $this->key;

}

/**

* Checks if current position is valid

* @link http://php.net/manual/en/iterator.valid.php

* @since 5.0.0

* @return bool The return value will be casted to bool and then evaluated.

* Returns true on success or false on failure.

public function valid()

{

$this->logger->addDebug("Checks if the current position is allowed.");

return ! feof($this->filePointer);

}

/**

* Rewind the Iterator to the first element

* @link http://php.net/manual/en/iterator.rewind.php

* @since 5.0.0

* @return void Any returned value is ignored.

public function rewind()

{

$this->logger->addDebug("Rewind the Iterator to the first element.");

rewind($this->filePointer);

$this->current = fgetcsv($this->filePointer, $this->length, $this->delimiter, $this->enclosure, $this->escape);

$this->key = 0;

}

/**

* Function setCsvOptions

* When no parameters given then standard values are assigned.

* Possible options:

* int $length = 0

* string $delimiter = ","

* string $enclosure = '"'

* string $escape = "\\"

* bool $headline = true

* Example:

* $file = "example.csv";

* $csvIterator = new CsvIterator($file);

* $csvIterator->setCsvOptions(array(

* 'length' => 1024,

* 'delimiter' => ';',

* 'enclosure' => '"',

* 'escape' => '\\',

* 'headline' => false

* ));

public function setCsvOptions()

{

$this->logger->addDebug("Set custom csv options:");

if (func_num_args() === 1) {

$options = func_get_args();

if (! empty($options[0]['length'])) {

$this->length = (int)$options[0]['length'];

$this->logger->addDebug("length = {$this->length}");

}

if (! empty($options[0]['delimiter'])) {

$this->delimiter = $options[0]['delimiter'];

$this->logger->addDebug("delimiter = {$this->delimiter}");

}

if (! empty($options[0]['enclosure'])) {

$this->enclosure = $options[0]['enclosure'];

$this->logger->addDebug("enclosure = {$this->enclosure}");

}

if (! empty($options[0]['escape'])) {

$this->escape = $options[0]['escape'];

$this->logger->addDebug("escape = {$this->escape}");

}

if (! empty($options[0]['headline'])) {

$this->headline = (bool)$options[0]['headline'];

$this->logger->addDebug("headline = {$this->headline}");

}

/**

* Function setStandardCsvOptions

private function setStandardCsvOptions()

{

$this->logger->addDebug("Set standard csv options:");

$this->length = 0;

$this->logger->addDebug("length = {$this->length}");

$this->delimiter = ",";

$this->logger->addDebug("delimiter = {$this->delimiter}");

$this->enclosure = '"';

$this->logger->addDebug("enclosure = {$this->enclosure}");

$this->escape = "\\";

$this->logger->addDebug("escape = {$this->escape}");

$this->headline = true;

$this->logger->addDebug("headline = {$this->headline}");

}

/**

* Set a the structure for the csv. Needed when you want to combine

* the structure with the csv values.

* @param array $structure Structure of the csv data

public function setStructure(array $structure)

{

$this->logger->addDebug("Set csv structure.");

$this->structure = $structure;

}

/**

* Function getCombinedCsvData

* Combines specified structure (key) and data structure (value)

* you can ignore columns when you set them to 'XXXX' in the structure

* Example:

* Specified: array('FOO', 'BAR', 'XXXX', 'QUZ')

* Data: array('some foo', 'some bar', 'whatever', 'some quz')

* Combined: array('FOO' => 'some foo', 'BAR' => 'some bar', 'QUZ' => 'some quz')

* @param bool $removeEmpty When true empty values are removed from the array

* @return array Combined array

public function getCombinedData($removeEmpty = false)

{

$response = array();

$this->logger->addDebug("Start combine data and structure.");

foreach ($this as $row => $data) {

if ($this->checkHeadline()) {

continue;

}

$countCsv = count($this->structure);

$countData = count($data);

if ($countCsv !== $countData) {

$this->logger->addWarning("Structure at row ({$this->key}) not equal specified structure, row will be skipped. Expected ({$countCsv}) got ({$countData}) elements.");

continue;

}

$response[$this->key] = array_combine($this->structure, $data);

$removeEmpty ? $response[$this->key] = Functions::removeEmpty($response[$this->key]) : null;

unset($response[$this->key]['XXXX']);

}

$this->logger->addDebug("Finished combine data and structure.");

return $response;

}

/**

* When headline is set to true and we are at the first line (headline)

* then return true so you can skip the headline.

* @return bool

private function checkHeadline()

{

if ($this->key === 0 && $this->headline === true) {

$this->logger->addDebug("Headline skipped.");

return true;

}

return false;

}

PHPluz

collection, library, compilation

CsvIterator

Like this:

Related

Leave a Reply Cancel reply

Share:

Like this:

Related

Leave a Reply Cancel reply