EventRepository::injectEventDispatcher() - Code Metrics - Inspection of "[TASK] Fix phpstan issues for EventRepository" - derhansen/sf_event_mgt - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — develop ( b2d169...d716f5 )

by Torben
created 2022-05-27 11:37 UTC
EventRepository::injectEventDispatcher() A

↳ Parent: EventRepository
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	1
nc	1
nop	1
dl	0
loc	3
rs	10
c	0
b	0
f	0
<?php

declare(strict_types=1);

/*
 * This file is part of the Extension "sf_event_mgt" for TYPO3 CMS.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 */

namespace DERHANSEN\SfEventMgt\Domain\Repository;

use DERHANSEN\SfEventMgt\Domain\Model\Dto\EventDemand;
use DERHANSEN\SfEventMgt\Event\ModifyEventQueryConstraintsEvent;
use DERHANSEN\SfEventMgt\Service\CategoryService;
use Psr\EventDispatcher\EventDispatcherInterface;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Extbase\Persistence\Generic\Qom\ConstraintInterface;
use TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings;
use TYPO3\CMS\Extbase\Persistence\QueryInterface;
use TYPO3\CMS\Extbase\Persistence\QueryResultInterface;
use TYPO3\CMS\Extbase\Persistence\Repository;

/**
 * The repository for Events
 */
class EventRepository extends Repository
{
    protected $defaultOrderings = [
        'startdate' => QueryInterface::ORDER_ASCENDING,
    ];

    protected EventDispatcherInterface $eventDispatcher;

    public function injectEventDispatcher(EventDispatcherInterface $eventDispatcher)
    {
        $this->eventDispatcher = $eventDispatcher;
    }

    /**
     * Disable the use of storage records, because the StoragePage can be set
     * in the plugin
     */
    public function initializeObject()
    {
        $this->defaultQuerySettings = GeneralUtility::makeInstance(Typo3QuerySettings::class);
        $this->defaultQuerySettings->setRespectStoragePage(false);
    }

    /**
     * Returns the objects of this repository matching the given demand
     *
     * @param EventDemand $eventDemand EventDemand
     *
     * @return array|QueryResultInterface QueryResultInterface
     */
    public function findDemanded(EventDemand $eventDemand)
    {
        $constraints = [];
        $query = $this->createQuery();
        $query->getQuerySettings()->setIgnoreEnableFields($eventDemand->getIgnoreEnableFields());

        $this->setStoragePageConstraint($query, $eventDemand, $constraints);
        $this->setDisplayModeConstraint($query, $eventDemand, $constraints);
        $this->setCategoryConstraint($query, $eventDemand, $constraints);
        $this->setLocationConstraint($query, $eventDemand, $constraints);
        $this->setLocationCityConstraint($query, $eventDemand, $constraints);
        $this->setLocationCountryConstraint($query, $eventDemand, $constraints);
        $this->setSpeakerConstraint($query, $eventDemand, $constraints);
        $this->setOrganisatorConstraint($query, $eventDemand, $constraints);
        $this->setStartEndDateConstraint($query, $eventDemand, $constraints);
        $this->setSearchConstraint($query, $eventDemand, $constraints);
        $this->setTopEventConstraint($query, $eventDemand, $constraints);
        $this->setYearMonthDayRestriction($query, $eventDemand, $constraints);

        $modifyEventQueryConstraintsEvent = new ModifyEventQueryConstraintsEvent(
            $constraints,
            $query,
            $eventDemand,
            $this
        );
        $this->eventDispatcher->dispatch($modifyEventQueryConstraintsEvent);
        $constraints = $modifyEventQueryConstraintsEvent->getConstraints();

        $this->setOrderingsFromDemand($query, $eventDemand);

        if (count($constraints) > 0) {
            $query->matching($query->logicalAnd($constraints));
        }

        $this->setQueryLimitFromDemand($query, $eventDemand);

        return $query->execute();
    }

    /**
     * Returns the event with the given UID and also respects the hidden state
     *
     * @param int $uid
     * @return object
     */
    public function findByUidIncludeHidden(int $uid): object
    {
        $query = $this->createQuery();
        $query->getQuerySettings()->setIgnoreEnableFields(true);
        $query->matching($query->equals('uid', $uid));
        return $query->execute()->getFirst();

    }

    /**
     * Sets a query limit to the given query for the given demand
     *
     * @param QueryInterface $query Query
     * @param EventDemand $eventDemand EventDemand
     */
    protected function setQueryLimitFromDemand(QueryInterface $query, EventDemand $eventDemand): void
    {
        if ($eventDemand->getQueryLimit() > 0) {
            $query->setLimit($eventDemand->getQueryLimit());
        }
    }

    /**
     * Sets the ordering to the given query for the given demand
     *
     * @param QueryInterface $query Query
     * @param EventDemand $eventDemand EventDemand
     */
    protected function setOrderingsFromDemand(QueryInterface $query, EventDemand $eventDemand): void
    {
        $orderings = [];
        $orderFieldAllowed = GeneralUtility::trimExplode(',', $eventDemand->getOrderFieldAllowed(), true);
        if ($eventDemand->getOrderField() != '' && $eventDemand->getOrderDirection() != '' &&
            !empty($orderFieldAllowed) && in_array($eventDemand->getOrderField(), $orderFieldAllowed, true)) {
            $orderings[$eventDemand->getOrderField()] = ((strtolower($eventDemand->getOrderDirection()) == 'desc') ?
                QueryInterface::ORDER_DESCENDING :
                QueryInterface::ORDER_ASCENDING);
            $query->setOrderings($orderings);
        }
    }

    /**
     * Sets the storagePage constraint to the given constraints array
     *
     * @param QueryInterface $query Query
     * @param EventDemand $eventDemand EventDemand
     * @param array $constraints Constraints
     */
    protected function setStoragePageConstraint(
        QueryInterface $query,
        EventDemand $eventDemand,
        array &$constraints
    ): void {
        if ($eventDemand->getStoragePage() !== '') {
            $pidList = GeneralUtility::intExplode(',', $eventDemand->getStoragePage(), true);
            $constraints['storagePage'] = $query->in('pid', $pidList);
        }
    }

    /**
     * Sets the displayMode constraint to the given constraints array
     *
     * @param QueryInterface $query Query
     * @param EventDemand $eventDemand EventDemand
     * @param array $constraints Constraints
     */
    protected function setDisplayModeConstraint(
        QueryInterface $query,
        EventDemand $eventDemand,
        array &$constraints
    ): void {
        switch ($eventDemand->getDisplayMode()) {
            case 'future':
                $constraints['displayMode'] = $query->greaterThan('startdate', $eventDemand->getCurrentDateTime());
                break;
            case 'current_future':
                $constraints['displayMode'] = $query->logicalOr([
                    $query->greaterThan('startdate', $eventDemand->getCurrentDateTime()),
                    $query->logicalAnd([
                        $query->greaterThanOrEqual('enddate', $eventDemand->getCurrentDateTime()),
                        $query->lessThanOrEqual('startdate', $eventDemand->getCurrentDateTime()),
                    ]),
                ]);
                break;
            case 'past':
                $constraints['displayMode'] = $query->lessThanOrEqual('enddate', $eventDemand->getCurrentDateTime());
                break;
            case 'time_restriction':
                $includeCurrentConstraint = null;
                if (!empty($eventDemand->getTimeRestrictionLow())) {
                    $timeRestriction = strtotime($eventDemand->getTimeRestrictionLow());
                    $timeRestrictionConstraints['timeRestrictionLow'] = $query->greaterThanOrEqual('startdate', $timeRestriction);


                    if ($eventDemand->getIncludeCurrent()) {
                        $includeCurrentConstraint = $query->logicalAnd([
                            $query->lessThan('startdate', $timeRestriction),
                            $query->greaterThan('enddate', $timeRestriction),
                        ]);
                    }
                }
                if (!empty($eventDemand->getTimeRestrictionHigh())) {
                    $timeRestrictionHigh = strtotime($eventDemand->getTimeRestrictionHigh());
                    $timeRestrictionConstraints['timeRestrictionHigh'] = $query->lessThanOrEqual('startdate', $timeRestrictionHigh);
                }
                if (isset($timeRestrictionConstraints)) {
                    if ($eventDemand->getIncludeCurrent() && $includeCurrentConstraint) {
                        $constraints['displayMode'] = $query->logicalOr([
                            $includeCurrentConstraint,
                            $query->logicalAnd($timeRestrictionConstraints),
                        ]);
                    } else {
                        $constraints['displayMode'] = $query->logicalAnd($timeRestrictionConstraints);
                    }
                }
                break;
            default:
        }
    }

    /**
     * Sets the category constraint to the given constraints array
     *
     * @param QueryInterface $query Query
     * @param EventDemand $eventDemand EventDemand
     * @param array $constraints Constraints
     */
    protected function setCategoryConstraint(QueryInterface $query, EventDemand $eventDemand, array &$constraints): void
    {
        // If no category constraint is set, categories should not be respected in the query
        if ($eventDemand->getCategoryConjunction() === '') {
            return;
        }

        if ($eventDemand->getCategory() != '') {
            $categoryConstraints = [];
            if ($eventDemand->getIncludeSubcategories()) {
                $categoryList = CategoryService::getCategoryListWithChilds($eventDemand->getCategory());
                $categories = GeneralUtility::intExplode(',', $categoryList, true);
            } else {
                $categories = GeneralUtility::intExplode(',', $eventDemand->getCategory(), true);
            }
            foreach ($categories as $category) {
                $categoryConstraints[] = $query->contains('category', $category);
            }
            if (count($categoryConstraints) > 0) {
                $constraints['category'] = $this->getCategoryConstraint($query, $eventDemand, $categoryConstraints);
            }
        }
    }

    /**
     * Returns the category constraint depending on the category conjunction configured in eventDemand
     *
     * @param QueryInterface $query
     * @param EventDemand $eventDemand
     * @param array $categoryConstraints
     * @return ConstraintInterface
     */
    public function getCategoryConstraint(
        QueryInterface $query,
        EventDemand $eventDemand,
        array $categoryConstraints
    ): ConstraintInterface {
        switch (strtolower($eventDemand->getCategoryConjunction())) {
            case 'and':
                $constraint = $query->logicalAnd($categoryConstraints);
                break;
            case 'notor':
                $constraint = $query->logicalNot($query->logicalOr($categoryConstraints));
                break;
            case 'notand':
                $constraint = $query->logicalNot($query->logicalAnd($categoryConstraints));
                break;
            case 'or':
            default:
                $constraint = $query->logicalOr($categoryConstraints);
        }

        return $constraint;
    }

    /**
     * Sets the location constraint to the given constraints array
     *
     * @param QueryInterface $query Query
     * @param EventDemand $eventDemand EventDemand
     * @param array $constraints Constraints
     */
    protected function setLocationConstraint($query, $eventDemand, &$constraints)
    {
        if ($eventDemand->getLocation() !== null && $eventDemand->getLocation() != '') {
            $constraints['location'] = $query->equals('location', $eventDemand->getLocation());
        }
    }

    /**
     * Sets the location.city constraint to the given constraints array
     *
     * @param QueryInterface $query Query
     * @param EventDemand $eventDemand EventDemand
     * @param array $constraints Constraints
     */
    protected function setLocationCityConstraint(
        QueryInterface $query,
        EventDemand $eventDemand,
        array &$constraints
    ): void {
        if ($eventDemand->getLocationCity() !== null && $eventDemand->getLocationCity() != '') {
            $constraints['locationCity'] = $query->equals('location.city', $eventDemand->getLocationCity());
        }
    }

    /**
     * Sets the location.country constraint to the given constraints array
     *
     * @param QueryInterface $query Query
     * @param EventDemand $eventDemand EventDemand
     * @param array $constraints Constraints
     */
    protected function setLocationCountryConstraint(
        QueryInterface $query,
        EventDemand $eventDemand,
        array &$constraints
    ): void {
        if ($eventDemand->getLocationCountry() !== null && $eventDemand->getLocationCountry() != '') {
            $constraints['locationCountry'] = $query->equals('location.country', $eventDemand->getLocationCountry());
        }
    }

    /**
     * Sets the speaker constraint to the given constraints array
     *
     * @param QueryInterface $query Query
     * @param EventDemand $eventDemand EventDemand
     * @param array $constraints Constraints
     */
    protected function setSpeakerConstraint(QueryInterface $query, EventDemand $eventDemand, array &$constraints): void
    {
        if ($eventDemand->getSpeaker() !== null && $eventDemand->getSpeaker() != '') {
            $constraints['speaker'] = $query->contains('speaker', $eventDemand->getSpeaker());
        }
    }

    /**
     * Sets the organisator constraint to the given constraints array
     *
     * @param QueryInterface $query Query
     * @param EventDemand $eventDemand EventDemand
     * @param array $constraints Constraints
     */
    protected function setOrganisatorConstraint(
        QueryInterface $query,
        EventDemand $eventDemand,
        array &$constraints
    ): void {
        if ($eventDemand->getOrganisator() !== null && $eventDemand->getOrganisator() != '') {
            $constraints['organisator'] = $query->equals('organisator', $eventDemand->getOrganisator());
        }
    }

    /**
     * Sets the start- and enddate constraint to the given constraints array
     *
     * @param QueryInterface $query Query
     * @param EventDemand $eventDemand EventDemand
     * @param array $constraints Constraints
     */
    protected function setStartEndDateConstraint(
        QueryInterface $query,
        EventDemand $eventDemand,
        array &$constraints
    ): void {
        if ($eventDemand->getSearchDemand() && $eventDemand->getSearchDemand()->getStartDate() !== null &&
            $eventDemand->getSearchDemand()->getEndDate() !== null
        ) {
            /* StartDate and EndDate  - Search for events between two given dates */
            $begin = $eventDemand->getSearchDemand()->getStartDate();
            $end = $eventDemand->getSearchDemand()->getEndDate();
            $constraints['startEndDate'] = $query->logicalOr([
                $query->between('startdate', $begin, $end),
                        between('startdate', $begin, $end),
                $query->between('enddate', $begin, $end),
                $query->logicalAnd([
                    $query->greaterThanOrEqual('enddate', $begin),
                    $query->lessThanOrEqual('startdate', $begin),
                ]),
            ]);
        } elseif ($eventDemand->getSearchDemand() && $eventDemand->getSearchDemand()->getStartDate() !== null) {
            /* StartDate - Search for events beginning at a given date */
            $constraints['startDate'] = $query->greaterThanOrEqual('startdate', $eventDemand->getSearchDemand()->getStartDate());
        } elseif ($eventDemand->getSearchDemand() && $eventDemand->getSearchDemand()->getEndDate() !== null) {
            /* EndDate - Search for events ending on a given date */
            $constraints['endDate'] = $query->lessThanOrEqual('enddate', $eventDemand->getSearchDemand()->getEndDate());
        }
    }

    /**
     * Sets the search constraint to the given constraints array
     *
     * @param QueryInterface $query Query
     * @param EventDemand $eventDemand EventDemand
     * @param array $constraints Constraints
     */
    protected function setSearchConstraint(QueryInterface $query, EventDemand $eventDemand, array &$constraints): void
    {
        if ($eventDemand->getSearchDemand() &&
            $eventDemand->getSearchDemand()->getSearch() !== null &&
            $eventDemand->getSearchDemand()->getSearch() !== ''
        ) {
            $searchFields = GeneralUtility::trimExplode(',', $eventDemand->getSearchDemand()->getFields(), true);
            $searchConstraints = [];

            if (count($searchFields) === 0) {
                throw new \UnexpectedValueException('No search fields defined', 1318497755);
            }

            $searchSubject = $eventDemand->getSearchDemand()->getSearch();
            foreach ($searchFields as $field) {
                $searchConstraints[] = $query->like($field, '%' . addcslashes($searchSubject, '_%') . '%');
            }

            $constraints['search'] = $query->logicalOr($searchConstraints);
        }
    }

    /**
     * Sets the topEvent constraint to the given constraints array
     *
     * @param QueryInterface $query Query
     * @param EventDemand $eventDemand EventDemand
     * @param array $constraints Constraints
     */
    protected function setTopEventConstraint(QueryInterface $query, EventDemand $eventDemand, array &$constraints): void
    {
        if ($eventDemand->getTopEventRestriction() > 0) {
            $constraints['topEvent'] = $query->equals('topEvent', (bool)($eventDemand->getTopEventRestriction() - 1));
        }
    }

    /**
     * Sets the restriction for year, year/month or year/month/day to the given constraints array
     *
     * @param QueryInterface $query
     * @param EventDemand $eventDemand
     * @param array $constraints
     */
    protected function setYearMonthDayRestriction(
        QueryInterface $query,
        EventDemand $eventDemand,
        array &$constraints
    ): void {
        if ($eventDemand->getYear() > 0) {
            if ($eventDemand->getMonth() > 0) {
                if ($eventDemand->getDay() > 0) {
                    $begin = mktime(0, 0, 0, $eventDemand->getMonth(), $eventDemand->getDay(), $eventDemand->getYear());
                    $end = mktime(23, 59, 59, $eventDemand->getMonth(), $eventDemand->getDay(), $eventDemand->getYear());
                } else {
                    $begin = mktime(0, 0, 0, $eventDemand->getMonth(), 1, $eventDemand->getYear());
                    $end = mktime(23, 59, 59, ($eventDemand->getMonth() + 1), 0, $eventDemand->getYear());
                }
            } else {
                $begin = mktime(0, 0, 0, 1, 1, $eventDemand->getYear());
                $end = mktime(23, 59, 59, 12, 31, $eventDemand->getYear());
            }
            $constraints['yearMonthDay'] = $query->logicalOr([
                $query->between('startdate', $begin, $end),
                $query->between('enddate', $begin, $end),
                $query->logicalAnd([
                    $query->greaterThanOrEqual('enddate', $begin),
                    $query->lessThanOrEqual('startdate', $begin),
                ]),
            ]);
        }
    }
}

derhansen / sf_event_mgt

Push — develop ( b2d169...d716f5 )

EventRepository::injectEventDispatcher() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
