Inheritance diagram for PHPExcel_Style_Borders:

Collaboration diagram for PHPExcel_Style_Borders:

Public Member Functions
	__construct ($isSupervisor=FALSE, $isConditional=FALSE)
	Create a new PHPExcel_Style_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 ($pStyles=null)
	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=PHPExcel_Style_Borders::DIAGONAL_NONE)
	Set DiagonalDirection. More...

	getHashCode ()
	Get hash code. More...

Public Member Functions inherited from PHPExcel_Style_Supervisor
	__construct ($isSupervisor=FALSE)
	Create a new PHPExcel_Style_Alignment. 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...

Data Fields
const	DIAGONAL_NONE = 0

const	DIAGONAL_UP = 1

const	DIAGONAL_DOWN = 2

const	DIAGONAL_BOTH = 3

Protected Attributes
	$_left

	$_right

	$_top

	$_bottom

	$_diagonal

	$_diagonalDirection

	$_allBorders

	$_outline

	$_inside

	$_vertical

	$_horizontal

Protected Attributes inherited from PHPExcel_Style_Supervisor
	$_isSupervisor

	$_parent

Detailed Description

Definition at line 36 of file Borders.php.

Constructor & Destructor Documentation

◆ __construct()

PHPExcel_Style_Borders::__construct	(	$isSupervisor = `FALSE`,
		$isConditional = `FALSE`
	)

Create a new PHPExcel_Style_Borders.

Parameters

boolean	$isSupervisor	Flag indicating if this is a supervisor or not Leave this value at default unless you understand exactly what its ramifications are
boolean	$isConditional	Flag indicating if this is a conditional style or not Leave this value at default unless you understand exactly what its ramifications are

Definition at line 131 of file Borders.php.

References DIAGONAL_NONE.

     {
         // Supervisor?
                 parent::__construct($isSupervisor);
 
         // Initialise values
         $this->_left                            = new PHPExcel_Style_Border($isSupervisor, $isConditional);
         $this->_right                           = new PHPExcel_Style_Border($isSupervisor, $isConditional);
         $this->_top                                     = new PHPExcel_Style_Border($isSupervisor, $isConditional);
         $this->_bottom                          = new PHPExcel_Style_Border($isSupervisor, $isConditional);
         $this->_diagonal                        = new PHPExcel_Style_Border($isSupervisor, $isConditional);
                 $this->_diagonalDirection       = PHPExcel_Style_Borders::DIAGONAL_NONE;
 
                 // Specially for supervisor
                 if ($isSupervisor) {
                         // Initialize pseudo-borders
                         $this->_allBorders                      = new PHPExcel_Style_Border(TRUE);
                         $this->_outline                         = new PHPExcel_Style_Border(TRUE);
                         $this->_inside                          = new PHPExcel_Style_Border(TRUE);
                         $this->_vertical                        = new PHPExcel_Style_Border(TRUE);
                         $this->_horizontal                      = new PHPExcel_Style_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()

PHPExcel_Style_Borders::applyFromArray ( $pStyles = null )

Apply styles from array.

$objPHPExcel->getActiveSheet()->getStyle('B2')->getBorders()->applyFromArray( array( 'bottom' => array( 'style' => PHPExcel_Style_Border::BORDER_DASHDOT, 'color' => array( 'rgb' => '808080' ) ), 'top' => array( 'style' => PHPExcel_Style_Border::BORDER_DASHDOT, 'color' => array( 'rgb' => '808080' ) ) ) ); $objPHPExcel->getActiveSheet()->getStyle('B2')->getBorders()->applyFromArray( array( 'allborders' => array( 'style' => PHPExcel_Style_Border::BORDER_DASHDOT, 'color' => array( 'rgb' => '808080' ) ) ) );

Parameters

array $pStyles Array containing style information

Exceptions

PHPExcel_Exception

Returns: PHPExcel_Style_Borders

Definition at line 227 of file Borders.php.

References PHPExcel_Style_Supervisor\getActiveSheet(), getBottom(), getDiagonal(), getLeft(), getRight(), PHPExcel_Style_Supervisor\getSelectedCells(), getStyleArray(), getTop(), and setDiagonalDirection().

                                                         {
                 if (is_array($pStyles)) {
                         if ($this->_isSupervisor) {
                                 $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($this->getStyleArray($pStyles));
                         } else {
                                 if (array_key_exists('left', $pStyles)) {
                                         $this->getLeft()->applyFromArray($pStyles['left']);
                                 }
                                 if (array_key_exists('right', $pStyles)) {
                                         $this->getRight()->applyFromArray($pStyles['right']);
                                 }
                                 if (array_key_exists('top', $pStyles)) {
                                         $this->getTop()->applyFromArray($pStyles['top']);
                                 }
                                 if (array_key_exists('bottom', $pStyles)) {
                                         $this->getBottom()->applyFromArray($pStyles['bottom']);
                                 }
                                 if (array_key_exists('diagonal', $pStyles)) {
                                         $this->getDiagonal()->applyFromArray($pStyles['diagonal']);
                                 }
                                 if (array_key_exists('diagonaldirection', $pStyles)) {
                                         $this->setDiagonalDirection($pStyles['diagonaldirection']);
                                 }
                                 if (array_key_exists('allborders', $pStyles)) {
                                         $this->getLeft()->applyFromArray($pStyles['allborders']);
                                         $this->getRight()->applyFromArray($pStyles['allborders']);
                                         $this->getTop()->applyFromArray($pStyles['allborders']);
                                         $this->getBottom()->applyFromArray($pStyles['allborders']);
                                 }
                         }
                 } else {
                         throw new PHPExcel_Exception("Invalid style array passed.");
                 }
                 return $this;
         }

Here is the call graph for this function:

◆ getAllBorders()

PHPExcel_Style_Borders::getAllBorders ( )

Get AllBorders (pseudo-border).

Only applies to supervisor.

Returns: PHPExcel_Style_Border

Exceptions

PHPExcel_Exception

Definition at line 314 of file Borders.php.

References $_allBorders.

                                     {
                 if (!$this->_isSupervisor) {
                         throw new PHPExcel_Exception('Can only get pseudo-border for supervisor.');
                 }
                 return $this->_allBorders;
     }

◆ getBottom()

PHPExcel_Style_Borders::getBottom ( )

Get Bottom.

Returns: PHPExcel_Style_Border

Definition at line 295 of file Borders.php.

References $_bottom.

Referenced by PHPExcel_Writer_HTML\_createCSSStyleBorders(), applyFromArray(), and getHashCode().

                                 {
                 return $this->_bottom;
     }

Here is the caller graph for this function:

◆ getDiagonal()

PHPExcel_Style_Borders::getDiagonal ( )

Get Diagonal.

Returns: PHPExcel_Style_Border

Definition at line 304 of file Borders.php.

References $_diagonal.

Referenced by applyFromArray(), and getHashCode().

                                   {
                 return $this->_diagonal;
     }

Here is the caller graph for this function:

◆ getDiagonalDirection()

PHPExcel_Style_Borders::getDiagonalDirection ( )

Get DiagonalDirection.

Returns: int

Definition at line 378 of file Borders.php.

References $_diagonalDirection, and getSharedComponent().

Referenced by getHashCode().

                                            {
                 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()

PHPExcel_Style_Borders::getHashCode ( )

Get hash code.

Returns: string Hash code

Implements PHPExcel_IComparable.

Definition at line 409 of file Borders.php.

References getBottom(), getDiagonal(), getDiagonalDirection(), getLeft(), getRight(), getSharedComponent(), and 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()

PHPExcel_Style_Borders::getHorizontal ( )

Get Horizontal (pseudo-border).

Only applies to supervisor.

Returns: PHPExcel_Style_Border

Exceptions

PHPExcel_Exception

Definition at line 366 of file Borders.php.

References $_horizontal.

                                     {
                 if (!$this->_isSupervisor) {
                         throw new PHPExcel_Exception('Can only get pseudo-border for supervisor.');
                 }
                 return $this->_horizontal;
     }

◆ getInside()

PHPExcel_Style_Borders::getInside ( )

Get Inside (pseudo-border).

Only applies to supervisor.

Returns: boolean

Exceptions

PHPExcel_Exception

Definition at line 340 of file Borders.php.

References $_inside.

                                 {
                 if (!$this->_isSupervisor) {
                         throw new PHPExcel_Exception('Can only get pseudo-border for supervisor.');
                 }
         return $this->_inside;
     }

◆ getLeft()

PHPExcel_Style_Borders::getLeft ( )

Get Left.

Returns: PHPExcel_Style_Border

Definition at line 268 of file Borders.php.

References $_left.

Referenced by PHPExcel_Writer_HTML\_createCSSStyleBorders(), applyFromArray(), and getHashCode().

                               {
                 return $this->_left;
     }

Here is the caller graph for this function:

◆ getOutline()

PHPExcel_Style_Borders::getOutline ( )

Get Outline (pseudo-border).

Only applies to supervisor.

Returns: boolean

Exceptions

PHPExcel_Exception

Definition at line 327 of file Borders.php.

References $_outline.

                                  {
                 if (!$this->_isSupervisor) {
                         throw new PHPExcel_Exception('Can only get pseudo-border for supervisor.');
                 }
         return $this->_outline;
     }

◆ getRight()

PHPExcel_Style_Borders::getRight ( )

Get Right.

Returns: PHPExcel_Style_Border

Definition at line 277 of file Borders.php.

References $_right.

Referenced by PHPExcel_Writer_HTML\_createCSSStyleBorders(), applyFromArray(), and getHashCode().

                                {
                 return $this->_right;
     }

Here is the caller graph for this function:

◆ getSharedComponent()

PHPExcel_Style_Borders::getSharedComponent ( )

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

Only used for style supervisor

Returns: PHPExcel_Style_Borders

Definition at line 173 of file Borders.php.

Referenced by getDiagonalDirection(), and getHashCode().

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

Here is the caller graph for this function:

◆ getStyleArray()

PHPExcel_Style_Borders::getStyleArray ( $array )

Build style array from subcomponents.

Parameters

array $array

Returns: array

Definition at line 184 of file Borders.php.

References array.

Referenced by applyFromArray(), and setDiagonalDirection().

         {
                 return array('borders' => $array);
         }

Here is the caller graph for this function:

◆ getTop()

PHPExcel_Style_Borders::getTop ( )

Get Top.

Returns: PHPExcel_Style_Border

Definition at line 286 of file Borders.php.

References $_top.

Referenced by PHPExcel_Writer_HTML\_createCSSStyleBorders(), applyFromArray(), and getHashCode().

                              {
                 return $this->_top;
     }

Here is the caller graph for this function:

◆ getVertical()

PHPExcel_Style_Borders::getVertical ( )

Get Vertical (pseudo-border).

Only applies to supervisor.

Returns: PHPExcel_Style_Border

Exceptions

PHPExcel_Exception

Definition at line 353 of file Borders.php.

References $_vertical.

                                   {
                 if (!$this->_isSupervisor) {
                         throw new PHPExcel_Exception('Can only get pseudo-border for supervisor.');
                 }
                 return $this->_vertical;
     }

◆ setDiagonalDirection()

PHPExcel_Style_Borders::setDiagonalDirection ( $pValue = PHPExcel_Style_Borders::DIAGONAL_NONE )

Set DiagonalDirection.

Parameters

int $pValue

Returns: PHPExcel_Style_Borders

Definition at line 391 of file Borders.php.

References array, DIAGONAL_NONE, PHPExcel_Style_Supervisor\getActiveSheet(), PHPExcel_Style_Supervisor\getSelectedCells(), and getStyleArray().

Referenced by applyFromArray().

                                                                                         {
         if ($pValue == '') {
                 $pValue = PHPExcel_Style_Borders::DIAGONAL_NONE;
         }
                 if ($this->_isSupervisor) {
                         $styleArray = $this->getStyleArray(array('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

PHPExcel_Style_Borders::$_allBorders

protected

Definition at line 91 of file Borders.php.

Referenced by getAllBorders().

◆ $_bottom

PHPExcel_Style_Borders::$_bottom

protected

Definition at line 70 of file Borders.php.

Referenced by getBottom().

◆ $_diagonal

PHPExcel_Style_Borders::$_diagonal

protected

Definition at line 77 of file Borders.php.

Referenced by getDiagonal().

◆ $_diagonalDirection

PHPExcel_Style_Borders::$_diagonalDirection

protected

Definition at line 84 of file Borders.php.

Referenced by getDiagonalDirection().

◆ $_horizontal

PHPExcel_Style_Borders::$_horizontal

protected

Definition at line 119 of file Borders.php.

Referenced by getHorizontal().

◆ $_inside

PHPExcel_Style_Borders::$_inside

protected

Definition at line 105 of file Borders.php.

Referenced by getInside().

◆ $_left

PHPExcel_Style_Borders::$_left

protected

Definition at line 49 of file Borders.php.

Referenced by getLeft().

◆ $_outline

PHPExcel_Style_Borders::$_outline

protected

Definition at line 98 of file Borders.php.

Referenced by getOutline().

◆ $_right

PHPExcel_Style_Borders::$_right

protected

Definition at line 56 of file Borders.php.

Referenced by getRight().

◆ $_top

PHPExcel_Style_Borders::$_top

protected

Definition at line 63 of file Borders.php.

Referenced by getTop().

◆ $_vertical

PHPExcel_Style_Borders::$_vertical

protected

Definition at line 112 of file Borders.php.

Referenced by getVertical().

◆ DIAGONAL_BOTH

const PHPExcel_Style_Borders::DIAGONAL_BOTH = 3

Definition at line 42 of file Borders.php.

Referenced by PHPExcel_Reader_Excel2007\_readStyle(), PHPExcel_Reader_Excel5\_readXf(), PHPExcel_Writer_Excel2007_Style\_writeBorder(), PHPExcel_Reader_Gnumeric\loadIntoExisting(), and PHPExcel_Writer_Excel5_Xf\writeXf().

◆ DIAGONAL_DOWN

const PHPExcel_Style_Borders::DIAGONAL_DOWN = 2

Definition at line 41 of file Borders.php.

Referenced by PHPExcel_Reader_Excel2007\_readStyle(), PHPExcel_Reader_Excel5\_readXf(), PHPExcel_Writer_Excel2007_Style\_writeBorder(), PHPExcel_Reader_Gnumeric\loadIntoExisting(), and PHPExcel_Writer_Excel5_Xf\writeXf().

◆ DIAGONAL_NONE

const PHPExcel_Style_Borders::DIAGONAL_NONE = 0

Definition at line 39 of file Borders.php.

Referenced by __construct(), PHPExcel_Reader_Excel2007\_readStyle(), PHPExcel_Reader_Excel5\_readXf(), and setDiagonalDirection().

◆ DIAGONAL_UP

const PHPExcel_Style_Borders::DIAGONAL_UP = 1

Definition at line 40 of file Borders.php.

Referenced by PHPExcel_Reader_Excel2007\_readStyle(), PHPExcel_Reader_Excel5\_readXf(), PHPExcel_Writer_Excel2007_Style\_writeBorder(), PHPExcel_Reader_Gnumeric\loadIntoExisting(), and PHPExcel_Writer_Excel5_Xf\writeXf().

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

libs/composer/vendor/phpoffice/phpexcel/Classes/PHPExcel/Style/Borders.php

Public Member Functions

Data Fields

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ applyFromArray()

◆ 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