\PhpOffice\PhpSpreadsheetSpreadsheet

hasMacros()

hasMacros() : boolean

The workbook has macros ?

Returns

setHasMacros()

setHasMacros(boolean  $hasMacros) 

Define if a workbook has macros.

Parameters

setMacrosCode()

setMacrosCode(string  $macroCode) 

Set the macros code.

Parameters

getMacrosCode()

getMacrosCode() : null|string

Return the macros code.

Returns

setMacrosCertificate()

setMacrosCertificate(null|string  $certificate) 

Set the macros certificate.

Parameters

hasMacrosCertificate()

hasMacrosCertificate() : boolean

Is the project signed ?

Returns

true|false

getMacrosCertificate()

getMacrosCertificate() : null|string

Return the macros certificate.

Returns

discardMacros()

discardMacros() 

Remove all macros, certificate from spreadsheet.

setRibbonXMLData()

setRibbonXMLData(null|mixed  $target, null|mixed  $xmlData) 

set ribbon XML data.

Parameters

getRibbonXMLData()

getRibbonXMLData(string  $what = 'all') : string

retrieve ribbon XML Data.

return string|null|array

Parameters

Returns

setRibbonBinObjects()

setRibbonBinObjects(null|mixed  $BinObjectsNames, null|mixed  $BinObjectsData) 

store binaries ribbon objects (pictures).

Parameters

getRibbonBinObjects()

getRibbonBinObjects(string  $what = 'all') : null|array

retrieve Binaries Ribbon Objects.

Parameters

Returns

hasRibbon()

hasRibbon() : boolean

This workbook have a custom UI ?

Returns

hasRibbonBinObjects()

hasRibbonBinObjects() : boolean

This workbook have additionnal object for the ribbon ?

Returns

sheetCodeNameExists()

sheetCodeNameExists(string  $pSheetCodeName) : boolean

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

Parameters

Returns

getSheetByCodeName()

getSheetByCodeName(string  $pName) : \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet

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

Parameters

Returns

__construct()

__construct() 

Create a new PhpSpreadsheet with one Worksheet.

__destruct()

__destruct() 

Code to execute when this worksheet is unset().

disconnectWorksheets()

disconnectWorksheets() 

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

getCalculationEngine()

getCalculationEngine() : \PhpOffice\PhpSpreadsheet\Calculation\Calculation

Return the calculation engine for this worksheet.

Returns

getProperties()

getProperties() : \PhpOffice\PhpSpreadsheet\Document\Properties

Get properties.

Returns

setProperties()

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

Set properties.

Parameters

getSecurity()

getSecurity() : \PhpOffice\PhpSpreadsheet\Document\Security

Get security.

Returns

setSecurity()

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

Set security.

Parameters

getActiveSheet()

getActiveSheet() : \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet

Get active sheet.

Throws

\PhpOffice\PhpSpreadsheet\Exception

Returns

createSheet()

createSheet(null|integer  $sheetIndex = null) : \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet

Create sheet and add it to this workbook.

Parameters

Throws

\PhpOffice\PhpSpreadsheet\Exception

Returns

sheetNameExists()

sheetNameExists(string  $pSheetName) : boolean

Check if a sheet with a specified name already exists.

Parameters

Returns

addSheet()

addSheet(\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet  $pSheet, null|integer  $iSheetIndex = null) : \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet

Add sheet.

Parameters

Throws

\PhpOffice\PhpSpreadsheet\Exception

Returns

removeSheetByIndex()

removeSheetByIndex(integer  $pIndex) 

Remove sheet by index.

Parameters

Throws

\PhpOffice\PhpSpreadsheet\Exception

getSheet()

getSheet(integer  $pIndex) : \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet

Get sheet by index.

Parameters

Throws

\PhpOffice\PhpSpreadsheet\Exception

Returns

getAllSheets()

getAllSheets() : array<mixed,\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet>

Get all sheets.

Returns

getSheetByName()

getSheetByName(string  $pName) : null|\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet

Get sheet by name.

Parameters

Returns

getIndex()

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

Get index for sheet.

Parameters

Throws

\PhpOffice\PhpSpreadsheet\Exception

Returns

index

setIndexByName()

setIndexByName(string  $sheetName, integer  $newIndex) : integer

Set index for sheet by sheet name.

Parameters

Throws

\PhpOffice\PhpSpreadsheet\Exception

Returns

New sheet index

getSheetCount()

getSheetCount() : integer

Get sheet count.

Returns

getActiveSheetIndex()

getActiveSheetIndex() : integer

Get active sheet index.

Returns

Active sheet index

setActiveSheetIndex()

setActiveSheetIndex(integer  $pIndex) : \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet

Set active sheet index.

Parameters

Throws

\PhpOffice\PhpSpreadsheet\Exception

Returns

setActiveSheetIndexByName()

setActiveSheetIndexByName(string  $pValue) : \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet

Set active sheet index by name.

Parameters

Throws

\PhpOffice\PhpSpreadsheet\Exception

Returns

getSheetNames()

getSheetNames() : array<mixed,string>

Get sheet names.

Returns

addExternalSheet()

addExternalSheet(\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet  $pSheet, null|integer  $iSheetIndex = null) : \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet

Add external sheet.

Parameters

Throws

\PhpOffice\PhpSpreadsheet\Exception

Returns

getNamedRanges()

getNamedRanges() : array<mixed,\PhpOffice\PhpSpreadsheet\NamedRange>

Get named ranges.

Returns

addNamedRange()

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

Add named range.

Parameters

Returns

getNamedRange()

getNamedRange(string  $namedRange, null|\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet  $pSheet = null) : null|\PhpOffice\PhpSpreadsheet\NamedRange

Get named range.

Parameters

Returns

removeNamedRange()

removeNamedRange(string  $namedRange, null|\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet  $pSheet = null) : $this

Remove named range.

Parameters

Returns

getWorksheetIterator()

getWorksheetIterator() : \PhpOffice\PhpSpreadsheet\Worksheet\Iterator

Get worksheet iterator.

Returns

copy()

copy() : \PhpOffice\PhpSpreadsheet\Spreadsheet

Copy workbook (!= clone!).

Returns

__clone()

__clone() 

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

getCellXfCollection()

getCellXfCollection() : array<mixed,\PhpOffice\PhpSpreadsheet\Style\Style>

Get the workbook collection of cellXfs.

Returns

getCellXfByIndex()

getCellXfByIndex(integer  $pIndex) : \PhpOffice\PhpSpreadsheet\Style\Style

Get cellXf by index.

Parameters

Returns

getCellXfByHashCode()

getCellXfByHashCode(string  $pValue) : false|\PhpOffice\PhpSpreadsheet\Style\Style

Get cellXf by hash code.

Parameters

Returns

cellXfExists()

cellXfExists(\PhpOffice\PhpSpreadsheet\Style\Style  $pCellStyle) : boolean

Check if style exists in style collection.

Parameters

Returns

getDefaultStyle()

getDefaultStyle() : \PhpOffice\PhpSpreadsheet\Style\Style

Get default style.

Throws

\PhpOffice\PhpSpreadsheet\Exception

Returns

addCellXf()

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

Add a cellXf to the workbook.

Parameters

removeCellXfByIndex()

removeCellXfByIndex(integer  $pIndex) 

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

Parameters

Throws

\PhpOffice\PhpSpreadsheet\Exception

getCellXfSupervisor()

getCellXfSupervisor() : \PhpOffice\PhpSpreadsheet\Style\Style

Get the cellXf supervisor.

Returns

getCellStyleXfCollection()

getCellStyleXfCollection() : array<mixed,\PhpOffice\PhpSpreadsheet\Style\Style>

Get the workbook collection of cellStyleXfs.

Returns

getCellStyleXfByIndex()

getCellStyleXfByIndex(integer  $pIndex) : \PhpOffice\PhpSpreadsheet\Style\Style

Get cellStyleXf by index.

Parameters

Returns

getCellStyleXfByHashCode()

getCellStyleXfByHashCode(string  $pValue) : false|\PhpOffice\PhpSpreadsheet\Style\Style

Get cellStyleXf by hash code.

Parameters

Returns

addCellStyleXf()

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

Add a cellStyleXf to the workbook.

Parameters

removeCellStyleXfByIndex()

removeCellStyleXfByIndex(integer  $pIndex) 

Remove cellStyleXf by index.

Parameters

Throws

\PhpOffice\PhpSpreadsheet\Exception

garbageCollect()

garbageCollect() 

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

getID()

getID() : string

Return the unique ID value assigned to this spreadsheet workbook.

Returns

getShowHorizontalScroll()

getShowHorizontalScroll() : boolean

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

Returns

True if horizonal scroll bar is visible

setShowHorizontalScroll()

setShowHorizontalScroll(boolean  $showHorizontalScroll) 

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

Parameters

getShowVerticalScroll()

getShowVerticalScroll() : boolean

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

Returns

True if vertical scroll bar is visible

setShowVerticalScroll()

setShowVerticalScroll(boolean  $showVerticalScroll) 

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

Parameters

getShowSheetTabs()

getShowSheetTabs() : boolean

Get the visibility of the sheet tabs in the application.

Returns

True if the sheet tabs are visible

setShowSheetTabs()

setShowSheetTabs(boolean  $showSheetTabs) 

Set the visibility of the sheet tabs in the application.

Parameters

getMinimized()

getMinimized() : boolean

Return whether the workbook window is minimized.

Returns

true if workbook window is minimized

setMinimized()

setMinimized(boolean  $minimized) 

Set whether the workbook window is minimized.

Parameters

getAutoFilterDateGrouping()

getAutoFilterDateGrouping() : boolean

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

Returns

true if workbook window is minimized

setAutoFilterDateGrouping()

setAutoFilterDateGrouping(boolean  $autoFilterDateGrouping) 

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

Parameters

getFirstSheetIndex()

getFirstSheetIndex() : integer

Return the first sheet in the book view.

Returns

First sheet in book view

setFirstSheetIndex()

setFirstSheetIndex(integer  $firstSheetIndex) 

Set the first sheet in the book view.

Parameters

Throws

\PhpOffice\PhpSpreadsheet\Exception

if the given value is invalid

getVisibility()

getVisibility() : string

Return the visibility status of the workbook.

This may be one of the following three values:

• visibile

Returns

Visible status

setVisibility()

setVisibility(string  $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

Throws

\PhpOffice\PhpSpreadsheet\Exception

if the given value is invalid

getTabRatio()

getTabRatio() : integer

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

Ratio between the workbook tabs bar and the horizontal scroll bar

setTabRatio()

setTabRatio(integer  $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

Throws

\PhpOffice\PhpSpreadsheet\Exception

if the given value is invalid

getExtensionOnly()

getExtensionOnly(mixed  $path) : string

return the extension of a filename. Internal use for a array_map callback (php<5.3 don't like lambda function).

Parameters

Returns