Collaboration diagram for PhpOffice\PhpSpreadsheet\Spreadsheet:

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

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

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

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

	setMacrosCertificate ($certificate)
	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, $xmlData)
	set ribbon XML data. More...

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

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

	getUnparsedLoadedData ()
	List of unparsed loaded data for export to same format with better compatibility. More...

	setUnparsedLoadedData (array $unparsedLoadedData)
	List of unparsed loaded data for export to same format with better compatibility. 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 PhpSpreadsheet with one Worksheet. More...

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

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

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

	getProperties ()
	Get properties. More...

	setProperties (Document\Properties $pValue)
	Set properties. More...

	getSecurity ()
	Get security. More...

	setSecurity (Document\Security $pValue)
	Set security. More...

	getActiveSheet ()
	Get active sheet. More...

	createSheet ($sheetIndex=null)
	Create sheet and add it to this workbook. More...

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

	addSheet (Worksheet $pSheet, $iSheetIndex=null)
	Add sheet. More...

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

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

	getAllSheets ()
	Get all sheets. More...

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

	getIndex (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)
	Set active sheet index. More...

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

	getSheetNames ()
	Get sheet names. More...

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

	getNamedRanges ()
	Get an array of all Named Ranges. More...

	getNamedFormulae ()
	Get an array of all Named Formulae. More...

	getDefinedNames ()
	Get an array of all Defined Names (both named ranges and named formulae). More...

	addNamedRange (NamedRange $namedRange)
	Add a named range. More...

	addNamedFormula (NamedFormula $namedFormula)
	Add a named formula. More...

	addDefinedName (DefinedName $definedName)
	Add a defined name (either a named range or a named formula). More...

	getNamedRange (string $namedRange, ?Worksheet $pSheet=null)
	Get named range. More...

	getNamedFormula (string $namedFormula, ?Worksheet $pSheet=null)
	Get named formula. More...

	getDefinedName (string $definedName, ?Worksheet $pSheet=null)
	Get named range. More...

	removeNamedRange (string $namedRange, ?Worksheet $pSheet=null)
	Remove named range. More...

	removeNamedFormula (string $namedFormula, ?Worksheet $pSheet=null)
	Remove named formula. More...

	removeDefinedName (string $definedName, ?Worksheet $pSheet=null)
	Remove defined name. 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)
	Get cellXf by index. More...

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

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

	getDefaultStyle ()
	Get default style. More...

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

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

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

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

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

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

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

	removeCellStyleXfByIndex ($pIndex)
	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...

	getShowHorizontalScroll ()
	Get the visibility of the horizonal scroll bar in the application. More...

	setShowHorizontalScroll ($showHorizontalScroll)
	Set the visibility of the horizonal scroll bar in the application. More...

	getShowVerticalScroll ()
	Get the visibility of the vertical scroll bar in the application. More...

	setShowVerticalScroll ($showVerticalScroll)
	Set the visibility of the vertical scroll bar in the application. More...

	getShowSheetTabs ()
	Get the visibility of the sheet tabs in the application. More...

	setShowSheetTabs ($showSheetTabs)
	Set the visibility of the sheet tabs in the application. More...

	getMinimized ()
	Return whether the workbook window is minimized. More...

	setMinimized ($minimized)
	Set whether the workbook window is minimized. More...

	getAutoFilterDateGrouping ()
	Return whether to group dates when presenting the user with filtering optiomd in the user interface. More...

	setAutoFilterDateGrouping ($autoFilterDateGrouping)
	Set whether to group dates when presenting the user with filtering optiomd in the user interface. More...

	getFirstSheetIndex ()
	Return the first sheet in the book view. More...

	setFirstSheetIndex ($firstSheetIndex)
	Set the first sheet in the book view. More...

	getVisibility ()
	Return the visibility status of the workbook. More...

	setVisibility ($visibility)
	Set the visibility status of the workbook. More...

	getTabRatio ()
	Get the ratio between the workbook tabs bar and the horizontal scroll bar. More...

	setTabRatio ($tabRatio)
	Set the ratio between the workbook tabs bar and the horizontal scroll bar TabRatio is assumed to be out of 1000 of the horizontal window width. More...

Data Fields
const	VISIBILITY_VISIBLE = 'visible'

const	VISIBILITY_HIDDEN = 'hidden'

const	VISIBILITY_VERY_HIDDEN = 'veryHidden'

Private Member Functions
	getExtensionOnly ($path)
	return the extension of a filename. More...

	getGlobalDefinedNameByType (string $name, bool $type)

	getLocalDefinedNameByType (string $name, bool $type, ?Worksheet $pSheet=null)

Private Attributes
const	DEFINED_NAME_IS_RANGE = false

const	DEFINED_NAME_IS_FORMULA = true

	$uniqueID

	$properties

	$security

	$workSheetCollection = []

	$calculationEngine

	$activeSheetIndex = 0

	$definedNames = []

	$cellXfSupervisor

	$cellXfCollection = []

	$cellStyleXfCollection = []

	$hasMacros = false

	$macrosCode

	$macrosCertificate

	$ribbonXMLData

	$ribbonBinObjects

	$unparsedLoadedData = []

	$showHorizontalScroll = true

	$showVerticalScroll = true

	$showSheetTabs = true

	$minimized = false

	$autoFilterDateGrouping = true

	$firstSheetIndex = 0

	$visibility = self::VISIBILITY_VISIBLE

	$tabRatio = 600

Static Private Attributes
static	$workbookViewVisibilityValues

Detailed Description

Definition at line 11 of file Spreadsheet.php.

Constructor & Destructor Documentation

◆ __construct()

PhpOffice\PhpSpreadsheet\Spreadsheet::__construct ( )

Create a new PhpSpreadsheet with one Worksheet.

Definition at line 473 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\addCellStyleXf(), and PhpOffice\PhpSpreadsheet\Spreadsheet\addCellXf().

     {
         $this->uniqueID = uniqid('', true);
         $this->calculationEngine = new Calculation($this);
 
         // Initialise worksheet collection and add one worksheet
         $this->workSheetCollection = [];
         $this->workSheetCollection[] = new Worksheet($this);
         $this->activeSheetIndex = 0;
 
         // Create document properties
         $this->properties = new Document\Properties();
 
         // Create document security
         $this->security = new Document\Security();
 
         // Set defined names
         $this->definedNames = [];
 
         // Create the cellXf supervisor
         $this->cellXfSupervisor = new Style(true);
         $this->cellXfSupervisor->bindParent($this);
 
         // Create the default style
         $this->addCellXf(new Style());
         $this->addCellStyleXf(new Style());
     }

Here is the call graph for this function:

◆ __destruct()

PhpOffice\PhpSpreadsheet\Spreadsheet::__destruct ( )

Code to execute when this worksheet is unset().

Definition at line 504 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\disconnectWorksheets().

     {
         $this->disconnectWorksheets();
         $this->calculationEngine = null;
         $this->cellXfCollection = [];
         $this->cellStyleXfCollection = [];
     }

Here is the call graph for this function:

Member Function Documentation

◆ __clone()

PhpOffice\PhpSpreadsheet\Spreadsheet::__clone ( )

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

Definition at line 1123 of file Spreadsheet.php.

References $key.

     {
         // @phpstan-ignore-next-line
         foreach ($this as $key => $val) {
             if (is_object($val) || (is_array($val))) {
                 $this->{$key} = unserialize(serialize($val));
             }
         }
     }

◆ addCellStyleXf()

PhpOffice\PhpSpreadsheet\Spreadsheet::addCellStyleXf ( Style $pStyle )

Add a cellStyleXf to the workbook.

Definition at line 1291 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Style\Style\setIndex().

Referenced by PhpOffice\PhpSpreadsheet\Spreadsheet\__construct().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addCellXf()

PhpOffice\PhpSpreadsheet\Spreadsheet::addCellXf ( Style $style )

Add a cellXf to the workbook.

Definition at line 1202 of file Spreadsheet.php.

References $style, and PhpOffice\PhpSpreadsheet\Style\Style\setIndex().

Referenced by PhpOffice\PhpSpreadsheet\Spreadsheet\__construct(), and PhpOffice\PhpSpreadsheet\Spreadsheet\addExternalSheet().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addDefinedName()

PhpOffice\PhpSpreadsheet\Spreadsheet::addDefinedName ( DefinedName $definedName )

Add a defined name (either a named range or a named formula).

If a defined named with this name already exists, then this will replace the existing value.

Definition at line 936 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\DefinedName\getName(), PhpOffice\PhpSpreadsheet\DefinedName\getScope(), and PhpOffice\PhpSpreadsheet\Shared\StringHelper\strToUpper().

Referenced by PhpOffice\PhpSpreadsheet\Spreadsheet\addNamedFormula(), PhpOffice\PhpSpreadsheet\Spreadsheet\addNamedRange(), PhpOffice\PhpSpreadsheet\Reader\Xml\load(), and PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\rebindParent().

                                                             : void
     {
         $upperCaseName = StringHelper::strToUpper($definedName->getName());
         if ($definedName->getScope() == null) {
             // global scope
             $this->definedNames[$upperCaseName] = $definedName;
         } else {
             // local scope
             $this->definedNames[$definedName->getScope()->getTitle() . '!' . $upperCaseName] = $definedName;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addExternalSheet()

PhpOffice\PhpSpreadsheet\Spreadsheet::addExternalSheet	(	Worksheet	$pSheet,
			$iSheetIndex = `null`
	)

Add external sheet.

Parameters

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

Returns: Worksheet

Definition at line 848 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\addCellXf(), PhpOffice\PhpSpreadsheet\Spreadsheet\addSheet(), PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\getCoordinates(), PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\getParent(), PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\getTitle(), PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\rebindParent(), and PhpOffice\PhpSpreadsheet\Spreadsheet\sheetNameExists().

     {
         if ($this->sheetNameExists($pSheet->getTitle())) {
             throw new 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->getCoordinates(false) as $coordinate) {
             $cell = $pSheet->getCell($coordinate);
             $cell->setXfIndex($cell->getXfIndex() + $countCellXfs);
         }
 
         return $this->addSheet($pSheet, $iSheetIndex);
     }

Here is the call graph for this function:

◆ addNamedFormula()

PhpOffice\PhpSpreadsheet\Spreadsheet::addNamedFormula ( NamedFormula $namedFormula )

Add a named formula.

If a named formula with this name already exists, then this will replace the existing value.

Definition at line 927 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\addDefinedName().

                                                                : void
     {
         $this->addDefinedName($namedFormula);
     }

Here is the call graph for this function:

◆ addNamedRange()

PhpOffice\PhpSpreadsheet\Spreadsheet::addNamedRange ( NamedRange $namedRange )

Add a named range.

If a named range with this name already exists, then this will replace the existing value.

Definition at line 918 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\addDefinedName().

                                                          : void
     {
         $this->addDefinedName($namedRange);
     }

Here is the call graph for this function:

◆ addSheet()

PhpOffice\PhpSpreadsheet\Spreadsheet::addSheet	(	Worksheet	$pSheet,
			$iSheetIndex = `null`
	)

Add sheet.

Parameters

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

Returns: Worksheet

Definition at line 615 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\$activeSheetIndex, PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\getParent(), PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\getTitle(), PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\rebindParent(), and PhpOffice\PhpSpreadsheet\Spreadsheet\sheetNameExists().

Referenced by PhpOffice\PhpSpreadsheet\Spreadsheet\addExternalSheet(), and PhpOffice\PhpSpreadsheet\Spreadsheet\createSheet().

     {
         if ($this->sheetNameExists($pSheet->getTitle())) {
             throw new 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,
                 [$pSheet]
             );
 
             // Adjust active sheet index if necessary
             if ($this->activeSheetIndex >= $iSheetIndex) {
                 ++$this->activeSheetIndex;
             }
         }
 
         if ($pSheet->getParent() === null) {
             $pSheet->rebindParent($this);
         }
 
         return $pSheet;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cellXfExists()

PhpOffice\PhpSpreadsheet\Spreadsheet::cellXfExists ( $pCellStyle )

Check if style exists in style collection.

Parameters

Style $pCellStyle

Returns: bool

Definition at line 1180 of file Spreadsheet.php.

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

◆ copy()

PhpOffice\PhpSpreadsheet\Spreadsheet::copy ( )

Copy workbook (!= clone!).

Returns: Spreadsheet

Definition at line 1107 of file Spreadsheet.php.

References $i.

     {
         $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()

PhpOffice\PhpSpreadsheet\Spreadsheet::createSheet ( $sheetIndex = null )

Create sheet and add it to this workbook.

Parameters

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

Returns: Worksheet

Definition at line 588 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\addSheet().

Referenced by PhpOffice\PhpSpreadsheet\Reader\Ods\load(), PhpOffice\PhpSpreadsheet\Reader\Xml\load(), PhpOffice\PhpSpreadsheet\Reader\Html\loadDocument(), PhpOffice\PhpSpreadsheet\Reader\Csv\loadIntoExisting(), and PhpOffice\PhpSpreadsheet\Reader\Slk\loadIntoExisting().

     {
         $newSheet = new Worksheet($this);
         $this->addSheet($newSheet, $sheetIndex);
 
         return $newSheet;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ discardMacros()

PhpOffice\PhpSpreadsheet\Spreadsheet::discardMacros ( )

Remove all macros, certificate from spreadsheet.

Definition at line 276 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\hasMacros().

                                    : void
     {
         $this->hasMacros = false;
         $this->macrosCode = null;
         $this->macrosCertificate = null;
     }

Here is the call graph for this function:

◆ disconnectWorksheets()

PhpOffice\PhpSpreadsheet\Spreadsheet::disconnectWorksheets ( )

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

Definition at line 516 of file Spreadsheet.php.

Referenced by PhpOffice\PhpSpreadsheet\Spreadsheet\__destruct().

                                           : void
     {
         foreach ($this->workSheetCollection as $worksheet) {
             $worksheet->disconnectCells();
             unset($worksheet);
         }
         $this->workSheetCollection = [];
     }

Here is the caller graph for this function:

◆ garbageCollect()

PhpOffice\PhpSpreadsheet\Spreadsheet::garbageCollect ( )

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

Definition at line 1314 of file Spreadsheet.php.

References $i, $index, $map, and PhpOffice\PhpSpreadsheet\Spreadsheet\getWorksheetIterator().

                                     : void
     {
         // how many references are there to each cellXf ?
         $countReferencesCellXf = [];
         foreach ($this->cellXfCollection as $index => $cellXf) {
             $countReferencesCellXf[$index] = 0;
         }
 
         foreach ($this->getWorksheetIterator() as $sheet) {
             // from cells
             foreach ($sheet->getCoordinates(false) as $coordinate) {
                 $cell = $sheet->getCell($coordinate);
                 ++$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;
         $map = [];
         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 Style();
         }
 
         // update the xfIndex for all cells, row dimensions, column dimensions
         foreach ($this->getWorksheetIterator() as $sheet) {
             // for all cells
             foreach ($sheet->getCoordinates(false) as $coordinate) {
                 $cell = $sheet->getCell($coordinate);
                 $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();
         }
     }

Here is the call graph for this function:

◆ getActiveSheet()

PhpOffice\PhpSpreadsheet\Spreadsheet::getActiveSheet ( )

Get active sheet.

Returns: Worksheet

Definition at line 576 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\getSheet().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getActiveSheetIndex()

PhpOffice\PhpSpreadsheet\Spreadsheet::getActiveSheetIndex ( )

Get active sheet index.

Returns: int Active sheet index

Definition at line 780 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\$activeSheetIndex.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Workbook\writeBookViews().

     {
         return $this->activeSheetIndex;
     }

Here is the caller graph for this function:

◆ getAllSheets()

PhpOffice\PhpSpreadsheet\Spreadsheet::getAllSheets ( )

Get all sheets.

Returns: Worksheet[]

Definition at line 699 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\$workSheetCollection.

     {
         return $this->workSheetCollection;
     }

◆ getAutoFilterDateGrouping()

PhpOffice\PhpSpreadsheet\Spreadsheet::getAutoFilterDateGrouping ( )

Return whether to group dates when presenting the user with filtering optiomd in the user interface.

Returns: bool true if workbook window is minimized

Definition at line 1487 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\$autoFilterDateGrouping.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Workbook\writeBookViews().

     {
         return $this->autoFilterDateGrouping;
     }

Here is the caller graph for this function:

◆ getCalculationEngine()

PhpOffice\PhpSpreadsheet\Spreadsheet::getCalculationEngine ( )

Return the calculation engine for this worksheet.

Returns: null|Calculation

Definition at line 530 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\$calculationEngine.

     {
         return $this->calculationEngine;
     }

◆ getCellStyleXfByHashCode()

PhpOffice\PhpSpreadsheet\Spreadsheet::getCellStyleXfByHashCode ( $pValue )

Get cellStyleXf by hash code.

Parameters

string $pValue

Returns: false|Style

Definition at line 1277 of file Spreadsheet.php.

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

◆ getCellStyleXfByIndex()

PhpOffice\PhpSpreadsheet\Spreadsheet::getCellStyleXfByIndex ( $pIndex )

Get cellStyleXf by index.

Parameters

int $pIndex Index to cellXf

Returns: Style

Definition at line 1265 of file Spreadsheet.php.

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

◆ getCellStyleXfCollection()

PhpOffice\PhpSpreadsheet\Spreadsheet::getCellStyleXfCollection ( )

Get the workbook collection of cellStyleXfs.

Returns: Style[]

Definition at line 1253 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\$cellStyleXfCollection.

     {
         return $this->cellStyleXfCollection;
     }

◆ getCellXfByHashCode()

PhpOffice\PhpSpreadsheet\Spreadsheet::getCellXfByHashCode ( $pValue )

Get cellXf by hash code.

Parameters

string $pValue

Returns: false|Style

Definition at line 1162 of file Spreadsheet.php.

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

◆ getCellXfByIndex()

PhpOffice\PhpSpreadsheet\Spreadsheet::getCellXfByIndex ( $pIndex )

Get cellXf by index.

Parameters

int $pIndex

Returns: Style

Definition at line 1150 of file Spreadsheet.php.

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

◆ getCellXfCollection()

PhpOffice\PhpSpreadsheet\Spreadsheet::getCellXfCollection ( )

Get the workbook collection of cellXfs.

Returns: Style[]

Definition at line 1138 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\$cellXfCollection.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Style\allStyles(), PhpOffice\PhpSpreadsheet\Writer\Xlsx\Style\writeStyles(), and PhpOffice\PhpSpreadsheet\Writer\Ods\Content\writeXfStyles().

     {
         return $this->cellXfCollection;
     }

Here is the caller graph for this function:

◆ getCellXfSupervisor()

PhpOffice\PhpSpreadsheet\Spreadsheet::getCellXfSupervisor ( )

Get the cellXf supervisor.

Returns: Style

Definition at line 1243 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\$cellXfSupervisor.

     {
         return $this->cellXfSupervisor;
     }

◆ getDefaultStyle()

PhpOffice\PhpSpreadsheet\Spreadsheet::getDefaultStyle ( )

Get default style.

Returns: Style

Definition at line 1190 of file Spreadsheet.php.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Slk\processPFinal(), and PhpOffice\PhpSpreadsheet\Writer\Xlsx\Style\writeCellStyleXf().

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

Here is the caller graph for this function:

◆ getDefinedName()

PhpOffice\PhpSpreadsheet\Spreadsheet::getDefinedName	(	string	$definedName,
		?Worksheet	$pSheet = `null`
	)

Get named range.

Parameters

null | Worksheet $pSheet Scope. Use null for global scope

Definition at line 1014 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Shared\StringHelper\strToUpper().

                                                                                   : ?DefinedName
     {
         $returnValue = null;
 
         if ($definedName !== '') {
             $definedName = StringHelper::strToUpper($definedName);
             // first look for global defined name
             if (isset($this->definedNames[$definedName])) {
                 $returnValue = $this->definedNames[$definedName];
             }
 
             // then look for local defined name (has priority over global defined name if both names exist)
             if (($pSheet !== null) && isset($this->definedNames[$pSheet->getTitle() . '!' . $definedName])) {
                 $returnValue = $this->definedNames[$pSheet->getTitle() . '!' . $definedName];
             }
         }
 
         return $returnValue;
     }

Here is the call graph for this function:

◆ getDefinedNames()

PhpOffice\PhpSpreadsheet\Spreadsheet::getDefinedNames ( )

Get an array of all Defined Names (both named ranges and named formulae).

Returns: DefinedName[]

Definition at line 909 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\$definedNames.

                                      : array
     {
         return $this->definedNames;
     }

◆ getExtensionOnly()

PhpOffice\PhpSpreadsheet\Spreadsheet::getExtensionOnly ( $path )

private

return the extension of a filename.

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

Parameters

mixed $path

Returns: string

Definition at line 372 of file Spreadsheet.php.

References $path.

     {
         $extension = pathinfo($path, PATHINFO_EXTENSION);
 
         return is_array($extension) ? '' : $extension;
     }

◆ getFirstSheetIndex()

PhpOffice\PhpSpreadsheet\Spreadsheet::getFirstSheetIndex ( )

Return the first sheet in the book view.

Returns: int First sheet in book view

Definition at line 1508 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\$firstSheetIndex.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Workbook\writeBookViews().

     {
         return $this->firstSheetIndex;
     }

Here is the caller graph for this function:

◆ getGlobalDefinedNameByType()

PhpOffice\PhpSpreadsheet\Spreadsheet::getGlobalDefinedNameByType	(	string	$name,
		bool	$type
	)

private

Definition at line 988 of file Spreadsheet.php.

References $name.

Referenced by PhpOffice\PhpSpreadsheet\Spreadsheet\getNamedFormula(), and PhpOffice\PhpSpreadsheet\Spreadsheet\getNamedRange().

                                                                          : ?DefinedName
     {
         if (isset($this->definedNames[$name]) && $this->definedNames[$name]->isFormula() === $type) {
             return $this->definedNames[$name];
         }
 
         return null;
     }

Here is the caller graph for this function:

◆ getID()

PhpOffice\PhpSpreadsheet\Spreadsheet::getID ( )

Return the unique ID value assigned to this spreadsheet workbook.

Returns: string

Definition at line 1396 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\$uniqueID.

     {
         return $this->uniqueID;
     }

◆ getIndex()

PhpOffice\PhpSpreadsheet\Spreadsheet::getIndex ( Worksheet $pSheet )

Get index for sheet.

Returns: int index

Definition at line 728 of file Spreadsheet.php.

References $key, and PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\getHashCode().

Referenced by PhpOffice\PhpSpreadsheet\Spreadsheet\setActiveSheetIndexByName(), and PhpOffice\PhpSpreadsheet\Spreadsheet\setIndexByName().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLocalDefinedNameByType()

PhpOffice\PhpSpreadsheet\Spreadsheet::getLocalDefinedNameByType	(	string	$name,
		bool	$type,
		?Worksheet	$pSheet = `null`
	)

private

Definition at line 997 of file Spreadsheet.php.

References $name, and $type.

Referenced by PhpOffice\PhpSpreadsheet\Spreadsheet\getNamedFormula(), and PhpOffice\PhpSpreadsheet\Spreadsheet\getNamedRange().

                                                                                                    : ?DefinedName
     {
         if (
             ($pSheet !== null) && isset($this->definedNames[$pSheet->getTitle() . '!' . $name])
             && $this->definedNames[$pSheet->getTitle() . '!' . $name]->isFormula() === $type
         ) {
             return $this->definedNames[$pSheet->getTitle() . '!' . $name];
         }
 
         return null;
     }

Here is the caller graph for this function:

◆ getMacrosCertificate()

PhpOffice\PhpSpreadsheet\Spreadsheet::getMacrosCertificate ( )

Return the macros certificate.

Returns: null|string

Definition at line 268 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\$macrosCertificate.

     {
         return $this->macrosCertificate;
     }

◆ getMacrosCode()

PhpOffice\PhpSpreadsheet\Spreadsheet::getMacrosCode ( )

Return the macros code.

Returns: null|string

Definition at line 238 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\$macrosCode.

     {
         return $this->macrosCode;
     }

◆ getMinimized()

PhpOffice\PhpSpreadsheet\Spreadsheet::getMinimized ( )

Return whether the workbook window is minimized.

Returns: bool true if workbook window is minimized

Definition at line 1466 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\$minimized.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Workbook\writeBookViews().

     {
         return $this->minimized;
     }

Here is the caller graph for this function:

◆ getNamedFormula()

PhpOffice\PhpSpreadsheet\Spreadsheet::getNamedFormula	(	string	$namedFormula,
		?Worksheet	$pSheet = `null`
	)

Get named formula.

Parameters

null | Worksheet $pSheet Scope. Use null for global scope

Definition at line 973 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\getGlobalDefinedNameByType(), PhpOffice\PhpSpreadsheet\Spreadsheet\getLocalDefinedNameByType(), and PhpOffice\PhpSpreadsheet\Shared\StringHelper\strToUpper().

Referenced by PhpOffice\PhpSpreadsheet\Spreadsheet\removeNamedFormula().

                                                                                     : ?NamedFormula
     {
         $returnValue = null;
 
         if ($namedFormula !== '') {
             $namedFormula = StringHelper::strToUpper($namedFormula);
             // first look for global named formula
             $returnValue = $this->getGlobalDefinedNameByType($namedFormula, self::DEFINED_NAME_IS_FORMULA);
             // then look for local named formula (has priority over global named formula if both names exist)
             $returnValue = $this->getLocalDefinedNameByType($namedFormula, self::DEFINED_NAME_IS_FORMULA, $pSheet) ?: $returnValue;
         }
 
         return $returnValue instanceof NamedFormula ? $returnValue : null;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getNamedFormulae()

PhpOffice\PhpSpreadsheet\Spreadsheet::getNamedFormulae ( )

Get an array of all Named Formulae.

Returns: DefinedName[]

Definition at line 894 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\DefinedName\isFormula().

                                       : array
     {
         return array_filter(
             $this->definedNames,
             function (DefinedName $definedName) {
                 return $definedName->isFormula() === self::DEFINED_NAME_IS_FORMULA;
             }
         );
     }

Here is the call graph for this function:

◆ getNamedRange()

PhpOffice\PhpSpreadsheet\Spreadsheet::getNamedRange	(	string	$namedRange,
		?Worksheet	$pSheet = `null`
	)

Get named range.

Parameters

null | Worksheet $pSheet Scope. Use null for global scope

Definition at line 953 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\getGlobalDefinedNameByType(), PhpOffice\PhpSpreadsheet\Spreadsheet\getLocalDefinedNameByType(), and PhpOffice\PhpSpreadsheet\Shared\StringHelper\strToUpper().

Referenced by PhpOffice\PhpSpreadsheet\Spreadsheet\removeNamedRange().

                                                                                 : ?NamedRange
     {
         $returnValue = null;
 
         if ($namedRange !== '') {
             $namedRange = StringHelper::strToUpper($namedRange);
             // first look for global named range
             $returnValue = $this->getGlobalDefinedNameByType($namedRange, self::DEFINED_NAME_IS_RANGE);
             // then look for local named range (has priority over global named range if both names exist)
             $returnValue = $this->getLocalDefinedNameByType($namedRange, self::DEFINED_NAME_IS_RANGE, $pSheet) ?: $returnValue;
         }
 
         return $returnValue instanceof NamedRange ? $returnValue : null;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getNamedRanges()

PhpOffice\PhpSpreadsheet\Spreadsheet::getNamedRanges ( )

Get an array of all Named Ranges.

Returns: DefinedName[]

Definition at line 879 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\DefinedName\isFormula().

                                     : array
     {
         return array_filter(
             $this->definedNames,
             function (DefinedName $definedName) {
                 return $definedName->isFormula() === self::DEFINED_NAME_IS_RANGE;
             }
         );
     }

Here is the call graph for this function:

◆ getProperties()

PhpOffice\PhpSpreadsheet\Spreadsheet::getProperties ( )

Get properties.

Returns: Document

Definition at line 540 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\$properties.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\ContentTypes\writeContentTypes(), PhpOffice\PhpSpreadsheet\Writer\Xlsx\DocProps\writeDocPropsApp(), PhpOffice\PhpSpreadsheet\Writer\Xlsx\DocProps\writeDocPropsCore(), PhpOffice\PhpSpreadsheet\Writer\Ods\Meta\writeDocPropsCustom(), PhpOffice\PhpSpreadsheet\Writer\Xlsx\DocProps\writeDocPropsCustom(), and PhpOffice\PhpSpreadsheet\Writer\Xlsx\Rels\writeRelationships().

     {
         return $this->properties;
     }

Here is the caller graph for this function:

◆ getRibbonBinObjects()

PhpOffice\PhpSpreadsheet\Spreadsheet::getRibbonBinObjects ( $what = 'all' )

retrieve Binaries Ribbon Objects.

Parameters

string $what

Returns: null|array

Definition at line 386 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\$ribbonBinObjects.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\ContentTypes\writeContentTypes(), and PhpOffice\PhpSpreadsheet\Writer\Xlsx\RelsRibbon\writeRibbonRelationships().

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

Here is the caller graph for this function:

◆ getRibbonXMLData()

PhpOffice\PhpSpreadsheet\Spreadsheet::getRibbonXMLData ( $what = 'all' )

retrieve ribbon XML Data.

Parameters

string $what

Returns: null|array|string

Definition at line 305 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\$ribbonXMLData.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Rels\writeRelationships().

     {
         $returnData = null;
         $what = strtolower($what);
         switch ($what) {
             case 'all':
                 $returnData = $this->ribbonXMLData;
 
                 break;
             case 'target':
             case 'data':
                 if (is_array($this->ribbonXMLData) && isset($this->ribbonXMLData[$what])) {
                     $returnData = $this->ribbonXMLData[$what];
                 }
 
                 break;
         }
 
         return $returnData;
     }

Here is the caller graph for this function:

◆ getSecurity()

PhpOffice\PhpSpreadsheet\Spreadsheet::getSecurity ( )

Get security.

Returns: Document

Definition at line 558 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\$security.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xlsx\readProtection(), and PhpOffice\PhpSpreadsheet\Writer\Xlsx\Workbook\writeWorkbookProtection().

     {
         return $this->security;
     }

Here is the caller graph for this function:

◆ getSheet()

PhpOffice\PhpSpreadsheet\Spreadsheet::getSheet ( $pIndex )

Get sheet by index.

Parameters

int $pIndex Sheet index

Returns: Worksheet

Definition at line 681 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\getSheetCount().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSheetByCodeName()

PhpOffice\PhpSpreadsheet\Spreadsheet::getSheetByCodeName ( $pName )

Get sheet by code name.

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

Parameters

string $pName Sheet name

Returns: null|Worksheet

Definition at line 458 of file Spreadsheet.php.

References $i.

Referenced by PhpOffice\PhpSpreadsheet\Spreadsheet\sheetCodeNameExists().

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

Here is the caller graph for this function:

◆ getSheetByName()

PhpOffice\PhpSpreadsheet\Spreadsheet::getSheetByName ( $pName )

Get sheet by name.

Parameters

string $pName Sheet name

Returns: null|Worksheet

Definition at line 711 of file Spreadsheet.php.

References $i.

Referenced by PhpOffice\PhpSpreadsheet\Spreadsheet\setActiveSheetIndexByName(), PhpOffice\PhpSpreadsheet\Spreadsheet\setIndexByName(), PhpOffice\PhpSpreadsheet\Reader\Ods\setSelected(), and PhpOffice\PhpSpreadsheet\Spreadsheet\sheetNameExists().

     {
         $worksheetCount = count($this->workSheetCollection);
         for ($i = 0; $i < $worksheetCount; ++$i) {
             if ($this->workSheetCollection[$i]->getTitle() === trim($pName, "'")) {
                 return $this->workSheetCollection[$i];
             }
         }
 
         return null;
     }

Here is the caller graph for this function:

◆ getSheetCount()

PhpOffice\PhpSpreadsheet\Spreadsheet::getSheetCount ( )

Get sheet count.

Returns: int

Definition at line 770 of file Spreadsheet.php.

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

Here is the caller graph for this function:

◆ getSheetNames()

PhpOffice\PhpSpreadsheet\Spreadsheet::getSheetNames ( )

Get sheet names.

Returns: string[]

Definition at line 829 of file Spreadsheet.php.

References $i, PhpOffice\PhpSpreadsheet\Spreadsheet\getSheet(), and PhpOffice\PhpSpreadsheet\Spreadsheet\getSheetCount().

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

Here is the call graph for this function:

◆ getShowHorizontalScroll()

PhpOffice\PhpSpreadsheet\Spreadsheet::getShowHorizontalScroll ( )

Get the visibility of the horizonal scroll bar in the application.

Returns: bool True if horizonal scroll bar is visible

Definition at line 1406 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\$showHorizontalScroll.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Workbook\writeBookViews().

     {
         return $this->showHorizontalScroll;
     }

Here is the caller graph for this function:

◆ getShowSheetTabs()

PhpOffice\PhpSpreadsheet\Spreadsheet::getShowSheetTabs ( )

Get the visibility of the sheet tabs in the application.

Returns: bool True if the sheet tabs are visible

Definition at line 1446 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\$showSheetTabs.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Workbook\writeBookViews().

     {
         return $this->showSheetTabs;
     }

Here is the caller graph for this function:

◆ getShowVerticalScroll()

PhpOffice\PhpSpreadsheet\Spreadsheet::getShowVerticalScroll ( )

Get the visibility of the vertical scroll bar in the application.

Returns: bool True if vertical scroll bar is visible

Definition at line 1426 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\$showVerticalScroll.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Workbook\writeBookViews().

     {
         return $this->showVerticalScroll;
     }

Here is the caller graph for this function:

◆ getTabRatio()

PhpOffice\PhpSpreadsheet\Spreadsheet::getTabRatio ( )

Get the ratio between the workbook tabs bar and the horizontal scroll bar.

TabRatio is assumed to be out of 1000 of the horizontal window width.

Returns: int Ratio between the workbook tabs bar and the horizontal scroll bar

Definition at line 1574 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\$tabRatio.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Workbook\writeBookViews().

     {
         return $this->tabRatio;
     }

Here is the caller graph for this function:

◆ getUnparsedLoadedData()

PhpOffice\PhpSpreadsheet\Spreadsheet::getUnparsedLoadedData ( )

List of unparsed loaded data for export to same format with better compatibility.

It has to be minimized when the library start to support currently unparsed data.

Definition at line 349 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\$unparsedLoadedData.

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

     {
         return $this->unparsedLoadedData;
     }

Here is the caller graph for this function:

◆ getVisibility()

PhpOffice\PhpSpreadsheet\Spreadsheet::getVisibility ( )

Return the visibility status of the workbook.

This may be one of the following three values:

visibile

Returns: string Visible status

Definition at line 1535 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\$visibility.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Workbook\writeBookViews().

     {
         return $this->visibility;
     }

Here is the caller graph for this function:

◆ getWorksheetIterator()

PhpOffice\PhpSpreadsheet\Spreadsheet::getWorksheetIterator ( )

Get worksheet iterator.

Returns: Iterator

Definition at line 1097 of file Spreadsheet.php.

Referenced by PhpOffice\PhpSpreadsheet\Spreadsheet\garbageCollect(), and PhpOffice\PhpSpreadsheet\ReferenceHelper\updateNamedFormulas().

     {
         return new Iterator($this);
     }

Here is the caller graph for this function:

◆ hasMacros()

PhpOffice\PhpSpreadsheet\Spreadsheet::hasMacros ( )

The workbook has macros ?

Returns: bool

Definition at line 207 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\$hasMacros.

Referenced by PhpOffice\PhpSpreadsheet\Spreadsheet\discardMacros(), PhpOffice\PhpSpreadsheet\Spreadsheet\setHasMacros(), PhpOffice\PhpSpreadsheet\Writer\Xlsx\ContentTypes\writeContentTypes(), and PhpOffice\PhpSpreadsheet\Writer\Xlsx\Rels\writeWorkbookRelationships().

     {
         return $this->hasMacros;
     }

Here is the caller graph for this function:

◆ hasMacrosCertificate()

PhpOffice\PhpSpreadsheet\Spreadsheet::hasMacrosCertificate ( )

Is the project signed ?

Returns: bool true|false

Definition at line 258 of file Spreadsheet.php.

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

     {
         return $this->macrosCertificate !== null;
     }

Here is the caller graph for this function:

◆ hasRibbon()

PhpOffice\PhpSpreadsheet\Spreadsheet::hasRibbon ( )

This workbook have a custom UI ?

Returns: bool

Definition at line 424 of file Spreadsheet.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Rels\writeRelationships().

     {
         return $this->ribbonXMLData !== null;
     }

Here is the caller graph for this function:

◆ hasRibbonBinObjects()

PhpOffice\PhpSpreadsheet\Spreadsheet::hasRibbonBinObjects ( )

This workbook have additionnal object for the ribbon ?

Returns: bool

Definition at line 434 of file Spreadsheet.php.

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

     {
         return $this->ribbonBinObjects !== null;
     }

Here is the caller graph for this function:

◆ removeCellStyleXfByIndex()

PhpOffice\PhpSpreadsheet\Spreadsheet::removeCellStyleXfByIndex ( $pIndex )

Remove cellStyleXf by index.

Parameters

int $pIndex Index to cellXf

Definition at line 1302 of file Spreadsheet.php.

                                                      : void
     {
         if ($pIndex > count($this->cellStyleXfCollection) - 1) {
             throw new Exception('CellStyleXf index is out of bounds.');
         }
         array_splice($this->cellStyleXfCollection, $pIndex, 1);
     }

◆ removeCellXfByIndex()

PhpOffice\PhpSpreadsheet\Spreadsheet::removeCellXfByIndex ( $pIndex )

Remove cellXf by index.

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

Parameters

int $pIndex Index to cellXf

Definition at line 1213 of file Spreadsheet.php.

                                                 : void
     {
         if ($pIndex > count($this->cellXfCollection) - 1) {
             throw new Exception('CellXf index is out of bounds.');
         }
 
         // first remove the cellXf
         array_splice($this->cellXfCollection, $pIndex, 1);
 
         // then update cellXf indexes for cells
         foreach ($this->workSheetCollection as $worksheet) {
             foreach ($worksheet->getCoordinates(false) as $coordinate) {
                 $cell = $worksheet->getCell($coordinate);
                 $xfIndex = $cell->getXfIndex();
                 if ($xfIndex > $pIndex) {
                     // decrease xf index by 1
                     $cell->setXfIndex($xfIndex - 1);
                 } elseif ($xfIndex == $pIndex) {
                     // set to default xf index 0
                     $cell->setXfIndex(0);
                 }
             }
         }
     }

◆ removeDefinedName()

PhpOffice\PhpSpreadsheet\Spreadsheet::removeDefinedName	(	string	$definedName,
		?Worksheet	$pSheet = `null`
	)

Remove defined name.

Parameters

null | Worksheet $pSheet scope: use null for global scope

Returns: $this

Definition at line 1073 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Shared\StringHelper\strToUpper().

Referenced by PhpOffice\PhpSpreadsheet\Spreadsheet\removeNamedFormula(), and PhpOffice\PhpSpreadsheet\Spreadsheet\removeNamedRange().

                                                                                      : self
     {
         $definedName = StringHelper::strToUpper($definedName);
 
         if ($pSheet === null) {
             if (isset($this->definedNames[$definedName])) {
                 unset($this->definedNames[$definedName]);
             }
         } else {
             if (isset($this->definedNames[$pSheet->getTitle() . '!' . $definedName])) {
                 unset($this->definedNames[$pSheet->getTitle() . '!' . $definedName]);
             } elseif (isset($this->definedNames[$definedName])) {
                 unset($this->definedNames[$definedName]);
             }
         }
 
         return $this;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeNamedFormula()

PhpOffice\PhpSpreadsheet\Spreadsheet::removeNamedFormula	(	string	$namedFormula,
		?Worksheet	$pSheet = `null`
	)

Remove named formula.

Parameters

null | Worksheet $pSheet scope: use null for global scope

Returns: $this

Definition at line 1057 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\getNamedFormula(), and PhpOffice\PhpSpreadsheet\Spreadsheet\removeDefinedName().

                                                                                        : self
     {
         if ($this->getNamedFormula($namedFormula, $pSheet) === null) {
             return $this;
         }
 
         return $this->removeDefinedName($namedFormula, $pSheet);
     }

Here is the call graph for this function:

◆ removeNamedRange()

PhpOffice\PhpSpreadsheet\Spreadsheet::removeNamedRange	(	string	$namedRange,
		?Worksheet	$pSheet = `null`
	)

Remove named range.

Parameters

null | Worksheet $pSheet scope: use null for global scope

Returns: $this

Definition at line 1041 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\getNamedRange(), and PhpOffice\PhpSpreadsheet\Spreadsheet\removeDefinedName().

                                                                                    : self
     {
         if ($this->getNamedRange($namedRange, $pSheet) === null) {
             return $this;
         }
 
         return $this->removeDefinedName($namedRange, $pSheet);
     }

Here is the call graph for this function:

◆ removeSheetByIndex()

PhpOffice\PhpSpreadsheet\Spreadsheet::removeSheetByIndex ( $pIndex )

Remove sheet by index.

Parameters

int $pIndex Active sheet index

Definition at line 655 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\$activeSheetIndex.

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

◆ setActiveSheetIndex()

PhpOffice\PhpSpreadsheet\Spreadsheet::setActiveSheetIndex ( $pIndex )

Set active sheet index.

Parameters

int $pIndex Active sheet index

Returns: Worksheet

Definition at line 792 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\getActiveSheet().

Referenced by PhpOffice\PhpSpreadsheet\Reader\Ods\load(), PhpOffice\PhpSpreadsheet\Reader\Xml\load(), PhpOffice\PhpSpreadsheet\Reader\Html\loadDocument(), PhpOffice\PhpSpreadsheet\Reader\Csv\loadIntoExisting(), PhpOffice\PhpSpreadsheet\Reader\Slk\loadIntoExisting(), PhpOffice\PhpSpreadsheet\Spreadsheet\setActiveSheetIndexByName(), and PhpOffice\PhpSpreadsheet\Helper\Sample\write().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setActiveSheetIndexByName()

PhpOffice\PhpSpreadsheet\Spreadsheet::setActiveSheetIndexByName ( $pValue )

Set active sheet index by name.

Parameters

string $pValue Sheet title

Returns: Worksheet

Definition at line 813 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\getIndex(), PhpOffice\PhpSpreadsheet\Spreadsheet\getSheetByName(), and PhpOffice\PhpSpreadsheet\Spreadsheet\setActiveSheetIndex().

Referenced by PhpOffice\PhpSpreadsheet\Reader\Ods\processSettings().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAutoFilterDateGrouping()

PhpOffice\PhpSpreadsheet\Spreadsheet::setAutoFilterDateGrouping ( $autoFilterDateGrouping )

Set whether to group dates when presenting the user with filtering optiomd in the user interface.

Parameters

bool $autoFilterDateGrouping true if workbook window is minimized

Definition at line 1498 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\$autoFilterDateGrouping.

                                                                       : void
     {
         $this->autoFilterDateGrouping = (bool) $autoFilterDateGrouping;
     }

◆ setFirstSheetIndex()

PhpOffice\PhpSpreadsheet\Spreadsheet::setFirstSheetIndex ( $firstSheetIndex )

Set the first sheet in the book view.

Parameters

int $firstSheetIndex First sheet in book view

Definition at line 1518 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\$firstSheetIndex.

                                                         : void
     {
         if ($firstSheetIndex >= 0) {
             $this->firstSheetIndex = (int) $firstSheetIndex;
         } else {
             throw new Exception('First sheet index must be a positive integer.');
         }
     }

◆ setHasMacros()

PhpOffice\PhpSpreadsheet\Spreadsheet::setHasMacros ( $hasMacros )

Define if a workbook has macros.

Parameters

bool $hasMacros true|false

Definition at line 217 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\$hasMacros, and PhpOffice\PhpSpreadsheet\Spreadsheet\hasMacros().

Referenced by PhpOffice\PhpSpreadsheet\Spreadsheet\setMacrosCode().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setIndexByName()

PhpOffice\PhpSpreadsheet\Spreadsheet::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: int New sheet index

Definition at line 747 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\getIndex(), and PhpOffice\PhpSpreadsheet\Spreadsheet\getSheetByName().

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

Here is the call graph for this function:

◆ setMacrosCertificate()

PhpOffice\PhpSpreadsheet\Spreadsheet::setMacrosCertificate ( $certificate )

Set the macros certificate.

Parameters

null | string $certificate

Definition at line 248 of file Spreadsheet.php.

References $certificate.

                                                       : void
     {
         $this->macrosCertificate = $certificate;
     }

◆ setMacrosCode()

PhpOffice\PhpSpreadsheet\Spreadsheet::setMacrosCode ( $macroCode )

Set the macros code.

Parameters

string $macroCode string|null

Definition at line 227 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\setHasMacros().

                                              : void
     {
         $this->macrosCode = $macroCode;
         $this->setHasMacros($macroCode !== null);
     }

Here is the call graph for this function:

◆ setMinimized()

PhpOffice\PhpSpreadsheet\Spreadsheet::setMinimized ( $minimized )

Set whether the workbook window is minimized.

Parameters

bool $minimized true if workbook window is minimized

Definition at line 1476 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\$minimized.

                                             : void
     {
         $this->minimized = (bool) $minimized;
     }

◆ setProperties()

PhpOffice\PhpSpreadsheet\Spreadsheet::setProperties ( Document\Properties $pValue )

Set properties.

Definition at line 548 of file Spreadsheet.php.

                                                               : void
     {
         $this->properties = $pValue;
     }

◆ setRibbonBinObjects()

PhpOffice\PhpSpreadsheet\Spreadsheet::setRibbonBinObjects	(	$BinObjectsNames,
		$BinObjectsData
	)

store binaries ribbon objects (pictures).

Parameters

null \| mixed	$BinObjectsNames
null \| mixed	$BinObjectsData

Definition at line 332 of file Spreadsheet.php.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xlsx\readRibbon().

                                                                           : void
     {
         if ($BinObjectsNames !== null && $BinObjectsData !== null) {
             $this->ribbonBinObjects = ['names' => $BinObjectsNames, 'data' => $BinObjectsData];
         } else {
             $this->ribbonBinObjects = null;
         }
     }

Here is the caller graph for this function:

◆ setRibbonXMLData()

PhpOffice\PhpSpreadsheet\Spreadsheet::setRibbonXMLData	(	$target,
		$xmlData
	)

set ribbon XML data.

Parameters

null \| mixed	$target
null \| mixed	$xmlData

Definition at line 289 of file Spreadsheet.php.

References $target.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xlsx\readRibbon().

                                                        : void
     {
         if ($target !== null && $xmlData !== null) {
             $this->ribbonXMLData = ['target' => $target, 'data' => $xmlData];
         } else {
             $this->ribbonXMLData = null;
         }
     }

Here is the caller graph for this function:

◆ setSecurity()

PhpOffice\PhpSpreadsheet\Spreadsheet::setSecurity ( Document\Security $pValue )

Set security.

Definition at line 566 of file Spreadsheet.php.

                                                           : void
     {
         $this->security = $pValue;
     }

◆ setShowHorizontalScroll()

PhpOffice\PhpSpreadsheet\Spreadsheet::setShowHorizontalScroll ( $showHorizontalScroll )

Set the visibility of the horizonal scroll bar in the application.

Parameters

bool $showHorizontalScroll True if horizonal scroll bar is visible

Definition at line 1416 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\$showHorizontalScroll.

                                                                   : void
     {
         $this->showHorizontalScroll = (bool) $showHorizontalScroll;
     }

◆ setShowSheetTabs()

PhpOffice\PhpSpreadsheet\Spreadsheet::setShowSheetTabs ( $showSheetTabs )

Set the visibility of the sheet tabs in the application.

Parameters

bool $showSheetTabs True if sheet tabs are visible

Definition at line 1456 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\$showSheetTabs.

                                                     : void
     {
         $this->showSheetTabs = (bool) $showSheetTabs;
     }

◆ setShowVerticalScroll()

PhpOffice\PhpSpreadsheet\Spreadsheet::setShowVerticalScroll ( $showVerticalScroll )

Set the visibility of the vertical scroll bar in the application.

Parameters

bool $showVerticalScroll True if vertical scroll bar is visible

Definition at line 1436 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\$showVerticalScroll.

                                                               : void
     {
         $this->showVerticalScroll = (bool) $showVerticalScroll;
     }

◆ setTabRatio()

PhpOffice\PhpSpreadsheet\Spreadsheet::setTabRatio ( $tabRatio )

Set the ratio between the workbook tabs bar and the horizontal scroll bar TabRatio is assumed to be out of 1000 of the horizontal window width.

Parameters

int $tabRatio Ratio between the tabs bar and the horizontal scroll bar

Definition at line 1585 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\$tabRatio.

                                           : void
     {
         if ($tabRatio >= 0 || $tabRatio <= 1000) {
             $this->tabRatio = (int) $tabRatio;
         } else {
             throw new Exception('Tab ratio must be between 0 and 1000.');
         }
     }

◆ setUnparsedLoadedData()

PhpOffice\PhpSpreadsheet\Spreadsheet::setUnparsedLoadedData ( array $unparsedLoadedData )

List of unparsed loaded data for export to same format with better compatibility.

It has to be minimized when the library start to support currently unparsed data.

Definition at line 360 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\$unparsedLoadedData.

                                                                     : void
     {
         $this->unparsedLoadedData = $unparsedLoadedData;
     }

◆ setVisibility()

PhpOffice\PhpSpreadsheet\Spreadsheet::setVisibility ( $visibility )

Set the visibility status of the workbook.

Valid values are:

'visible' (self::VISIBILITY_VISIBLE): Workbook window is visible
'hidden' (self::VISIBILITY_HIDDEN): Workbook window is hidden, but can be shown by the user via the user interface
'veryHidden' (self::VISIBILITY_VERY_HIDDEN): Workbook window is hidden and cannot be shown in the user interface.

Parameters

string $visibility visibility status of the workbook

Definition at line 1555 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\$visibility.

                                               : void
     {
         if ($visibility === null) {
             $visibility = self::VISIBILITY_VISIBLE;
         }
 
         if (in_array($visibility, self::$workbookViewVisibilityValues)) {
             $this->visibility = $visibility;
         } else {
             throw new Exception('Invalid visibility value.');
         }
     }

◆ sheetCodeNameExists()

PhpOffice\PhpSpreadsheet\Spreadsheet::sheetCodeNameExists ( $pSheetCodeName )

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

Parameters

string $pSheetCodeName Name of the worksheet to check

Returns: bool

Definition at line 446 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\getSheetByCodeName().

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

Here is the call graph for this function:

◆ sheetNameExists()

PhpOffice\PhpSpreadsheet\Spreadsheet::sheetNameExists ( $pSheetName )

Check if a sheet with a specified name already exists.

Parameters

string $pSheetName Name of the worksheet to check

Returns: bool

Definition at line 603 of file Spreadsheet.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\getSheetByName().

Referenced by PhpOffice\PhpSpreadsheet\Spreadsheet\addExternalSheet(), and PhpOffice\PhpSpreadsheet\Spreadsheet\addSheet().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $activeSheetIndex

PhpOffice\PhpSpreadsheet\Spreadsheet::$activeSheetIndex = 0

private

Definition at line 67 of file Spreadsheet.php.

Referenced by PhpOffice\PhpSpreadsheet\Spreadsheet\addSheet(), PhpOffice\PhpSpreadsheet\Spreadsheet\getActiveSheetIndex(), and PhpOffice\PhpSpreadsheet\Spreadsheet\removeSheetByIndex().

◆ $autoFilterDateGrouping

PhpOffice\PhpSpreadsheet\Spreadsheet::$autoFilterDateGrouping = true

private

Definition at line 177 of file Spreadsheet.php.

Referenced by PhpOffice\PhpSpreadsheet\Spreadsheet\getAutoFilterDateGrouping(), and PhpOffice\PhpSpreadsheet\Spreadsheet\setAutoFilterDateGrouping().

◆ $calculationEngine

PhpOffice\PhpSpreadsheet\Spreadsheet::$calculationEngine

private

Definition at line 60 of file Spreadsheet.php.

Referenced by PhpOffice\PhpSpreadsheet\Spreadsheet\getCalculationEngine().

◆ $cellStyleXfCollection

PhpOffice\PhpSpreadsheet\Spreadsheet::$cellStyleXfCollection = []

private

Definition at line 95 of file Spreadsheet.php.

Referenced by PhpOffice\PhpSpreadsheet\Spreadsheet\getCellStyleXfCollection().

◆ $cellXfCollection

PhpOffice\PhpSpreadsheet\Spreadsheet::$cellXfCollection = []

private

Definition at line 88 of file Spreadsheet.php.

Referenced by PhpOffice\PhpSpreadsheet\Spreadsheet\getCellXfCollection().

◆ $cellXfSupervisor

PhpOffice\PhpSpreadsheet\Spreadsheet::$cellXfSupervisor

private

Definition at line 81 of file Spreadsheet.php.

Referenced by PhpOffice\PhpSpreadsheet\Spreadsheet\getCellXfSupervisor().

◆ $definedNames

PhpOffice\PhpSpreadsheet\Spreadsheet::$definedNames = []

private

Definition at line 74 of file Spreadsheet.php.

Referenced by PhpOffice\PhpSpreadsheet\Spreadsheet\getDefinedNames().

◆ $firstSheetIndex

PhpOffice\PhpSpreadsheet\Spreadsheet::$firstSheetIndex = 0

private

Definition at line 184 of file Spreadsheet.php.

Referenced by PhpOffice\PhpSpreadsheet\Spreadsheet\getFirstSheetIndex(), and PhpOffice\PhpSpreadsheet\Spreadsheet\setFirstSheetIndex().

◆ $hasMacros

PhpOffice\PhpSpreadsheet\Spreadsheet::$hasMacros = false

private

Definition at line 102 of file Spreadsheet.php.

Referenced by PhpOffice\PhpSpreadsheet\Spreadsheet\hasMacros(), and PhpOffice\PhpSpreadsheet\Spreadsheet\setHasMacros().

◆ $macrosCertificate

PhpOffice\PhpSpreadsheet\Spreadsheet::$macrosCertificate

private

Definition at line 116 of file Spreadsheet.php.

Referenced by PhpOffice\PhpSpreadsheet\Spreadsheet\getMacrosCertificate().

◆ $macrosCode

PhpOffice\PhpSpreadsheet\Spreadsheet::$macrosCode

private

Definition at line 109 of file Spreadsheet.php.

Referenced by PhpOffice\PhpSpreadsheet\Spreadsheet\getMacrosCode().

◆ $minimized

PhpOffice\PhpSpreadsheet\Spreadsheet::$minimized = false

private

Definition at line 168 of file Spreadsheet.php.

Referenced by PhpOffice\PhpSpreadsheet\Spreadsheet\getMinimized(), and PhpOffice\PhpSpreadsheet\Spreadsheet\setMinimized().

◆ $properties

PhpOffice\PhpSpreadsheet\Spreadsheet::$properties

private

Definition at line 39 of file Spreadsheet.php.

Referenced by PhpOffice\PhpSpreadsheet\Spreadsheet\getProperties().

◆ $ribbonBinObjects

PhpOffice\PhpSpreadsheet\Spreadsheet::$ribbonBinObjects

private

Definition at line 131 of file Spreadsheet.php.

Referenced by PhpOffice\PhpSpreadsheet\Spreadsheet\getRibbonBinObjects().

◆ $ribbonXMLData

PhpOffice\PhpSpreadsheet\Spreadsheet::$ribbonXMLData

private

Definition at line 123 of file Spreadsheet.php.

Referenced by PhpOffice\PhpSpreadsheet\Spreadsheet\getRibbonXMLData().

◆ $security

PhpOffice\PhpSpreadsheet\Spreadsheet::$security

private

Definition at line 46 of file Spreadsheet.php.

Referenced by PhpOffice\PhpSpreadsheet\Spreadsheet\getSecurity().

◆ $showHorizontalScroll

PhpOffice\PhpSpreadsheet\Spreadsheet::$showHorizontalScroll = true

private

Definition at line 146 of file Spreadsheet.php.

Referenced by PhpOffice\PhpSpreadsheet\Spreadsheet\getShowHorizontalScroll(), and PhpOffice\PhpSpreadsheet\Spreadsheet\setShowHorizontalScroll().

◆ $showSheetTabs

PhpOffice\PhpSpreadsheet\Spreadsheet::$showSheetTabs = true

private

Definition at line 160 of file Spreadsheet.php.

Referenced by PhpOffice\PhpSpreadsheet\Spreadsheet\getShowSheetTabs(), and PhpOffice\PhpSpreadsheet\Spreadsheet\setShowSheetTabs().

◆ $showVerticalScroll

PhpOffice\PhpSpreadsheet\Spreadsheet::$showVerticalScroll = true

private

Definition at line 153 of file Spreadsheet.php.

Referenced by PhpOffice\PhpSpreadsheet\Spreadsheet\getShowVerticalScroll(), and PhpOffice\PhpSpreadsheet\Spreadsheet\setShowVerticalScroll().

◆ $tabRatio

PhpOffice\PhpSpreadsheet\Spreadsheet::$tabRatio = 600

private

Definition at line 200 of file Spreadsheet.php.

Referenced by PhpOffice\PhpSpreadsheet\Spreadsheet\getTabRatio(), and PhpOffice\PhpSpreadsheet\Spreadsheet\setTabRatio().

◆ $uniqueID

PhpOffice\PhpSpreadsheet\Spreadsheet::$uniqueID

private

Definition at line 32 of file Spreadsheet.php.

Referenced by PhpOffice\PhpSpreadsheet\Spreadsheet\getID().

◆ $unparsedLoadedData

PhpOffice\PhpSpreadsheet\Spreadsheet::$unparsedLoadedData = []

private

Definition at line 139 of file Spreadsheet.php.

Referenced by PhpOffice\PhpSpreadsheet\Spreadsheet\getUnparsedLoadedData(), and PhpOffice\PhpSpreadsheet\Spreadsheet\setUnparsedLoadedData().

◆ $visibility

PhpOffice\PhpSpreadsheet\Spreadsheet::$visibility = self::VISIBILITY_VISIBLE

private

Definition at line 191 of file Spreadsheet.php.

Referenced by PhpOffice\PhpSpreadsheet\Spreadsheet\getVisibility(), and PhpOffice\PhpSpreadsheet\Spreadsheet\setVisibility().

◆ $workbookViewVisibilityValues

PhpOffice\PhpSpreadsheet\Spreadsheet::$workbookViewVisibilityValues

staticprivate

Initial value:

= [
        self::VISIBILITY_VISIBLE,
        self::VISIBILITY_HIDDEN,
        self::VISIBILITY_VERY_HIDDEN,
    ]

Definition at line 21 of file Spreadsheet.php.

◆ $workSheetCollection

PhpOffice\PhpSpreadsheet\Spreadsheet::$workSheetCollection = []

private

Definition at line 53 of file Spreadsheet.php.

Referenced by PhpOffice\PhpSpreadsheet\Spreadsheet\getAllSheets().

◆ DEFINED_NAME_IS_FORMULA

const PhpOffice\PhpSpreadsheet\Spreadsheet::DEFINED_NAME_IS_FORMULA = true

private

Definition at line 19 of file Spreadsheet.php.

◆ DEFINED_NAME_IS_RANGE

const PhpOffice\PhpSpreadsheet\Spreadsheet::DEFINED_NAME_IS_RANGE = false

private

Definition at line 18 of file Spreadsheet.php.

◆ VISIBILITY_HIDDEN

const PhpOffice\PhpSpreadsheet\Spreadsheet::VISIBILITY_HIDDEN = 'hidden'

Definition at line 15 of file Spreadsheet.php.

◆ VISIBILITY_VERY_HIDDEN

const PhpOffice\PhpSpreadsheet\Spreadsheet::VISIBILITY_VERY_HIDDEN = 'veryHidden'

Definition at line 16 of file Spreadsheet.php.

◆ VISIBILITY_VISIBLE

const PhpOffice\PhpSpreadsheet\Spreadsheet::VISIBILITY_VISIBLE = 'visible'

Definition at line 14 of file Spreadsheet.php.

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

libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Spreadsheet.php

Public Member Functions

Data Fields

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

◆ __destruct()

Member Function Documentation

◆ __clone()

◆ addCellStyleXf()

◆ addCellXf()

◆ addDefinedName()

◆ addExternalSheet()

◆ addNamedFormula()

◆ addNamedRange()

◆ addSheet()

◆ cellXfExists()

◆ copy()

◆ createSheet()

◆ discardMacros()

◆ disconnectWorksheets()

◆ garbageCollect()

◆ getActiveSheet()

◆ getActiveSheetIndex()

◆ getAllSheets()

◆ getAutoFilterDateGrouping()

◆ getCalculationEngine()

◆ getCellStyleXfByHashCode()

◆ getCellStyleXfByIndex()

◆ getCellStyleXfCollection()

◆ getCellXfByHashCode()

◆ getCellXfByIndex()

◆ getCellXfCollection()

◆ getCellXfSupervisor()

◆ getDefaultStyle()

◆ getDefinedName()

◆ getDefinedNames()

◆ getExtensionOnly()

◆ getFirstSheetIndex()

◆ getGlobalDefinedNameByType()

◆ getID()

◆ getIndex()

◆ getLocalDefinedNameByType()

◆ getMacrosCertificate()

◆ getMacrosCode()

◆ getMinimized()

◆ getNamedFormula()

◆ getNamedFormulae()

◆ getNamedRange()

◆ getNamedRanges()

◆ getProperties()

◆ getRibbonBinObjects()

◆ getRibbonXMLData()

◆ getSecurity()

◆ getSheet()

◆ getSheetByCodeName()

◆ getSheetByName()

◆ getSheetCount()

◆ getSheetNames()

◆ getShowHorizontalScroll()

◆ getShowSheetTabs()

◆ getShowVerticalScroll()

◆ getTabRatio()

◆ getUnparsedLoadedData()

◆ getVisibility()

◆ getWorksheetIterator()

◆ hasMacros()

◆ hasMacrosCertificate()

◆ hasRibbon()

◆ hasRibbonBinObjects()

◆ removeCellStyleXfByIndex()

◆ removeCellXfByIndex()

◆ removeDefinedName()

◆ removeNamedFormula()

◆ removeNamedRange()

◆ removeSheetByIndex()

◆ setActiveSheetIndex()

◆ setActiveSheetIndexByName()