Excel Class Reference

Public Member Functions
	__construct (\Iterator $iterator, $rowCallback=[])
	setDataHeader ($data)
	setDataFooter ($data)
	convert ($sheetName='')
	write (WriteInterface $stream, $sheetName='')

Protected Member Functions
	_getXmlHeader ($sheetName='')
	_getXmlFooter ()

Protected Attributes
	$_iterator = null
	$_rowCallback = []
	$_dataHeader = []
	$_dataFooter = []

Detailed Description

Convert the data to XML Excel

Definition at line 13 of file Excel.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Iterator	$iterator,
			$rowCallback = []
	)

Class Constructor

Parameters

\Iterator	$iterator
array	$rowCallback

Definition at line 49 of file Excel.php.

    {
        $this->_iterator = $iterator;
        $this->_rowCallback = $rowCallback;
    }

Member Function Documentation

_getXmlFooter()

_getXmlFooter ( )

protected

Retrieve Excel XML Document Footer XML Fragment Append data footer if it is available

Returns

string

Definition at line 105 of file Excel.php.

    {
        $xmlFooter = '';

        if ($this->_dataFooter) {
            $xmlFooter = $this->_getXmlRow($this->_dataFooter, false);
        }

        $xmlFooter .= '</Table></Worksheet></Workbook>';

        return $xmlFooter;
    }

_getXmlHeader()

_getXmlHeader (   $sheetName = '' )

protected

Retrieve Excel XML Document Header XML Fragment Append data header if it is available

Parameters

string

$sheetName

Returns

string

Definition at line 62 of file Excel.php.

    {
        if (empty($sheetName)) {
            $sheetName = 'Sheet 1';
        }

        $sheetName = htmlspecialchars($sheetName);

        $xmlHeader = '<' .
            '?xml version="1.0"?' .
            '><' .
            '?mso-application progid="Excel.Sheet"?' .
            '><Workbook' .
            ' xmlns="urn:schemas-microsoft-com:office:spreadsheet"' .
            ' xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"' .
            ' xmlns:x="urn:schemas-microsoft-com:office:excel"' .
            ' xmlns:x2="http://schemas.microsoft.com/office/excel/2003/xml"' .
            ' xmlns:ss="urn:schemas-microsoft-com:office:spreadsheet"' .
            ' xmlns:o="urn:schemas-microsoft-com:office:office"' .
            ' xmlns:html="http://www.w3.org/TR/REC-html40"' .
            ' xmlns:c="urn:schemas-microsoft-com:office:component:spreadsheet">' .
            '<OfficeDocumentSettings xmlns="urn:schemas-microsoft-com:office:office">' .
            '</OfficeDocumentSettings>' .
            '<ExcelWorkbook xmlns="urn:schemas-microsoft-com:office:excel">' .
            '</ExcelWorkbook>' .
            '<Worksheet ss:Name="' .
            $sheetName .
            '">' .
            '<Table>';

        if ($this->_dataHeader) {
            $xmlHeader .= $this->_getXmlRow($this->_dataHeader, false);
        }

        return $xmlHeader;
    }

convert()

convert

(

$sheetName = ''

)

Convert Data to Excel XML Document

Parameters

string

$sheetName

Returns

string

Definition at line 192 of file Excel.php.

    {
        $xml = $this->_getXmlHeader($sheetName);

        foreach ($this->_iterator as $dataRow) {
            $xml .= $this->_getXmlRow($dataRow, true);
        }
        $xml .= $this->_getXmlFooter();

        return $xml;
    }

setDataFooter()

setDataFooter

(

$data

)

Set Data Footer

Parameters

array

$data

Returns

void

Definition at line 181 of file Excel.php.

    {
        $this->_dataFooter = $data;
    }

setDataHeader()

setDataHeader

(

$data

)

Set Data Header

Parameters

array

$data

Returns

void

Definition at line 170 of file Excel.php.

    {
        $this->_dataHeader = $data;
    }

write()

write	(	WriteInterface	$stream,
			$sheetName = ''
	)

Write Converted XML Data to Temporary File

Parameters

WriteInterface	$stream
string	$sheetName

Returns

void

Definition at line 211 of file Excel.php.

    {
        $stream->write($this->_getXmlHeader($sheetName));

        foreach ($this->_iterator as $dataRow) {
            $stream->write($this->_getXmlRow($dataRow, true));
        }
        $stream->write($this->_getXmlFooter());
    }

Field Documentation

$_dataFooter

$_dataFooter = []

protected

Definition at line 41 of file Excel.php.

$_dataHeader

$_dataHeader = []

protected

Definition at line 34 of file Excel.php.

$_iterator

$_iterator = null

protected

Definition at line 20 of file Excel.php.

$_rowCallback

$_rowCallback = []

protected

Definition at line 27 of file Excel.php.

---

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

• vendor/magento/framework/Convert/Excel.php