PhpOffice\PhpSpreadsheet\Style\Supervisor Class Reference

Inheritance diagram for PhpOffice\PhpSpreadsheet\Style\Supervisor:

Public Member Functions
	__construct (bool $isSupervisor=false)
	Create a new Supervisor.
	__clone ()
	Implement PHP __clone to create a deep clone, not just a shallow copy.
	bindParent (Spreadsheet|self $parent, ?string $parentPropertyName=null)
	Bind parent.
	exportArray ()
	Export style as array.
	getActiveCell ()
	Get the currently active cell coordinate in currently active sheet.
	getActiveSheet ()
	Get the currently active sheet.
	getHashCode ()
	getIsSupervisor ()
	Is this a supervisor or a cell style component?
	getSelectedCells ()
	Get the currently active cell coordinate in currently active sheet.
	getSharedComponent ()
	Get the shared style component for the currently active cell in currently active sheet.
	getStyleArray (array $array)
	Build style array from subcomponents.

Protected Member Functions
	exportArray1 ()
	Abstract method to be implemented in anything which extends this class.
	exportArray2 (array &$exportedArray, string $index, mixed $objOrValue)
	Populate array from exportArray1.

Protected Attributes
bool	$isSupervisor
Spreadsheet Supervisor	$parent
	Parent.
string	$parentPropertyName = null
	Parent property name.

Constructor & Destructor Documentation

__construct()

PhpOffice\PhpSpreadsheet\Style\Supervisor::__construct

(

bool

$isSupervisor = false

)

Create a new Supervisor.

Parameters

bool

$isSupervisor

Flag indicating if this is a supervisor or not Leave this value at default unless you understand exactly what its ramifications are

Member Function Documentation

__clone()

PhpOffice\PhpSpreadsheet\Style\Supervisor::__clone

(

)

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

Reimplemented in PhpOffice\PhpSpreadsheet\Style\Font.

bindParent()

PhpOffice\PhpSpreadsheet\Style\Supervisor::bindParent	(	Spreadsheet|self	$parent,
		?string	$parentPropertyName = null )

Bind parent.

Only used for supervisor.

Return values

$this

exportArray()

PhpOffice\PhpSpreadsheet\Style\Supervisor::exportArray ( )

final

Export style as array.

Available to anything which extends this class: Alignment, Border, Borders, Color, Fill, Font, NumberFormat, Protection, and Style.

exportArray1()

PhpOffice\PhpSpreadsheet\Style\Supervisor::exportArray1 ( )

abstractprotected

Abstract method to be implemented in anything which extends this class.

This method invokes exportArray2 with the names and values of all properties to be included in output array, returning that array to exportArray, then to caller.

Reimplemented in PhpOffice\PhpSpreadsheet\Style\Alignment, PhpOffice\PhpSpreadsheet\Style\Border, PhpOffice\PhpSpreadsheet\Style\Borders, PhpOffice\PhpSpreadsheet\Style\Color, PhpOffice\PhpSpreadsheet\Style\Fill, PhpOffice\PhpSpreadsheet\Style\Font, PhpOffice\PhpSpreadsheet\Style\NumberFormat, PhpOffice\PhpSpreadsheet\Style\Protection, and PhpOffice\PhpSpreadsheet\Style\Style.

exportArray2()

PhpOffice\PhpSpreadsheet\Style\Supervisor::exportArray2 ( array & $exportedArray, string $index, mixed $objOrValue )

finalprotected

Populate array from exportArray1.

This method is available to anything which extends this class. The parameter index is the key to be added to the array. The parameter objOrValue is either a primitive type, which is the value added to the array, or a Style object to be recursively added via exportArray.

getActiveCell()

PhpOffice\PhpSpreadsheet\Style\Supervisor::getActiveCell

(

)

Get the currently active cell coordinate in currently active sheet.

Only used for supervisor.

Return values

string

E.g. 'A1'

getActiveSheet()

PhpOffice\PhpSpreadsheet\Style\Supervisor::getActiveSheet

(

)

Get the currently active sheet.

Only used for supervisor.

getHashCode()

PhpOffice\PhpSpreadsheet\IComparable::getHashCode ( )

inherited

Implemented in PhpOffice\PhpSpreadsheet\Comment, PhpOffice\PhpSpreadsheet\RichText\RichText, PhpOffice\PhpSpreadsheet\Style\Alignment, PhpOffice\PhpSpreadsheet\Style\Border, PhpOffice\PhpSpreadsheet\Style\Borders, PhpOffice\PhpSpreadsheet\Style\Color, PhpOffice\PhpSpreadsheet\Style\Conditional, PhpOffice\PhpSpreadsheet\Style\Fill, PhpOffice\PhpSpreadsheet\Style\Font, PhpOffice\PhpSpreadsheet\Style\NumberFormat, PhpOffice\PhpSpreadsheet\Style\Protection, PhpOffice\PhpSpreadsheet\Style\Style, PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing, PhpOffice\PhpSpreadsheet\Worksheet\Drawing, PhpOffice\PhpSpreadsheet\Worksheet\Drawing\Shadow, and PhpOffice\PhpSpreadsheet\Worksheet\MemoryDrawing.

getSelectedCells()

PhpOffice\PhpSpreadsheet\Style\Supervisor::getSelectedCells

(

)

Get the currently active cell coordinate in currently active sheet.

Only used for supervisor.

Return values

string

E.g. 'A1'

getSharedComponent()

PhpOffice\PhpSpreadsheet\Style\Supervisor::getSharedComponent ( )

abstract

Get the shared style component for the currently active cell in currently active sheet.

Only used for style supervisor.

Reimplemented in PhpOffice\PhpSpreadsheet\Style\Alignment, PhpOffice\PhpSpreadsheet\Style\Border, PhpOffice\PhpSpreadsheet\Style\Borders, PhpOffice\PhpSpreadsheet\Style\Color, PhpOffice\PhpSpreadsheet\Style\Fill, PhpOffice\PhpSpreadsheet\Style\Font, PhpOffice\PhpSpreadsheet\Style\NumberFormat, PhpOffice\PhpSpreadsheet\Style\Protection, and PhpOffice\PhpSpreadsheet\Style\Style.

getStyleArray()

PhpOffice\PhpSpreadsheet\Style\Supervisor::getStyleArray ( array $array )

abstract

Build style array from subcomponents.

Reimplemented in PhpOffice\PhpSpreadsheet\Style\Alignment, PhpOffice\PhpSpreadsheet\Style\Border, PhpOffice\PhpSpreadsheet\Style\Borders, PhpOffice\PhpSpreadsheet\Style\Color, PhpOffice\PhpSpreadsheet\Style\Fill, PhpOffice\PhpSpreadsheet\Style\Font, PhpOffice\PhpSpreadsheet\Style\NumberFormat, PhpOffice\PhpSpreadsheet\Style\Protection, and PhpOffice\PhpSpreadsheet\Style\Style.

Member Data Documentation

$parent

Spreadsheet Supervisor PhpOffice\PhpSpreadsheet\Style\Supervisor::$parent

protected

Parent.

Only used for supervisor.

---

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

• lib/phpspreadsheet/phpspreadsheet/src/PhpSpreadsheet/Style/Supervisor.php