Inheritance diagram for PHPExcel_Style_Fill:

Collaboration diagram for PHPExcel_Style_Fill:

Public Member Functions
	__construct ($isSupervisor=FALSE, $isConditional=FALSE)
	Create a new PHPExcel_Style_Fill. 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...

	getFillType ()
	Get Fill Type. More...

	setFillType ($pValue=PHPExcel_Style_Fill::FILL_NONE)
	Set Fill Type. More...

	getRotation ()
	Get Rotation. More...

	setRotation ($pValue=0)
	Set Rotation. More...

	getStartColor ()
	Get Start Color. More...

	setStartColor (PHPExcel_Style_Color $pValue=null)
	Set Start Color. More...

	getEndColor ()
	Get End Color. More...

	setEndColor (PHPExcel_Style_Color $pValue=null)
	Set End 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	FILL_NONE = 'none'

const	FILL_SOLID = 'solid'

const	FILL_GRADIENT_LINEAR = 'linear'

const	FILL_GRADIENT_PATH = 'path'

const	FILL_PATTERN_DARKDOWN = 'darkDown'

const	FILL_PATTERN_DARKGRAY = 'darkGray'

const	FILL_PATTERN_DARKGRID = 'darkGrid'

const	FILL_PATTERN_DARKHORIZONTAL = 'darkHorizontal'

const	FILL_PATTERN_DARKTRELLIS = 'darkTrellis'

const	FILL_PATTERN_DARKUP = 'darkUp'

const	FILL_PATTERN_DARKVERTICAL = 'darkVertical'

const	FILL_PATTERN_GRAY0625 = 'gray0625'

const	FILL_PATTERN_GRAY125 = 'gray125'

const	FILL_PATTERN_LIGHTDOWN = 'lightDown'

const	FILL_PATTERN_LIGHTGRAY = 'lightGray'

const	FILL_PATTERN_LIGHTGRID = 'lightGrid'

const	FILL_PATTERN_LIGHTHORIZONTAL = 'lightHorizontal'

const	FILL_PATTERN_LIGHTTRELLIS = 'lightTrellis'

const	FILL_PATTERN_LIGHTUP = 'lightUp'

const	FILL_PATTERN_LIGHTVERTICAL = 'lightVertical'

const	FILL_PATTERN_MEDIUMGRAY = 'mediumGray'

Protected Attributes
	$_fillType = PHPExcel_Style_Fill::FILL_NONE

	$_rotation = 0

	$_startColor

	$_endColor

Protected Attributes inherited from PHPExcel_Style_Supervisor
	$_isSupervisor

	$_parent

Detailed Description

Definition at line 36 of file Fill.php.

Constructor & Destructor Documentation

◆ __construct()

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

Create a new PHPExcel_Style_Fill.

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 99 of file Fill.php.

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

References PHPExcel_Style_Color\COLOR_BLACK, and PHPExcel_Style_Color\COLOR_WHITE.

Member Function Documentation

◆ applyFromArray()

PHPExcel_Style_Fill::applyFromArray ( $pStyles = null )

Apply styles from array.

$objPHPExcel->getActiveSheet()->getStyle('B2')->getFill()->applyFromArray( array( 'type' => PHPExcel_Style_Fill::FILL_GRADIENT_LINEAR, 'rotation' => 0, 'startcolor' => array( 'rgb' => '000000' ), 'endcolor' => array( 'argb' => 'FFFFFFFF' ) ) );

Parameters

array $pStyles Array containing style information

Exceptions

PHPExcel_Exception

Returns: PHPExcel_Style_Fill

Definition at line 162 of file Fill.php.

                                                        {
                if (is_array($pStyles)) {
                        if ($this->_isSupervisor) {
                                $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($this->getStyleArray($pStyles));
                        } else {
                                if (array_key_exists('type', $pStyles)) {
                                        $this->setFillType($pStyles['type']);
                                }
                                if (array_key_exists('rotation', $pStyles)) {
                                        $this->setRotation($pStyles['rotation']);
                                }
                                if (array_key_exists('startcolor', $pStyles)) {
                                        $this->getStartColor()->applyFromArray($pStyles['startcolor']);
                                }
                                if (array_key_exists('endcolor', $pStyles)) {
                                        $this->getEndColor()->applyFromArray($pStyles['endcolor']);
                                }
                                if (array_key_exists('color', $pStyles)) {
                                        $this->getStartColor()->applyFromArray($pStyles['color']);
                                }
                        }
                } else {
                        throw new PHPExcel_Exception("Invalid style array passed.");
                }
                return $this;
        }

References PHPExcel_Style_Supervisor\getActiveSheet(), getEndColor(), PHPExcel_Style_Supervisor\getSelectedCells(), getStartColor(), getStyleArray(), setFillType(), and setRotation().

Here is the call graph for this function:

◆ getEndColor()

PHPExcel_Style_Fill::getEndColor ( )

Get End Color.

Returns: PHPExcel_Style_Color

Definition at line 279 of file Fill.php.

                                      {
                return $this->_endColor;
        }

References $_endColor.

Referenced by applyFromArray(), getHashCode(), and setEndColor().

Here is the caller graph for this function:

◆ getFillType()

PHPExcel_Style_Fill::getFillType ( )

Get Fill Type.

Returns: string

Definition at line 194 of file Fill.php.

                                      {
                if ($this->_isSupervisor) {
                        return $this->getSharedComponent()->getFillType();
                }
                return $this->_fillType;
        }

References $_fillType, and getSharedComponent().

Referenced by PHPExcel_Writer_HTML\_createCSSStyleFill(), and getHashCode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getHashCode()

PHPExcel_Style_Fill::getHashCode ( )

Get hash code.

Returns: string Hash code

Implements PHPExcel_IComparable.

Definition at line 308 of file Fill.php.

                                      {
                if ($this->_isSupervisor) {
                        return $this->getSharedComponent()->getHashCode();
                }
                return md5(
                          $this->getFillType()
                        . $this->getRotation()
                        . $this->getStartColor()->getHashCode()
                        . $this->getEndColor()->getHashCode()
                        . __CLASS__
                );
        }

References getEndColor(), getFillType(), getHashCode(), getRotation(), getSharedComponent(), and getStartColor().

Referenced by getHashCode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRotation()

PHPExcel_Style_Fill::getRotation ( )

Get Rotation.

Returns: double

Definition at line 222 of file Fill.php.

                                      {
                if ($this->_isSupervisor) {
                        return $this->getSharedComponent()->getRotation();
                }
                return $this->_rotation;
        }

References $_rotation, and getSharedComponent().

Referenced by getHashCode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSharedComponent()

PHPExcel_Style_Fill::getSharedComponent ( )

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

Only used for style supervisor

Returns: PHPExcel_Style_Fill

Definition at line 124 of file Fill.php.

        {
                return $this->_parent->getSharedComponent()->getFill();
        }

Referenced by getFillType(), getHashCode(), and getRotation().

Here is the caller graph for this function:

◆ getStartColor()

PHPExcel_Style_Fill::getStartColor ( )

Get Start Color.

Returns: PHPExcel_Style_Color

Definition at line 250 of file Fill.php.

                                        {
                return $this->_startColor;
        }

References $_startColor.

Referenced by PHPExcel_Writer_HTML\_createCSSStyleFill(), applyFromArray(), getHashCode(), and setStartColor().

Here is the caller graph for this function:

◆ getStyleArray()

PHPExcel_Style_Fill::getStyleArray ( $array )

Build style array from subcomponents.

Parameters

array $array

Returns: array

Definition at line 135 of file Fill.php.

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

Referenced by applyFromArray(), setFillType(), and setRotation().

Here is the caller graph for this function:

◆ setEndColor()

PHPExcel_Style_Fill::setEndColor ( PHPExcel_Style_Color $pValue = null )

Set End Color.

Parameters

PHPExcel_Style_Color $pValue

Exceptions

PHPExcel_Exception

Returns: PHPExcel_Style_Fill

Definition at line 290 of file Fill.php.

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

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

Here is the call graph for this function:

◆ setFillType()

PHPExcel_Style_Fill::setFillType ( $pValue = PHPExcel_Style_Fill::FILL_NONE )

Set Fill Type.

Parameters

string $pValue PHPExcel_Style_Fill fill type

Returns: PHPExcel_Style_Fill

Definition at line 207 of file Fill.php.

                                                                            {
                if ($this->_isSupervisor) {
                        $styleArray = $this->getStyleArray(array('type' => $pValue));
                        $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
                } else {
                        $this->_fillType = $pValue;
                }
                return $this;
        }

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

◆ setRotation()

PHPExcel_Style_Fill::setRotation ( $pValue = 0 )

Set Rotation.

Parameters

double $pValue

Returns: PHPExcel_Style_Fill

Definition at line 235 of file Fill.php.

                                                 {
                if ($this->_isSupervisor) {
                        $styleArray = $this->getStyleArray(array('rotation' => $pValue));
                        $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
                } else {
                        $this->_rotation = $pValue;
                }
                return $this;
        }

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

◆ setStartColor()

PHPExcel_Style_Fill::setStartColor ( PHPExcel_Style_Color $pValue = null )

Set Start Color.

Parameters

PHPExcel_Style_Color $pValue

Exceptions

PHPExcel_Exception

Returns: PHPExcel_Style_Fill

Definition at line 261 of file Fill.php.

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