File Records/RecordSetIterator.php

 1  2  3  4  5  6  7  8  9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61

<?php
namespace Gedcomx\Records;

use Gedcomx\Gedcomx;

/**
 * Use this class to iterate over a large set of records in order to avoid large memory and cpu consumption
 *
 * Class RecordSetIterator
 * @package Gedcomx\Records
 */
class RecordSetIterator
{

    const RECORD_NODE_NAME = 'record';

    /**
     * @var \XMLReader
     */
    private $xmlReader;

    /**
     * @param \XMLReader $xmlReader
     */
    public function __construct(\XMLReader $xmlReader)
    {
        $this->xmlReader = $xmlReader;
        $this->nextNode($xmlReader);
    }

    /**
     * @param bool $asString - true - return xml as string, false - return as Gedcomx object
     * @return Gedcomx|null|string - null when there are no more records
     */
    public function nextRecord($asString)
    {
        $xmlReader = $this->xmlReader;
        if ($xmlReader->name !== self::RECORD_NODE_NAME) {
            return null;
        }
        $record = $xmlReader->readOuterXml();
        $xmlReader->next(self::RECORD_NODE_NAME);
        if (!$asString) {
            $tempXmlReader = new \XMLReader();
            $tempXmlReader->XML($record);
            $record = new Gedcomx($tempXmlReader);
        }
        return $record;

    }

    /**
     * @param \XMLReader $xmlReader
     */
    private function nextNode(\XMLReader $xmlReader)
    {
        while ($xmlReader->read() && $xmlReader->name !== self::RECORD_NODE_NAME) {}
    }

}

Namespaces

Classes

Interfaces

Exceptions