PhpOffice\PhpSpreadsheet\Shared\XMLWriter Class Reference

Inheritance diagram for PhpOffice\PhpSpreadsheet\Shared\XMLWriter:

Collaboration diagram for PhpOffice\PhpSpreadsheet\Shared\XMLWriter:

Public Member Functions
	__construct ($pTemporaryStorage=self::STORAGE_MEMORY, $pTemporaryStorageFolder=null)
	Create a new XMLWriter instance. More...
	__destruct ()
	Destructor. More...
	getData ()
	Get written data. More...
	writeRawData ($text)
	Wrapper method for writeRaw. More...

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

Static Public Attributes
static	$debugEnabled = false

Private Attributes
	$tempFileName = ''

Detailed Description

Definition at line 5 of file XMLWriter.php.

Constructor & Destructor Documentation

__construct()

PhpOffice\PhpSpreadsheet\Shared\XMLWriter::__construct	(		$pTemporaryStorage = self::STORAGE_MEMORY,
			$pTemporaryStorageFolder = null
	)

Create a new XMLWriter instance.

Parameters

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

Definition at line 26 of file XMLWriter.php.

References PhpOffice\PhpSpreadsheet\Shared\File\sysGetTempDir().

    {
        // Open temporary storage
        if ($pTemporaryStorage == self::STORAGE_MEMORY) {
            $this->openMemory();
        } else {
            // Create temporary filename
            if ($pTemporaryStorageFolder === null) {
                $pTemporaryStorageFolder = File::sysGetTempDir();
            }
            $this->tempFileName = @tempnam($pTemporaryStorageFolder, 'xml');

            // Open storage
            if ($this->openUri($this->tempFileName) === false) {
                // Fallback to memory...
                $this->openMemory();
            }
        }

        // Set default values
        if (self::$debugEnabled) {
            $this->setIndent(true);
        }
    }

Here is the call graph for this function:

__destruct()

PhpOffice\PhpSpreadsheet\Shared\XMLWriter::__destruct

(

)

Destructor.

Definition at line 54 of file XMLWriter.php.

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

Member Function Documentation

getData()

PhpOffice\PhpSpreadsheet\Shared\XMLWriter::getData

(

)

Get written data.

Returns

string

Definition at line 67 of file XMLWriter.php.

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

        return file_get_contents($this->tempFileName);
    }

writeRawData()

PhpOffice\PhpSpreadsheet\Shared\XMLWriter::writeRawData

(

$text

)

Wrapper method for writeRaw.

Parameters

string|string[]

$text

Returns

bool

Definition at line 84 of file XMLWriter.php.

References $text.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Ods\Meta\writeDocPropsCustom(), PhpOffice\PhpSpreadsheet\Writer\Xlsx\Chart\writePlotSeriesValues(), PhpOffice\PhpSpreadsheet\Writer\Xlsx\StringTable\writeRichText(), and PhpOffice\PhpSpreadsheet\Writer\Xlsx\StringTable\writeRichTextForCharts().

    {
        if (is_array($text)) {
            $text = implode("\n", $text);
        }

        return $this->writeRaw(htmlspecialchars($text ?? ''));
    }

Here is the caller graph for this function:

Field Documentation

$debugEnabled

PhpOffice\PhpSpreadsheet\Shared\XMLWriter::$debugEnabled = false

static

Definition at line 7 of file XMLWriter.php.

$tempFileName

PhpOffice\PhpSpreadsheet\Shared\XMLWriter::$tempFileName = ''

private

Definition at line 18 of file XMLWriter.php.

STORAGE_DISK

const PhpOffice\PhpSpreadsheet\Shared\XMLWriter::STORAGE_DISK = 2

Definition at line 11 of file XMLWriter.php.

STORAGE_MEMORY

const PhpOffice\PhpSpreadsheet\Shared\XMLWriter::STORAGE_MEMORY = 1

Temporary storage method.

Definition at line 10 of file XMLWriter.php.

---

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

• libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Shared/XMLWriter.php