PHPOffice/PHPPresentation

<?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\Shape\Chart\Type;

/**
 * \PhpOffice\PhpPresentation\Shape\Chart\Type\Bar.
 */
abstract class AbstractTypeBar extends AbstractType
{
    /** Orientation of bars */
    public const DIRECTION_VERTICAL = 'col';
    public const DIRECTION_HORIZONTAL = 'bar';

    /** Grouping of bars */
    public const GROUPING_CLUSTERED = 'clustered'; //Chart series are drawn next to each other along the category axis.
    public const GROUPING_STACKED = 'stacked'; //Chart series are drawn next to each other on the value axis.
    public const GROUPING_PERCENTSTACKED = 'percentStacked'; //Chart series are drawn next to each other along the value axis and scaled to total 100%

    /**
     * Orientation of bars.
     *
     * @var string
     */
    protected $barDirection = self::DIRECTION_VERTICAL;

    /**
     * Grouping of bars.
     *
     * @var string
     */
    protected $barGrouping = self::GROUPING_CLUSTERED;

    /**
     * Space between bar or columns clusters.
     *
     * @var int
     */
    protected $gapWidthPercent = 150;

    /**
     * Overlap within bar or columns clusters. Value between 100 and -100 percent.
     * For stacked bar charts, the default overlap will be 100, for grouped bar charts 0.
     *
     * @var int
     */
    protected $overlapWidthPercent = 0;

    /**
     * Set bar orientation.
     *
     * @param string $value
     *
     * @return AbstractTypeBar
     */
    public function setBarDirection($value = self::DIRECTION_VERTICAL)
    {
        $this->barDirection = $value;

        return $this;
    }

    /**
     * Get orientation.
     *
     * @return string
     */
    public function getBarDirection()
    {
        return $this->barDirection;
    }

    /**
     * Set bar grouping (stack or expanded style bar).
     *
     * @param string $value
     *
     * @return AbstractTypeBar
     */
    public function setBarGrouping($value = self::GROUPING_CLUSTERED)
    {
        $this->barGrouping = $value;
        $this->overlapWidthPercent = 0;

        if ($value === self::GROUPING_STACKED || $value === self::GROUPING_PERCENTSTACKED) {
            $this->overlapWidthPercent = 100;
        }

        return $this;
    }

    /**
     * Get grouping  (stack or expanded style bar).
     *
     * @return string
     */
    public function getBarGrouping()
    {
        return $this->barGrouping;
    }

    /**
     * @return int
     */
    public function getGapWidthPercent()
    {
        return $this->gapWidthPercent;
    }

    /**
     * @param int $gapWidthPercent
     *
     * @return $this
     */
    public function setGapWidthPercent($gapWidthPercent)
    {
        if ($gapWidthPercent < 0) {
            $gapWidthPercent = 0;
        }
        if ($gapWidthPercent > 500) {
            $gapWidthPercent = 500;
        }
        $this->gapWidthPercent = $gapWidthPercent;

        return $this;
    }

    public function getOverlapWidthPercent(): int
    {
        return $this->overlapWidthPercent;
    }

    /**
     * @param int $value overlap width percentage
     */
    public function setOverlapWidthPercent(int $value): self
    {
        if ($value < -100) {
            $value = -100;
        }
        if ($value > 100) {
            $value = 100;
        }
        $this->overlapWidthPercent = $value;

        return $this;
    }

    /**
     * Get hash code.
     *
     * @return string Hash code
     */
    public function getHashCode(): string
    {
        $hash = '';
        foreach ($this->getSeries() as $series) {
            $hash .= $series->getHashCode();
        }

        return $hash;
    }
}