\PhpOffice\PhpSpreadsheetSpreadsheet

Summary

Methods
Properties
Constants
hasMacros()
setHasMacros()
setMacrosCode()
getMacrosCode()
setMacrosCertificate()
hasMacrosCertificate()
getMacrosCertificate()
discardMacros()
setRibbonXMLData()
getRibbonXMLData()
setRibbonBinObjects()
getRibbonBinObjects()
hasRibbon()
hasRibbonBinObjects()
sheetCodeNameExists()
getSheetByCodeName()
__construct()
__destruct()
disconnectWorksheets()
getCalculationEngine()
getProperties()
setProperties()
getSecurity()
setSecurity()
getActiveSheet()
createSheet()
sheetNameExists()
addSheet()
removeSheetByIndex()
getSheet()
getAllSheets()
getSheetByName()
getIndex()
setIndexByName()
getSheetCount()
getActiveSheetIndex()
setActiveSheetIndex()
setActiveSheetIndexByName()
getSheetNames()
addExternalSheet()
getNamedRanges()
getNamedFormulae()
getDefinedNames()
addNamedRange()
addNamedFormula()
addDefinedName()
getNamedRange()
getNamedFormula()
getDefinedName()
removeNamedRange()
removeNamedFormula()
removeDefinedName()
getWorksheetIterator()
copy()
__clone()
getCellXfCollection()
getCellXfByIndex()
getCellXfByHashCode()
cellXfExists()
getDefaultStyle()
addCellXf()
removeCellXfByIndex()
getCellXfSupervisor()
getCellStyleXfCollection()
getCellStyleXfByIndex()
getCellStyleXfByHashCode()
addCellStyleXf()
removeCellStyleXfByIndex()
garbageCollect()
getID()
getShowHorizontalScroll()
setShowHorizontalScroll()
getShowVerticalScroll()
setShowVerticalScroll()
getShowSheetTabs()
setShowSheetTabs()
getMinimized()
setMinimized()
getAutoFilterDateGrouping()
setAutoFilterDateGrouping()
getFirstSheetIndex()
setFirstSheetIndex()
getVisibility()
setVisibility()
getTabRatio()
setTabRatio()
No public properties found
VISIBILITY_VISIBLE
VISIBILITY_HIDDEN
VISIBILITY_VERY_HIDDEN
DEFINED_NAME_IS_RANGE
DEFINED_NAME_IS_FORMULA
No protected methods found
No protected properties found
N/A
getExtensionOnly()
getGlobalDefinedNameByType()
getLocalDefinedNameByType()
$workbookViewVisibilityValues
$uniqueID
$properties
$security
$workSheetCollection
$calculationEngine
$activeSheetIndex
$definedNames
$cellXfSupervisor
$cellXfCollection
$cellStyleXfCollection
$hasMacros
$macrosCode
$macrosCertificate
$ribbonXMLData
$ribbonBinObjects
$unparsedLoadedData
$showHorizontalScroll
$showVerticalScroll
$showSheetTabs
$minimized
$autoFilterDateGrouping
$firstSheetIndex
$visibility
$tabRatio
N/A

Constants

VISIBILITY_VISIBLE

VISIBILITY_VISIBLE = 'visible'

VISIBILITY_HIDDEN

VISIBILITY_HIDDEN = 'hidden'

VISIBILITY_VERY_HIDDEN

VISIBILITY_VERY_HIDDEN = 'veryHidden'

DEFINED_NAME_IS_RANGE

DEFINED_NAME_IS_RANGE = false

DEFINED_NAME_IS_FORMULA

DEFINED_NAME_IS_FORMULA = true

Properties

$workbookViewVisibilityValues

$workbookViewVisibilityValues

$uniqueID

$uniqueID : string

Unique ID.

Type

string

$properties

$properties : \PhpOffice\PhpSpreadsheet\Document\Properties

Document properties.

Type

Properties

$security

$security : \PhpOffice\PhpSpreadsheet\Document\Security

Document security.

Type

Security

$workSheetCollection

$workSheetCollection : \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet[]

Collection of Worksheet objects.

Type

Worksheet[]

$calculationEngine

$calculationEngine : \PhpOffice\PhpSpreadsheet\Calculation\Calculation

Calculation Engine.

Type

Calculation

$activeSheetIndex

$activeSheetIndex : int

Active sheet index.

Type

int

$definedNames

$definedNames : \PhpOffice\PhpSpreadsheet\NamedRange[]

Named ranges.

Type

NamedRange[]

$cellXfSupervisor

$cellXfSupervisor : \PhpOffice\PhpSpreadsheet\Style\Style

CellXf supervisor.

Type

Style

$cellXfCollection

$cellXfCollection : \PhpOffice\PhpSpreadsheet\Style\Style[]

CellXf collection.

Type

Style[]

$cellStyleXfCollection

$cellStyleXfCollection : \PhpOffice\PhpSpreadsheet\Style\Style[]

CellStyleXf collection.

Type

Style[]

$hasMacros

$hasMacros : bool

hasMacros : this workbook have macros ?

Type

bool

$macrosCode

$macrosCode : string

macrosCode : all macros code as binary data (the vbaProject.bin file, this include form, code, etc.), null if no macro.

Type

string

$macrosCertificate

$macrosCertificate : string

macrosCertificate : if macros are signed, contains binary data vbaProjectSignature.bin file, null if not signed.

Type

string

$ribbonXMLData

$ribbonXMLData : null|string

ribbonXMLData : null if workbook is'nt Excel 2007 or not contain a customized UI.

Type

null|string

$ribbonBinObjects

$ribbonBinObjects : null|array

ribbonBinObjects : null if workbook is'nt Excel 2007 or not contain embedded objects (picture(s)) for Ribbon Elements ignored if $ribbonXMLData is null.

Type

null|array

$unparsedLoadedData

$unparsedLoadedData : array

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.

Type

array

$showHorizontalScroll

$showHorizontalScroll : bool

Controls visibility of the horizonal scroll bar in the application.

Type

bool

$showVerticalScroll

$showVerticalScroll : bool

Controls visibility of the horizonal scroll bar in the application.

Type

bool

$showSheetTabs

$showSheetTabs : bool

Controls visibility of the sheet tabs in the application.

Type

bool

$minimized

$minimized : bool

Specifies a boolean value that indicates whether the workbook window is minimized.

Type

bool

$autoFilterDateGrouping

$autoFilterDateGrouping : bool

Specifies a boolean value that indicates whether to group dates when presenting the user with filtering optiomd in the user interface.

Type

bool

$firstSheetIndex

$firstSheetIndex : int

Specifies the index to the first sheet in the book view.

Type

int

$visibility

$visibility : string

Specifies the visible status of the workbook.

Type

string

$tabRatio

$tabRatio : int

Specifies 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.

Type

int

Methods

hasMacros()

hasMacros() : bool

The workbook has macros ?

Returns

bool —

setHasMacros()

setHasMacros(bool  $hasMacros) : void

Define if a workbook has macros.

Parameters

bool $hasMacros

true|false

setMacrosCode()

setMacrosCode(string  $macroCode) : void

Set the macros code.

Parameters

string $macroCode

string|null

getMacrosCode()

getMacrosCode() : null|string

Return the macros code.

Returns

null|string —

setMacrosCertificate()

setMacrosCertificate(null|string  $certificate) : void

Set the macros certificate.

Parameters

null|string $certificate

hasMacrosCertificate()

hasMacrosCertificate() : bool

Is the project signed ?

Returns

bool —

true|false

getMacrosCertificate()

getMacrosCertificate() : null|string

Return the macros certificate.

Returns

null|string —

discardMacros()

discardMacros() : void

Remove all macros, certificate from spreadsheet.

setRibbonXMLData()

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

set ribbon XML data.

Parameters

null|mixed $target
null|mixed $xmlData

getRibbonXMLData()

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

retrieve ribbon XML Data.

return string|null|array

Parameters

string $what

Returns

string —

setRibbonBinObjects()

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

store binaries ribbon objects (pictures).

Parameters

null|mixed $BinObjectsNames
null|mixed $BinObjectsData

getRibbonBinObjects()

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

retrieve Binaries Ribbon Objects.

Parameters

string $what

Returns

null|array —

hasRibbon()

hasRibbon() : bool

This workbook have a custom UI ?

Returns

bool —

hasRibbonBinObjects()

hasRibbonBinObjects() : bool

This workbook have additionnal object for the ribbon ?

Returns

bool —

sheetCodeNameExists()

sheetCodeNameExists(string  $pSheetCodeName) : bool

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

Parameters

string $pSheetCodeName

Name of the worksheet to check

Returns

bool —

getSheetByCodeName()

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

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

Parameters

string $pName

Sheet name

Returns

\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet —

__construct()

__construct() : mixed

Create a new PhpSpreadsheet with one Worksheet.

Returns

mixed —

__destruct()

__destruct() : mixed

Code to execute when this worksheet is unset().

Returns

mixed —

disconnectWorksheets()

disconnectWorksheets() : void

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

\PhpOffice\PhpSpreadsheet\Calculation\Calculation —

getProperties()

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

Get properties.

Returns

\PhpOffice\PhpSpreadsheet\Document\Properties —

setProperties()

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

Set properties.

Parameters

\PhpOffice\PhpSpreadsheet\Document\Properties $pValue

getSecurity()

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

Get security.

Returns

\PhpOffice\PhpSpreadsheet\Document\Security —

setSecurity()

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

Set security.

Parameters

\PhpOffice\PhpSpreadsheet\Document\Security $pValue

getActiveSheet()

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

Get active sheet.

Returns

\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet —

createSheet()

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

Create sheet and add it to this workbook.

Parameters

null|int $sheetIndex

Index where sheet should go (0,1,..., or null for last)

Returns

\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet —

sheetNameExists()

sheetNameExists(string  $pSheetName) : bool

Check if a sheet with a specified name already exists.

Parameters

string $pSheetName

Name of the worksheet to check

Returns

bool —

addSheet()

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

Add sheet.

Parameters

\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $pSheet
null|int $iSheetIndex

Index where sheet should go (0,1,..., or null for last)

Returns

\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet —

removeSheetByIndex()

removeSheetByIndex(int  $pIndex) : void

Remove sheet by index.

Parameters

int $pIndex

Active sheet index

getSheet()

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

Get sheet by index.

Parameters

int $pIndex

Sheet index

Returns

\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet —

getAllSheets()

getAllSheets() : \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet[]

Get all sheets.

Returns

\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet[] —

getSheetByName()

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

Get sheet by name.

Parameters

string $pName

Sheet name

Returns

null|\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet —

getIndex()

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

Get index for sheet.

Parameters

\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $pSheet

Returns

int —

index

setIndexByName()

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

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

getSheetCount()

getSheetCount() : int

Get sheet count.

Returns

int —

getActiveSheetIndex()

getActiveSheetIndex() : int

Get active sheet index.

Returns

int —

Active sheet index

setActiveSheetIndex()

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

Set active sheet index.

Parameters

int $pIndex

Active sheet index

Returns

\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet —

setActiveSheetIndexByName()

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

Set active sheet index by name.

Parameters

string $pValue

Sheet title

Returns

\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet —

getSheetNames()

getSheetNames() : string[]

Get sheet names.

Returns

string[] —

addExternalSheet()

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

Add external sheet.

Parameters

\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $pSheet

External sheet to add

null|int $iSheetIndex

Index where sheet should go (0,1,..., or null for last)

Returns

\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet —

getNamedRanges()

getNamedRanges() : \PhpOffice\PhpSpreadsheet\NamedRange[]

Get an array of all Named Ranges.

Returns

\PhpOffice\PhpSpreadsheet\NamedRange[] —

getNamedFormulae()

getNamedFormulae() : \PhpOffice\PhpSpreadsheet\NamedFormula[]

Get an array of all Named Formulae.

Returns

\PhpOffice\PhpSpreadsheet\NamedFormula[] —

getDefinedNames()

getDefinedNames() : \PhpOffice\PhpSpreadsheet\DefinedName[]

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

Returns

\PhpOffice\PhpSpreadsheet\DefinedName[] —

addNamedRange()

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

Add a named range.

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

Parameters

\PhpOffice\PhpSpreadsheet\NamedRange $namedRange

addNamedFormula()

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

Add a named formula.

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

Parameters

\PhpOffice\PhpSpreadsheet\NamedFormula $namedFormula

addDefinedName()

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

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.

Parameters

\PhpOffice\PhpSpreadsheet\DefinedName $definedName

getNamedRange()

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

Get named range.

Parameters

string $namedRange
null|\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $pSheet

Scope. Use null for global scope

Returns

?\PhpOffice\PhpSpreadsheet\NamedRange —

getNamedFormula()

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

Get named formula.

Parameters

string $namedFormula
null|\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $pSheet

Scope. Use null for global scope

Returns

?\PhpOffice\PhpSpreadsheet\NamedFormula —

getDefinedName()

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

Get named range.

Parameters

string $definedName
null|\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $pSheet

Scope. Use null for global scope

Returns

?\PhpOffice\PhpSpreadsheet\DefinedName —

removeNamedRange()

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

Remove named range.

Parameters

string $namedRange
null|\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $pSheet

scope: use null for global scope

Returns

$this —

removeNamedFormula()

removeNamedFormula(string  $namedFormula, null|\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet  $pSheet = null) : $this

Remove named formula.

Parameters

string $namedFormula
null|\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $pSheet

scope: use null for global scope

Returns

$this —

removeDefinedName()

removeDefinedName(string  $definedName, null|\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet  $pSheet = null) : $this

Remove defined name.

Parameters

string $definedName
null|\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $pSheet

scope: use null for global scope

Returns

$this —

getWorksheetIterator()

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

Get worksheet iterator.

Returns

\PhpOffice\PhpSpreadsheet\Worksheet\Iterator —

copy()

copy() : \PhpOffice\PhpSpreadsheet\Spreadsheet

Copy workbook (!= clone!).

Returns

\PhpOffice\PhpSpreadsheet\Spreadsheet —

__clone()

__clone() : mixed

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

Returns

mixed —

getCellXfCollection()

getCellXfCollection() : \PhpOffice\PhpSpreadsheet\Style\Style[]

Get the workbook collection of cellXfs.

Returns

\PhpOffice\PhpSpreadsheet\Style\Style[] —

getCellXfByIndex()

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

Get cellXf by index.

Parameters

int $pIndex

Returns

\PhpOffice\PhpSpreadsheet\Style\Style —

getCellXfByHashCode()

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

Get cellXf by hash code.

Parameters

string $pValue

Returns

false|\PhpOffice\PhpSpreadsheet\Style\Style —

cellXfExists()

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

Check if style exists in style collection.

Parameters

\PhpOffice\PhpSpreadsheet\Style\Style $pCellStyle

Returns

bool —

getDefaultStyle()

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

Get default style.

Returns

\PhpOffice\PhpSpreadsheet\Style\Style —

addCellXf()

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

Add a cellXf to the workbook.

Parameters

\PhpOffice\PhpSpreadsheet\Style\Style $style

removeCellXfByIndex()

removeCellXfByIndex(int  $pIndex) : void

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

Parameters

int $pIndex

Index to cellXf

getCellXfSupervisor()

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

Get the cellXf supervisor.

Returns

\PhpOffice\PhpSpreadsheet\Style\Style —

getCellStyleXfCollection()

getCellStyleXfCollection() : \PhpOffice\PhpSpreadsheet\Style\Style[]

Get the workbook collection of cellStyleXfs.

Returns

\PhpOffice\PhpSpreadsheet\Style\Style[] —

getCellStyleXfByIndex()

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

Get cellStyleXf by index.

Parameters

int $pIndex

Index to cellXf

Returns

\PhpOffice\PhpSpreadsheet\Style\Style —

getCellStyleXfByHashCode()

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

Get cellStyleXf by hash code.

Parameters

string $pValue

Returns

false|\PhpOffice\PhpSpreadsheet\Style\Style —

addCellStyleXf()

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

Add a cellStyleXf to the workbook.

Parameters

\PhpOffice\PhpSpreadsheet\Style\Style $pStyle

removeCellStyleXfByIndex()

removeCellStyleXfByIndex(int  $pIndex) : void

Remove cellStyleXf by index.

Parameters

int $pIndex

Index to cellXf

garbageCollect()

garbageCollect() : void

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

string —

getShowHorizontalScroll()

getShowHorizontalScroll() : bool

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

Returns

bool —

True if horizonal scroll bar is visible

setShowHorizontalScroll()

setShowHorizontalScroll(bool  $showHorizontalScroll) : void

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

Parameters

bool $showHorizontalScroll

True if horizonal scroll bar is visible

getShowVerticalScroll()

getShowVerticalScroll() : bool

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

Returns

bool —

True if vertical scroll bar is visible

setShowVerticalScroll()

setShowVerticalScroll(bool  $showVerticalScroll) : void

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

Parameters

bool $showVerticalScroll

True if vertical scroll bar is visible

getShowSheetTabs()

getShowSheetTabs() : bool

Get the visibility of the sheet tabs in the application.

Returns

bool —

True if the sheet tabs are visible

setShowSheetTabs()

setShowSheetTabs(bool  $showSheetTabs) : void

Set the visibility of the sheet tabs in the application.

Parameters

bool $showSheetTabs

True if sheet tabs are visible

getMinimized()

getMinimized() : bool

Return whether the workbook window is minimized.

Returns

bool —

true if workbook window is minimized

setMinimized()

setMinimized(bool  $minimized) : void

Set whether the workbook window is minimized.

Parameters

bool $minimized

true if workbook window is minimized

getAutoFilterDateGrouping()

getAutoFilterDateGrouping() : bool

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

Returns

bool —

true if workbook window is minimized

setAutoFilterDateGrouping()

setAutoFilterDateGrouping(bool  $autoFilterDateGrouping) : void

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

getFirstSheetIndex()

getFirstSheetIndex() : int

Return the first sheet in the book view.

Returns

int —

First sheet in book view

setFirstSheetIndex()

setFirstSheetIndex(int  $firstSheetIndex) : void

Set the first sheet in the book view.

Parameters

int $firstSheetIndex

First sheet in book view

getVisibility()

getVisibility() : string

Return the visibility status of the workbook.

This may be one of the following three values:

  • visibile

Returns

string —

Visible status

setVisibility()

setVisibility(string  $visibility) : void

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

getTabRatio()

getTabRatio() : int

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

setTabRatio()

setTabRatio(int  $tabRatio) : void

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

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

mixed $path

Returns

string —

getGlobalDefinedNameByType()

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

Parameters

string $name
bool $type

Returns

?\PhpOffice\PhpSpreadsheet\DefinedName —

getLocalDefinedNameByType()

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

Parameters

string $name
bool $type
?\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $pSheet

Returns

?\PhpOffice\PhpSpreadsheet\DefinedName —