ExcelTest Class Reference

Inheritance diagram for ExcelTest:

Public Member Functions
	callbackMethod ($row)
	testConvert ()
	testConvertCallback ()
	testWrite ()
	testWriteCallback ()

Protected Member Functions
	_getSampleOutputFile ()
	_writeFile ($callback=false)

Protected Attributes
	$_testHeader
	$_testFooter

Detailed Description

Definition at line 12 of file ExcelTest.php.

Member Function Documentation

_getSampleOutputFile()

_getSampleOutputFile ( )

protected

Path for Sample File

Returns

string

Definition at line 45 of file ExcelTest.php.

    {
        return __DIR__ . '/_files/sample.xml';
    }

_writeFile()

_writeFile (   $callback = false )

protected

Write Data into File

Parameters

bool

$callback

Returns

string

Definition at line 103 of file ExcelTest.php.

    {
        $name = md5(microtime());
        $file = TESTS_TEMP_DIR . '/' . $name . '.xml';

        $stream = new \Magento\Framework\Filesystem\File\Write(
            $file,
            new \Magento\Framework\Filesystem\Driver\File(),
            'w+'
        );
        $stream->lock();

        if (!$callback) {
            $convert = new \Magento\Framework\Convert\Excel(new \ArrayIterator($this->_testData));
            $convert->setDataHeader($this->_testHeader);
            $convert->setDataFooter($this->_testFooter);
        } else {
            $convert = new \Magento\Framework\Convert\Excel(
                new \ArrayIterator($this->_testData),
                [$this, 'callbackMethod']
            );
        }

        $convert->write($stream);
        $stream->unlock();
        $stream->close();

        return $file;
    }

callbackMethod()

callbackMethod

(

$row

)

Callback method

Parameters

array

$row

Returns

array

Definition at line 56 of file ExcelTest.php.

    {
        $data = [];
        foreach ($row as $value) {
            $data[] = $value . '_TRUE_';
        }
        return $data;
    }

testConvert()

testConvert

(

)

Test \Magento\Framework\Convert\Excel->convert() \Magento\Framework\Convert\Excel($iterator)

Returns

void

Definition at line 71 of file ExcelTest.php.

    {
        $convert = new \Magento\Framework\Convert\Excel(new \ArrayIterator($this->_testData));
        $convert->setDataHeader($this->_testHeader);
        $convert->setDataFooter($this->_testFooter);
        $this->assertXmlStringEqualsXmlString(
            file_get_contents($this->_getSampleOutputFile()),
            $convert->convert()
        );
    }

testConvertCallback()

testConvertCallback

(

)

Test \Magento\Framework\Convert\Excel->convert() \Magento\Framework\Convert\Excel($iterator, $callbackMethod)

Returns

void

Definition at line 88 of file ExcelTest.php.

    {
        $convert = new \Magento\Framework\Convert\Excel(
            new \ArrayIterator($this->_testData),
            [$this, 'callbackMethod']
        );
        $this->assertContains('_TRUE_', $convert->convert(), 'Failed asserting that callback method is called.');
    }

testWrite()

testWrite

(

)

Test \Magento\Framework\Convert\Excel->write() \Magento\Framework\Convert\Excel($iterator)

Returns

void

Definition at line 139 of file ExcelTest.php.

    {
        $file = $this->_writeFile();
        $this->assertXmlStringEqualsXmlString(
            file_get_contents($this->_getSampleOutputFile()),
            file_get_contents($file)
        );
    }

testWriteCallback()

testWriteCallback

(

)

Test \Magento\Framework\Convert\Excel->write() \Magento\Framework\Convert\Excel($iterator, $callbackMethod)

Returns

void

Definition at line 154 of file ExcelTest.php.

    {
        $file = $this->_writeFile(true);
        $this->assertContains('_TRUE_', file_get_contents($file), 'Failed asserting that callback method is called.');
    }

Field Documentation

$_testFooter

$_testFooter

protected

Initial value:

= [
        'FooterID', 'FooterName', 'FooterEmail', 'FooterGroup', 'FooterPhone', 'Footer+Phone', 'FooterZIP',
        'Footer0ZIP', 'FooterCountry', 'FooterRegion', 'FooterSymbol=', 'FooterSymbol-', 'FooterSymbol+'
    ]

Definition at line 35 of file ExcelTest.php.

$_testHeader

$_testHeader

protected

Initial value:

= [
        'HeaderID', 'HeaderName', 'HeaderEmail', 'HeaderGroup', 'HeaderPhone', 'Header+Phone', 'HeaderZIP',
        'Header0ZIP', 'HeaderCountry', 'HeaderRegion', 'HeaderSymbol=', 'HeaderSymbol-', 'HeaderSymbol+'
    ]

Definition at line 30 of file ExcelTest.php.

---

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

• vendor/magento/framework/Convert/Test/Unit/ExcelTest.php