Inheritance diagram for PhpOffice\PhpSpreadsheet\Style\Supervisor:

Collaboration diagram for PhpOffice\PhpSpreadsheet\Style\Supervisor:

Public Member Functions
	__construct ($isSupervisor=false)
	Create a new Supervisor. More...

	bindParent ($parent, $parentPropertyName=null)
	Bind parent. More...

	getIsSupervisor ()
	Is this a supervisor or a cell style component? More...

	getActiveSheet ()
	Get the currently active sheet. More...

	getSelectedCells ()
	Get the currently active cell coordinate in currently active sheet. More...

	getActiveCell ()
	Get the currently active cell coordinate in currently active sheet. More...

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

	exportArray ()
	Export style as array. More...

Public Member Functions inherited from PhpOffice\PhpSpreadsheet\IComparable
	getHashCode ()
	Get hash code. More...

Protected Member Functions
	exportArray1 ()
	Abstract method to be implemented in anything which extends this class. More...

	exportArray2 (array &$exportedArray, string $index, $objOrValue)
	Populate array from exportArray1. More...

Protected Attributes
	$isSupervisor

	$parent

	$parentPropertyName

Detailed Description

Definition at line 9 of file Supervisor.php.

Constructor & Destructor Documentation

◆ __construct()

PhpOffice\PhpSpreadsheet\Style\Supervisor::__construct ( $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

Definition at line 39 of file Supervisor.php.

References PhpOffice\PhpSpreadsheet\Style\Supervisor\$isSupervisor.

     {
         // Supervisor?
         $this->isSupervisor = $isSupervisor;
     }

Member Function Documentation

◆ __clone()

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

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

Definition at line 106 of file Supervisor.php.

References $key.

     {
         $vars = get_object_vars($this);
         foreach ($vars as $key => $value) {
             if ((is_object($value)) && ($key != 'parent')) {
                 $this->$key = clone $value;
             } else {
                 $this->$key = $value;
             }
         }
     }

◆ bindParent()

PhpOffice\PhpSpreadsheet\Style\Supervisor::bindParent	(	$parent,
		$parentPropertyName = `null`
	)

Bind parent.

Only used for supervisor.

Parameters

Spreadsheet \| Style	$parent
null \| string	$parentPropertyName

Returns: $this

Definition at line 53 of file Supervisor.php.

References PhpOffice\PhpSpreadsheet\Style\Supervisor\$parent, and PhpOffice\PhpSpreadsheet\Style\Supervisor\$parentPropertyName.

     {
         $this->parent = $parent;
         $this->parentPropertyName = $parentPropertyName;
 
         return $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.

Definition at line 125 of file Supervisor.php.

References PhpOffice\PhpSpreadsheet\Style\Supervisor\exportArray1().

                                        : array
     {
         return $this->exportArray1();
     }

Here is the call graph for this function:

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

Referenced by PhpOffice\PhpSpreadsheet\Style\Supervisor\exportArray().

Here is the caller graph for this function:

◆ exportArray2()

PhpOffice\PhpSpreadsheet\Style\Supervisor::exportArray2	(	array &	$exportedArray,
		string	$index,
			$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.

Parameters

mixed $objOrValue

Definition at line 150 of file Supervisor.php.

References PhpOffice\PhpSpreadsheet\Style\Style\$index.

                                                                                             : void
     {
         if ($objOrValue instanceof self) {
             $exportedArray[$index] = $objOrValue->exportArray();
         } else {
             $exportedArray[$index] = $objOrValue;
         }
     }

Here is the caller graph for this function:

◆ getActiveCell()

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

Get the currently active cell coordinate in currently active sheet.

Only used for supervisor.

Returns: string E.g. 'A1'

Definition at line 98 of file Supervisor.php.

References PhpOffice\PhpSpreadsheet\Style\Supervisor\getActiveSheet().

Referenced by PhpOffice\PhpSpreadsheet\Style\Style\getConditionalStyles(), and PhpOffice\PhpSpreadsheet\Style\Style\getSharedComponent().

     {
         return $this->getActiveSheet()->getActiveCell();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getActiveSheet()

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

Get the currently active sheet.

Only used for supervisor.

Returns: Worksheet

Definition at line 76 of file Supervisor.php.

     {
         return $this->parent->getActiveSheet();
     }

Here is the caller graph for this function:

◆ getIsSupervisor()

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

Is this a supervisor or a cell style component?

Returns: bool

Definition at line 66 of file Supervisor.php.

References PhpOffice\PhpSpreadsheet\Style\Supervisor\$isSupervisor.

Referenced by PhpOffice\PhpSpreadsheet\Style\Border\setColor(), PhpOffice\PhpSpreadsheet\Style\Font\setColor(), PhpOffice\PhpSpreadsheet\Style\Fill\setEndColor(), and PhpOffice\PhpSpreadsheet\Style\Fill\setStartColor().

     {
         return $this->isSupervisor;
     }

Here is the caller graph for this function:

◆ getSelectedCells()

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

Get the currently active cell coordinate in currently active sheet.

Only used for supervisor.

Returns: string E.g. 'A1'

Definition at line 87 of file Supervisor.php.

References PhpOffice\PhpSpreadsheet\Style\Supervisor\getActiveSheet().

     {
         return $this->getActiveSheet()->getSelectedCells();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $isSupervisor

PhpOffice\PhpSpreadsheet\Style\Supervisor::$isSupervisor

protected

Definition at line 16 of file Supervisor.php.

◆ $parent

PhpOffice\PhpSpreadsheet\Style\Supervisor::$parent

protected

Definition at line 23 of file Supervisor.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\Supervisor\bindParent(), and PhpOffice\PhpSpreadsheet\Style\Style\getParent().

◆ $parentPropertyName

PhpOffice\PhpSpreadsheet\Style\Supervisor::$parentPropertyName

protected

Definition at line 30 of file Supervisor.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\Supervisor\bindParent().

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

libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Style/Supervisor.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __clone()

◆ bindParent()

◆ exportArray()

◆ exportArray1()

◆ exportArray2()

◆ getActiveCell()

◆ getActiveSheet()

◆ getIsSupervisor()

◆ getSelectedCells()

Field Documentation

◆ $isSupervisor

◆ $parent

◆ $parentPropertyName