PHPExcel_Shared_File Class Reference

Collaboration diagram for PHPExcel_Shared_File:

Static Public Member Functions
static	setUseUploadTempDirectory ($useUploadTempDir=FALSE)
	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	file_exists ($pFilename)
	Verify if a file exists. More...
static	realpath ($pFilename)
	Returns canonicalized absolute pathname, also for ZIP archives. More...
static	sys_get_temp_dir ()
	Get the systems temporary directory. More...

Static Protected Attributes
static	$_useUploadTempDirectory = FALSE

Detailed Description

Definition at line 36 of file File.php.

Member Function Documentation

file_exists()

static PHPExcel_Shared_File::file_exists (   $pFilename )

static

Verify if a file exists.

Parameters

string

$pFilename

Filename

Returns

bool

Definition at line 73 of file File.php.

Referenced by PHPExcel_Writer_Excel2007_ContentTypes\_getImageMimeType(), realpath(), and sys_get_temp_dir().

                                                       {
                // 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;
                        } else {
                                return false;
                        }
                } else {
                        // Regular file_exists
                        return file_exists($pFilename);
                }
        }

Here is the caller graph for this function:

getUseUploadTempDirectory()

static PHPExcel_Shared_File::getUseUploadTempDirectory ( )

static

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

Returns

boolean Use File Upload Temporary directory (true or false)

Definition at line 62 of file File.php.

                                                           {
                return self::$_useUploadTempDirectory;
        }       //      function getUseUploadTempDirectory()

realpath()

static PHPExcel_Shared_File::realpath (   $pFilename )

static

Returns canonicalized absolute pathname, also for ZIP archives.

Parameters

string

$pFilename

Returns

string

Definition at line 102 of file File.php.

References file_exists().

Referenced by PHPExcel_Reader_Excel2007\_getFromZipArchive(), PHPExcel_Reader_Excel2007\listWorksheetInfo(), PHPExcel_Reader_Excel2007\load(), and sys_get_temp_dir().

                                                    {
                // 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] != '..') {
                                for ($i = 0; $i < count($pathArray); ++$i) {
                                        if ($pathArray[$i] == '..' && $i > 0) {
                                                unset($pathArray[$i]);
                                                unset($pathArray[$i - 1]);
                                                break;
                                        }
                                }
                        }
                        $returnValue = implode('/', $pathArray);
                }

                // Return
                return $returnValue;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

setUseUploadTempDirectory()

static PHPExcel_Shared_File::setUseUploadTempDirectory (   $useUploadTempDir = FALSE )

static

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

Parameters

boolean

$useUploadTempDir

Use File Upload Temporary directory (true or false)

Definition at line 52 of file File.php.

                                                                                    {
                self::$_useUploadTempDirectory = (boolean) $useUploadTempDir;
        }       //      function setUseUploadTempDirectory()

sys_get_temp_dir()

static PHPExcel_Shared_File::sys_get_temp_dir ( )

static

Get the systems temporary directory.

Returns

string

Definition at line 135 of file File.php.

References file_exists(), and realpath().

Referenced by PHPExcel_Shared_OLE_PPS_Root\__construct(), PHPExcel_Shared_XMLWriter\__construct(), PHPExcel_CachedObjectStorage_DiscISAM\__construct(), PHPExcel_Writer_PDF_Core\__construct(), PHPExcel_Writer_HTML\_writeChartInCell(), PHPExcel_Shared_ZipArchive\open(), PHPExcel_Shared_OLE_PPS_Root\save(), PHPExcel_Writer_OpenDocument\save(), and PHPExcel_Writer_Excel2007\save().

        {
                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);
                                }
                        }
                }

                // sys_get_temp_dir is only available since PHP 5.2.1
                // http://php.net/manual/en/function.sys-get-temp-dir.php#94119
                if ( !function_exists('sys_get_temp_dir')) {
                        if ($temp = getenv('TMP') ) {
                                if ((!empty($temp)) && (file_exists($temp))) { return realpath($temp); }
                        }
                        if ($temp = getenv('TEMP') ) {
                                if ((!empty($temp)) && (file_exists($temp))) { return realpath($temp); }
                        }
                        if ($temp = getenv('TMPDIR') ) {
                                if ((!empty($temp)) && (file_exists($temp))) { return realpath($temp); }
                        }

                        // trick for creating a file in system's temporary dir
                        // without knowing the path of the system's temporary dir
                        $temp = tempnam(__FILE__, '');
                        if (file_exists($temp)) {
                                unlink($temp);
                                return realpath(dirname($temp));
                        }

                        return null;
                }

                // use ordinary built-in PHP function
                //      There should be no problem with the 5.2.4 Suhosin realpath() bug, because this line should only
                //              be called if we're running 5.2.1 or earlier
                return realpath(sys_get_temp_dir());
        }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$_useUploadTempDirectory

PHPExcel_Shared_File::$_useUploadTempDirectory = FALSE

staticprotected

Definition at line 44 of file File.php.

---

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

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