Inheritance diagram for PHPExcel_Style_Border:

Collaboration diagram for PHPExcel_Style_Border:

Public Member Functions
	__construct ($isSupervisor=FALSE, $isConditional=FALSE)
	Create a new PHPExcel_Style_Border. More...

	bindParent ($parent, $parentPropertyName=NULL)
	Bind parent. 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...

	getBorderStyle ()
	Get Border style. More...

	setBorderStyle ($pValue=PHPExcel_Style_Border::BORDER_NONE)
	Set Border style. More...

	getColor ()
	Get Border Color. More...

	setColor (PHPExcel_Style_Color $pValue=null)
	Set Border Color. 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...

	getHashCode ()
	Get hash code. 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'

Protected Attributes
	$_borderStyle = PHPExcel_Style_Border::BORDER_NONE

	$_color

	$_parentPropertyName

Protected Attributes inherited from PHPExcel_Style_Supervisor
	$_isSupervisor

	$_parent

Detailed Description

Definition at line 36 of file Border.php.

Constructor & Destructor Documentation

◆ __construct()

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

Create a new PHPExcel_Style_Border.

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

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

References PHPExcel_Style_Color\COLOR_BLACK.

Member Function Documentation

◆ applyFromArray()

PHPExcel_Style_Border::applyFromArray ( $pStyles = null )

Apply styles from array.

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

Parameters

array $pStyles Array containing style information

Exceptions

PHPExcel_Exception

Returns: PHPExcel_Style_Border

Definition at line 195 of file Border.php.

                                                        {
                if (is_array($pStyles)) {
                        if ($this->_isSupervisor) {
                                $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($this->getStyleArray($pStyles));
                        } else {
                                if (isset($pStyles['style'])) {
                                        $this->setBorderStyle($pStyles['style']);
                                }
                                if (isset($pStyles['color'])) {
                                        $this->getColor()->applyFromArray($pStyles['color']);
                                }
                        }
                } else {
                        throw new PHPExcel_Exception("Invalid style array passed.");
                }
                return $this;
        }

References PHPExcel_Style_Supervisor\getActiveSheet(), getColor(), PHPExcel_Style_Supervisor\getSelectedCells(), getStyleArray(), and setBorderStyle().

Here is the call graph for this function:

◆ bindParent()

PHPExcel_Style_Border::bindParent	(	$parent,
		$parentPropertyName = `NULL`
	)

Bind parent.

Only used for supervisor

Parameters

PHPExcel_Style_Borders	$parent
string	$parentPropertyName

Returns: PHPExcel_Style_Border

Reimplemented from PHPExcel_Style_Supervisor.

Definition at line 106 of file Border.php.

        {
                $this->_parent = $parent;
                $this->_parentPropertyName = $parentPropertyName;
                return $this;
        }

◆ getBorderStyle()

PHPExcel_Style_Border::getBorderStyle ( )

Get Border style.

Returns: string

Definition at line 218 of file Border.php.

                                         {
                if ($this->_isSupervisor) {
                        return $this->getSharedComponent()->getBorderStyle();
                }
                return $this->_borderStyle;
        }

References $_borderStyle, and getSharedComponent().

Referenced by PHPExcel_Writer_HTML\_createCSSStyleBorder().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getColor()

PHPExcel_Style_Border::getColor ( )

Get Border Color.

Returns: PHPExcel_Style_Color

Definition at line 254 of file Border.php.

                                   {
                return $this->_color;
        }

References $_color.

Referenced by PHPExcel_Writer_HTML\_createCSSStyleBorder(), applyFromArray(), and setColor().

Here is the caller graph for this function:

◆ getHashCode()

PHPExcel_Style_Border::getHashCode ( )

Get hash code.

Returns: string Hash code

Implements PHPExcel_IComparable.

Definition at line 283 of file Border.php.

                                      {
                if ($this->_isSupervisor) {
                        return $this->getSharedComponent()->getHashCode();
                }
                return md5(
                          $this->_borderStyle
                        . $this->_color->getHashCode()
                        . __CLASS__
                );
        }

References getSharedComponent().

Here is the call graph for this function:

◆ getSharedComponent()

PHPExcel_Style_Border::getSharedComponent ( )

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

Only used for style supervisor

Returns: PHPExcel_Style_Border

Exceptions

PHPExcel_Exception

Definition at line 120 of file Border.php.

        {
                switch ($this->_parentPropertyName) {
                        case '_allBorders':
                        case '_horizontal':
                        case '_inside':
                        case '_outline':
                        case '_vertical':
                                throw new PHPExcel_Exception('Cannot get shared component for a pseudo-border.');
                                break;
                        case '_bottom':
                                return $this->_parent->getSharedComponent()->getBottom();               break;
                        case '_diagonal':
                                return $this->_parent->getSharedComponent()->getDiagonal();             break;
                        case '_left':
                                return $this->_parent->getSharedComponent()->getLeft();                 break;
                        case '_right':
                                return $this->_parent->getSharedComponent()->getRight();                break;
                        case '_top':
                                return $this->_parent->getSharedComponent()->getTop();                  break;
 
                }
        }

Referenced by getBorderStyle(), and getHashCode().

Here is the caller graph for this function:

◆ getStyleArray()

PHPExcel_Style_Border::getStyleArray ( $array )

Build style array from subcomponents.

Parameters

array $array

Returns: array

Definition at line 150 of file Border.php.

        {
                switch ($this->_parentPropertyName) {
                case '_allBorders':
                                $key = 'allborders';    break;
                case '_bottom':
                                $key = 'bottom';                break;
                case '_diagonal':
                                $key = 'diagonal';              break;
                case '_horizontal':
                                $key = 'horizontal';    break;
                case '_inside':
                                $key = 'inside';                break;
                case '_left':
                                $key = 'left';                  break;
                case '_outline':
                                $key = 'outline';               break;
                case '_right':
                                $key = 'right';                 break;
                case '_top':
                                $key = 'top';                   break;
                case '_vertical':
                                $key = 'vertical';              break;
                }
                return $this->_parent->getStyleArray(array($key => $array));
        }

Referenced by applyFromArray(), and setBorderStyle().

Here is the caller graph for this function:

◆ setBorderStyle()

PHPExcel_Style_Border::setBorderStyle ( $pValue = PHPExcel_Style_Border::BORDER_NONE )

Set Border style.

Parameters

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

Returns: PHPExcel_Style_Border

Definition at line 233 of file Border.php.

                                                                                   {
 
                if (empty($pValue)) {
                        $pValue = PHPExcel_Style_Border::BORDER_NONE;
                } elseif(is_bool($pValue) && $pValue) {
                        $pValue = PHPExcel_Style_Border::BORDER_MEDIUM;
                }
                if ($this->_isSupervisor) {
                        $styleArray = $this->getStyleArray(array('style' => $pValue));
                        $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
                } else {
                        $this->_borderStyle = $pValue;
                }
                return $this;
        }

References BORDER_MEDIUM, BORDER_NONE, PHPExcel_Style_Supervisor\getActiveSheet(), PHPExcel_Style_Supervisor\getSelectedCells(), and getStyleArray().

Referenced by applyFromArray().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setColor()

PHPExcel_Style_Border::setColor ( PHPExcel_Style_Color $pValue = null )

Set Border Color.

Parameters

PHPExcel_Style_Color $pValue

Exceptions

PHPExcel_Exception

Returns: PHPExcel_Style_Border

Definition at line 265 of file Border.php.

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