Collaboration diagram for PHPExcel:

Public Member Functions
	hasMacros ()
	The workbook has macros ? More...

	setHasMacros ($hasMacros=false)
	Define if a workbook has macros. More...

	setMacrosCode ($MacrosCode)
	Set the macros code. More...

	getMacrosCode ()
	Return the macros code. More...

	setMacrosCertificate ($Certificate=NULL)
	Set the macros certificate. More...

	hasMacrosCertificate ()
	Is the project signed ? More...

	getMacrosCertificate ()
	Return the macros certificate. More...

	discardMacros ()
	Remove all macros, certificate from spreadsheet. More...

	setRibbonXMLData ($Target=NULL, $XMLData=NULL)
	set ribbon XML data More...

	getRibbonXMLData ($What='all')
	retrieve ribbon XML Data More...

	setRibbonBinObjects ($BinObjectsNames=NULL, $BinObjectsData=NULL)
	store binaries ribbon objects (pictures) More...

	getRibbonBinObjects ($What='all')
	retrieve Binaries Ribbon Objects More...

	hasRibbon ()
	This workbook have a custom UI ? More...

	hasRibbonBinObjects ()
	This workbook have additionnal object for the ribbon ? More...

	sheetCodeNameExists ($pSheetCodeName)
	Check if a sheet with a specified code name already exists. More...

	getSheetByCodeName ($pName='')
	Get sheet by code name. More...

	__construct ()
	Create a new PHPExcel with one Worksheet. More...

	__destruct ()
	Code to execute when this worksheet is unset() More...

	disconnectWorksheets ()
	Disconnect all worksheets from this PHPExcel workbook object, typically so that the PHPExcel object can be unset. More...

	getCalculationEngine ()
	Return the calculation engine for this worksheet. More...

	getProperties ()
	Get properties. More...

	setProperties (PHPExcel_DocumentProperties $pValue)
	Set properties. More...

	getSecurity ()
	Get security. More...

	setSecurity (PHPExcel_DocumentSecurity $pValue)
	Set security. More...

	getActiveSheet ()
	Get active sheet. More...

	createSheet ($iSheetIndex=NULL)
	Create sheet and add it to this workbook. More...

	sheetNameExists ($pSheetName)
	Check if a sheet with a specified name already exists. More...

	addSheet (PHPExcel_Worksheet $pSheet, $iSheetIndex=NULL)
	Add sheet. More...

	removeSheetByIndex ($pIndex=0)
	Remove sheet by index. More...

	getSheet ($pIndex=0)
	Get sheet by index. More...

	getAllSheets ()
	Get all sheets. More...

	getSheetByName ($pName='')
	Get sheet by name. More...

	getIndex (PHPExcel_Worksheet $pSheet)
	Get index for sheet. More...

	setIndexByName ($sheetName, $newIndex)
	Set index for sheet by sheet name. More...

	getSheetCount ()
	Get sheet count. More...

	getActiveSheetIndex ()
	Get active sheet index. More...

	setActiveSheetIndex ($pIndex=0)
	Set active sheet index. More...

	setActiveSheetIndexByName ($pValue='')
	Set active sheet index by name. More...

	getSheetNames ()
	Get sheet names. More...

	addExternalSheet (PHPExcel_Worksheet $pSheet, $iSheetIndex=null)
	Add external sheet. More...

	getNamedRanges ()
	Get named ranges. More...

	addNamedRange (PHPExcel_NamedRange $namedRange)
	Add named range. More...

	getNamedRange ($namedRange, PHPExcel_Worksheet $pSheet=null)
	Get named range. More...

	removeNamedRange ($namedRange, PHPExcel_Worksheet $pSheet=null)
	Remove named range. More...

	getWorksheetIterator ()
	Get worksheet iterator. More...

	copy ()
	Copy workbook (!= clone!) More...

	__clone ()
	Implement PHP __clone to create a deep clone, not just a shallow copy. More...

	getCellXfCollection ()
	Get the workbook collection of cellXfs. More...

	getCellXfByIndex ($pIndex=0)
	Get cellXf by index. More...

	getCellXfByHashCode ($pValue='')
	Get cellXf by hash code. More...

	cellXfExists ($pCellStyle=null)
	Check if style exists in style collection. More...

	getDefaultStyle ()
	Get default style. More...

	addCellXf (PHPExcel_Style $style)
	Add a cellXf to the workbook. More...

	removeCellXfByIndex ($pIndex=0)
	Remove cellXf by index. More...

	getCellXfSupervisor ()
	Get the cellXf supervisor. More...

	getCellStyleXfCollection ()
	Get the workbook collection of cellStyleXfs. More...

	getCellStyleXfByIndex ($pIndex=0)
	Get cellStyleXf by index. More...

	getCellStyleXfByHashCode ($pValue='')
	Get cellStyleXf by hash code. More...

	addCellStyleXf (PHPExcel_Style $pStyle)
	Add a cellStyleXf to the workbook. More...

	removeCellStyleXfByIndex ($pIndex=0)
	Remove cellStyleXf by index. More...

	garbageCollect ()
	Eliminate all unneeded cellXf and afterwards update the xfIndex for all cells and columns in the workbook. More...

	getID ()
	Return the unique ID value assigned to this spreadsheet workbook. More...

Private Member Functions
	_getExtensionOnly ($ThePath)
	return the extension of a filename. More...

Private Attributes
	$_uniqueID

	$_properties

	$_security

	$_workSheetCollection = array()

	$_calculationEngine = NULL

	$_activeSheetIndex = 0

	$_namedRanges = array()

	$_cellXfSupervisor

	$_cellXfCollection = array()

	$_cellStyleXfCollection = array()

	$_hasMacros = FALSE

	$_macrosCode =NULL

	$_macrosCertificate =NULL

	$_ribbonXMLData =NULL

	$_ribbonBinObjects =NULL

Detailed Description

Definition at line 43 of file PHPExcel.php.

Constructor & Destructor Documentation

◆ __construct()

PHPExcel::__construct ( )

Create a new PHPExcel with one Worksheet.

Definition at line 357 of file PHPExcel.php.

        {
                $this->_uniqueID = uniqid();
                $this->_calculationEngine       = PHPExcel_Calculation::getInstance($this);
 
                // Initialise worksheet collection and add one worksheet
                $this->_workSheetCollection = array();
                $this->_workSheetCollection[] = new PHPExcel_Worksheet($this);
                $this->_activeSheetIndex = 0;
 
        // Create document properties
        $this->_properties = new PHPExcel_DocumentProperties();
 
        // Create document security
        $this->_security = new PHPExcel_DocumentSecurity();
 
        // Set named ranges
        $this->_namedRanges = array();
 
        // Create the cellXf supervisor
        $this->_cellXfSupervisor = new PHPExcel_Style(true);
        $this->_cellXfSupervisor->bindParent($this);
 
        // Create the default style
        $this->addCellXf(new PHPExcel_Style);
        $this->addCellStyleXf(new PHPExcel_Style);
    }

References addCellStyleXf(), addCellXf(), and PHPExcel_Calculation\getInstance().

Here is the call graph for this function:

◆ __destruct()

PHPExcel::__destruct ( )

Code to execute when this worksheet is unset()

Definition at line 389 of file PHPExcel.php.

                                 {
        PHPExcel_Calculation::unsetInstance($this);
        $this->disconnectWorksheets();
    }    //    function __destruct()

References disconnectWorksheets(), and PHPExcel_Calculation\unsetInstance().

Here is the call graph for this function:

Member Function Documentation

◆ __clone()

PHPExcel::__clone ( )

Implement PHP __clone to create a deep clone, not just a shallow copy.

Definition at line 863 of file PHPExcel.php.

                              {
        foreach($this as $key => $val) {
            if (is_object($val) || (is_array($val))) {
                $this->{$key} = unserialize(serialize($val));
            }
        }
    }

◆ _getExtensionOnly()

PHPExcel::_getExtensionOnly ( $ThePath )

private

return the extension of a filename.

Internal use for a array_map callback (php<5.3 don't like lambda function)

Definition at line 275 of file PHPExcel.php.

                                                    {
                return pathinfo($ThePath, PATHINFO_EXTENSION);
        }

◆ addCellStyleXf()

PHPExcel::addCellStyleXf ( PHPExcel_Style $pStyle )

Add a cellStyleXf to the workbook.

Parameters

PHPExcel_Style $pStyle

Definition at line 1027 of file PHPExcel.php.

    {
        $this->_cellStyleXfCollection[] = $pStyle;
        $pStyle->setIndex(count($this->_cellStyleXfCollection) - 1);
    }

References PHPExcel_Style\setIndex().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addCellXf()

PHPExcel::addCellXf ( PHPExcel_Style $style )

Add a cellXf to the workbook.

Parameters

PHPExcel_Style $style

Definition at line 938 of file PHPExcel.php.

    {
        $this->_cellXfCollection[] = $style;
        $style->setIndex(count($this->_cellXfCollection) - 1);
    }

References $style.

Referenced by __construct(), and addExternalSheet().

Here is the caller graph for this function:

◆ addExternalSheet()

PHPExcel::addExternalSheet	(	PHPExcel_Worksheet	$pSheet,
			$iSheetIndex = `null`
	)

Add external sheet.

Parameters

PHPExcel_Worksheet	$pSheet	External sheet to add
int \| null	$iSheetIndex	Index where sheet should go (0,1,..., or null for last)

Exceptions

PHPExcel_Exception

Returns: PHPExcel_Worksheet

Definition at line 738 of file PHPExcel.php.

                                                                                      {
        if ($this->sheetNameExists($pSheet->getTitle())) {
            throw new PHPExcel_Exception("Workbook already contains a worksheet named '{$pSheet->getTitle()}'. Rename the external sheet first.");
        }
 
        // count how many cellXfs there are in this workbook currently, we will need this below
        $countCellXfs = count($this->_cellXfCollection);
 
        // copy all the shared cellXfs from the external workbook and append them to the current
        foreach ($pSheet->getParent()->getCellXfCollection() as $cellXf) {
            $this->addCellXf(clone $cellXf);
        }
 
        // move sheet to this workbook
        $pSheet->rebindParent($this);
 
        // update the cellXfs
        foreach ($pSheet->getCellCollection(false) as $cellID) {
            $cell = $pSheet->getCell($cellID);
            $cell->setXfIndex( $cell->getXfIndex() + $countCellXfs );
        }
 
        return $this->addSheet($pSheet, $iSheetIndex);
    }

References addCellXf(), addSheet(), PHPExcel_Worksheet\getCell(), PHPExcel_Worksheet\getCellCollection(), PHPExcel_Worksheet\getParent(), PHPExcel_Worksheet\getTitle(), PHPExcel_Worksheet\rebindParent(), and sheetNameExists().

Here is the call graph for this function:

◆ addNamedRange()

PHPExcel::addNamedRange ( PHPExcel_NamedRange $namedRange )

Add named range.

Parameters

PHPExcel_NamedRange $namedRange

Returns: PHPExcel

Definition at line 778 of file PHPExcel.php.

                                                                   {
        if ($namedRange->getScope() == null) {
            // global scope
            $this->_namedRanges[$namedRange->getName()] = $namedRange;
        } else {
            // local scope
            $this->_namedRanges[$namedRange->getScope()->getTitle().'!'.$namedRange->getName()] = $namedRange;
        }
        return true;
    }

References PHPExcel_NamedRange\getName(), and PHPExcel_NamedRange\getScope().

Referenced by PHPExcel_Worksheet\rebindParent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addSheet()

PHPExcel::addSheet	(	PHPExcel_Worksheet	$pSheet,
			$iSheetIndex = `NULL`
	)

Add sheet.

Parameters

PHPExcel_Worksheet	$pSheet
int \| null	$iSheetIndex	Index where sheet should go (0,1,..., or null for last)

Returns: PHPExcel_Worksheet

Exceptions

PHPExcel_Exception

Definition at line 505 of file PHPExcel.php.

    {
        if ($this->sheetNameExists($pSheet->getTitle())) {
            throw new PHPExcel_Exception(
                "Workbook already contains a worksheet named '{$pSheet->getTitle()}'. Rename this worksheet first."
            );
        }
 
        if($iSheetIndex === NULL) {
            if ($this->_activeSheetIndex < 0) {
                $this->_activeSheetIndex = 0;
            }
            $this->_workSheetCollection[] = $pSheet;
        } else {
            // Insert the sheet at the requested index
            array_splice(
                $this->_workSheetCollection,
                $iSheetIndex,
                0,
                array($pSheet)
                );
 
            // Adjust active sheet index if necessary
            if ($this->_activeSheetIndex >= $iSheetIndex) {
                ++$this->_activeSheetIndex;
            }
        }
 
        if ($pSheet->getParent() === null) {
            $pSheet->rebindParent($this);
        }
 
        return $pSheet;
    }

References $_activeSheetIndex, PHPExcel_Worksheet\getParent(), PHPExcel_Worksheet\getTitle(), PHPExcel_Worksheet\rebindParent(), and sheetNameExists().

Referenced by addExternalSheet(), and createSheet().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cellXfExists()

PHPExcel::cellXfExists ( $pCellStyle = null )

Check if style exists in style collection.

Parameters

PHPExcel_Style $pCellStyle

Returns: boolean

Definition at line 914 of file PHPExcel.php.

    {
        return in_array($pCellStyle, $this->_cellXfCollection, true);
    }

◆ copy()

PHPExcel::copy ( )

Copy workbook (!= clone!)

Returns: PHPExcel

Definition at line 848 of file PHPExcel.php.

                           {
        $copied = clone $this;
 
        $worksheetCount = count($this->_workSheetCollection);
        for ($i = 0; $i < $worksheetCount; ++$i) {
            $this->_workSheetCollection[$i] = $this->_workSheetCollection[$i]->copy();
            $this->_workSheetCollection[$i]->rebindParent($this);
        }
 
        return $copied;
    }

◆ createSheet()

PHPExcel::createSheet ( $iSheetIndex = NULL )

Create sheet and add it to this workbook.

Parameters

int | null $iSheetIndex Index where sheet should go (0,1,..., or null for last)

Returns: PHPExcel_Worksheet

Exceptions

PHPExcel_Exception

Definition at line 479 of file PHPExcel.php.

    {
        $newSheet = new PHPExcel_Worksheet($this);
        $this->addSheet($newSheet, $iSheetIndex);
        return $newSheet;
    }

References addSheet().

Here is the call graph for this function:

◆ discardMacros()

PHPExcel::discardMacros ( )

Remove all macros, certificate from spreadsheet.

Parameters

none

Returns: void

Definition at line 220 of file PHPExcel.php.

                                       {
                $this->_hasMacros=false;
                $this->_macrosCode=NULL;
                $this->_macrosCertificate=NULL;
        }

◆ disconnectWorksheets()

PHPExcel::disconnectWorksheets ( )

Disconnect all worksheets from this PHPExcel workbook object, typically so that the PHPExcel object can be unset.

Definition at line 399 of file PHPExcel.php.

    {
        $worksheet = NULL;
        foreach($this->_workSheetCollection as $k => &$worksheet) {
            $worksheet->disconnectCells();
            $this->_workSheetCollection[$k] = null;
        }
        unset($worksheet);
        $this->_workSheetCollection = array();
    }

References $worksheet.

Referenced by __destruct().

Here is the caller graph for this function:

◆ garbageCollect()

PHPExcel::garbageCollect ( )

Eliminate all unneeded cellXf and afterwards update the xfIndex for all cells and columns in the workbook.

Definition at line 1052 of file PHPExcel.php.

    {
        // how many references are there to each cellXf ?
        $countReferencesCellXf = array();
        foreach ($this->_cellXfCollection as $index => $cellXf) {
            $countReferencesCellXf[$index] = 0;
        }
 
        foreach ($this->getWorksheetIterator() as $sheet) {
 
            // from cells
            foreach ($sheet->getCellCollection(false) as $cellID) {
                $cell = $sheet->getCell($cellID);
                ++$countReferencesCellXf[$cell->getXfIndex()];
            }
 
            // from row dimensions
            foreach ($sheet->getRowDimensions() as $rowDimension) {
                if ($rowDimension->getXfIndex() !== null) {
                    ++$countReferencesCellXf[$rowDimension->getXfIndex()];
                }
            }
 
            // from column dimensions
            foreach ($sheet->getColumnDimensions() as $columnDimension) {
                ++$countReferencesCellXf[$columnDimension->getXfIndex()];
            }
        }
 
        // remove cellXfs without references and create mapping so we can update xfIndex
        // for all cells and columns
        $countNeededCellXfs = 0;
        foreach ($this->_cellXfCollection as $index => $cellXf) {
            if ($countReferencesCellXf[$index] > 0 || $index == 0) { // we must never remove the first cellXf
                ++$countNeededCellXfs;
            } else {
                unset($this->_cellXfCollection[$index]);
            }
            $map[$index] = $countNeededCellXfs - 1;
        }
        $this->_cellXfCollection = array_values($this->_cellXfCollection);
 
        // update the index for all cellXfs
        foreach ($this->_cellXfCollection as $i => $cellXf) {
            $cellXf->setIndex($i);
        }
 
        // make sure there is always at least one cellXf (there should be)
        if (empty($this->_cellXfCollection)) {
            $this->_cellXfCollection[] = new PHPExcel_Style();
        }
 
        // update the xfIndex for all cells, row dimensions, column dimensions
        foreach ($this->getWorksheetIterator() as $sheet) {
 
            // for all cells
            foreach ($sheet->getCellCollection(false) as $cellID) {
                $cell = $sheet->getCell($cellID);
                $cell->setXfIndex( $map[$cell->getXfIndex()] );
            }
 
            // for all row dimensions
            foreach ($sheet->getRowDimensions() as $rowDimension) {
                if ($rowDimension->getXfIndex() !== null) {
                    $rowDimension->setXfIndex( $map[$rowDimension->getXfIndex()] );
                }
            }
 
            // for all column dimensions
            foreach ($sheet->getColumnDimensions() as $columnDimension) {
                $columnDimension->setXfIndex( $map[$columnDimension->getXfIndex()] );
            }
 
                        // also do garbage collection for all the sheets
            $sheet->garbageCollect();
        }
    }

References getWorksheetIterator().

Here is the call graph for this function:

◆ getActiveSheet()

PHPExcel::getActiveSheet ( )

Get active sheet.

Returns: PHPExcel_Worksheet

Exceptions

PHPExcel_Exception

Definition at line 467 of file PHPExcel.php.

    {
        return $this->getSheet($this->_activeSheetIndex);
    }

References getSheet().

Referenced by setActiveSheetIndex().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getActiveSheetIndex()

PHPExcel::getActiveSheetIndex ( )

Get active sheet index.

Returns: int Active sheet index

Definition at line 671 of file PHPExcel.php.

    {
        return $this->_activeSheetIndex;
    }

References $_activeSheetIndex.

◆ getAllSheets()

PHPExcel::getAllSheets ( )

Get all sheets.

Returns: PHPExcel_Worksheet[]

Definition at line 590 of file PHPExcel.php.

    {
        return $this->_workSheetCollection;
    }

References $_workSheetCollection.

◆ getCalculationEngine()

PHPExcel::getCalculationEngine ( )

Return the calculation engine for this worksheet.

Returns: PHPExcel_Calculation

Definition at line 415 of file PHPExcel.php.

        {
                return $this->_calculationEngine;
        }       //      function getCellCacheController()

References $_calculationEngine.

◆ getCellStyleXfByHashCode()

PHPExcel::getCellStyleXfByHashCode ( $pValue = '' )

Get cellStyleXf by hash code.

Parameters

string $pValue

Returns: PHPExcel_Style|false

Definition at line 1012 of file PHPExcel.php.

    {
        foreach ($this->_cellStyleXfCollection as $cellStyleXf) {
            if ($cellStyleXf->getHashCode() == $pValue) {
                return $cellStyleXf;
            }
        }
        return false;
    }

◆ getCellStyleXfByIndex()

PHPExcel::getCellStyleXfByIndex ( $pIndex = 0 )

Get cellStyleXf by index.

Parameters

int $pIndex

Returns: PHPExcel_Style

Definition at line 1001 of file PHPExcel.php.

    {
        return $this->_cellStyleXfCollection[$pIndex];
    }

◆ getCellStyleXfCollection()

PHPExcel::getCellStyleXfCollection ( )

Get the workbook collection of cellStyleXfs.

Returns: PHPExcel_Style[]

Definition at line 990 of file PHPExcel.php.

    {
        return $this->_cellStyleXfCollection;
    }

References $_cellStyleXfCollection.

◆ getCellXfByHashCode()

PHPExcel::getCellXfByHashCode ( $pValue = '' )

Get cellXf by hash code.

Parameters

string $pValue

Returns: PHPExcel_Style|false

Definition at line 898 of file PHPExcel.php.

    {
        foreach ($this->_cellXfCollection as $cellXf) {
            if ($cellXf->getHashCode() == $pValue) {
                return $cellXf;
            }
        }
        return false;
    }

◆ getCellXfByIndex()

PHPExcel::getCellXfByIndex ( $pIndex = 0 )

Get cellXf by index.

Parameters

int $pIndex

Returns: PHPExcel_Style

Definition at line 887 of file PHPExcel.php.

    {
        return $this->_cellXfCollection[$pIndex];
    }

◆ getCellXfCollection()

PHPExcel::getCellXfCollection ( )

Get the workbook collection of cellXfs.

Returns: PHPExcel_Style[]

Definition at line 876 of file PHPExcel.php.

    {
        return $this->_cellXfCollection;
    }

References $_cellXfCollection.

◆ getCellXfSupervisor()

PHPExcel::getCellXfSupervisor ( )

Get the cellXf supervisor.

Returns: PHPExcel_Style

Definition at line 980 of file PHPExcel.php.

    {
        return $this->_cellXfSupervisor;
    }

References $_cellXfSupervisor.

◆ getDefaultStyle()

PHPExcel::getDefaultStyle ( )

Get default style.

Returns: PHPExcel_Style

Exceptions

PHPExcel_Exception

Definition at line 925 of file PHPExcel.php.

    {
        if (isset($this->_cellXfCollection[0])) {
            return $this->_cellXfCollection[0];
        }
        throw new PHPExcel_Exception('No default style found for this workbook');
    }

Referenced by PHPExcel_Writer_HTML\__construct().

Here is the caller graph for this function:

◆ getID()

PHPExcel::getID ( )

Return the unique ID value assigned to this spreadsheet workbook.

Returns: string

Definition at line 1135 of file PHPExcel.php.

                            {
        return $this->_uniqueID;
    }

References $_uniqueID.

◆ getIndex()

PHPExcel::getIndex ( PHPExcel_Worksheet $pSheet )

Get index for sheet.

Parameters

PHPExcel_Worksheet $pSheet

Returns: Sheet index

Exceptions

PHPExcel_Exception

Definition at line 620 of file PHPExcel.php.

    {
        foreach ($this->_workSheetCollection as $key => $value) {
            if ($value->getHashCode() == $pSheet->getHashCode()) {
                return $key;
            }
        }
 
        throw new PHPExcel_Exception("Sheet does not exist.");
    }

References PHPExcel_Worksheet\getHashCode().

Referenced by setActiveSheetIndexByName(), and setIndexByName().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMacrosCertificate()

PHPExcel::getMacrosCertificate ( )

Return the macros certificate.

Returns: binary|null

Definition at line 210 of file PHPExcel.php.

                                              {
                return $this->_macrosCertificate;
        }

References $_macrosCertificate.

◆ getMacrosCode()

PHPExcel::getMacrosCode ( )

Return the macros code.

Returns: binary|null

Definition at line 183 of file PHPExcel.php.

                                       {
                return $this->_macrosCode;
        }

References $_macrosCode.

◆ getNamedRange()

PHPExcel::getNamedRange	(		$namedRange,
		PHPExcel_Worksheet	$pSheet = `null`
	)

Get named range.

Parameters

string	$namedRange
PHPExcel_Worksheet \| null	$pSheet	Scope. Use null for global scope

Returns: PHPExcel_NamedRange|null

Definition at line 796 of file PHPExcel.php.

                                                                                  {
        $returnValue = null;
 
        if ($namedRange != '' && ($namedRange !== NULL)) {
            // first look for global defined name
            if (isset($this->_namedRanges[$namedRange])) {
                $returnValue = $this->_namedRanges[$namedRange];
            }
 
            // then look for local defined name (has priority over global defined name if both names exist)
            if (($pSheet !== NULL) && isset($this->_namedRanges[$pSheet->getTitle() . '!' . $namedRange])) {
                $returnValue = $this->_namedRanges[$pSheet->getTitle() . '!' . $namedRange];
            }
        }
 
        return $returnValue;
    }

◆ getNamedRanges()

PHPExcel::getNamedRanges ( )

Get named ranges.

Returns: PHPExcel_NamedRange[]

Definition at line 768 of file PHPExcel.php.

                                     {
        return $this->_namedRanges;
    }

References $_namedRanges.

Referenced by PHPExcel_Writer_Excel2007_Workbook\_writeNamedRanges().

Here is the caller graph for this function:

◆ getProperties()

PHPExcel::getProperties ( )

Get properties.

Returns: PHPExcel_DocumentProperties

Definition at line 425 of file PHPExcel.php.

    {
        return $this->_properties;
    }

References $_properties.

◆ getRibbonBinObjects()

PHPExcel::getRibbonBinObjects ( $What = 'all' )

retrieve Binaries Ribbon Objects

Definition at line 283 of file PHPExcel.php.

                                                        {
                $ReturnData=NULL;
                $What=strtolower($What);
                switch($What){
                case 'all':
                        return $this->_ribbonBinObjects;
                        break;
                case 'names':
                case 'data':
                        if(is_array($this->_ribbonBinObjects) && array_key_exists($What, $this->_ribbonBinObjects)){
                                $ReturnData=$this->_ribbonBinObjects[$What];
                        }
                        break;
                case 'types':
                        if(is_array($this->_ribbonBinObjects) && array_key_exists('data', $this->_ribbonBinObjects) && is_array($this->_ribbonBinObjects['data'])){
                                $tmpTypes=array_keys($this->_ribbonBinObjects['data']);
                                $ReturnData=array_unique(array_map(array($this,'_getExtensionOnly'), $tmpTypes));
                        }else
                                $ReturnData=array();//the caller want an array... not null if empty
                        break;
                }
                return $ReturnData;
        }

References $_ribbonBinObjects.

◆ getRibbonXMLData()

PHPExcel::getRibbonXMLData ( $What = 'all' )

retrieve ribbon XML Data

return string|null|array

Definition at line 243 of file PHPExcel.php.

                                                     {//we need some constants here...
                $ReturnData=NULL;
                $What=strtolower($What);
                switch($What){
                case 'all':
                        $ReturnData=$this->_ribbonXMLData;
                        break;
                case 'target':
                case 'data':
                        if(is_array($this->_ribbonXMLData) && array_key_exists($What,$this->_ribbonXMLData)){
                                $ReturnData=$this->_ribbonXMLData[$What];
                        }//else $ReturnData stay at null
                        break;
                }//default: $ReturnData at null
                return $ReturnData;
        }

References $_ribbonXMLData.

◆ getSecurity()

PHPExcel::getSecurity ( )

Get security.

Returns: PHPExcel_DocumentSecurity

Definition at line 445 of file PHPExcel.php.

    {
        return $this->_security;
    }

References $_security.

◆ getSheet()

PHPExcel::getSheet ( $pIndex = 0 )

Get sheet by index.

Parameters

int $pIndex Sheet index

Returns: PHPExcel_Worksheet

Exceptions

PHPExcel_Exception

Definition at line 573 of file PHPExcel.php.

    {
        if (!isset($this->_workSheetCollection[$pIndex])) {
            $numSheets = $this->getSheetCount();
            throw new PHPExcel_Exception(
                "Your requested sheet index: {$pIndex} is out of bounds. The actual number of sheets is {$numSheets}."
            );
        }
 
        return $this->_workSheetCollection[$pIndex];
    }

References getSheetCount().

Referenced by getActiveSheet(), and getSheetNames().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSheetByCodeName()

PHPExcel::getSheetByCodeName ( $pName = '' )

Get sheet by code name.

Warning : sheet don't have always a code name !

Parameters

string $pName Sheet name

Returns: PHPExcel_Worksheet

Definition at line 342 of file PHPExcel.php.

        {
                $worksheetCount = count($this->_workSheetCollection);
                for ($i = 0; $i < $worksheetCount; ++$i) {
                        if ($this->_workSheetCollection[$i]->getCodeName() == $pName) {
                                return $this->_workSheetCollection[$i];
                        }
                }
 
                return null;
        }

Referenced by sheetCodeNameExists().

Here is the caller graph for this function:

◆ getSheetByName()

PHPExcel::getSheetByName ( $pName = '' )

Get sheet by name.

Parameters

string $pName Sheet name

Returns: PHPExcel_Worksheet

Definition at line 601 of file PHPExcel.php.

    {
        $worksheetCount = count($this->_workSheetCollection);
        for ($i = 0; $i < $worksheetCount; ++$i) {
            if ($this->_workSheetCollection[$i]->getTitle() === $pName) {
                return $this->_workSheetCollection[$i];
            }
        }
 
        return NULL;
    }

Referenced by setActiveSheetIndexByName(), setIndexByName(), and sheetNameExists().

Here is the caller graph for this function:

◆ getSheetCount()

PHPExcel::getSheetCount ( )

Get sheet count.

Returns: int

Definition at line 661 of file PHPExcel.php.

    {
        return count($this->_workSheetCollection);
    }

Referenced by getSheet(), getSheetNames(), and PHPExcel_Reader_CSV\loadIntoExisting().

Here is the caller graph for this function:

◆ getSheetNames()

PHPExcel::getSheetNames ( )

Get sheet names.

Returns: string[]

Definition at line 719 of file PHPExcel.php.

    {
        $returnValue = array();
        $worksheetCount = $this->getSheetCount();
        for ($i = 0; $i < $worksheetCount; ++$i) {
            $returnValue[] = $this->getSheet($i)->getTitle();
        }
 
        return $returnValue;
    }

References getSheet(), and getSheetCount().

Here is the call graph for this function:

◆ getWorksheetIterator()

PHPExcel::getWorksheetIterator ( )

Get worksheet iterator.

Returns: PHPExcel_WorksheetIterator

Definition at line 839 of file PHPExcel.php.

                                           {
        return new PHPExcel_WorksheetIterator($this);
    }

Referenced by garbageCollect(), and PHPExcel_ReferenceHelper\updateNamedFormulas().

Here is the caller graph for this function:

◆ hasMacros()

PHPExcel::hasMacros ( )

The workbook has macros ?

Returns: true if workbook has macros, false if not

Definition at line 155 of file PHPExcel.php.

                                   {
                return $this->_hasMacros;
        }

References $_hasMacros.

◆ hasMacrosCertificate()

PHPExcel::hasMacrosCertificate ( )

Is the project signed ?

Returns: true|false

Definition at line 201 of file PHPExcel.php.

                                              {
                return !is_null($this->_macrosCertificate);
        }

◆ hasRibbon()

PHPExcel::hasRibbon ( )

This workbook have a custom UI ?

Returns: true|false

Definition at line 312 of file PHPExcel.php.

                                   {
                return !is_null($this->_ribbonXMLData);
        }

◆ hasRibbonBinObjects()

PHPExcel::hasRibbonBinObjects ( )

This workbook have additionnal object for the ribbon ?

Returns: true|false

Definition at line 321 of file PHPExcel.php.

                                             {
                return !is_null($this->_ribbonBinObjects);
        }

◆ removeCellStyleXfByIndex()

PHPExcel::removeCellStyleXfByIndex ( $pIndex = 0 )

Remove cellStyleXf by index.

Parameters

int $pIndex

Exceptions

PHPExcel_Exception

Definition at line 1039 of file PHPExcel.php.

    {
        if ($pIndex > count($this->_cellStyleXfCollection) - 1) {
            throw new PHPExcel_Exception("CellStyleXf index is out of bounds.");
        } else {
            array_splice($this->_cellStyleXfCollection, $pIndex, 1);
        }
    }

◆ removeCellXfByIndex()

PHPExcel::removeCellXfByIndex ( $pIndex = 0 )

Remove cellXf by index.

It is ensured that all cells get their xf index updated.

Parameters

int $pIndex Index to cellXf

Exceptions

PHPExcel_Exception

Definition at line 950 of file PHPExcel.php.

    {
        if ($pIndex > count($this->_cellXfCollection) - 1) {
            throw new PHPExcel_Exception("CellXf index is out of bounds.");
        } else {
            // first remove the cellXf
            array_splice($this->_cellXfCollection, $pIndex, 1);
 
            // then update cellXf indexes for cells
            foreach ($this->_workSheetCollection as $worksheet) {
                foreach ($worksheet->getCellCollection(false) as $cellID) {
                    $cell = $worksheet->getCell($cellID);
                    $xfIndex = $cell->getXfIndex();
                    if ($xfIndex > $pIndex ) {
                        // decrease xf index by 1
                        $cell->setXfIndex($xfIndex - 1);
                    } else if ($xfIndex == $pIndex) {
                        // set to default xf index 0
                        $cell->setXfIndex(0);
                    }
                }
            }
        }
    }

References $worksheet.

◆ removeNamedRange()

PHPExcel::removeNamedRange	(		$namedRange,
		PHPExcel_Worksheet	$pSheet = `null`
	)

Remove named range.

Parameters

string	$namedRange
PHPExcel_Worksheet \| null	$pSheet	Scope: use null for global scope.

Returns: PHPExcel

Definition at line 821 of file PHPExcel.php.

                                                                                     {
        if ($pSheet === NULL) {
            if (isset($this->_namedRanges[$namedRange])) {
                unset($this->_namedRanges[$namedRange]);
            }
        } else {
            if (isset($this->_namedRanges[$pSheet->getTitle() . '!' . $namedRange])) {
                unset($this->_namedRanges[$pSheet->getTitle() . '!' . $namedRange]);
            }
        }
        return $this;
    }

◆ removeSheetByIndex()

PHPExcel::removeSheetByIndex ( $pIndex = 0 )

Remove sheet by index.

Parameters

int $pIndex Active sheet index

Exceptions

PHPExcel_Exception

Definition at line 546 of file PHPExcel.php.

    {
 
        $numSheets = count($this->_workSheetCollection);
 
        if ($pIndex > $numSheets - 1) {
            throw new PHPExcel_Exception(
                "You tried to remove a sheet by the out of bounds index: {$pIndex}. The actual number of sheets is {$numSheets}."
            );
        } else {
            array_splice($this->_workSheetCollection, $pIndex, 1);
        }
        // Adjust active sheet index if necessary
        if (($this->_activeSheetIndex >= $pIndex) &&
            ($pIndex > count($this->_workSheetCollection) - 1)) {
            --$this->_activeSheetIndex;
        }
 
    }

References $_activeSheetIndex.

◆ setActiveSheetIndex()

PHPExcel::setActiveSheetIndex ( $pIndex = 0 )

Set active sheet index.

Parameters

int $pIndex Active sheet index

Exceptions

PHPExcel_Exception

Returns: PHPExcel_Worksheet

Definition at line 683 of file PHPExcel.php.

    {
        $numSheets = count($this->_workSheetCollection);
 
        if ($pIndex > $numSheets - 1) {
            throw new PHPExcel_Exception(
                "You tried to set a sheet active by the out of bounds index: {$pIndex}. The actual number of sheets is {$numSheets}."
            );
        } else {
            $this->_activeSheetIndex = $pIndex;
        }
        return $this->getActiveSheet();
    }

References getActiveSheet().

Referenced by setActiveSheetIndexByName().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setActiveSheetIndexByName()

PHPExcel::setActiveSheetIndexByName ( $pValue = '' )

Set active sheet index by name.

Parameters

string $pValue Sheet title

Returns: PHPExcel_Worksheet

Exceptions

PHPExcel_Exception

Definition at line 704 of file PHPExcel.php.

    {
        if (($worksheet = $this->getSheetByName($pValue)) instanceof PHPExcel_Worksheet) {
            $this->setActiveSheetIndex($this->getIndex($worksheet));
            return $worksheet;
        }
 
        throw new PHPExcel_Exception('Workbook does not contain sheet:' . $pValue);
    }

References $worksheet, getIndex(), getSheetByName(), and setActiveSheetIndex().

Here is the call graph for this function:

◆ setHasMacros()

PHPExcel::setHasMacros ( $hasMacros = false )

Define if a workbook has macros.

Parameters

true|false

Definition at line 164 of file PHPExcel.php.

                                                      {
                $this->_hasMacros=(bool)$hasMacros;
        }

Referenced by setMacrosCode().

Here is the caller graph for this function:

◆ setIndexByName()

PHPExcel::setIndexByName	(	$sheetName,
		$newIndex
	)

Set index for sheet by sheet name.

Parameters

string	$sheetName	Sheet name to modify index for
int	$newIndex	New index for the sheet

Returns: New sheet index

Exceptions

PHPExcel_Exception

Definition at line 639 of file PHPExcel.php.

    {
        $oldIndex = $this->getIndex($this->getSheetByName($sheetName));
        $pSheet = array_splice(
            $this->_workSheetCollection,
            $oldIndex,
            1
        );
        array_splice(
            $this->_workSheetCollection,
            $newIndex,
            0,
            $pSheet
        );
        return $newIndex;
    }

References getIndex(), and getSheetByName().

Here is the call graph for this function:

◆ setMacrosCertificate()

PHPExcel::setMacrosCertificate ( $Certificate = NULL )

Set the macros certificate.

Parameters

binary|null

Definition at line 192 of file PHPExcel.php.

                                                               {
                $this->_macrosCertificate=$Certificate;
        }

◆ setMacrosCode()

PHPExcel::setMacrosCode ( $MacrosCode )

Set the macros code.

Parameters

binary string|null

Definition at line 173 of file PHPExcel.php.

                                                  {
                $this->_macrosCode=$MacrosCode;
                $this->setHasMacros(!is_null($MacrosCode));
        }

References setHasMacros().

Here is the call graph for this function:

◆ setProperties()

PHPExcel::setProperties ( PHPExcel_DocumentProperties $pValue )

Set properties.

Parameters

PHPExcel_DocumentProperties $pValue

Definition at line 435 of file PHPExcel.php.

    {
        $this->_properties = $pValue;
    }

◆ setRibbonBinObjects()

PHPExcel::setRibbonBinObjects	(	$BinObjectsNames = `NULL`,
		$BinObjectsData = `NULL`
	)

store binaries ribbon objects (pictures)

Definition at line 264 of file PHPExcel.php.

                                                                                        {
                if(!is_null($BinObjectsNames) && !is_null($BinObjectsData)){
                        $this->_ribbonBinObjects=array('names'=>$BinObjectsNames, 'data'=>$BinObjectsData);
                }else{
                        $this->_ribbonBinObjects=NULL;
                }
        }

◆ setRibbonXMLData()

PHPExcel::setRibbonXMLData	(	$Target = `NULL`,
		$XMLData = `NULL`
	)

set ribbon XML data

Definition at line 230 of file PHPExcel.php.

                                                                     {
                if(!is_null($Target) && !is_null($XMLData)){
                        $this->_ribbonXMLData=array('target'=>$Target, 'data'=>$XMLData);
                }else{
                        $this->_ribbonXMLData=NULL;
                }
        }

◆ setSecurity()

PHPExcel::setSecurity ( PHPExcel_DocumentSecurity $pValue )

Set security.

Parameters

PHPExcel_DocumentSecurity $pValue

Definition at line 455 of file PHPExcel.php.

    {
        $this->_security = $pValue;
    }

◆ sheetCodeNameExists()

PHPExcel::sheetCodeNameExists ( $pSheetCodeName )

Check if a sheet with a specified code name already exists.

Parameters

string $pSheetCodeName Name of the worksheet to check

Returns: boolean

Definition at line 331 of file PHPExcel.php.

    {
                return ($this->getSheetByCodeName($pSheetCodeName) !== NULL);
    }

References getSheetByCodeName().

Here is the call graph for this function:

◆ sheetNameExists()

PHPExcel::sheetNameExists ( $pSheetName )

Check if a sheet with a specified name already exists.

Parameters

string $pSheetName Name of the worksheet to check

Returns: boolean

Definition at line 492 of file PHPExcel.php.

    {
        return ($this->getSheetByName($pSheetName) !== NULL);
    }

References getSheetByName().

Referenced by addExternalSheet(), and addSheet().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $_activeSheetIndex

PHPExcel::$_activeSheetIndex = 0

private

Definition at line 85 of file PHPExcel.php.

Referenced by addSheet(), getActiveSheetIndex(), and removeSheetByIndex().

◆ $_calculationEngine

PHPExcel::$_calculationEngine = NULL

private

Definition at line 78 of file PHPExcel.php.

Referenced by getCalculationEngine().

◆ $_cellStyleXfCollection

PHPExcel::$_cellStyleXfCollection = array()

private

Definition at line 113 of file PHPExcel.php.

Referenced by getCellStyleXfCollection().

◆ $_cellXfCollection

PHPExcel::$_cellXfCollection = array()

private

Definition at line 106 of file PHPExcel.php.

Referenced by getCellXfCollection().

◆ $_cellXfSupervisor

PHPExcel::$_cellXfSupervisor

private

Definition at line 99 of file PHPExcel.php.

Referenced by getCellXfSupervisor().

◆ $_hasMacros

PHPExcel::$_hasMacros = FALSE

private

Definition at line 120 of file PHPExcel.php.

Referenced by hasMacros().

◆ $_macrosCertificate

PHPExcel::$_macrosCertificate =NULL

private

Definition at line 133 of file PHPExcel.php.

Referenced by getMacrosCertificate().

◆ $_macrosCode

PHPExcel::$_macrosCode =NULL

private

Definition at line 127 of file PHPExcel.php.

Referenced by getMacrosCode().

◆ $_namedRanges

PHPExcel::$_namedRanges = array()

private

Definition at line 92 of file PHPExcel.php.

Referenced by getNamedRanges().

◆ $_properties

PHPExcel::$_properties

private

Definition at line 57 of file PHPExcel.php.

Referenced by getProperties().

◆ $_ribbonBinObjects

PHPExcel::$_ribbonBinObjects =NULL

private

Definition at line 148 of file PHPExcel.php.

Referenced by getRibbonBinObjects().

◆ $_ribbonXMLData

PHPExcel::$_ribbonXMLData =NULL

private

Definition at line 140 of file PHPExcel.php.

Referenced by getRibbonXMLData().

◆ $_security

PHPExcel::$_security

private

Definition at line 64 of file PHPExcel.php.

Referenced by getSecurity().

◆ $_uniqueID

PHPExcel::$_uniqueID

private

Definition at line 50 of file PHPExcel.php.

Referenced by getID().

◆ $_workSheetCollection

PHPExcel::$_workSheetCollection = array()

private

Definition at line 71 of file PHPExcel.php.

Referenced by getAllSheets().

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

libs/composer/vendor/phpoffice/phpexcel/Classes/PHPExcel.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

◆ __destruct()

Member Function Documentation

◆ __clone()

◆ _getExtensionOnly()

◆ addCellStyleXf()

◆ addCellXf()

◆ addExternalSheet()

◆ addNamedRange()

◆ addSheet()

◆ cellXfExists()

◆ copy()

◆ createSheet()

◆ discardMacros()

◆ disconnectWorksheets()

◆ garbageCollect()

◆ getActiveSheet()

◆ getActiveSheetIndex()

◆ getAllSheets()

◆ getCalculationEngine()

◆ getCellStyleXfByHashCode()

◆ getCellStyleXfByIndex()

◆ getCellStyleXfCollection()

◆ getCellXfByHashCode()

◆ getCellXfByIndex()

◆ getCellXfCollection()

◆ getCellXfSupervisor()

◆ getDefaultStyle()

◆ getID()

◆ getIndex()

◆ getMacrosCertificate()

◆ getMacrosCode()

◆ getNamedRange()

◆ getNamedRanges()

◆ getProperties()

◆ getRibbonBinObjects()

◆ getRibbonXMLData()

◆ getSecurity()

◆ getSheet()

◆ getSheetByCodeName()

◆ getSheetByName()

◆ getSheetCount()

◆ getSheetNames()

◆ getWorksheetIterator()

◆ hasMacros()

◆ hasMacrosCertificate()

◆ hasRibbon()

◆ hasRibbonBinObjects()

◆ removeCellStyleXfByIndex()

◆ removeCellXfByIndex()

◆ removeNamedRange()

◆ removeSheetByIndex()

◆ setActiveSheetIndex()

◆ setActiveSheetIndexByName()

◆ setHasMacros()

◆ setIndexByName()

◆ setMacrosCertificate()

◆ setMacrosCode()

◆ setProperties()

◆ setRibbonBinObjects()

◆ setRibbonXMLData()

◆ setSecurity()

◆ sheetCodeNameExists()

◆ sheetNameExists()

Field Documentation

◆ $_activeSheetIndex

◆ $_calculationEngine

◆ $_cellStyleXfCollection

◆ $_cellXfCollection

◆ $_cellXfSupervisor

◆ $_hasMacros

◆ $_macrosCertificate

◆ $_macrosCode

◆ $_namedRanges

◆ $_properties