mautic / mautic

app/bundles/LeadBundle/Segment/Decorator/Date/DateOptionParameters.php

<?php

/*
 * @copyright   2018 Mautic Contributors. All rights reserved
 * @author      Mautic
 *
 * @link        http://mautic.org
 *
 * @license     GNU/GPLv3 http://www.gnu.org/licenses/gpl-3.0.html
 */

namespace Mautic\LeadBundle\Segment\Decorator\Date;

use Mautic\CoreBundle\Helper\DateTimeHelper;
use Mautic\LeadBundle\Segment\ContactSegmentFilterCrate;

class DateOptionParameters
{
    /**
     * @var bool
     */
    private $hasTimePart;

    /**
     * @var string
     */
    private $timeframe;

    /**
     * @var bool
     */
    private $requiresBetween;

    /**
     * @var bool
     */
    private $shouldUseLastDayOfRange;

    /**
     * @var DateTimeHelper
     */
    private $dateTimeHelper;

    public function __construct(
        ContactSegmentFilterCrate $leadSegmentFilterCrate,
        array $relativeDateStrings,
        TimezoneResolver $timezoneResolver
    ) {
        $this->hasTimePart             = $leadSegmentFilterCrate->hasTimeParts();
        $this->timeframe               = $this->parseTimeFrame($leadSegmentFilterCrate, $relativeDateStrings);
        $this->requiresBetween         = in_array($leadSegmentFilterCrate->getOperator(), ['=', '!='], true);
        $this->shouldUseLastDayOfRange = in_array($leadSegmentFilterCrate->getOperator(), ['gt', 'lte'], true);

        $this->setDateTimeHelper($timezoneResolver);
    }

    /**
     * @return bool
     */
    public function hasTimePart()
    {
        return $this->hasTimePart;
    }

    /**
     * @return string
     */
    public function getTimeframe()
    {
        return $this->timeframe;
    }

    /**
     * @return bool
     */
    public function isBetweenRequired()
    {
        return $this->requiresBetween;
    }

    /**
     * This function indicates that we need to modify date to the last date of range.
     * "Less than or equal" operator means that we need to include whole week / month / year > last day from range
     * "Grater than" needs same logic.
     *
     * @return bool
     */
    public function shouldUseLastDayOfRange()
    {
        return $this->shouldUseLastDayOfRange;
    }

    /**
     * @return DateTimeHelper
     */
    public function getDefaultDate()
    {
        return $this->dateTimeHelper;
    }

    /**
     * @return string
     */
    private function parseTimeFrame(ContactSegmentFilterCrate $leadSegmentFilterCrate, array $relativeDateStrings)
    {
        $key = array_search($leadSegmentFilterCrate->getFilter(), $relativeDateStrings, true);

        if (false === $key) {
            // Time frame does not match any option from $relativeDateStrings, so return original value
            return $leadSegmentFilterCrate->getFilter();

The expression return $leadSegmentFilterCrate->getFilter() also could return the type array|boolean which is incompatible with the documented return type string.

        }

        return str_replace('mautic.lead.list.', '', $key);
    }

    private function setDateTimeHelper(TimezoneResolver $timezoneResolver)
    {
        $this->dateTimeHelper = $timezoneResolver->getDefaultDate($this->hasTimePart());
    }
}