123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239 |
- <?php
- namespace PhpOffice\PhpSpreadsheet\Style;
- use PhpOffice\PhpSpreadsheet\Exception as PhpSpreadsheetException;
- class Border extends Supervisor
- {
- // Border style
- 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';
- /**
- * Border style.
- *
- * @var string
- */
- protected $borderStyle = self::BORDER_NONE;
- /**
- * Border color.
- *
- * @var Color
- */
- protected $color;
- /**
- * @var int
- */
- public $colorIndex;
- /**
- * Create a new Border.
- *
- * @param bool $isSupervisor Flag indicating if this is a supervisor or not
- * Leave this value at default unless you understand exactly what
- * its ramifications are
- * @param bool $isConditional Flag indicating if this is a conditional style or not
- * Leave this value at default unless you understand exactly what
- * its ramifications are
- */
- public function __construct($isSupervisor = false, $isConditional = false)
- {
- // 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');
- }
- }
- /**
- * Get the shared style component for the currently active cell in currently active sheet.
- * Only used for style supervisor.
- *
- * @throws PhpSpreadsheetException
- *
- * @return Border
- */
- public function getSharedComponent()
- {
- switch ($this->parentPropertyName) {
- case 'allBorders':
- case 'horizontal':
- case 'inside':
- case 'outline':
- case 'vertical':
- throw new PhpSpreadsheetException('Cannot get shared component for a pseudo-border.');
- break;
- case 'bottom':
- return $this->parent->getSharedComponent()->getBottom();
- case 'diagonal':
- return $this->parent->getSharedComponent()->getDiagonal();
- case 'left':
- return $this->parent->getSharedComponent()->getLeft();
- case 'right':
- return $this->parent->getSharedComponent()->getRight();
- case 'top':
- return $this->parent->getSharedComponent()->getTop();
- }
- }
- /**
- * Build style array from subcomponents.
- *
- * @param array $array
- *
- * @return array
- */
- public function getStyleArray($array)
- {
- return $this->parent->getStyleArray([$this->parentPropertyName => $array]);
- }
- /**
- * Apply styles from array.
- *
- * <code>
- * $spreadsheet->getActiveSheet()->getStyle('B2')->getBorders()->getTop()->applyFromArray(
- * array(
- * 'borderStyle' => Border::BORDER_DASHDOT,
- * 'color' => array(
- * 'rgb' => '808080'
- * )
- * )
- * );
- * </code>
- *
- * @param array $pStyles Array containing style information
- *
- * @throws PhpSpreadsheetException
- *
- * @return Border
- */
- public function applyFromArray(array $pStyles)
- {
- 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;
- }
- /**
- * Get Border style.
- *
- * @return string
- */
- public function getBorderStyle()
- {
- if ($this->isSupervisor) {
- return $this->getSharedComponent()->getBorderStyle();
- }
- return $this->borderStyle;
- }
- /**
- * Set Border style.
- *
- * @param bool|string $pValue
- * When passing a boolean, FALSE equates Border::BORDER_NONE
- * and TRUE to Border::BORDER_MEDIUM
- *
- * @return Border
- */
- public function setBorderStyle($pValue)
- {
- 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;
- }
- /**
- * Get Border Color.
- *
- * @return Color
- */
- public function getColor()
- {
- return $this->color;
- }
- /**
- * Set Border Color.
- *
- * @param Color $pValue
- *
- * @throws PhpSpreadsheetException
- *
- * @return Border
- */
- public function setColor(Color $pValue)
- {
- // 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;
- }
- /**
- * Get hash code.
- *
- * @return string Hash code
- */
- public function getHashCode()
- {
- if ($this->isSupervisor) {
- return $this->getSharedComponent()->getHashCode();
- }
- return md5(
- $this->borderStyle .
- $this->color->getHashCode() .
- __CLASS__
- );
- }
- }
|