testDataFileIterator Class Reference

Inheritance diagram for testDataFileIterator:

Collaboration diagram for testDataFileIterator:

Public Member Functions
	__construct ($file)
	__destruct ()
	rewind ()
	valid ()
	key ()
	current ()
	next ()

Protected Attributes
	$file
	$key = 0
	$current

Private Member Functions
	_parseNextDataset ()
	_getcsv ($input, $delimiter, $enclosure)
	_parseDataValue ($dataValue)

Detailed Description

Definition at line 3 of file testDataFileIterator.php.

Constructor & Destructor Documentation

__construct()

testDataFileIterator::__construct

(

$file

)

Definition at line 10 of file testDataFileIterator.php.

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

References $file.

__destruct()

testDataFileIterator::__destruct

(

)

Definition at line 15 of file testDataFileIterator.php.

    {
        fclose($this->file);
    }

Member Function Documentation

_getcsv()

testDataFileIterator::_getcsv (   $input,   $delimiter,   $enclosure  )

private

Definition at line 69 of file testDataFileIterator.php.

    {
        if (function_exists('str_getcsv')) {
            return str_getcsv($input, $delimiter, $enclosure);
        }
 
        $temp = fopen('php://memory', 'rw');
        fwrite($temp, $input);
        rewind($temp);
        $data = fgetcsv($temp, strlen($input), $delimiter, $enclosure);
        fclose($temp);
 
        if ($data === false) {
            $data = array(null);
        }
 
        return $data;
    }

References $data, and rewind().

Referenced by _parseNextDataset().

Here is the call graph for this function:

Here is the caller graph for this function:

_parseDataValue()

testDataFileIterator::_parseDataValue (   $dataValue )

private

Definition at line 88 of file testDataFileIterator.php.

                                                 {
        //    discard any white space
        $dataValue = trim($dataValue);
        //    test for the required datatype and convert accordingly
        if (!is_numeric($dataValue)) {
            if($dataValue == '') {
                $dataValue = NULL;
            } elseif($dataValue == '""') {
                $dataValue = '';
            } elseif(($dataValue[0] == '"') && ($dataValue[strlen($dataValue)-1] == '"')) {
                $dataValue = substr($dataValue,1,-1);
            } elseif(($dataValue[0] == '{') && ($dataValue[strlen($dataValue)-1] == '}')) {
                $dataValue = explode(';',substr($dataValue,1,-1));
                foreach($dataValue as &$dataRow) {
                    if (strpos($dataRow,'|') !== FALSE) {
                        $dataRow = explode('|',$dataRow);
                        foreach($dataRow as &$dataCell) {
                            $dataCell = $this->_parseDataValue($dataCell);
                        }
                        unset($dataCell);
                    } else {
                        $dataRow = $this->_parseDataValue($dataRow);
                    }
                }
                unset($dataRow);
            } else {
                switch (strtoupper($dataValue)) {
                    case 'NULL' :  $dataValue = NULL; break;
                    case 'TRUE' :  $dataValue = TRUE; break;
                    case 'FALSE' : $dataValue = FALSE; break;
                }
            }
        } else {
            if (strpos($dataValue,'.') !== FALSE) {
                $dataValue = (float) $dataValue;
            } else {
                $dataValue = (int) $dataValue;
            }
        }
 
                return $dataValue;
    }

References _parseDataValue().

Referenced by _parseDataValue(), and _parseNextDataset().

Here is the call graph for this function:

Here is the caller graph for this function:

_parseNextDataset()

testDataFileIterator::_parseNextDataset ( )

private

Definition at line 48 of file testDataFileIterator.php.

    {
        //    Read a line of test data from the file
        do {
            //    Only take lines that contain test data and that aren't commented out
            $testDataRow = trim(fgets($this->file));
        } while (($testDataRow > '') && ($testDataRow{0} === '#'));
 
        //    Discard any comments at the end of the line
        list($testData) = explode('//',$testDataRow);
 
        //    Split data into an array of individual values and a result
        $dataSet = $this->_getcsv($testData, ',', "'");
        foreach($dataSet as &$dataValue) {
            $dataValue = $this->_parseDataValue($dataValue);
        }
        unset($dataValue);
 
        return $dataSet;
    }

References _getcsv(), and _parseDataValue().

Referenced by next(), and rewind().

Here is the call graph for this function:

Here is the caller graph for this function:

current()

testDataFileIterator::current

(

)

Definition at line 37 of file testDataFileIterator.php.

    {
        return $this->current;
    }

References $current.

Referenced by next(), and rewind().

Here is the caller graph for this function:

key()

testDataFileIterator::key

(

)

Definition at line 32 of file testDataFileIterator.php.

    {
        return $this->key;
    }

References $key.

Referenced by next(), and rewind().

Here is the caller graph for this function:

next()

testDataFileIterator::next

(

)

Definition at line 42 of file testDataFileIterator.php.

    {
        $this->current = $this->_parseNextDataset();
        $this->key++;
    }

References _parseNextDataset(), current(), and key().

Here is the call graph for this function:

rewind()

testDataFileIterator::rewind

(

)

Definition at line 20 of file testDataFileIterator.php.

    {
        rewind($this->file);
        $this->current = $this->_parseNextDataset();
        $this->key = 0;
    }

References _parseNextDataset(), current(), key(), and rewind().

Referenced by _getcsv(), and rewind().

Here is the call graph for this function:

Here is the caller graph for this function:

valid()

testDataFileIterator::valid

(

)

Definition at line 27 of file testDataFileIterator.php.

    {
        return !feof($this->file);
    }

Field Documentation

$current

testDataFileIterator::$current

protected

Definition at line 8 of file testDataFileIterator.php.

Referenced by current().

$file

testDataFileIterator::$file

protected

Definition at line 6 of file testDataFileIterator.php.

Referenced by __construct().

$key

testDataFileIterator::$key = 0

protected

Definition at line 7 of file testDataFileIterator.php.

Referenced by key().

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/phpoffice/phpexcel/unitTests/testDataFileIterator.php