PHPExcel_Shared_XMLWriter Class Reference

Inheritance diagram for PHPExcel_Shared_XMLWriter:

Collaboration diagram for PHPExcel_Shared_XMLWriter:

Public Member Functions
	__construct ($pTemporaryStorage=self::STORAGE_MEMORY, $pTemporaryStorageFolder=NULL)
	Create a new PHPExcel_Shared_XMLWriter instance. More...
	__destruct ()
	Destructor. More...
	getData ()
	Get written data. More...
	writeRawData ($text)
	Fallback method for writeRaw, introduced in PHP 5.2. More...

Data Fields
const	STORAGE_MEMORY = 1
	Temporary storage method. More...
const	STORAGE_DISK = 2

Private Attributes
	$_tempFileName = ''

Detailed Description

Definition at line 44 of file XMLWriter.php.

Constructor & Destructor Documentation

__construct()

PHPExcel_Shared_XMLWriter::__construct	(		$pTemporaryStorage = self::STORAGE_MEMORY,
			$pTemporaryStorageFolder = NULL
	)

Create a new PHPExcel_Shared_XMLWriter instance.

Parameters

int	$pTemporaryStorage	Temporary storage location
string	$pTemporaryStorageFolder	Temporary storage folder

Definition at line 62 of file XMLWriter.php.

                                                                                                              {
                // Open temporary storage
                if ($pTemporaryStorage == self::STORAGE_MEMORY) {
                        $this->openMemory();
                } else {
                        // Create temporary filename
                        if ($pTemporaryStorageFolder === NULL)
                                $pTemporaryStorageFolder = PHPExcel_Shared_File::sys_get_temp_dir();
                        $this->_tempFileName = @tempnam($pTemporaryStorageFolder, 'xml');
 
                        // Open storage
                        if ($this->openUri($this->_tempFileName) === false) {
                                // Fallback to memory...
                                $this->openMemory();
                        }
                }
 
                // Set default values
                if (DEBUGMODE_ENABLED) {
                        $this->setIndent(true);
                }
        }

References PHPExcel_Shared_File\sys_get_temp_dir().

Here is the call graph for this function:

__destruct()

PHPExcel_Shared_XMLWriter::__destruct

(

)

Destructor.

Definition at line 88 of file XMLWriter.php.

                                     {
                // Unlink temporary files
                if ($this->_tempFileName != '') {
                        @unlink($this->_tempFileName);
                }
        }

Member Function Documentation

getData()

PHPExcel_Shared_XMLWriter::getData

(

)

Get written data.

Returns

$data

Definition at line 100 of file XMLWriter.php.

                                  {
                if ($this->_tempFileName == '') {
                        return $this->outputMemory(true);
                } else {
                        $this->flush();
                        return file_get_contents($this->_tempFileName);
                }
        }

writeRawData()

PHPExcel_Shared_XMLWriter::writeRawData

(

$text

)

Fallback method for writeRaw, introduced in PHP 5.2.

Parameters

string

$text

Returns

string

Definition at line 115 of file XMLWriter.php.

        {
                if (is_array($text)) {
                        $text = implode("\n",$text);
                }
 
                if (method_exists($this, 'writeRaw')) {
                        return $this->writeRaw(htmlspecialchars($text));
                }
 
                return $this->text($text);
        }

References $text.

Field Documentation

$_tempFileName

PHPExcel_Shared_XMLWriter::$_tempFileName = ''

private

Definition at line 54 of file XMLWriter.php.

STORAGE_DISK

const PHPExcel_Shared_XMLWriter::STORAGE_DISK = 2

Definition at line 47 of file XMLWriter.php.

Referenced by PHPExcel_Writer_OpenDocument_Content\write(), PHPExcel_Writer_OpenDocument_Meta\write(), PHPExcel_Writer_OpenDocument_Settings\write(), PHPExcel_Writer_OpenDocument_Styles\write(), PHPExcel_Writer_Excel2007_Chart\writeChart(), PHPExcel_Writer_Excel2007_Comments\writeComments(), PHPExcel_Writer_Excel2007_ContentTypes\writeContentTypes(), PHPExcel_Writer_Excel2007_DocProps\writeDocPropsApp(), PHPExcel_Writer_Excel2007_DocProps\writeDocPropsCore(), PHPExcel_Writer_Excel2007_DocProps\writeDocPropsCustom(), PHPExcel_Writer_Excel2007_Rels\writeDrawingRelationships(), PHPExcel_Writer_Excel2007_Drawing\writeDrawings(), PHPExcel_Writer_Excel2007_Rels\writeHeaderFooterDrawingRelationships(), PHPExcel_Writer_OpenDocument_MetaInf\writeManifest(), PHPExcel_Writer_Excel2007_Rels\writeRelationships(), PHPExcel_Writer_Excel2007_RelsRibbon\writeRibbonRelationships(), PHPExcel_Writer_Excel2007_StringTable\writeStringTable(), PHPExcel_Writer_Excel2007_Style\writeStyles(), PHPExcel_Writer_Excel2007_Theme\writeTheme(), PHPExcel_Writer_Excel2007_RelsVBA\writeVBARelationships(), PHPExcel_Writer_Excel2007_Comments\writeVMLComments(), PHPExcel_Writer_Excel2007_Drawing\writeVMLHeaderFooterImages(), PHPExcel_Writer_Excel2007_Workbook\writeWorkbook(), PHPExcel_Writer_Excel2007_Rels\writeWorkbookRelationships(), PHPExcel_Writer_Excel2007_Worksheet\writeWorksheet(), and PHPExcel_Writer_Excel2007_Rels\writeWorksheetRelationships().

STORAGE_MEMORY

const PHPExcel_Shared_XMLWriter::STORAGE_MEMORY = 1

Temporary storage method.

Definition at line 46 of file XMLWriter.php.

Referenced by PHPExcel_Writer_OpenDocument_Content\write(), PHPExcel_Writer_OpenDocument_Meta\write(), PHPExcel_Writer_OpenDocument_Settings\write(), PHPExcel_Writer_OpenDocument_Styles\write(), PHPExcel_Writer_Excel2007_Chart\writeChart(), PHPExcel_Writer_Excel2007_Comments\writeComments(), PHPExcel_Writer_Excel2007_ContentTypes\writeContentTypes(), PHPExcel_Writer_Excel2007_DocProps\writeDocPropsApp(), PHPExcel_Writer_Excel2007_DocProps\writeDocPropsCore(), PHPExcel_Writer_Excel2007_DocProps\writeDocPropsCustom(), PHPExcel_Writer_Excel2007_Rels\writeDrawingRelationships(), PHPExcel_Writer_Excel2007_Drawing\writeDrawings(), PHPExcel_Writer_Excel2007_Rels\writeHeaderFooterDrawingRelationships(), PHPExcel_Writer_OpenDocument_MetaInf\writeManifest(), PHPExcel_Writer_Excel2007_Rels\writeRelationships(), PHPExcel_Writer_Excel2007_RelsRibbon\writeRibbonRelationships(), PHPExcel_Writer_Excel2007_StringTable\writeStringTable(), PHPExcel_Writer_Excel2007_Style\writeStyles(), PHPExcel_Writer_Excel2007_Theme\writeTheme(), PHPExcel_Writer_Excel2007_RelsVBA\writeVBARelationships(), PHPExcel_Writer_Excel2007_Comments\writeVMLComments(), PHPExcel_Writer_Excel2007_Drawing\writeVMLHeaderFooterImages(), PHPExcel_Writer_Excel2007_Workbook\writeWorkbook(), PHPExcel_Writer_Excel2007_Rels\writeWorkbookRelationships(), PHPExcel_Writer_Excel2007_Worksheet\writeWorksheet(), and PHPExcel_Writer_Excel2007_Rels\writeWorksheetRelationships().

---

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

• libs/composer/vendor/phpoffice/phpexcel/Classes/PHPExcel/Shared/XMLWriter.php