Inheritance diagram for PhpOffice\PhpSpreadsheet\Style\Style:

Collaboration diagram for PhpOffice\PhpSpreadsheet\Style\Style:

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

	getSharedComponent ()
	Get the shared style component for the currently active cell in currently active sheet. More...

	getParent ()
	Get parent. More...

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

	applyFromArray (array $pStyles, $pAdvanced=true)
	Apply styles from array. More...

	getFill ()
	Get Fill. More...

	getFont ()
	Get Font. More...

	setFont (Font $font)
	Set font. More...

	getBorders ()
	Get Borders. More...

	getAlignment ()
	Get Alignment. More...

	getNumberFormat ()
	Get Number Format. More...

	getConditionalStyles ()
	Get Conditional Styles. More...

	setConditionalStyles (array $pValue)
	Set Conditional Styles. More...

	getProtection ()
	Get Protection. More...

	getQuotePrefix ()
	Get quote prefix. More...

	setQuotePrefix ($pValue)
	Set quote prefix. More...

	getHashCode ()
	Get hash code. More...

	getIndex ()
	Get own index in style collection. More...

	setIndex ($pValue)
	Set own index in style collection. 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...

	getHashCode ()
	Get hash code. More...

Protected Member Functions
	exportArray1 ()
	Abstract method to be implemented in anything which extends this class. More...

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
	$font

	$fill

	$borders

	$alignment

	$numberFormat

	$protection

	$index

	$quotePrefix = false

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

	$parent

	$parentPropertyName

Private Member Functions
	getOldXfIndexes (string $selectionType, array $rangeStart, array $rangeEnd, string $columnStart, string $columnEnd, array $pStyles)

Detailed Description

Definition at line 8 of file Style.php.

Constructor & Destructor Documentation

◆ __construct()

PhpOffice\PhpSpreadsheet\Style\Style::__construct	(	$isSupervisor = `false`,
		$isConditional = `false`
	)

Create a new Style.

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
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

Definition at line 76 of file Style.php.

    {
        parent::__construct($isSupervisor);
 
        // Initialise values
        $this->font = new Font($isSupervisor, $isConditional);
        $this->fill = new Fill($isSupervisor, $isConditional);
        $this->borders = new Borders($isSupervisor);
        $this->alignment = new Alignment($isSupervisor, $isConditional);
        $this->numberFormat = new NumberFormat($isSupervisor, $isConditional);
        $this->protection = new Protection($isSupervisor, $isConditional);
 
        // bind parent if we are a supervisor
        if ($isSupervisor) {
            $this->font->bindParent($this);
            $this->fill->bindParent($this);
            $this->borders->bindParent($this);
            $this->alignment->bindParent($this);
            $this->numberFormat->bindParent($this);
            $this->protection->bindParent($this);
        }
    }

References PhpOffice\PhpSpreadsheet\Style\Supervisor\$isSupervisor.

Member Function Documentation

◆ applyFromArray()

PhpOffice\PhpSpreadsheet\Style\Style::applyFromArray	(	array	$pStyles,
			$pAdvanced = `true`
	)

Apply styles from array.

$spreadsheet->getActiveSheet()->getStyle('B2')->applyFromArray( [ 'font' => [ 'name' => 'Arial', 'bold' => true, 'italic' => false, 'underline' => Font::UNDERLINE_DOUBLE, 'strikethrough' => false, 'color' => [ 'rgb' => '808080' ] ], 'borders' => [ 'bottom' => [ 'borderStyle' => Border::BORDER_DASHDOT, 'color' => [ 'rgb' => '808080' ] ], 'top' => [ 'borderStyle' => Border::BORDER_DASHDOT, 'color' => [ 'rgb' => '808080' ] ] ], 'alignment' => [ 'horizontal' => Alignment::HORIZONTAL_CENTER, 'vertical' => Alignment::VERTICAL_CENTER, 'wrapText' => true, ], 'quotePrefix' => true ] );

Parameters

array	$pStyles	Array containing style information
bool	$pAdvanced	advanced mode for setting borders

Returns: $this

Definition at line 186 of file Style.php.

    {
        if ($this->isSupervisor) {
            $pRange = $this->getSelectedCells();
 
            // Uppercase coordinate
            $pRange = strtoupper($pRange);
 
            // Is it a cell range or a single cell?
            if (strpos($pRange, ':') === false) {
                $rangeA = $pRange;
                $rangeB = $pRange;
            } else {
                [$rangeA, $rangeB] = explode(':', $pRange);
            }
 
            // Calculate range outer borders
            $rangeStart = Coordinate::coordinateFromString($rangeA);
            $rangeEnd = Coordinate::coordinateFromString($rangeB);
            $rangeStartIndexes = Coordinate::indexesFromString($rangeA);
            $rangeEndIndexes = Coordinate::indexesFromString($rangeB);
 
            $columnStart = $rangeStart[0];
            $columnEnd = $rangeEnd[0];
 
            // Make sure we can loop upwards on rows and columns
            if ($rangeStartIndexes[0] > $rangeEndIndexes[0] && $rangeStartIndexes[1] > $rangeEndIndexes[1]) {
                $tmp = $rangeStartIndexes;
                $rangeStartIndexes = $rangeEndIndexes;
                $rangeEndIndexes = $tmp;
            }
 
            // ADVANCED MODE:
            if ($pAdvanced && isset($pStyles['borders'])) {
                // 'allBorders' is a shorthand property for 'outline' and 'inside' and
                //        it applies to components that have not been set explicitly
                if (isset($pStyles['borders']['allBorders'])) {
                    foreach (['outline', 'inside'] as $component) {
                        if (!isset($pStyles['borders'][$component])) {
                            $pStyles['borders'][$component] = $pStyles['borders']['allBorders'];
                        }
                    }
                    unset($pStyles['borders']['allBorders']); // not needed any more
                }
                // 'outline' is a shorthand property for 'top', 'right', 'bottom', 'left'
                //        it applies to components that have not been set explicitly
                if (isset($pStyles['borders']['outline'])) {
                    foreach (['top', 'right', 'bottom', 'left'] as $component) {
                        if (!isset($pStyles['borders'][$component])) {
                            $pStyles['borders'][$component] = $pStyles['borders']['outline'];
                        }
                    }
                    unset($pStyles['borders']['outline']); // not needed any more
                }
                // 'inside' is a shorthand property for 'vertical' and 'horizontal'
                //        it applies to components that have not been set explicitly
                if (isset($pStyles['borders']['inside'])) {
                    foreach (['vertical', 'horizontal'] as $component) {
                        if (!isset($pStyles['borders'][$component])) {
                            $pStyles['borders'][$component] = $pStyles['borders']['inside'];
                        }
                    }
                    unset($pStyles['borders']['inside']); // not needed any more
                }
                // width and height characteristics of selection, 1, 2, or 3 (for 3 or more)
                $xMax = min($rangeEndIndexes[0] - $rangeStartIndexes[0] + 1, 3);
                $yMax = min($rangeEndIndexes[1] - $rangeStartIndexes[1] + 1, 3);
 
                // loop through up to 3 x 3 = 9 regions
                for ($x = 1; $x <= $xMax; ++$x) {
                    // start column index for region
                    $colStart = ($x == 3) ?
                        Coordinate::stringFromColumnIndex($rangeEndIndexes[0])
                        : Coordinate::stringFromColumnIndex($rangeStartIndexes[0] + $x - 1);
                    // end column index for region
                    $colEnd = ($x == 1) ?
                        Coordinate::stringFromColumnIndex($rangeStartIndexes[0])
                        : Coordinate::stringFromColumnIndex($rangeEndIndexes[0] - $xMax + $x);
 
                    for ($y = 1; $y <= $yMax; ++$y) {
                        // which edges are touching the region
                        $edges = [];
                        if ($x == 1) {
                            // are we at left edge
                            $edges[] = 'left';
                        }
                        if ($x == $xMax) {
                            // are we at right edge
                            $edges[] = 'right';
                        }
                        if ($y == 1) {
                            // are we at top edge?
                            $edges[] = 'top';
                        }
                        if ($y == $yMax) {
                            // are we at bottom edge?
                            $edges[] = 'bottom';
                        }
 
                        // start row index for region
                        $rowStart = ($y == 3) ?
                            $rangeEndIndexes[1] : $rangeStartIndexes[1] + $y - 1;
 
                        // end row index for region
                        $rowEnd = ($y == 1) ?
                            $rangeStartIndexes[1] : $rangeEndIndexes[1] - $yMax + $y;
 
                        // build range for region
                        $range = $colStart . $rowStart . ':' . $colEnd . $rowEnd;
 
                        // retrieve relevant style array for region
                        $regionStyles = $pStyles;
                        unset($regionStyles['borders']['inside']);
 
                        // what are the inner edges of the region when looking at the selection
                        $innerEdges = array_diff(['top', 'right', 'bottom', 'left'], $edges);
 
                        // inner edges that are not touching the region should take the 'inside' border properties if they have been set
                        foreach ($innerEdges as $innerEdge) {
                            switch ($innerEdge) {
                                case 'top':
                                case 'bottom':
                                    // should pick up 'horizontal' border property if set
                                    if (isset($pStyles['borders']['horizontal'])) {
                                        $regionStyles['borders'][$innerEdge] = $pStyles['borders']['horizontal'];
                                    } else {
                                        unset($regionStyles['borders'][$innerEdge]);
                                    }
 
                                    break;
                                case 'left':
                                case 'right':
                                    // should pick up 'vertical' border property if set
                                    if (isset($pStyles['borders']['vertical'])) {
                                        $regionStyles['borders'][$innerEdge] = $pStyles['borders']['vertical'];
                                    } else {
                                        unset($regionStyles['borders'][$innerEdge]);
                                    }
 
                                    break;
                            }
                        }
 
                        // apply region style to region by calling applyFromArray() in simple mode
                        $this->getActiveSheet()->getStyle($range)->applyFromArray($regionStyles, false);
                    }
                }
 
                // restore initial cell selection range
                $this->getActiveSheet()->getStyle($pRange);
 
                return $this;
            }
 
            // SIMPLE MODE:
            // Selection type, inspect
            if (preg_match('/^[A-Z]+1:[A-Z]+1048576$/', $pRange)) {
                $selectionType = 'COLUMN';
            } elseif (preg_match('/^A\d+:XFD\d+$/', $pRange)) {
                $selectionType = 'ROW';
            } else {
                $selectionType = 'CELL';
            }
 
            // First loop through columns, rows, or cells to find out which styles are affected by this operation
            $oldXfIndexes = $this->getOldXfIndexes($selectionType, $rangeStartIndexes, $rangeEndIndexes, $columnStart, $columnEnd, $pStyles);
 
            // clone each of the affected styles, apply the style array, and add the new styles to the workbook
            $workbook = $this->getActiveSheet()->getParent();
            $newXfIndexes = [];
            foreach ($oldXfIndexes as $oldXfIndex => $dummy) {
                $style = $workbook->getCellXfByIndex($oldXfIndex);
                $newStyle = clone $style;
                $newStyle->applyFromArray($pStyles);
 
                if ($existingStyle = $workbook->getCellXfByHashCode($newStyle->getHashCode())) {
                    // there is already such cell Xf in our collection
                    $newXfIndexes[$oldXfIndex] = $existingStyle->getIndex();
                } else {
                    // we don't have such a cell Xf, need to add
                    $workbook->addCellXf($newStyle);
                    $newXfIndexes[$oldXfIndex] = $newStyle->getIndex();
                }
            }
 
            // Loop through columns, rows, or cells again and update the XF index
            switch ($selectionType) {
                case 'COLUMN':
                    for ($col = $rangeStartIndexes[0]; $col <= $rangeEndIndexes[0]; ++$col) {
                        $columnDimension = $this->getActiveSheet()->getColumnDimensionByColumn($col);
                        $oldXfIndex = $columnDimension->getXfIndex();
                        $columnDimension->setXfIndex($newXfIndexes[$oldXfIndex]);
                    }
 
                    break;
                case 'ROW':
                    for ($row = $rangeStartIndexes[1]; $row <= $rangeEndIndexes[1]; ++$row) {
                        $rowDimension = $this->getActiveSheet()->getRowDimension($row);
                        // row without explicit style should be formatted based on default style
                        $oldXfIndex = $rowDimension->getXfIndex() ?? 0;
                        $rowDimension->setXfIndex($newXfIndexes[$oldXfIndex]);
                    }
 
                    break;
                case 'CELL':
                    for ($col = $rangeStartIndexes[0]; $col <= $rangeEndIndexes[0]; ++$col) {
                        for ($row = $rangeStartIndexes[1]; $row <= $rangeEndIndexes[1]; ++$row) {
                            $cell = $this->getActiveSheet()->getCellByColumnAndRow($col, $row);
                            $oldXfIndex = $cell->getXfIndex();
                            $cell->setXfIndex($newXfIndexes[$oldXfIndex]);
                        }
                    }
 
                    break;
            }
        } else {
            // not a supervisor, just apply the style array directly on style object
            if (isset($pStyles['fill'])) {
                $this->getFill()->applyFromArray($pStyles['fill']);
            }
            if (isset($pStyles['font'])) {
                $this->getFont()->applyFromArray($pStyles['font']);
            }
            if (isset($pStyles['borders'])) {
                $this->getBorders()->applyFromArray($pStyles['borders']);
            }
            if (isset($pStyles['alignment'])) {
                $this->getAlignment()->applyFromArray($pStyles['alignment']);
            }
            if (isset($pStyles['numberFormat'])) {
                $this->getNumberFormat()->applyFromArray($pStyles['numberFormat']);
            }
            if (isset($pStyles['protection'])) {
                $this->getProtection()->applyFromArray($pStyles['protection']);
            }
            if (isset($pStyles['quotePrefix'])) {
                $this->quotePrefix = $pStyles['quotePrefix'];
            }
        }
 
        return $this;
    }

Here is the call graph for this function:

◆ exportArray1()

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

protected

Abstract method to be implemented in anything which extends this class.

This method invokes exportArray2 with the names and values of all properties to be included in output array, returning that array to exportArray, then to caller.

Reimplemented from PhpOffice\PhpSpreadsheet\Style\Supervisor.

Definition at line 651 of file Style.php.

                                     : array
    {
        $exportedArray = [];
        $this->exportArray2($exportedArray, 'alignment', $this->getAlignment());
        $this->exportArray2($exportedArray, 'borders', $this->getBorders());
        $this->exportArray2($exportedArray, 'fill', $this->getFill());
        $this->exportArray2($exportedArray, 'font', $this->getFont());
        $this->exportArray2($exportedArray, 'numberFormat', $this->getNumberFormat());
        $this->exportArray2($exportedArray, 'protection', $this->getProtection());
        $this->exportArray2($exportedArray, 'quotePrefx', $this->getQuotePrefix());
 
        return $exportedArray;
    }

References PhpOffice\PhpSpreadsheet\Style\Supervisor\exportArray2(), PhpOffice\PhpSpreadsheet\Style\Style\getAlignment(), PhpOffice\PhpSpreadsheet\Style\Style\getBorders(), PhpOffice\PhpSpreadsheet\Style\Style\getFill(), PhpOffice\PhpSpreadsheet\Style\Style\getFont(), PhpOffice\PhpSpreadsheet\Style\Style\getNumberFormat(), PhpOffice\PhpSpreadsheet\Style\Style\getProtection(), and PhpOffice\PhpSpreadsheet\Style\Style\getQuotePrefix().

Here is the call graph for this function:

◆ getAlignment()

PhpOffice\PhpSpreadsheet\Style\Style::getAlignment ( )

Get Alignment.

Returns: Alignment

Definition at line 527 of file Style.php.

    {
        return $this->alignment;
    }

References PhpOffice\PhpSpreadsheet\Style\Style\$alignment.

Referenced by PhpOffice\PhpSpreadsheet\Style\Style\applyFromArray(), PhpOffice\PhpSpreadsheet\Writer\Html\createCSSStyle(), PhpOffice\PhpSpreadsheet\Style\Style\exportArray1(), and PhpOffice\PhpSpreadsheet\Reader\Xlsx\Styles\readStyle().

Here is the caller graph for this function:

◆ getBorders()

PhpOffice\PhpSpreadsheet\Style\Style::getBorders ( )

Get Borders.

Returns: Borders

Definition at line 517 of file Style.php.

    {
        return $this->borders;
    }

References PhpOffice\PhpSpreadsheet\Style\Style\$borders.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xls\Workbook\addXfWriter(), PhpOffice\PhpSpreadsheet\Style\Style\applyFromArray(), PhpOffice\PhpSpreadsheet\Writer\Html\createCSSStyle(), PhpOffice\PhpSpreadsheet\Style\Style\exportArray1(), and PhpOffice\PhpSpreadsheet\Reader\Xlsx\Styles\readStyle().

Here is the caller graph for this function:

◆ getConditionalStyles()

PhpOffice\PhpSpreadsheet\Style\Style::getConditionalStyles ( )

Get Conditional Styles.

Only used on supervisor.

Returns: Conditional[]

Definition at line 547 of file Style.php.

    {
        return $this->getActiveSheet()->getConditionalStyles($this->getActiveCell());
    }

References PhpOffice\PhpSpreadsheet\Style\Supervisor\getActiveCell(), and PhpOffice\PhpSpreadsheet\Style\Supervisor\getActiveSheet().

Here is the call graph for this function:

◆ getFill()

PhpOffice\PhpSpreadsheet\Style\Style::getFill ( )

Get Fill.

Returns: Fill

Definition at line 485 of file Style.php.

    {
        return $this->fill;
    }

References PhpOffice\PhpSpreadsheet\Style\Style\$fill.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xls\Workbook\addXfWriter(), PhpOffice\PhpSpreadsheet\Style\Style\applyFromArray(), PhpOffice\PhpSpreadsheet\Writer\Html\createCSSStyle(), PhpOffice\PhpSpreadsheet\Style\Style\exportArray1(), and PhpOffice\PhpSpreadsheet\Reader\Xlsx\Styles\readStyle().

Here is the caller graph for this function:

◆ getFont()

PhpOffice\PhpSpreadsheet\Style\Style::getFont ( )

Get Font.

Returns: Font

Definition at line 495 of file Style.php.

    {
        return $this->font;
    }

References PhpOffice\PhpSpreadsheet\Style\Style\$font.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xls\Workbook\addXfWriter(), PhpOffice\PhpSpreadsheet\Style\Style\applyFromArray(), PhpOffice\PhpSpreadsheet\Writer\Html\createCSSStyle(), PhpOffice\PhpSpreadsheet\Style\Style\exportArray1(), and PhpOffice\PhpSpreadsheet\Reader\Xlsx\Styles\readStyle().

Here is the caller graph for this function:

◆ getHashCode()

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

Get hash code.

Returns: string Hash code

Implements PhpOffice\PhpSpreadsheet\IComparable.

Definition at line 617 of file Style.php.

    {
        return md5(
            $this->fill->getHashCode() .
            $this->font->getHashCode() .
            $this->borders->getHashCode() .
            $this->alignment->getHashCode() .
            $this->numberFormat->getHashCode() .
            $this->protection->getHashCode() .
            ($this->quotePrefix ? 't' : 'f') .
            __CLASS__
        );
    }

◆ getIndex()

PhpOffice\PhpSpreadsheet\Style\Style::getIndex ( )

Get own index in style collection.

Returns: int

Definition at line 636 of file Style.php.

    {
        return $this->index;
    }

References PhpOffice\PhpSpreadsheet\Style\Style\$index.

◆ getNumberFormat()

PhpOffice\PhpSpreadsheet\Style\Style::getNumberFormat ( )

Get Number Format.

Returns: NumberFormat

Definition at line 537 of file Style.php.

    {
        return $this->numberFormat;
    }

References PhpOffice\PhpSpreadsheet\Style\Style\$numberFormat.

Referenced by PhpOffice\PhpSpreadsheet\Style\Style\applyFromArray(), PhpOffice\PhpSpreadsheet\Style\Style\exportArray1(), and PhpOffice\PhpSpreadsheet\Reader\Xlsx\Styles\readStyle().

Here is the caller graph for this function:

◆ getOldXfIndexes()

PhpOffice\PhpSpreadsheet\Style\Style::getOldXfIndexes	(	string	$selectionType,
		array	$rangeStart,
		array	$rangeEnd,
		string	$columnStart,
		string	$columnEnd,
		array	$pStyles
	)

private

Definition at line 429 of file Style.php.

                                                                                                                                                       : array
    {
        $oldXfIndexes = [];
        switch ($selectionType) {
            case 'COLUMN':
                for ($col = $rangeStart[0]; $col <= $rangeEnd[0]; ++$col) {
                    $oldXfIndexes[$this->getActiveSheet()->getColumnDimensionByColumn($col)->getXfIndex()] = true;
                }
                foreach ($this->getActiveSheet()->getColumnIterator($columnStart, $columnEnd) as $columnIterator) {
                    $cellIterator = $columnIterator->getCellIterator();
                    $cellIterator->setIterateOnlyExistingCells(true);
                    foreach ($cellIterator as $columnCell) {
                        if ($columnCell !== null) {
                            $columnCell->getStyle()->applyFromArray($pStyles);
                        }
                    }
                }
 
                break;
            case 'ROW':
                for ($row = $rangeStart[1]; $row <= $rangeEnd[1]; ++$row) {
                    if ($this->getActiveSheet()->getRowDimension($row)->getXfIndex() === null) {
                        $oldXfIndexes[0] = true; // row without explicit style should be formatted based on default style
                    } else {
                        $oldXfIndexes[$this->getActiveSheet()->getRowDimension($row)->getXfIndex()] = true;
                    }
                }
                foreach ($this->getActiveSheet()->getRowIterator((int) $rangeStart[1], (int) $rangeEnd[1]) as $rowIterator) {
                    $cellIterator = $rowIterator->getCellIterator();
                    $cellIterator->setIterateOnlyExistingCells(true);
                    foreach ($cellIterator as $rowCell) {
                        if ($rowCell !== null) {
                            $rowCell->getStyle()->applyFromArray($pStyles);
                        }
                    }
                }
 
                break;
            case 'CELL':
                for ($col = $rangeStart[0]; $col <= $rangeEnd[0]; ++$col) {
                    for ($row = $rangeStart[1]; $row <= $rangeEnd[1]; ++$row) {
                        $oldXfIndexes[$this->getActiveSheet()->getCellByColumnAndRow($col, $row)->getXfIndex()] = true;
                    }
                }
 
                break;
        }
 
        return $oldXfIndexes;
    }

References $row, and PhpOffice\PhpSpreadsheet\Style\Supervisor\getActiveSheet().

Referenced by PhpOffice\PhpSpreadsheet\Style\Style\applyFromArray().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getParent()

PhpOffice\PhpSpreadsheet\Style\Style::getParent ( )

Get parent.

Only used for style supervisor.

Returns: Spreadsheet

Definition at line 124 of file Style.php.

    {
        return $this->parent;
    }

References PhpOffice\PhpSpreadsheet\Style\Supervisor\$parent.

◆ getProtection()

PhpOffice\PhpSpreadsheet\Style\Style::getProtection ( )

Get Protection.

Returns: Protection

Definition at line 571 of file Style.php.

    {
        return $this->protection;
    }

References PhpOffice\PhpSpreadsheet\Style\Style\$protection.

Referenced by PhpOffice\PhpSpreadsheet\Style\Style\applyFromArray(), PhpOffice\PhpSpreadsheet\Style\Style\exportArray1(), PhpOffice\PhpSpreadsheet\Reader\Xlsx\Styles\readProtectionHidden(), and PhpOffice\PhpSpreadsheet\Reader\Xlsx\Styles\readProtectionLocked().

Here is the caller graph for this function:

◆ getQuotePrefix()

PhpOffice\PhpSpreadsheet\Style\Style::getQuotePrefix ( )

Get quote prefix.

Returns: bool

Definition at line 581 of file Style.php.

    {
        if ($this->isSupervisor) {
            return $this->getSharedComponent()->getQuotePrefix();
        }
 
        return $this->quotePrefix;
    }

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

Referenced by PhpOffice\PhpSpreadsheet\Style\Style\exportArray1().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSharedComponent()

PhpOffice\PhpSpreadsheet\Style\Style::getSharedComponent ( )

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

Only used for style supervisor.

Returns: Style

Definition at line 105 of file Style.php.

    {
        $activeSheet = $this->getActiveSheet();
        $selectedCell = $this->getActiveCell(); // e.g. 'A1'
 
        if ($activeSheet->cellExists($selectedCell)) {
            $xfIndex = $activeSheet->getCell($selectedCell)->getXfIndex();
        } else {
            $xfIndex = 0;
        }
 
        return $this->parent->getCellXfByIndex($xfIndex);
    }

References PhpOffice\PhpSpreadsheet\Style\Supervisor\getActiveCell(), and PhpOffice\PhpSpreadsheet\Style\Supervisor\getActiveSheet().

Referenced by PhpOffice\PhpSpreadsheet\Style\Color\getARGB(), PhpOffice\PhpSpreadsheet\Style\Border\getBorderStyle(), PhpOffice\PhpSpreadsheet\Style\Border\getHashCode(), PhpOffice\PhpSpreadsheet\Style\Color\getHashCode(), PhpOffice\PhpSpreadsheet\Style\Style\getQuotePrefix(), and PhpOffice\PhpSpreadsheet\Style\Color\getRGB().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStyleArray()

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

Build style array from subcomponents.

Parameters

array $array

Returns: array

Definition at line 136 of file Style.php.

    {
        return ['quotePrefix' => $array];
    }

◆ setConditionalStyles()

PhpOffice\PhpSpreadsheet\Style\Style::setConditionalStyles ( array $pValue )

Set Conditional Styles.

Only used on supervisor.

Parameters

Conditional[] $pValue Array of conditional styles

Returns: $this

Definition at line 559 of file Style.php.

    {
        $this->getActiveSheet()->setConditionalStyles($this->getSelectedCells(), $pValue);
 
        return $this;
    }

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

Here is the call graph for this function:

◆ setFont()

PhpOffice\PhpSpreadsheet\Style\Style::setFont ( Font $font )

Set font.

Returns: $this

Definition at line 505 of file Style.php.

    {
        $this->font = $font;
 
        return $this;
    }

References PhpOffice\PhpSpreadsheet\Style\Style\$font.

◆ setIndex()

PhpOffice\PhpSpreadsheet\Style\Style::setIndex ( $pValue )

Set own index in style collection.

Parameters

int $pValue

Definition at line 646 of file Style.php.

                                     : void
    {
        $this->index = $pValue;
    }

Referenced by PhpOffice\PhpSpreadsheet\Spreadsheet\addCellStyleXf().

Here is the caller graph for this function:

◆ setQuotePrefix()

PhpOffice\PhpSpreadsheet\Style\Style::setQuotePrefix ( $pValue )

Set quote prefix.

Parameters

bool $pValue

Returns: $this

Definition at line 597 of file Style.php.

    {
        if ($pValue == '') {
            $pValue = false;
        }
        if ($this->isSupervisor) {
            $styleArray = ['quotePrefix' => $pValue];
            $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
        } else {
            $this->quotePrefix = (bool) $pValue;
        }
 
        return $this;
    }

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

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xlsx\Styles\readStyle().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $alignment

PhpOffice\PhpSpreadsheet\Style\Style::$alignment

protected

Definition at line 36 of file Style.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\Style\getAlignment(), PhpOffice\PhpSpreadsheet\Writer\Xls\Style\CellAlignment\horizontal(), PhpOffice\PhpSpreadsheet\Writer\Xls\Style\CellAlignment\vertical(), and PhpOffice\PhpSpreadsheet\Writer\Xls\Style\CellAlignment\wrap().

◆ $borders

PhpOffice\PhpSpreadsheet\Style\Style::$borders

protected

Definition at line 29 of file Style.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\Style\getBorders().

◆ $fill

PhpOffice\PhpSpreadsheet\Style\Style::$fill

protected

Definition at line 22 of file Style.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\Style\getFill(), and PhpOffice\PhpSpreadsheet\Writer\Xls\Style\CellFill\style().

◆ $font

PhpOffice\PhpSpreadsheet\Style\Style::$font

protected

Definition at line 15 of file Style.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\Style\getFont(), and PhpOffice\PhpSpreadsheet\Style\Style\setFont().

◆ $index

PhpOffice\PhpSpreadsheet\Style\Style::$index

protected

Definition at line 57 of file Style.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\Supervisor\exportArray2(), and PhpOffice\PhpSpreadsheet\Style\Style\getIndex().

◆ $numberFormat

PhpOffice\PhpSpreadsheet\Style\Style::$numberFormat

protected

Definition at line 43 of file Style.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\Style\getNumberFormat().

◆ $protection

PhpOffice\PhpSpreadsheet\Style\Style::$protection

protected

Definition at line 50 of file Style.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\Style\getProtection().

◆ $quotePrefix

PhpOffice\PhpSpreadsheet\Style\Style::$quotePrefix = false

protected

Definition at line 64 of file Style.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\Style\getQuotePrefix().

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ applyFromArray()

◆ exportArray1()

◆ getAlignment()

◆ getBorders()

◆ getConditionalStyles()

◆ getFill()

◆ getFont()

◆ getHashCode()

◆ getIndex()

◆ getNumberFormat()

◆ getOldXfIndexes()

◆ getParent()

◆ getProtection()

◆ getQuotePrefix()

◆ getSharedComponent()

◆ getStyleArray()

◆ setConditionalStyles()

◆ setFont()

◆ setIndex()

◆ setQuotePrefix()

Field Documentation

◆ $alignment

◆ $borders

◆ $fill

◆ $font

◆ $index

◆ $numberFormat

◆ $protection

◆ $quotePrefix