Inheritance diagram for PhpOffice\PhpSpreadsheet\Style\Borders:

Collaboration diagram for PhpOffice\PhpSpreadsheet\Style\Borders:

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

	getSharedComponent ()
	Get the shared style component for the currently active cell in currently active sheet. More...

	getStyleArray ($array)
	Build style array from subcomponents. More...

	applyFromArray (array $pStyles)
	Apply styles from array. More...

	getLeft ()
	Get Left. More...

	getRight ()
	Get Right. More...

	getTop ()
	Get Top. More...

	getBottom ()
	Get Bottom. More...

	getDiagonal ()
	Get Diagonal. More...

	getAllBorders ()
	Get AllBorders (pseudo-border). More...

	getOutline ()
	Get Outline (pseudo-border). More...

	getInside ()
	Get Inside (pseudo-border). More...

	getVertical ()
	Get Vertical (pseudo-border). More...

	getHorizontal ()
	Get Horizontal (pseudo-border). More...

	getDiagonalDirection ()
	Get DiagonalDirection. More...

	setDiagonalDirection ($pValue)
	Set DiagonalDirection. More...

	getHashCode ()
	Get hash code. More...

Public Member Functions inherited from PhpOffice\PhpSpreadsheet\Style\Supervisor
	__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...

Data Fields
const	DIAGONAL_NONE = 0

const	DIAGONAL_UP = 1

const	DIAGONAL_DOWN = 2

const	DIAGONAL_BOTH = 3

Protected Member Functions
	exportArray1 ()

Protected Member Functions inherited from PhpOffice\PhpSpreadsheet\Style\Supervisor
	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
	$left

	$right

	$top

	$bottom

	$diagonal

	$diagonalDirection

	$allBorders

	$outline

	$inside

	$vertical

	$horizontal

Protected Attributes inherited from PhpOffice\PhpSpreadsheet\Style\Supervisor
	$isSupervisor

	$parent

	$parentPropertyName

Detailed Description

Definition at line 7 of file Borders.php.

Constructor & Destructor Documentation

◆ __construct()

PhpOffice\PhpSpreadsheet\Style\Borders::__construct ( $isSupervisor = false )

Create a new Borders.

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 99 of file Borders.php.

References PhpOffice\PhpSpreadsheet\Style\Supervisor\$isSupervisor, and left.

     {
         // Supervisor?
         parent::__construct($isSupervisor);
 
         // Initialise values
         $this->left = new Border($isSupervisor);
         $this->right = new Border($isSupervisor);
         $this->top = new Border($isSupervisor);
         $this->bottom = new Border($isSupervisor);
         $this->diagonal = new Border($isSupervisor);
         $this->diagonalDirection = self::DIAGONAL_NONE;
 
         // Specially for supervisor
         if ($isSupervisor) {
             // Initialize pseudo-borders
             $this->allBorders = new Border(true);
             $this->outline = new Border(true);
             $this->inside = new Border(true);
             $this->vertical = new Border(true);
             $this->horizontal = new Border(true);
 
             // bind parent if we are a supervisor
             $this->left->bindParent($this, 'left');
             $this->right->bindParent($this, 'right');
             $this->top->bindParent($this, 'top');
             $this->bottom->bindParent($this, 'bottom');
             $this->diagonal->bindParent($this, 'diagonal');
             $this->allBorders->bindParent($this, 'allBorders');
             $this->outline->bindParent($this, 'outline');
             $this->inside->bindParent($this, 'inside');
             $this->vertical->bindParent($this, 'vertical');
             $this->horizontal->bindParent($this, 'horizontal');
         }
     }

Member Function Documentation

◆ applyFromArray()

PhpOffice\PhpSpreadsheet\Style\Borders::applyFromArray ( array $pStyles )

Apply styles from array.

$spreadsheet->getActiveSheet()->getStyle('B2')->getBorders()->applyFromArray( [ 'bottom' => [ 'borderStyle' => Border::BORDER_DASHDOT, 'color' => [ 'rgb' => '808080' ] ], 'top' => [ 'borderStyle' => Border::BORDER_DASHDOT, 'color' => [ 'rgb' => '808080' ] ] ] );

$spreadsheet->getActiveSheet()->getStyle('B2')->getBorders()->applyFromArray( [ 'allBorders' => [ 'borderStyle' => Border::BORDER_DASHDOT, 'color' => [ 'rgb' => '808080' ] ] ] );

Parameters

array $pStyles Array containing style information

Returns: $this

Definition at line 197 of file Borders.php.

     {
         if ($this->isSupervisor) {
             $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($this->getStyleArray($pStyles));
         } else {
             if (isset($pStyles['left'])) {
                 $this->getLeft()->applyFromArray($pStyles['left']);
             }
             if (isset($pStyles['right'])) {
                 $this->getRight()->applyFromArray($pStyles['right']);
             }
             if (isset($pStyles['top'])) {
                 $this->getTop()->applyFromArray($pStyles['top']);
             }
             if (isset($pStyles['bottom'])) {
                 $this->getBottom()->applyFromArray($pStyles['bottom']);
             }
             if (isset($pStyles['diagonal'])) {
                 $this->getDiagonal()->applyFromArray($pStyles['diagonal']);
             }
             if (isset($pStyles['diagonalDirection'])) {
                 $this->setDiagonalDirection($pStyles['diagonalDirection']);
             }
             if (isset($pStyles['allBorders'])) {
                 $this->getLeft()->applyFromArray($pStyles['allBorders']);
                 $this->getRight()->applyFromArray($pStyles['allBorders']);
                 $this->getTop()->applyFromArray($pStyles['allBorders']);
                 $this->getBottom()->applyFromArray($pStyles['allBorders']);
             }
         }
 
         return $this;
     }

Here is the call graph for this function:

◆ exportArray1()

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

protected

Definition at line 409 of file Borders.php.

References PhpOffice\PhpSpreadsheet\Style\Supervisor\exportArray2(), PhpOffice\PhpSpreadsheet\Style\Borders\getBottom(), PhpOffice\PhpSpreadsheet\Style\Borders\getDiagonal(), PhpOffice\PhpSpreadsheet\Style\Borders\getDiagonalDirection(), PhpOffice\PhpSpreadsheet\Style\Borders\getLeft(), PhpOffice\PhpSpreadsheet\Style\Borders\getRight(), and PhpOffice\PhpSpreadsheet\Style\Borders\getTop().

                                      : array
     {
         $exportedArray = [];
         $this->exportArray2($exportedArray, 'bottom', $this->getBottom());
         $this->exportArray2($exportedArray, 'diagonal', $this->getDiagonal());
         $this->exportArray2($exportedArray, 'diagonalDirection', $this->getDiagonalDirection());
         $this->exportArray2($exportedArray, 'left', $this->getLeft());
         $this->exportArray2($exportedArray, 'right', $this->getRight());
         $this->exportArray2($exportedArray, 'top', $this->getTop());
 
         return $exportedArray;
     }

Here is the call graph for this function:

◆ getAllBorders()

PhpOffice\PhpSpreadsheet\Style\Borders::getAllBorders ( )

Get AllBorders (pseudo-border).

Only applies to supervisor.

Returns: Border

Definition at line 286 of file Borders.php.

References PhpOffice\PhpSpreadsheet\Style\Borders\$allBorders.

     {
         if (!$this->isSupervisor) {
             throw new PhpSpreadsheetException('Can only get pseudo-border for supervisor.');
         }
 
         return $this->allBorders;
     }

◆ getBottom()

PhpOffice\PhpSpreadsheet\Style\Borders::getBottom ( )

Get Bottom.

Returns: Border

Definition at line 266 of file Borders.php.

References PhpOffice\PhpSpreadsheet\Style\Borders\$bottom.

Referenced by PhpOffice\PhpSpreadsheet\Style\Borders\applyFromArray(), PhpOffice\PhpSpreadsheet\Writer\Html\createCSSStyleBorders(), PhpOffice\PhpSpreadsheet\Style\Borders\exportArray1(), PhpOffice\PhpSpreadsheet\Style\Borders\getHashCode(), PhpOffice\PhpSpreadsheet\Reader\Xlsx\Styles\readBorderStyle(), and PhpOffice\PhpSpreadsheet\Writer\Xlsx\Style\writeBorder().

     {
         return $this->bottom;
     }

Here is the caller graph for this function:

◆ getDiagonal()

PhpOffice\PhpSpreadsheet\Style\Borders::getDiagonal ( )

Get Diagonal.

Returns: Border

Definition at line 276 of file Borders.php.

References PhpOffice\PhpSpreadsheet\Style\Borders\$diagonal.

Referenced by PhpOffice\PhpSpreadsheet\Style\Borders\applyFromArray(), PhpOffice\PhpSpreadsheet\Style\Borders\exportArray1(), PhpOffice\PhpSpreadsheet\Style\Borders\getHashCode(), PhpOffice\PhpSpreadsheet\Reader\Xlsx\Styles\readBorderStyle(), and PhpOffice\PhpSpreadsheet\Writer\Xlsx\Style\writeBorder().

     {
         return $this->diagonal;
     }

Here is the caller graph for this function:

◆ getDiagonalDirection()

PhpOffice\PhpSpreadsheet\Style\Borders::getDiagonalDirection ( )

Get DiagonalDirection.

Returns: int

Definition at line 356 of file Borders.php.

References PhpOffice\PhpSpreadsheet\Style\Borders\$diagonalDirection, and PhpOffice\PhpSpreadsheet\Style\Borders\getSharedComponent().

Referenced by PhpOffice\PhpSpreadsheet\Style\Borders\exportArray1(), PhpOffice\PhpSpreadsheet\Style\Borders\getHashCode(), and PhpOffice\PhpSpreadsheet\Writer\Xlsx\Style\writeBorder().

     {
         if ($this->isSupervisor) {
             return $this->getSharedComponent()->getDiagonalDirection();
         }
 
         return $this->diagonalDirection;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getHashCode()

PhpOffice\PhpSpreadsheet\Style\Borders::getHashCode ( )

Get hash code.

Returns: string Hash code

Implements PhpOffice\PhpSpreadsheet\IComparable.

Definition at line 392 of file Borders.php.

References PhpOffice\PhpSpreadsheet\Style\Borders\getBottom(), PhpOffice\PhpSpreadsheet\Style\Borders\getDiagonal(), PhpOffice\PhpSpreadsheet\Style\Borders\getDiagonalDirection(), PhpOffice\PhpSpreadsheet\Style\Borders\getLeft(), PhpOffice\PhpSpreadsheet\Style\Borders\getRight(), PhpOffice\PhpSpreadsheet\Style\Borders\getSharedComponent(), and PhpOffice\PhpSpreadsheet\Style\Borders\getTop().

     {
         if ($this->isSupervisor) {
             return $this->getSharedComponent()->getHashcode();
         }
 
         return md5(
             $this->getLeft()->getHashCode() .
             $this->getRight()->getHashCode() .
             $this->getTop()->getHashCode() .
             $this->getBottom()->getHashCode() .
             $this->getDiagonal()->getHashCode() .
             $this->getDiagonalDirection() .
             __CLASS__
         );
     }

Here is the call graph for this function:

◆ getHorizontal()

PhpOffice\PhpSpreadsheet\Style\Borders::getHorizontal ( )

Get Horizontal (pseudo-border).

Only applies to supervisor.

Returns: Border

Definition at line 342 of file Borders.php.

References PhpOffice\PhpSpreadsheet\Style\Borders\$horizontal.

     {
         if (!$this->isSupervisor) {
             throw new PhpSpreadsheetException('Can only get pseudo-border for supervisor.');
         }
 
         return $this->horizontal;
     }

◆ getInside()

PhpOffice\PhpSpreadsheet\Style\Borders::getInside ( )

Get Inside (pseudo-border).

Only applies to supervisor.

Returns: Border

Definition at line 314 of file Borders.php.

References PhpOffice\PhpSpreadsheet\Style\Borders\$inside.

     {
         if (!$this->isSupervisor) {
             throw new PhpSpreadsheetException('Can only get pseudo-border for supervisor.');
         }
 
         return $this->inside;
     }

◆ getLeft()

PhpOffice\PhpSpreadsheet\Style\Borders::getLeft ( )

Get Left.

Returns: Border

Definition at line 236 of file Borders.php.

References PhpOffice\PhpSpreadsheet\Style\Borders\$left.

Referenced by PhpOffice\PhpSpreadsheet\Style\Borders\applyFromArray(), PhpOffice\PhpSpreadsheet\Writer\Html\createCSSStyleBorders(), PhpOffice\PhpSpreadsheet\Style\Borders\exportArray1(), PhpOffice\PhpSpreadsheet\Style\Borders\getHashCode(), PhpOffice\PhpSpreadsheet\Reader\Xlsx\Styles\readBorderStyle(), and PhpOffice\PhpSpreadsheet\Writer\Xlsx\Style\writeBorder().

     {
         return $this->left;
     }

Here is the caller graph for this function:

◆ getOutline()

PhpOffice\PhpSpreadsheet\Style\Borders::getOutline ( )

Get Outline (pseudo-border).

Only applies to supervisor.

Returns: Border

Definition at line 300 of file Borders.php.

References PhpOffice\PhpSpreadsheet\Style\Borders\$outline.

     {
         if (!$this->isSupervisor) {
             throw new PhpSpreadsheetException('Can only get pseudo-border for supervisor.');
         }
 
         return $this->outline;
     }

◆ getRight()

PhpOffice\PhpSpreadsheet\Style\Borders::getRight ( )

Get Right.

Returns: Border

Definition at line 246 of file Borders.php.

References PhpOffice\PhpSpreadsheet\Style\Borders\$right.

Referenced by PhpOffice\PhpSpreadsheet\Style\Borders\applyFromArray(), PhpOffice\PhpSpreadsheet\Writer\Html\createCSSStyleBorders(), PhpOffice\PhpSpreadsheet\Style\Borders\exportArray1(), PhpOffice\PhpSpreadsheet\Style\Borders\getHashCode(), PhpOffice\PhpSpreadsheet\Reader\Xlsx\Styles\readBorderStyle(), and PhpOffice\PhpSpreadsheet\Writer\Xlsx\Style\writeBorder().

     {
         return $this->right;
     }

Here is the caller graph for this function:

◆ getSharedComponent()

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

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

Only used for style supervisor.

Returns: Borders

Definition at line 141 of file Borders.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\Borders\getDiagonalDirection(), and PhpOffice\PhpSpreadsheet\Style\Borders\getHashCode().

     {
         return $this->parent->getSharedComponent()->getBorders();
     }

Here is the caller graph for this function:

◆ getStyleArray()

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

Build style array from subcomponents.

Parameters

array $array

Returns: array

Definition at line 153 of file Borders.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\Borders\applyFromArray(), and PhpOffice\PhpSpreadsheet\Style\Borders\setDiagonalDirection().

     {
         return ['borders' => $array];
     }

Here is the caller graph for this function:

◆ getTop()

PhpOffice\PhpSpreadsheet\Style\Borders::getTop ( )

Get Top.

Returns: Border

Definition at line 256 of file Borders.php.

References PhpOffice\PhpSpreadsheet\Style\Borders\$top.

Referenced by PhpOffice\PhpSpreadsheet\Style\Borders\applyFromArray(), PhpOffice\PhpSpreadsheet\Writer\Html\createCSSStyleBorders(), PhpOffice\PhpSpreadsheet\Style\Borders\exportArray1(), PhpOffice\PhpSpreadsheet\Style\Borders\getHashCode(), PhpOffice\PhpSpreadsheet\Reader\Xlsx\Styles\readBorderStyle(), and PhpOffice\PhpSpreadsheet\Writer\Xlsx\Style\writeBorder().

     {
         return $this->top;
     }

Here is the caller graph for this function:

◆ getVertical()

PhpOffice\PhpSpreadsheet\Style\Borders::getVertical ( )

Get Vertical (pseudo-border).

Only applies to supervisor.

Returns: Border

Definition at line 328 of file Borders.php.

References PhpOffice\PhpSpreadsheet\Style\Borders\$vertical.

     {
         if (!$this->isSupervisor) {
             throw new PhpSpreadsheetException('Can only get pseudo-border for supervisor.');
         }
 
         return $this->vertical;
     }

◆ setDiagonalDirection()

PhpOffice\PhpSpreadsheet\Style\Borders::setDiagonalDirection ( $pValue )

Set DiagonalDirection.

Parameters

int $pValue see self::DIAGONAL_*

Returns: $this

Definition at line 372 of file Borders.php.

References PhpOffice\PhpSpreadsheet\Style\Supervisor\getActiveSheet(), PhpOffice\PhpSpreadsheet\Style\Supervisor\getSelectedCells(), and PhpOffice\PhpSpreadsheet\Style\Borders\getStyleArray().

Referenced by PhpOffice\PhpSpreadsheet\Style\Borders\applyFromArray(), and PhpOffice\PhpSpreadsheet\Reader\Xlsx\Styles\readBorderStyle().

     {
         if ($pValue == '') {
             $pValue = self::DIAGONAL_NONE;
         }
         if ($this->isSupervisor) {
             $styleArray = $this->getStyleArray(['diagonalDirection' => $pValue]);
             $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
         } else {
             $this->diagonalDirection = $pValue;
         }
 
         return $this;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $allBorders

PhpOffice\PhpSpreadsheet\Style\Borders::$allBorders

protected

Definition at line 62 of file Borders.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\Borders\getAllBorders().

◆ $bottom

PhpOffice\PhpSpreadsheet\Style\Borders::$bottom

protected

Definition at line 41 of file Borders.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\Borders\getBottom().

◆ $diagonal

PhpOffice\PhpSpreadsheet\Style\Borders::$diagonal

protected

Definition at line 48 of file Borders.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\Borders\getDiagonal().

◆ $diagonalDirection

PhpOffice\PhpSpreadsheet\Style\Borders::$diagonalDirection

protected

Definition at line 55 of file Borders.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\Borders\getDiagonalDirection().

◆ $horizontal

PhpOffice\PhpSpreadsheet\Style\Borders::$horizontal

protected

Definition at line 90 of file Borders.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\Borders\getHorizontal().

◆ $inside

PhpOffice\PhpSpreadsheet\Style\Borders::$inside

protected

Definition at line 76 of file Borders.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\Borders\getInside().

◆ $left

PhpOffice\PhpSpreadsheet\Style\Borders::$left

protected

Definition at line 20 of file Borders.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\Borders\getLeft().

◆ $outline

PhpOffice\PhpSpreadsheet\Style\Borders::$outline

protected

Definition at line 69 of file Borders.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\Borders\getOutline().

◆ $right

PhpOffice\PhpSpreadsheet\Style\Borders::$right

protected

Definition at line 27 of file Borders.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\Borders\getRight().

◆ $top

PhpOffice\PhpSpreadsheet\Style\Borders::$top

protected

Definition at line 34 of file Borders.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\Borders\getTop().

◆ $vertical

PhpOffice\PhpSpreadsheet\Style\Borders::$vertical

protected

Definition at line 83 of file Borders.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\Borders\getVertical().

◆ DIAGONAL_BOTH

const PhpOffice\PhpSpreadsheet\Style\Borders::DIAGONAL_BOTH = 3

Definition at line 13 of file Borders.php.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xml\Style\Border\parsePosition(), PhpOffice\PhpSpreadsheet\Reader\Xlsx\Styles\readBorderStyle(), PhpOffice\PhpSpreadsheet\Reader\Xls\readXf(), PhpOffice\PhpSpreadsheet\Writer\Xlsx\Style\writeBorder(), and PhpOffice\PhpSpreadsheet\Writer\Xls\Xf\writeXf().

◆ DIAGONAL_DOWN

const PhpOffice\PhpSpreadsheet\Style\Borders::DIAGONAL_DOWN = 2

Definition at line 12 of file Borders.php.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xml\Style\Border\parsePosition(), PhpOffice\PhpSpreadsheet\Reader\Xlsx\Styles\readBorderStyle(), PhpOffice\PhpSpreadsheet\Reader\Xls\readXf(), PhpOffice\PhpSpreadsheet\Writer\Xlsx\Style\writeBorder(), and PhpOffice\PhpSpreadsheet\Writer\Xls\Xf\writeXf().

◆ DIAGONAL_NONE

const PhpOffice\PhpSpreadsheet\Style\Borders::DIAGONAL_NONE = 0

Definition at line 10 of file Borders.php.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xlsx\Styles\readBorderStyle(), and PhpOffice\PhpSpreadsheet\Reader\Xls\readXf().

◆ DIAGONAL_UP

const PhpOffice\PhpSpreadsheet\Style\Borders::DIAGONAL_UP = 1

Definition at line 11 of file Borders.php.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xml\Style\Border\parsePosition(), PhpOffice\PhpSpreadsheet\Reader\Xlsx\Styles\readBorderStyle(), PhpOffice\PhpSpreadsheet\Reader\Xls\readXf(), PhpOffice\PhpSpreadsheet\Writer\Xlsx\Style\writeBorder(), and PhpOffice\PhpSpreadsheet\Writer\Xls\Xf\writeXf().

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

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

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ applyFromArray()

◆ exportArray1()

◆ getAllBorders()

◆ getBottom()

◆ getDiagonal()

◆ getDiagonalDirection()

◆ getHashCode()

◆ getHorizontal()

◆ getInside()

◆ getLeft()

◆ getOutline()

◆ getRight()

◆ getSharedComponent()

◆ getStyleArray()

◆ getTop()

◆ getVertical()

◆ setDiagonalDirection()

Field Documentation

◆ $allBorders

◆ $bottom

◆ $diagonal

◆ $diagonalDirection

◆ $horizontal

◆ $inside

◆ $left

◆ $outline

◆ $right

◆ $top

◆ $vertical

◆ DIAGONAL_BOTH

◆ DIAGONAL_DOWN

◆ DIAGONAL_NONE

◆ DIAGONAL_UP