src/PhpPresentation/Style/Fill.php
<?php
/**
* This file is part of PHPPresentation - A pure PHP library for reading and writing
* presentations documents.
*
* PHPPresentation is free software distributed under the terms of the GNU Lesser
* General Public License version 3 as published by the Free Software Foundation.
*
* For the full copyright and license information, please read the LICENSE
* file that was distributed with this source code. For the full list of
* contributors, visit https://github.com/PHPOffice/PHPPresentation/contributors.
*
* @see https://github.com/PHPOffice/PHPPresentation
*
* @license http://www.gnu.org/licenses/lgpl.txt LGPL version 3
*/
declare(strict_types=1);
namespace PhpOffice\PhpPresentation\Style;
use PhpOffice\PhpPresentation\ComparableInterface;
class Fill implements ComparableInterface
{
// Fill types
public const FILL_NONE = 'none';
public const FILL_SOLID = 'solid';
public const FILL_GRADIENT_LINEAR = 'linear';
public const FILL_GRADIENT_PATH = 'path';
public const FILL_PATTERN_DARKDOWN = 'darkDown';
public const FILL_PATTERN_DARKGRAY = 'darkGray';
public const FILL_PATTERN_DARKGRID = 'darkGrid';
public const FILL_PATTERN_DARKHORIZONTAL = 'darkHorizontal';
public const FILL_PATTERN_DARKTRELLIS = 'darkTrellis';
public const FILL_PATTERN_DARKUP = 'darkUp';
public const FILL_PATTERN_DARKVERTICAL = 'darkVertical';
public const FILL_PATTERN_GRAY0625 = 'gray0625';
public const FILL_PATTERN_GRAY125 = 'gray125';
public const FILL_PATTERN_LIGHTDOWN = 'lightDown';
public const FILL_PATTERN_LIGHTGRAY = 'lightGray';
public const FILL_PATTERN_LIGHTGRID = 'lightGrid';
public const FILL_PATTERN_LIGHTHORIZONTAL = 'lightHorizontal';
public const FILL_PATTERN_LIGHTTRELLIS = 'lightTrellis';
public const FILL_PATTERN_LIGHTUP = 'lightUp';
public const FILL_PATTERN_LIGHTVERTICAL = 'lightVertical';
public const FILL_PATTERN_MEDIUMGRAY = 'mediumGray';
/**
* Fill type.
*
* @var string
*/
private $fillType = self::FILL_NONE;
/**
* Rotation.
*
* @var float
*/
private $rotation = 0.0;
/**
* Start color.
*
* @var Color
*/
private $startColor;
/**
* End color.
*
* @var Color
*/
private $endColor;
/**
* Hash index.
*
* @var int
*/
private $hashIndex;
/**
* Create a new \PhpOffice\PhpPresentation\Style\Fill.
*/
public function __construct()
{
$this->startColor = new Color(Color::COLOR_BLACK);
$this->endColor = new Color(Color::COLOR_WHITE);
}
/**
* Get Fill Type.
*/
public function getFillType(): string
{
return $this->fillType;
}
/**
* Set Fill Type.
*
* @param string $pValue Fill type
*/
public function setFillType(string $pValue = self::FILL_NONE): self
{
$this->fillType = $pValue;
return $this;
}
/**
* Get Rotation.
*/
public function getRotation(): float
{
return $this->rotation;
}
/**
* Set Rotation.
*/
public function setRotation(float $pValue = 0): self
{
$this->rotation = $pValue;
return $this;
}
/**
* Get Start Color.
*/
public function getStartColor(): Color
{
// It's a get but it may lead to a modified color which we won't detect but in which case we must bind.
// So bind as an assurance.
return $this->startColor;
}
/**
* Set Start Color.
*/
public function setStartColor(Color $pValue): self
{
$this->startColor = $pValue;
return $this;
}
/**
* Get End Color.
*/
public function getEndColor(): Color
{
// It's a get but it may lead to a modified color which we won't detect but in which case we must bind.
// So bind as an assurance.
return $this->endColor;
}
/**
* Set End Color.
*/
public function setEndColor(Color $pValue): self
{
$this->endColor = $pValue;
return $this;
}
/**
* Get hash code.
*
* @return string Hash code
*/
public function getHashCode(): string
{
return md5(
$this->getFillType()
. $this->getRotation()
. $this->getStartColor()->getHashCode()
. $this->getEndColor()->getHashCode()
. __CLASS__
);
}
/**
* Get hash index.
*
* Note that this index may vary during script execution! Only reliable moment is
* while doing a write of a workbook and when changes are not allowed.
*
* @return null|int Hash index
*/
public function getHashIndex(): ?int
{
return $this->hashIndex;
}
/**
* Set hash index.
*
* Note that this index may vary during script execution! Only reliable moment is
* while doing a write of a workbook and when changes are not allowed.
*
* @param int $value Hash index
*
* @return $this
*/
public function setHashIndex(int $value)
{
$this->hashIndex = $value;
return $this;
}
}