Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
  • Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.
<?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';
> const BORDER_OMIT = 'omit'; // should be used only for Conditional
/** * Border style. * * @var string */ protected $borderStyle = self::BORDER_NONE; /** * Border color. * * @var Color */ protected $color; /**
< * @var int
> * @var null|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)
> public function __construct($isSupervisor = false, bool $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'); }
> if ($isConditional) { } > $this->borderStyle = self::BORDER_OMIT; > }
/** * 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.');
> /** @var Style */ > $parent = $this->parent;
< break;
> /** @var Borders $sharedComponent */ > $sharedComponent = $parent->getSharedComponent(); > switch ($this->parentPropertyName) {
case 'bottom':
< return $this->parent->getSharedComponent()->getBottom();
> return $sharedComponent->getBottom();
case 'diagonal':
< return $this->parent->getSharedComponent()->getDiagonal();
> return $sharedComponent->getDiagonal();
case 'left':
< return $this->parent->getSharedComponent()->getLeft();
> return $sharedComponent->getLeft();
case 'right':
< return $this->parent->getSharedComponent()->getRight();
> return $sharedComponent->getRight();
case 'top':
< return $this->parent->getSharedComponent()->getTop();
> return $sharedComponent->getTop();
}
> } > throw new PhpSpreadsheetException('Cannot get shared component for a pseudo-border.');
/** * Build style array from subcomponents. * * @param array $array * * @return array */ public function getStyleArray($array) {
< return $this->parent->getStyleArray([$this->parentPropertyName => $array]);
> /** @var Style */ > $parent = $this->parent; > > return $parent->/** @scrutinizer ignore-call */ getStyleArray([$this->parentPropertyName => $array]);
} /** * Apply styles from array. * * <code> * $spreadsheet->getActiveSheet()->getStyle('B2')->getBorders()->getTop()->applyFromArray( * [ * 'borderStyle' => Border::BORDER_DASHDOT, * 'color' => [ * 'rgb' => '808080' * ] * ] * ); * </code> *
< * @param array $pStyles Array containing style information < * < * @throws PhpSpreadsheetException
> * @param array $styleArray Array containing style information
*
< * @return Border
> * @return $this
*/
< public function applyFromArray(array $pStyles)
> public function applyFromArray(array $styleArray)
{ if ($this->isSupervisor) {
< $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($this->getStyleArray($pStyles));
> $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($this->getStyleArray($styleArray));
} else {
< if (isset($pStyles['borderStyle'])) { < $this->setBorderStyle($pStyles['borderStyle']);
> if (isset($styleArray['borderStyle'])) { > $this->setBorderStyle($styleArray['borderStyle']);
}
< if (isset($pStyles['color'])) { < $this->getColor()->applyFromArray($pStyles['color']);
> if (isset($styleArray['color'])) { > $this->getColor()->applyFromArray($styleArray['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
> * @param bool|string $style
* When passing a boolean, FALSE equates Border::BORDER_NONE * and TRUE to Border::BORDER_MEDIUM *
< * @return Border
> * @return $this
*/
< public function setBorderStyle($pValue)
> public function setBorderStyle($style)
{
< if (empty($pValue)) { < $pValue = self::BORDER_NONE; < } elseif (is_bool($pValue) && $pValue) { < $pValue = self::BORDER_MEDIUM;
> if (empty($style)) { > $style = self::BORDER_NONE; > } elseif (is_bool($style)) { > $style = self::BORDER_MEDIUM;
}
>
if ($this->isSupervisor) {
< $styleArray = $this->getStyleArray(['borderStyle' => $pValue]);
> $styleArray = $this->getStyleArray(['borderStyle' => $style]);
$this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray); } else {
< $this->borderStyle = $pValue;
> $this->borderStyle = $style;
} return $this; } /** * Get Border Color. * * @return Color */ public function getColor() { return $this->color; } /** * Set Border Color. *
< * @param Color $pValue < * < * @throws PhpSpreadsheetException < * < * @return Border
> * @return $this
*/
< public function setColor(Color $pValue)
> public function setColor(Color $color)
{ // make sure parameter is a real color and not a supervisor
< $color = $pValue->getIsSupervisor() ? $pValue->getSharedComponent() : $pValue;
> $color = $color->getIsSupervisor() ? $color->getSharedComponent() : $color;
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__ );
> } } > } > protected function exportArray1(): array > { > $exportedArray = []; > $this->exportArray2($exportedArray, 'borderStyle', $this->getBorderStyle()); > $this->exportArray2($exportedArray, 'color', $this->getColor()); > > return $exportedArray;