PhpOffice\PhpSpreadsheet\Shared\File Class Reference

Collaboration diagram for PhpOffice\PhpSpreadsheet\Shared\File:

Static Public Member Functions
static	setUseUploadTempDirectory ($useUploadTempDir)
	Set the flag indicating whether the File Upload Temp directory should be used for temporary files. More...
static	getUseUploadTempDirectory ()
	Get the flag indicating whether the File Upload Temp directory should be used for temporary files. More...
static	fileExists ($pFilename)
	Verify if a file exists. More...
static	realpath ($pFilename)
	Returns canonicalized absolute pathname, also for ZIP archives. More...
static	sysGetTempDir ()
	Get the systems temporary directory. More...
static	temporaryFilename ()
static	assertFile ($filename)
	Assert that given path is an existing file and is readable, otherwise throw exception. More...

Static Protected Attributes
static	$useUploadTempDirectory = false

Detailed Description

Definition at line 9 of file File.php.

Member Function Documentation

assertFile()

static PhpOffice\PhpSpreadsheet\Shared\File::assertFile (   $filename )

static

Assert that given path is an existing file and is readable, otherwise throw exception.

Parameters

string

$filename

Definition at line 143 of file File.php.

References $filename.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Ods\canRead(), PhpOffice\PhpSpreadsheet\Reader\Xlsx\canRead(), PhpOffice\PhpSpreadsheet\Reader\Gnumeric\canRead(), PhpOffice\PhpSpreadsheet\Reader\Xls\canRead(), PhpOffice\PhpSpreadsheet\IOFactory\createReaderForFile(), PhpOffice\PhpSpreadsheet\Reader\Xlsx\getFromZipArchive(), PhpOffice\PhpSpreadsheet\Reader\Gnumeric\listWorksheetInfo(), PhpOffice\PhpSpreadsheet\Reader\Ods\listWorksheetInfo(), PhpOffice\PhpSpreadsheet\Reader\Xml\listWorksheetInfo(), PhpOffice\PhpSpreadsheet\Reader\Xls\listWorksheetInfo(), PhpOffice\PhpSpreadsheet\Reader\Ods\listWorksheetNames(), PhpOffice\PhpSpreadsheet\Reader\Xlsx\listWorksheetNames(), PhpOffice\PhpSpreadsheet\Reader\Gnumeric\listWorksheetNames(), PhpOffice\PhpSpreadsheet\Reader\Xml\listWorksheetNames(), PhpOffice\PhpSpreadsheet\Reader\Xls\listWorksheetNames(), PhpOffice\PhpSpreadsheet\Reader\Ods\load(), PhpOffice\PhpSpreadsheet\Reader\Xml\load(), PhpOffice\PhpSpreadsheet\Reader\Gnumeric\loadIntoExisting(), PhpOffice\PhpSpreadsheet\Reader\BaseReader\openFile(), and PhpOffice\PhpSpreadsheet\Shared\OLERead\read().

                                                : void
    {
        if (!is_file($filename)) {
            throw new InvalidArgumentException('File "' . $filename . '" does not exist.');
        }

        if (!is_readable($filename)) {
            throw new InvalidArgumentException('Could not open "' . $filename . '" for reading.');
        }
    }

Here is the caller graph for this function:

fileExists()

static PhpOffice\PhpSpreadsheet\Shared\File::fileExists (   $pFilename )

static

Verify if a file exists.

Parameters

string

$pFilename

Filename

Returns

bool

Definition at line 45 of file File.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\ContentTypes\getImageMimeType().

    {
        // Sick construction, but it seems that
        // file_exists returns strange values when
        // doing the original file_exists on ZIP archives...
        if (strtolower(substr($pFilename, 0, 3)) == 'zip') {
            // Open ZIP file and verify if the file exists
            $zipFile = substr($pFilename, 6, strpos($pFilename, '#') - 6);
            $archiveFile = substr($pFilename, strpos($pFilename, '#') + 1);

            $zip = new ZipArchive();
            if ($zip->open($zipFile) === true) {
                $returnValue = ($zip->getFromName($archiveFile) !== false);
                $zip->close();

                return $returnValue;
            }

            return false;
        }

        return file_exists($pFilename);
    }

Here is the caller graph for this function:

getUseUploadTempDirectory()

static PhpOffice\PhpSpreadsheet\Shared\File::getUseUploadTempDirectory ( )

static

Get the flag indicating whether the File Upload Temp directory should be used for temporary files.

Returns

bool Use File Upload Temporary directory (true or false)

Definition at line 33 of file File.php.

    {
        return self::$useUploadTempDirectory;
    }

realpath()

static PhpOffice\PhpSpreadsheet\Shared\File::realpath (   $pFilename )

static

Returns canonicalized absolute pathname, also for ZIP archives.

Parameters

string

$pFilename

Returns

string

Definition at line 76 of file File.php.

References $i.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xlsx\getFromZipArchive(), PhpOffice\PhpSpreadsheet\Reader\Xlsx\listWorksheetNames(), and PhpOffice\PhpSpreadsheet\Shared\File\sysGetTempDir().

    {
        // Returnvalue
        $returnValue = '';

        // Try using realpath()
        if (file_exists($pFilename)) {
            $returnValue = realpath($pFilename);
        }

        // Found something?
        if ($returnValue == '' || ($returnValue === null)) {
            $pathArray = explode('/', $pFilename);
            while (in_array('..', $pathArray) && $pathArray[0] != '..') {
                $iMax = count($pathArray);
                for ($i = 0; $i < $iMax; ++$i) {
                    if ($pathArray[$i] == '..' && $i > 0) {
                        unset($pathArray[$i], $pathArray[$i - 1]);

                        break;
                    }
                }
            }
            $returnValue = implode('/', $pathArray);
        }

        // Return
        return $returnValue;
    }

Here is the caller graph for this function:

setUseUploadTempDirectory()

static PhpOffice\PhpSpreadsheet\Shared\File::setUseUploadTempDirectory (   $useUploadTempDir )

static

Set the flag indicating whether the File Upload Temp directory should be used for temporary files.

Parameters

bool

$useUploadTempDir

Use File Upload Temporary directory (true or false)

Definition at line 23 of file File.php.

                                                                       : void
    {
        self::$useUploadTempDirectory = (bool) $useUploadTempDir;
    }

sysGetTempDir()

static PhpOffice\PhpSpreadsheet\Shared\File::sysGetTempDir ( )

static

Get the systems temporary directory.

Returns

string

Definition at line 111 of file File.php.

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

Referenced by PhpOffice\PhpSpreadsheet\Shared\XMLWriter\__construct(), PhpOffice\PhpSpreadsheet\Writer\Pdf\__construct(), and PhpOffice\PhpSpreadsheet\Writer\Html\writeChartInCell().

    {
        if (self::$useUploadTempDirectory) {
            //  use upload-directory when defined to allow running on environments having very restricted
            //      open_basedir configs
            if (ini_get('upload_tmp_dir') !== false) {
                if ($temp = ini_get('upload_tmp_dir')) {
                    if (file_exists($temp)) {
                        return realpath($temp);
                    }
                }
            }
        }

        return realpath(sys_get_temp_dir());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

temporaryFilename()

static PhpOffice\PhpSpreadsheet\Shared\File::temporaryFilename ( )

static

Definition at line 128 of file File.php.

References $filename.

                                              : string
    {
        $filename = tempnam(self::sysGetTempDir(), 'phpspreadsheet');
        if ($filename === false) {
            throw new Exception('Could not create temporary file');
        }

        return $filename;
    }

Field Documentation

$useUploadTempDirectory

PhpOffice\PhpSpreadsheet\Shared\File::$useUploadTempDirectory = false

staticprotected

Definition at line 16 of file File.php.

---

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

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