PHPExcel_Style Class Reference

Inheritance diagram for PHPExcel_Style:

Collaboration diagram for PHPExcel_Style:

Public Member Functions
	__construct ($isSupervisor=false, $isConditional=false)
	Create a new PHPExcel_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 ($pStyles=null, $pAdvanced=true)
	Apply styles from array. More...
	getFill ()
	Get Fill. More...
	getFont ()
	Get Font. More...
	setFont (PHPExcel_Style_Font $font)
	Set font. More...
	getBorders ()
	Get Borders. More...
	getAlignment ()
	Get Alignment. More...
	getNumberFormat ()
	Get Number Format. More...
	getConditionalStyles ()
	Get Conditional Styles. More...
	setConditionalStyles ($pValue=null)
	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 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...

Protected Attributes
	$_font
	$_fill
	$_borders
	$_alignment
	$_numberFormat
	$_conditionalStyles
	$_protection
	$_index
	$_quotePrefix = false
Protected Attributes inherited from PHPExcel_Style_Supervisor
	$_isSupervisor
	$_parent

Detailed Description

Definition at line 36 of file Style.php.

Constructor & Destructor Documentation

__construct()

PHPExcel_Style::__construct	(		$isSupervisor = false,
			$isConditional = false
	)

Create a new PHPExcel_Style.

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 111 of file Style.php.

    {
        // Supervisor?
        $this->_isSupervisor = $isSupervisor;
 
        // Initialise values
        $this->_conditionalStyles       = array();
        $this->_font              = new PHPExcel_Style_Font($isSupervisor, $isConditional);
        $this->_fill              = new PHPExcel_Style_Fill($isSupervisor, $isConditional);
        $this->_borders           = new PHPExcel_Style_Borders($isSupervisor, $isConditional);
        $this->_alignment         = new PHPExcel_Style_Alignment($isSupervisor, $isConditional);
        $this->_numberFormat      = new PHPExcel_Style_NumberFormat($isSupervisor, $isConditional);
        $this->_protection        = new PHPExcel_Style_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);
        }
    }

Member Function Documentation

applyFromArray()

PHPExcel_Style::applyFromArray	(		$pStyles = null,
			$pAdvanced = true
	)

Apply styles from array.

$objPHPExcel->getActiveSheet()->getStyle('B2')->applyFromArray( array( 'font' => array( 'name' => 'Arial', 'bold' => true, 'italic' => false, 'underline' => PHPExcel_Style_Font::UNDERLINE_DOUBLE, 'strike' => false, 'color' => array( 'rgb' => '808080' ) ), 'borders' => 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' ) ) ), 'quotePrefix' => true ) );

Parameters

array	$pStyles	Array containing style information
boolean	$pAdvanced	Advanced mode for setting borders.

Exceptions

PHPExcel_Exception

Returns

PHPExcel_Style

Definition at line 217 of file Style.php.

    {
        if (is_array($pStyles)) {
            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 {
                    list($rangeA, $rangeB) = explode(':', $pRange);
                }
 
                // Calculate range outer borders
                $rangeStart = PHPExcel_Cell::coordinateFromString($rangeA);
                $rangeEnd     = PHPExcel_Cell::coordinateFromString($rangeB);
 
                // Translate column into index
                $rangeStart[0]    = PHPExcel_Cell::columnIndexFromString($rangeStart[0]) - 1;
                $rangeEnd[0]    = PHPExcel_Cell::columnIndexFromString($rangeEnd[0]) - 1;
 
                // Make sure we can loop upwards on rows and columns
                if ($rangeStart[0] > $rangeEnd[0] && $rangeStart[1] > $rangeEnd[1]) {
                    $tmp = $rangeStart;
                    $rangeStart = $rangeEnd;
                    $rangeEnd = $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 (array('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 (array('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 (array('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($rangeEnd[0] - $rangeStart[0] + 1, 3);
                    $yMax = min($rangeEnd[1] - $rangeStart[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) ?
                            PHPExcel_Cell::stringFromColumnIndex($rangeEnd[0])
                                : PHPExcel_Cell::stringFromColumnIndex($rangeStart[0] + $x - 1);
 
                        // end column index for region
                        $colEnd = ($x == 1) ?
                            PHPExcel_Cell::stringFromColumnIndex($rangeStart[0])
                                : PHPExcel_Cell::stringFromColumnIndex($rangeEnd[0] - $xMax + $x);
 
                        for ($y = 1; $y <= $yMax; ++$y) {
 
                            // which edges are touching the region
                            $edges = array();
 
                            // are we at left edge
                            if ($x == 1) {
                                $edges[] = 'left';
                            }
 
                            // are we at right edge
                            if ($x == $xMax) {
                                $edges[] = 'right';
                            }
 
                            // are we at top edge?
                            if ($y == 1) {
                                $edges[] = 'top';
                            }
 
                            // are we at bottom edge?
                            if ($y == $yMax) {
                                $edges[] = 'bottom';
                            }
 
                            // start row index for region
                            $rowStart = ($y == 3) ?
                                $rangeEnd[1] : $rangeStart[1] + $y - 1;
 
                            // end row index for region
                            $rowEnd = ($y == 1) ?
                                $rangeStart[1] : $rangeEnd[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( array('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);
                        }
                    }
                    return $this;
                }
 
                // SIMPLE MODE:
 
                // Selection type, inspect
                if (preg_match('/^[A-Z]+1:[A-Z]+1048576$/', $pRange)) {
                    $selectionType = 'COLUMN';
                } else if (preg_match('/^A[0-9]+:XFD[0-9]+$/', $pRange)) {
                    $selectionType = 'ROW';
                } else {
                    $selectionType = 'CELL';
                }
 
                // First loop through columns, rows, or cells to find out which styles are affected by this operation
                switch ($selectionType) {
                    case 'COLUMN':
                        $oldXfIndexes = array();
                        for ($col = $rangeStart[0]; $col <= $rangeEnd[0]; ++$col) {
                            $oldXfIndexes[$this->getActiveSheet()->getColumnDimensionByColumn($col)->getXfIndex()] = true;
                        }
                        break;
 
                    case 'ROW':
                        $oldXfIndexes = array();
                        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;
                            }
                        }
                        break;
 
                    case 'CELL':
                        $oldXfIndexes = array();
                        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;
                }
 
                // clone each of the affected styles, apply the style array, and add the new styles to the workbook
                $workbook = $this->getActiveSheet()->getParent();
                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 = $rangeStart[0]; $col <= $rangeEnd[0]; ++$col) {
                            $columnDimension = $this->getActiveSheet()->getColumnDimensionByColumn($col);
                            $oldXfIndex = $columnDimension->getXfIndex();
                            $columnDimension->setXfIndex($newXfIndexes[$oldXfIndex]);
                        }
                        break;
 
                    case 'ROW':
                        for ($row = $rangeStart[1]; $row <= $rangeEnd[1]; ++$row) {
                            $rowDimension = $this->getActiveSheet()->getRowDimension($row);
                            $oldXfIndex = $rowDimension->getXfIndex() === null ?
                                0 : $rowDimension->getXfIndex(); // row without explicit style should be formatted based on default style
                            $rowDimension->setXfIndex($newXfIndexes[$oldXfIndex]);
                        }
                        break;
 
                    case 'CELL':
                        for ($col = $rangeStart[0]; $col <= $rangeEnd[0]; ++$col) {
                            for ($row = $rangeStart[1]; $row <= $rangeEnd[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 (array_key_exists('fill', $pStyles)) {
                    $this->getFill()->applyFromArray($pStyles['fill']);
                }
                if (array_key_exists('font', $pStyles)) {
                    $this->getFont()->applyFromArray($pStyles['font']);
                }
                if (array_key_exists('borders', $pStyles)) {
                    $this->getBorders()->applyFromArray($pStyles['borders']);
                }
                if (array_key_exists('alignment', $pStyles)) {
                    $this->getAlignment()->applyFromArray($pStyles['alignment']);
                }
                if (array_key_exists('numberformat', $pStyles)) {
                    $this->getNumberFormat()->applyFromArray($pStyles['numberformat']);
                }
                if (array_key_exists('protection', $pStyles)) {
                    $this->getProtection()->applyFromArray($pStyles['protection']);
                }
                if (array_key_exists('quotePrefix', $pStyles)) {
                    $this->_quotePrefix = $pStyles['quotePrefix'];
                }
            }
        } else {
            throw new PHPExcel_Exception("Invalid style array passed.");
        }
        return $this;
    }

References $row, $style, $x, $y, PHPExcel_Cell\columnIndexFromString(), PHPExcel_Cell\coordinateFromString(), PHPExcel_Style_Supervisor\getActiveSheet(), getAlignment(), getBorders(), getFill(), getFont(), getNumberFormat(), getProtection(), PHPExcel_Style_Supervisor\getSelectedCells(), and PHPExcel_Cell\stringFromColumnIndex().

Here is the call graph for this function:

getAlignment()

PHPExcel_Style::getAlignment

(

)

Get Alignment.

Returns

PHPExcel_Style_Alignment

Definition at line 542 of file Style.php.

    {
        return $this->_alignment;
    }

References $_alignment.

Referenced by PHPExcel_Writer_HTML\_createCSSStyle(), and applyFromArray().

Here is the caller graph for this function:

getBorders()

PHPExcel_Style::getBorders

(

)

Get Borders.

Returns

PHPExcel_Style_Borders

Definition at line 532 of file Style.php.

    {
        return $this->_borders;
    }

References $_borders.

Referenced by PHPExcel_Writer_HTML\_createCSSStyle(), and applyFromArray().

Here is the caller graph for this function:

getConditionalStyles()

PHPExcel_Style::getConditionalStyles

(

)

Get Conditional Styles.

Only used on supervisor.

Returns

PHPExcel_Style_Conditional[]

Definition at line 562 of file Style.php.

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

References PHPExcel_Style_Supervisor\getActiveCell(), and PHPExcel_Style_Supervisor\getActiveSheet().

Here is the call graph for this function:

getFill()

PHPExcel_Style::getFill

(

)

Get Fill.

Returns

PHPExcel_Style_Fill

Definition at line 500 of file Style.php.

    {
        return $this->_fill;
    }

References $_fill.

Referenced by PHPExcel_Writer_HTML\_createCSSStyle(), and applyFromArray().

Here is the caller graph for this function:

getFont()

PHPExcel_Style::getFont

(

)

Get Font.

Returns

PHPExcel_Style_Font

Definition at line 510 of file Style.php.

    {
        return $this->_font;
    }

References $_font.

Referenced by PHPExcel_Writer_HTML\_createCSSStyle(), applyFromArray(), and PHPExcel_Worksheet\setDefaultStyle().

Here is the caller graph for this function:

getHashCode()

PHPExcel_Style::getHashCode

(

)

Get hash code.

Returns

string Hash code

Implements PHPExcel_IComparable.

Definition at line 628 of file Style.php.

    {
        $hashConditionals = '';
        foreach ($this->_conditionalStyles as $conditional) {
            $hashConditionals .= $conditional->getHashCode();
        }
 
        return md5(
              $this->_fill->getHashCode()
            . $this->_font->getHashCode()
            . $this->_borders->getHashCode()
            . $this->_alignment->getHashCode()
            . $this->_numberFormat->getHashCode()
            . $hashConditionals
            . $this->_protection->getHashCode()
            . ($this->_quotePrefix  ? 't' : 'f')
            . __CLASS__
        );
    }

getIndex()

PHPExcel_Style::getIndex

(

)

Get own index in style collection.

Returns

int

Definition at line 653 of file Style.php.

    {
        return $this->_index;
    }

References $_index.

getNumberFormat()

PHPExcel_Style::getNumberFormat

(

)

Get Number Format.

Returns

PHPExcel_Style_NumberFormat

Definition at line 552 of file Style.php.

    {
        return $this->_numberFormat;
    }

References $_numberFormat.

Referenced by applyFromArray().

Here is the caller graph for this function:

getParent()

PHPExcel_Style::getParent

(

)

Get parent.

Only used for style supervisor

Returns

PHPExcel

Definition at line 161 of file Style.php.

    {
        return $this->_parent;
    }

References PHPExcel_Style_Supervisor\$_parent.

getProtection()

PHPExcel_Style::getProtection

(

)

Get Protection.

Returns

PHPExcel_Style_Protection

Definition at line 586 of file Style.php.

    {
        return $this->_protection;
    }

References $_protection.

Referenced by applyFromArray().

Here is the caller graph for this function:

getQuotePrefix()

PHPExcel_Style::getQuotePrefix

(

)

Get quote prefix.

Returns

boolean

Definition at line 596 of file Style.php.

    {
        if ($this->_isSupervisor) {
            return $this->getSharedComponent()->getQuotePrefix();
        }
        return $this->_quotePrefix;
    }

References $_quotePrefix, and getSharedComponent().

Here is the call graph for this function:

getSharedComponent()

PHPExcel_Style::getSharedComponent

(

)

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

Only used for style supervisor

Returns

PHPExcel_Style

Definition at line 142 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 PHPExcel_Style_Supervisor\getActiveCell(), and PHPExcel_Style_Supervisor\getActiveSheet().

Referenced by getQuotePrefix().

Here is the call graph for this function:

Here is the caller graph for this function:

getStyleArray()

PHPExcel_Style::getStyleArray

(

$array

)

Build style array from subcomponents.

Parameters

array

$array

Returns

array

Definition at line 172 of file Style.php.

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

setConditionalStyles()

PHPExcel_Style::setConditionalStyles

(

$pValue = null

)

Set Conditional Styles.

Only used on supervisor.

Parameters

PHPExcel_Style_Conditional[]

$pValue

Array of condtional styles

Returns

PHPExcel_Style

Definition at line 573 of file Style.php.

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

References PHPExcel_Style_Supervisor\getActiveSheet(), and PHPExcel_Style_Supervisor\getSelectedCells().

Here is the call graph for this function:

setFont()

PHPExcel_Style::setFont

(

PHPExcel_Style_Font

$font

)

Set font.

Parameters

PHPExcel_Style_Font

$font

Returns

PHPExcel_Style

Definition at line 521 of file Style.php.

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

setIndex()

PHPExcel_Style::setIndex

(

$pValue

)

Set own index in style collection.

Parameters

int

$pValue

Definition at line 663 of file Style.php.

    {
        $this->_index = $pValue;
    }

Referenced by PHPExcel\addCellStyleXf().

Here is the caller graph for this function:

setQuotePrefix()

PHPExcel_Style::setQuotePrefix

(

$pValue

)

Set quote prefix.

Parameters

boolean

$pValue

Definition at line 609 of file Style.php.

    {
        if ($pValue == '') {
            $pValue = false;
        }
        if ($this->_isSupervisor) {
            $styleArray = array('quotePrefix' => $pValue);
            $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
        } else {
            $this->_quotePrefix = (boolean) $pValue;
        }
        return $this;
    }

References PHPExcel_Style_Supervisor\getActiveSheet(), and PHPExcel_Style_Supervisor\getSelectedCells().

Here is the call graph for this function:

Field Documentation

$_alignment

PHPExcel_Style::$_alignment

protected

Definition at line 64 of file Style.php.

Referenced by getAlignment().

$_borders

PHPExcel_Style::$_borders

protected

Definition at line 57 of file Style.php.

Referenced by getBorders().

$_conditionalStyles

PHPExcel_Style::$_conditionalStyles

protected

Definition at line 78 of file Style.php.

$_fill

PHPExcel_Style::$_fill

protected

Definition at line 50 of file Style.php.

Referenced by getFill().

$_font

PHPExcel_Style::$_font

protected

Definition at line 43 of file Style.php.

Referenced by getFont().

$_index

PHPExcel_Style::$_index

protected

Definition at line 92 of file Style.php.

Referenced by getIndex().

$_numberFormat

PHPExcel_Style::$_numberFormat

protected

Definition at line 71 of file Style.php.

Referenced by getNumberFormat().

$_protection

PHPExcel_Style::$_protection

protected

Definition at line 85 of file Style.php.

Referenced by getProtection().

$_quotePrefix

PHPExcel_Style::$_quotePrefix = false

protected

Definition at line 99 of file Style.php.

Referenced by getQuotePrefix().

---

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

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