PhpOffice\PhpSpreadsheet\Helper\Sample Class Reference

Helper class to be used in sample code. More...

Collaboration diagram for PhpOffice\PhpSpreadsheet\Helper\Sample:

Public Member Functions
	isCli ()
	Returns whether we run on CLI or browser. More...
	getScriptFilename ()
	Return the filename currently being executed. More...
	isIndex ()
	Whether we are executing the index page. More...
	getPageTitle ()
	Return the page title. More...
	getPageHeading ()
	Return the page heading. More...
	getSamples ()
	Returns an array of all known samples. More...
	write (Spreadsheet $spreadsheet, $filename, array $writers=['Xlsx', 'Xls'])
	Write documents. More...
	getFilename ($filename, $extension='xlsx')
	Returns the filename that should be used for sample output. More...
	getTemporaryFilename ($extension='xlsx')
	Return a random temporary file name. More...
	log ($message)
	logEndingNotes ()
	Log ending notes. More...
	logWrite (IWriter $writer, $path, $callStartTime)
	Log a line about the write operation. More...
	logRead ($format, $path, $callStartTime)
	Log a line about the read operation. More...

Protected Member Functions
	isDirOrMkdir (string $folder)

Private Member Functions
	getTemporaryFolder ()
	Returns the temporary directory and make sure it exists. More...

Detailed Description

Helper class to be used in sample code.

Definition at line 18 of file Sample.php.

Member Function Documentation

getFilename()

PhpOffice\PhpSpreadsheet\Helper\Sample::getFilename	(		$filename,
			$extension = 'xlsx'
	)

Returns the filename that should be used for sample output.

Parameters

string	$filename
string	$extension

Returns

string

Definition at line 157 of file Sample.php.

References $filename, and PhpOffice\PhpSpreadsheet\Helper\Sample\getTemporaryFolder().

Referenced by PhpOffice\PhpSpreadsheet\Helper\Sample\write().

    {
        $originalExtension = pathinfo($filename, PATHINFO_EXTENSION);

        return $this->getTemporaryFolder() . '/' . str_replace('.' . $originalExtension, '.' . $extension, basename($filename));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPageHeading()

PhpOffice\PhpSpreadsheet\Helper\Sample::getPageHeading

(

)

Return the page heading.

Returns

string

Definition at line 65 of file Sample.php.

References PhpOffice\PhpSpreadsheet\Helper\Sample\getScriptFilename(), and PhpOffice\PhpSpreadsheet\Helper\Sample\isIndex().

    {
        return $this->isIndex() ? '' : '<h1>' . str_replace('_', ' ', $this->getScriptFilename()) . '</h1>';
    }

Here is the call graph for this function:

getPageTitle()

PhpOffice\PhpSpreadsheet\Helper\Sample::getPageTitle

(

)

Return the page title.

Returns

string

Definition at line 55 of file Sample.php.

References PhpOffice\PhpSpreadsheet\Helper\Sample\getScriptFilename(), and PhpOffice\PhpSpreadsheet\Helper\Sample\isIndex().

    {
        return $this->isIndex() ? 'PHPSpreadsheet' : $this->getScriptFilename();
    }

Here is the call graph for this function:

getSamples()

PhpOffice\PhpSpreadsheet\Helper\Sample::getSamples

(

)

Returns an array of all known samples.

Returns

string[][] [$name => $path]

Definition at line 75 of file Sample.php.

References $baseDir, $f, $files, $info, and $name.

    {
        // Populate samples
        $baseDir = realpath(__DIR__ . '/../../../samples');
        $directory = new RecursiveDirectoryIterator($baseDir);
        $iterator = new RecursiveIteratorIterator($directory);
        $regex = new RegexIterator($iterator, '/^.+\.php$/', RecursiveRegexIterator::GET_MATCH);

        $files = [];
        foreach ($regex as $file) {
            $file = str_replace(str_replace('\\', '/', $baseDir) . '/', '', str_replace('\\', '/', $file[0]));
            $info = pathinfo($file);
            $category = str_replace('_', ' ', $info['dirname']);
            $name = str_replace('_', ' ', preg_replace('/(|\.php)/', '', $info['filename']));
            if (!in_array($category, ['.', 'boostrap', 'templates'])) {
                if (!isset($files[$category])) {
                    $files[$category] = [];
                }
                $files[$category][$name] = $file;
            }
        }

        // Sort everything
        ksort($files);
        foreach ($files as &$f) {
            asort($f);
        }

        return $files;
    }

getScriptFilename()

PhpOffice\PhpSpreadsheet\Helper\Sample::getScriptFilename

(

)

Return the filename currently being executed.

Returns

string

Definition at line 35 of file Sample.php.

References $_SERVER.

Referenced by PhpOffice\PhpSpreadsheet\Helper\Sample\getPageHeading(), PhpOffice\PhpSpreadsheet\Helper\Sample\getPageTitle(), and PhpOffice\PhpSpreadsheet\Helper\Sample\isIndex().

    {
        return basename($_SERVER['SCRIPT_FILENAME'], '.php');
    }

Here is the caller graph for this function:

getTemporaryFilename()

PhpOffice\PhpSpreadsheet\Helper\Sample::getTemporaryFilename

(

$extension = 'xlsx'

)

Return a random temporary file name.

Parameters

string

$extension

Returns

string

Definition at line 171 of file Sample.php.

References PhpOffice\PhpSpreadsheet\Helper\Sample\getTemporaryFolder().

    {
        $temporaryFilename = tempnam($this->getTemporaryFolder(), 'phpspreadsheet-');
        unlink($temporaryFilename);

        return $temporaryFilename . '.' . $extension;
    }

Here is the call graph for this function:

getTemporaryFolder()

PhpOffice\PhpSpreadsheet\Helper\Sample::getTemporaryFolder ( )

private

Returns the temporary directory and make sure it exists.

Returns

string

Definition at line 139 of file Sample.php.

References PhpOffice\PhpSpreadsheet\Helper\Sample\isDirOrMkdir().

Referenced by PhpOffice\PhpSpreadsheet\Helper\Sample\getFilename(), and PhpOffice\PhpSpreadsheet\Helper\Sample\getTemporaryFilename().

    {
        $tempFolder = sys_get_temp_dir() . '/phpspreadsheet';
        if (!$this->isDirOrMkdir($tempFolder)) {
            throw new RuntimeException(sprintf('Directory "%s" was not created', $tempFolder));
        }

        return $tempFolder;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isCli()

PhpOffice\PhpSpreadsheet\Helper\Sample::isCli

(

)

Returns whether we run on CLI or browser.

Returns

bool

Definition at line 25 of file Sample.php.

Referenced by PhpOffice\PhpSpreadsheet\Helper\Sample\log().

    {
        return PHP_SAPI === 'cli';
    }

Here is the caller graph for this function:

isDirOrMkdir()

PhpOffice\PhpSpreadsheet\Helper\Sample::isDirOrMkdir ( string  $folder )

protected

Definition at line 129 of file Sample.php.

Referenced by PhpOffice\PhpSpreadsheet\Helper\Sample\getTemporaryFolder().

                                                   : bool
    {
        return \is_dir($folder) || \mkdir($folder);
    }

Here is the caller graph for this function:

isIndex()

PhpOffice\PhpSpreadsheet\Helper\Sample::isIndex

(

)

Whether we are executing the index page.

Returns

bool

Definition at line 45 of file Sample.php.

References PhpOffice\PhpSpreadsheet\Helper\Sample\getScriptFilename().

Referenced by PhpOffice\PhpSpreadsheet\Helper\Sample\getPageHeading(), and PhpOffice\PhpSpreadsheet\Helper\Sample\getPageTitle().

    {
        return $this->getScriptFilename() === 'index';
    }

Here is the call graph for this function:

Here is the caller graph for this function:

log()

PhpOffice\PhpSpreadsheet\Helper\Sample::log

(

$message

)

Definition at line 179 of file Sample.php.

References $message, PhpOffice\PhpSpreadsheet\Helper\Sample\isCli(), and PHP_EOL.

Referenced by PhpOffice\PhpSpreadsheet\Helper\Sample\logEndingNotes(), PhpOffice\PhpSpreadsheet\Helper\Sample\logRead(), and PhpOffice\PhpSpreadsheet\Helper\Sample\logWrite().

                                 : void
    {
        $eol = $this->isCli() ? PHP_EOL : '<br />';
        echo date('H:i:s ') . $message . $eol;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

logEndingNotes()

PhpOffice\PhpSpreadsheet\Helper\Sample::logEndingNotes

(

)

Log ending notes.

Definition at line 188 of file Sample.php.

References PhpOffice\PhpSpreadsheet\Helper\Sample\log().

Referenced by PhpOffice\PhpSpreadsheet\Helper\Sample\write().

                                    : void
    {
        // Do not show execution time for index
        $this->log('Peak memory usage: ' . (memory_get_peak_usage(true) / 1024 / 1024) . 'MB');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

logRead()

PhpOffice\PhpSpreadsheet\Helper\Sample::logRead	(		$format,
			$path,
			$callStartTime
	)

Log a line about the read operation.

Parameters

string	$format
string	$path
float	$callStartTime

Definition at line 218 of file Sample.php.

References $message, and PhpOffice\PhpSpreadsheet\Helper\Sample\log().

                                                           : void
    {
        $callEndTime = microtime(true);
        $callTime = $callEndTime - $callStartTime;
        $message = "Read {$format} format from <code>{$path}</code>  in " . sprintf('%.4f', $callTime) . ' seconds';

        $this->log($message);
    }

Here is the call graph for this function:

logWrite()

PhpOffice\PhpSpreadsheet\Helper\Sample::logWrite	(	IWriter	$writer,
			$path,
			$callStartTime
	)

Log a line about the write operation.

Parameters

string	$path
float	$callStartTime

Definition at line 200 of file Sample.php.

References $format, $message, and PhpOffice\PhpSpreadsheet\Helper\Sample\log().

Referenced by PhpOffice\PhpSpreadsheet\Helper\Sample\write().

                                                                    : void
    {
        $callEndTime = microtime(true);
        $callTime = $callEndTime - $callStartTime;
        $reflection = new ReflectionClass($writer);
        $format = $reflection->getShortName();
        $message = "Write {$format} format to <code>{$path}</code>  in " . sprintf('%.4f', $callTime) . ' seconds';

        $this->log($message);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

write()

PhpOffice\PhpSpreadsheet\Helper\Sample::write	(	Spreadsheet	$spreadsheet,
			$filename,
		array	$writers = ['Xlsx',
		'Xls']
	)

Write documents.

Parameters

string	$filename
	string[]	$writers

Definition at line 112 of file Sample.php.

References $filename, $path, PhpOffice\PhpSpreadsheet\IOFactory\createWriter(), PhpOffice\PhpSpreadsheet\Helper\Sample\getFilename(), PhpOffice\PhpSpreadsheet\Helper\Sample\logEndingNotes(), PhpOffice\PhpSpreadsheet\Helper\Sample\logWrite(), and PhpOffice\PhpSpreadsheet\Spreadsheet\setActiveSheetIndex().

                                                                                                : void
    {
        // Set active sheet index to the first sheet, so Excel opens this as the first sheet
        $spreadsheet->setActiveSheetIndex(0);

        // Write documents
        foreach ($writers as $writerType) {
            $path = $this->getFilename($filename, mb_strtolower($writerType));
            $writer = IOFactory::createWriter($spreadsheet, $writerType);
            $callStartTime = microtime(true);
            $writer->save($path);
            $this->logWrite($writer, $path, $callStartTime);
        }

        $this->logEndingNotes();
    }

Here is the call graph for this function:

---

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

• libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Helper/Sample.php