PhpSpreadsheet\Helper\Sample

Complexity

Total Complexity

21

Size/Duplication

Total Lines	178
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	3

Importance

Changes	1
Bugs	0	Features	0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	isCli()	0	4	1
A	getScriptFilename()	0	4	1
A	isIndex()	0	4	1
A	getPageTitle()	0	4	2
A	getPageHeading()	0	4	2
A	getSamples()	0	14	3
A	write()	0	20	3
A	getTemporaryFolder()	0	9	2
A	getFilename()	0	4	1
A	getTemporaryFilename()	0	7	1
A	log()	0	4	1
A	logEndingNotes()	0	5	1
A	logWrite()	0	10	1
A	logRead()	0	8	1

<?php

namespace PhpSpreadsheet\Helper;

use PhpSpreadsheet\IOFactory;
use PhpSpreadsheet\Spreadsheet;

class Sample
{
    /**
     * Returns wether we run on CLI or browser
     * @return bool
     */
    public function isCli()
    {
        return PHP_SAPI === 'cli';
    }

    /**
     * Return the filename currently being executed
     * @return string
     */
    public function getScriptFilename()

getScriptFilename uses the super-global variable $_SERVER which is generally not recommended.

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

    /**
     * Wether we are executing the index page
     * @return bool
     */
    public function isIndex()
    {
        return $this->getScriptFilename() === 'index';
    }

    /**
     * Return the page title
     * @return string
     */
    public function getPageTitle()
    {
        return $this->isIndex() ? 'PHPSpreadsheet' : $this->getScriptFilename();
    }

    /**
     * Return the page heading
     * @return string
     */
    public function getPageHeading()
    {
        return $this->isIndex() ? '' : '<h1>' . str_replace('_', ' ', $this->getScriptFilename()) . '</h1>';
    }

    /**
     * Returns an array of all known samples
     * @return string[] [$name => $path]
     */
    public function getSamples()
    {
        // Populate samples
        $files = [];
        foreach (glob(realpath(__DIR__ . '/../../../samples') . '/*.php') as $file) {
            $info = pathinfo($file);
            $name = str_replace('_', ' ', preg_replace('/(|\.php)/', '', $info['filename']));
            if (preg_match('/^\d+/', $name)) {
                $files[$name] = $file;
            }
        }

        return $files;
    }

    /**
     * Write documents
     *
     * @param Spreadsheet $spreadsheet
     * @param string $filename
     * @param array $writers
     */
    public function write(Spreadsheet $spreadsheet, $filename, array $writers = ['Excel2007' => 'xlsx', 'Excel5' => 'xls'])
    {
        // Set active sheet index to the first sheet, so Excel opens this as the first sheet
        $spreadsheet->setActiveSheetIndex(0);

        // Write documents
        foreach ($writers as $format => $extension) {
            $path = $this->getFilename($filename, $extension);
            if (!is_null($extension)) {
                $writer = IOFactory::createWriter($spreadsheet, $format);
                $callStartTime = microtime(true);
                $writer->save($path);
                $this->logWrite($writer, $path, $callStartTime);
            } else {
                throw new \Exception('Missing extension');
            }
        }

        $this->logEndingNotes();
    }

    /**
     * Returns the temporary directory and make sure it exists
     * @return string
     */
    private function getTemporaryFolder()
    {
        $tempFolder = sys_get_temp_dir() . '/phpspreadsheet';
        if (!is_dir($tempFolder)) {
            mkdir($tempFolder);
        }

        return $tempFolder;
    }

    /**
     * Returns the filename that should be used for sample output
     * @param string $filename
     * @param string $extension
     * @return string
     */
    public function getFilename($filename, $extension = 'xlsx')
    {
        return $this->getTemporaryFolder() . '/' . str_replace('.php', '.' . $extension, basename($filename));
    }

    /**
     * Return a random temporary file name
     * @param string $extension
     * @return string
     */
    public function getTemporaryFilename($extension = 'xlsx')
    {
        $temporaryFilename = tempnam($this->getTemporaryFolder(), 'phpspreadsheet-');
        unlink($temporaryFilename);

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

    public function log($message)
    {
        echo date('H:i:s '), $message, EOL;
    }

    /**
     * Log ending notes
     */
    public function logEndingNotes()
    {
        // Do not show execution time for index
        $this->log('Peak memory usage: ' . (memory_get_peak_usage(true) / 1024 / 1024) . 'MB');
    }

    /**
     * Log a line about the write operation
     * @param \PhpSpreadsheet\Writer\IWriter $writer
     * @param string $path
     * @param float $callStartTime
     */
    public function logWrite(\PhpSpreadsheet\Writer\IWriter $writer, $path, $callStartTime)
    {
        $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);
    }

    /**
     * Log a line about the read operation
     * @param string $format
     * @param string $path
     * @param float $callStartTime
     */
    public function logRead($format, $path, $callStartTime)
    {
        $callEndTime = microtime(true);
        $callTime = $callEndTime - $callStartTime;
        $message = "Read {$format} format from <code>{$path}</code>  in " . sprintf('%.4f', $callTime) . ' seconds';

        $this->log($message);
    }
}