Inheritance diagram for PhpOffice\PhpSpreadsheet\Style\Border:

Collaboration diagram for PhpOffice\PhpSpreadsheet\Style\Border:

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

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

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

	getBorderStyle ()
	Get Border style. More...

	setBorderStyle ($pValue)
	Set Border style. More...

	getColor ()
	Get Border Color. More...

	setColor (Color $pValue)
	Set Border Color. 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	BORDER_NONE = 'none'

const	BORDER_DASHDOT = 'dashDot'

const	BORDER_DASHDOTDOT = 'dashDotDot'

const	BORDER_DASHED = 'dashed'

const	BORDER_DOTTED = 'dotted'

const	BORDER_DOUBLE = 'double'

const	BORDER_HAIR = 'hair'

const	BORDER_MEDIUM = 'medium'

const	BORDER_MEDIUMDASHDOT = 'mediumDashDot'

const	BORDER_MEDIUMDASHDOTDOT = 'mediumDashDotDot'

const	BORDER_MEDIUMDASHED = 'mediumDashed'

const	BORDER_SLANTDASHDOT = 'slantDashDot'

const	BORDER_THICK = 'thick'

const	BORDER_THIN = 'thin'

	$colorIndex

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
	$borderStyle = self::BORDER_NONE

	$color

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

	$parent

	$parentPropertyName

Detailed Description

Definition at line 7 of file Border.php.

Constructor & Destructor Documentation

◆ __construct()

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

Create a new Border.

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 51 of file Border.php.

References PhpOffice\PhpSpreadsheet\Style\Supervisor\$isSupervisor, color, PhpOffice\PhpSpreadsheet\Style\Color\COLOR_BLACK, and PhpOffice\PhpSpreadsheet\Style\Style\getSharedComponent().

     {
         // Supervisor?
         parent::__construct($isSupervisor);
 
         // Initialise values
         $this->color = new Color(Color::COLOR_BLACK, $isSupervisor);
 
         // bind parent if we are a supervisor
         if ($isSupervisor) {
             $this->color->bindParent($this, 'color');
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ applyFromArray()

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

Apply styles from array.

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

Parameters

array $pStyles Array containing style information

Returns: $this

Definition at line 121 of file Border.php.

References PhpOffice\PhpSpreadsheet\Style\Supervisor\getActiveSheet(), PhpOffice\PhpSpreadsheet\Style\Border\getColor(), PhpOffice\PhpSpreadsheet\Style\Supervisor\getSelectedCells(), PhpOffice\PhpSpreadsheet\Style\Border\getStyleArray(), and PhpOffice\PhpSpreadsheet\Style\Border\setBorderStyle().

     {
         if ($this->isSupervisor) {
             $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($this->getStyleArray($pStyles));
         } else {
             if (isset($pStyles['borderStyle'])) {
                 $this->setBorderStyle($pStyles['borderStyle']);
             }
             if (isset($pStyles['color'])) {
                 $this->getColor()->applyFromArray($pStyles['color']);
             }
         }
 
         return $this;
     }

Here is the call graph for this function:

◆ exportArray1()

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

protected

Definition at line 225 of file Border.php.

References PhpOffice\PhpSpreadsheet\Style\Supervisor\exportArray2(), PhpOffice\PhpSpreadsheet\Style\Border\getBorderStyle(), and PhpOffice\PhpSpreadsheet\Style\Border\getColor().

                                      : array
     {
         $exportedArray = [];
         $this->exportArray2($exportedArray, 'borderStyle', $this->getBorderStyle());
         $this->exportArray2($exportedArray, 'color', $this->getColor());
 
         return $exportedArray;
     }

Here is the call graph for this function:

◆ getBorderStyle()

PhpOffice\PhpSpreadsheet\Style\Border::getBorderStyle ( )

Get Border style.

Returns: string

Definition at line 142 of file Border.php.

References PhpOffice\PhpSpreadsheet\Style\Border\$borderStyle, and PhpOffice\PhpSpreadsheet\Style\Style\getSharedComponent().

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\createCSSStyleBorder(), PhpOffice\PhpSpreadsheet\Style\Border\exportArray1(), PhpOffice\PhpSpreadsheet\Writer\Xls\Style\CellBorder\style(), and PhpOffice\PhpSpreadsheet\Writer\Xlsx\Style\writeBorderPr().

     {
         if ($this->isSupervisor) {
             return $this->getSharedComponent()->getBorderStyle();
         }
 
         return $this->borderStyle;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getColor()

PhpOffice\PhpSpreadsheet\Style\Border::getColor ( )

Get Border Color.

Returns: Color

Definition at line 182 of file Border.php.

References PhpOffice\PhpSpreadsheet\Style\Border\$color.

Referenced by PhpOffice\PhpSpreadsheet\Style\Border\applyFromArray(), PhpOffice\PhpSpreadsheet\Writer\Html\createCSSStyleBorder(), PhpOffice\PhpSpreadsheet\Style\Border\exportArray1(), PhpOffice\PhpSpreadsheet\Reader\Xlsx\Styles\readBorder(), PhpOffice\PhpSpreadsheet\Style\Border\setColor(), and PhpOffice\PhpSpreadsheet\Writer\Xlsx\Style\writeBorderPr().

     {
         return $this->color;
     }

Here is the caller graph for this function:

◆ getHashCode()

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

Get hash code.

Returns: string Hash code

Implements PhpOffice\PhpSpreadsheet\IComparable.

Definition at line 212 of file Border.php.

References color, and PhpOffice\PhpSpreadsheet\Style\Style\getSharedComponent().

     {
         if ($this->isSupervisor) {
             return $this->getSharedComponent()->getHashCode();
         }
 
         return md5(
             $this->borderStyle .
             $this->color->getHashCode() .
             __CLASS__
         );
     }

Here is the call graph for this function:

◆ getStyleArray()

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

Build style array from subcomponents.

Parameters

array $array

Returns: array

Definition at line 98 of file Border.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\Border\applyFromArray(), and PhpOffice\PhpSpreadsheet\Style\Border\setBorderStyle().

     {
         return $this->parent->getStyleArray([$this->parentPropertyName => $array]);
     }

Here is the caller graph for this function:

◆ setBorderStyle()

PhpOffice\PhpSpreadsheet\Style\Border::setBorderStyle ( $pValue )

Set Border style.

Parameters

bool | string $pValue When passing a boolean, FALSE equates Border::BORDER_NONE and TRUE to Border::BORDER_MEDIUM

Returns: $this

Definition at line 160 of file Border.php.

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

Referenced by PhpOffice\PhpSpreadsheet\Style\Border\applyFromArray(), and PhpOffice\PhpSpreadsheet\Reader\Xlsx\Styles\readBorder().

     {
         if (empty($pValue)) {
             $pValue = self::BORDER_NONE;
         } elseif (is_bool($pValue) && $pValue) {
             $pValue = self::BORDER_MEDIUM;
         }
         if ($this->isSupervisor) {
             $styleArray = $this->getStyleArray(['borderStyle' => $pValue]);
             $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
         } else {
             $this->borderStyle = $pValue;
         }
 
         return $this;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setColor()

PhpOffice\PhpSpreadsheet\Style\Border::setColor ( Color $pValue )

Set Border Color.

Returns: $this

Definition at line 192 of file Border.php.

References PhpOffice\PhpSpreadsheet\Style\Border\$color, color, PhpOffice\PhpSpreadsheet\Style\Supervisor\getActiveSheet(), PhpOffice\PhpSpreadsheet\Style\Border\getColor(), PhpOffice\PhpSpreadsheet\Style\Supervisor\getIsSupervisor(), and PhpOffice\PhpSpreadsheet\Style\Supervisor\getSelectedCells().

     {
         // make sure parameter is a real color and not a supervisor
         $color = $pValue->getIsSupervisor() ? $pValue->getSharedComponent() : $pValue;
 
         if ($this->isSupervisor) {
             $styleArray = $this->getColor()->getStyleArray(['argb' => $color->getARGB()]);
             $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
         } else {
             $this->color = $color;
         }
 
         return $this;
     }

Here is the call graph for this function:

Field Documentation

◆ $borderStyle

PhpOffice\PhpSpreadsheet\Style\Border::$borderStyle = self::BORDER_NONE

protected

Definition at line 30 of file Border.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\Border\getBorderStyle().

◆ $color

PhpOffice\PhpSpreadsheet\Style\Border::$color

protected

Definition at line 37 of file Border.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\Border\getColor(), and PhpOffice\PhpSpreadsheet\Style\Border\setColor().

◆ $colorIndex

PhpOffice\PhpSpreadsheet\Style\Border::$colorIndex

Definition at line 42 of file Border.php.

◆ BORDER_DASHDOT

const PhpOffice\PhpSpreadsheet\Style\Border::BORDER_DASHDOT = 'dashDot'

Definition at line 11 of file Border.php.

◆ BORDER_DASHDOTDOT

const PhpOffice\PhpSpreadsheet\Style\Border::BORDER_DASHDOTDOT = 'dashDotDot'

Definition at line 12 of file Border.php.

◆ BORDER_DASHED

const PhpOffice\PhpSpreadsheet\Style\Border::BORDER_DASHED = 'dashed'

Definition at line 13 of file Border.php.

◆ BORDER_DOTTED

const PhpOffice\PhpSpreadsheet\Style\Border::BORDER_DOTTED = 'dotted'

Definition at line 14 of file Border.php.

◆ BORDER_DOUBLE

const PhpOffice\PhpSpreadsheet\Style\Border::BORDER_DOUBLE = 'double'

Definition at line 15 of file Border.php.

◆ BORDER_HAIR

const PhpOffice\PhpSpreadsheet\Style\Border::BORDER_HAIR = 'hair'

Definition at line 16 of file Border.php.

◆ BORDER_MEDIUM

const PhpOffice\PhpSpreadsheet\Style\Border::BORDER_MEDIUM = 'medium'

Definition at line 17 of file Border.php.

◆ BORDER_MEDIUMDASHDOT

const PhpOffice\PhpSpreadsheet\Style\Border::BORDER_MEDIUMDASHDOT = 'mediumDashDot'

Definition at line 18 of file Border.php.

◆ BORDER_MEDIUMDASHDOTDOT

const PhpOffice\PhpSpreadsheet\Style\Border::BORDER_MEDIUMDASHDOTDOT = 'mediumDashDotDot'

Definition at line 19 of file Border.php.

◆ BORDER_MEDIUMDASHED

const PhpOffice\PhpSpreadsheet\Style\Border::BORDER_MEDIUMDASHED = 'mediumDashed'

Definition at line 20 of file Border.php.

◆ BORDER_NONE

const PhpOffice\PhpSpreadsheet\Style\Border::BORDER_NONE = 'none'

Definition at line 10 of file Border.php.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Html\setBorderStyle(), PhpOffice\PhpSpreadsheet\Writer\Xls\Style\CellBorder\style(), PhpOffice\PhpSpreadsheet\Writer\Xlsx\Style\writeBorderPr(), and PhpOffice\PhpSpreadsheet\Writer\Xls\Worksheet\writeCFRule().

◆ BORDER_SLANTDASHDOT

const PhpOffice\PhpSpreadsheet\Style\Border::BORDER_SLANTDASHDOT = 'slantDashDot'

Definition at line 21 of file Border.php.

◆ BORDER_THICK

const PhpOffice\PhpSpreadsheet\Style\Border::BORDER_THICK = 'thick'

Definition at line 22 of file Border.php.

◆ BORDER_THIN

const PhpOffice\PhpSpreadsheet\Style\Border::BORDER_THIN = 'thin'

Definition at line 23 of file Border.php.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Slk\styleSettings().

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

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

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ applyFromArray()

◆ exportArray1()

◆ getBorderStyle()

◆ getColor()

◆ getHashCode()

◆ getStyleArray()

◆ setBorderStyle()

◆ setColor()

Field Documentation

◆ $borderStyle

◆ $color

◆ $colorIndex

◆ BORDER_DASHDOT

◆ BORDER_DASHDOTDOT

◆ BORDER_DASHED

◆ BORDER_DOTTED

◆ BORDER_DOUBLE

◆ BORDER_HAIR

◆ BORDER_MEDIUM

◆ BORDER_MEDIUMDASHDOT

◆ BORDER_MEDIUMDASHDOTDOT

◆ BORDER_MEDIUMDASHED

◆ BORDER_NONE

◆ BORDER_SLANTDASHDOT

◆ BORDER_THICK

◆ BORDER_THIN