Obblm\Core\Helper\Rule\Traits\AbstractInducementRuleTrait

Complexity

Total Complexity

29

Size/Duplication

Total Lines	146
Duplicated Lines	0 %

Test Coverage

Coverage

26.58%

Importance

Changes	2
Bugs	0	Features	0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	getAvailableStarPlayers()	0	10	1
A	getStarPlayer()	0	6	2
A	getInducementsByTeamOptions()	0	22	5
A	getMaxStarPlayers()	0	3	1
A	getBudgetExpression()	0	7	3
A	getRosterExpression()	0	10	3
A	getInducementsFor()	0	18	2
A	getInducementExpression()	0	16	4
A	getTypeExpression()	0	20	6
A	getInducements()	0	5	1
A	getStarPlayers()	0	5	1

<?php

namespace Obblm\Core\Helper\Rule\Traits;

use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Criteria;
use Doctrine\Common\Collections\Expr\CompositeExpression;
use Doctrine\Common\Collections\Expr\Expression;
use Obblm\Core\Contracts\InducementInterface;
use Obblm\Core\Entity\Team;
use Obblm\Core\Exception\InvalidArgumentException;
use Obblm\Core\Exception\NotFoundRuleKeyExcepion;
use Obblm\Core\Helper\CoreTranslation;
use Obblm\Core\Helper\Rule\Inducement\Inducement;

/*********************
 * INDUCEMENT METHODS
 ********************/
trait AbstractInducementRuleTrait
{
    abstract public function getInducementTable():ArrayCollection;

    private function getInducementExpression($options):CompositeExpression
    {
        $expressions = [];
        if (isset($options['type'])) {
            // Criteria by inducement type
            $expressions['type'] = $this->getTypeExpression($options);
        }
        if (isset($options['cost_limit'])) {
            // Criteria by cost limit
            $expressions['cost'] = $this->getBudgetExpression($options);
        }
        if (isset($options['roster'])) {
            // Criteria by roster
            $expressions['roster'] = $this->getRosterExpression($options);
        }
        return new CompositeExpression(CompositeExpression::TYPE_AND, $expressions);
    }

    private function getTypeExpression($options):Expression
    {
        if (isset($options['type'])) {
            // Criteria by inducement type
            if (is_array($options['type'])) {
                $types = [];
                foreach ($options['type'] as $type) {
                    if (is_string($type)) {
                        $inducementType = $this->getInducementType($type);

The method getInducementType() does not exist on Obblm\Core\Helper\Rule\Traits\AbstractInducementRuleTrait. Did you maybe mean getInducementTable()?

                        $types[] = Criteria::expr()->eq('type', $inducementType);
                    }
                }
                return new CompositeExpression(CompositeExpression::TYPE_OR, $types);
            } elseif (is_string($options['type'])) {
                $inducementType = $this->getInducementType($options['type']);
                return Criteria::expr()->eq('type', $inducementType);
            }
            throw new InvalidArgumentException('"type" option is not an array or a string');
        }
        throw new InvalidArgumentException('"type" option must be defined');
    }

    private function getRosterExpression($options):Expression
    {
        if (isset($options['roster']) && is_string($options['roster'])) {
            // Criteria by roster
            return Criteria::expr()->orX(
                Criteria::expr()->memberOf('rosters', $options['roster']),
                Criteria::expr()->eq('rosters', [])
            );
        }
        throw new InvalidArgumentException('"roster" option must be defined');
    }

    private function getBudgetExpression($options):Expression
    {
        if (isset($options['cost_limit']) && is_int($options['cost_limit'])) {
            // Criteria by cost limit
            return Criteria::expr()->lte('value', $options['cost_limit']);
        }
        throw new InvalidArgumentException('"cost_limit" option must be defined');
    }

    public function getInducements():ArrayCollection
    {
        $criteria = Criteria::create()
            ->where($this->getInducementExpression(['type' => 'inducements']));
        return $this->getInducementTable()->matching($criteria);
    }

    public function getStarPlayers():ArrayCollection
    {
        $criteria = Criteria::create()
            ->where($this->getInducementExpression(['type' => 'star_players']));
        return $this->getInducementTable()->matching($criteria);
    }

    public function getInducementsFor(Team $team, ?int $budget = null):ArrayCollection
    {
        $criteria = Criteria::create();
        $expr = [
            'type' => [
                'inducements',
                'star_players'
            ],
            'roster' => $team->getRoster()
        ];
        if ($budget !== null) {
            $expr['cost_limit'] = $budget;
        }
        $criteria->where(Criteria::expr()->andX(
            $this->getInducementExpression($expr)
        ));
        $availableInducements = $this->getInducementTable()->matching($criteria);
        return $availableInducements->toArray();

The expression return $availableInducements->toArray() returns the type array which is incompatible with the type-hinted return Doctrine\Common\Collections\ArrayCollection.

    }

    public function getInducementsByTeamOptions(array $options):array
    {
        $inducements = [];
        $ruleKey = $this->getAttachedRule()->getRuleKey();

It seems like getAttachedRule() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $availableInducements = $this->rule['inducements'];

        foreach ($availableInducements as $key => $value) {
            if ($key !== 'star_players') {
                if ($options[$key]) {
                    $inducement = [
                        'type' => $this->getInducementType('inducements'),
                        'key' => join(CoreTranslation::TRANSLATION_GLUE, [$ruleKey, 'inducements', $key]),
                        'translation_domain' => $this->getAttachedRule()->getRuleKey(),
                        'translation_key' => CoreTranslation::getInducementName($ruleKey, $key),
                        'max' => $value['max'] ?? 0,
                        'value' => ($options[$key] === 'discount') ? $value['discounted_cost'] : $value['cost'],
                    ];
                    $inducements[] = new Inducement($inducement);
                }
            }
        }
        return $inducements;
    }

    public function getMaxStarPlayers():int
    {
        return $this->rule['inducements']['star_players']['max'];
    }

    public function getStarPlayer(string $key):InducementInterface
    {
        if (!$this->getStarPlayers()->containsKey($key)) {
            throw new NotFoundRuleKeyExcepion($key);
        }
        return $this->getStarPlayers()->get($key);

The expression return $this->getStarPlayers()->get($key) could return the type null which is incompatible with the type-hinted return Obblm\Core\Contracts\InducementInterface. Consider adding an additional type-check to rule them out.

    }

    public function getAvailableStarPlayers(Team $team):array
    {
        $criteria = Criteria::create();
        $criteria->where(Criteria::expr()->andX(
            $this->getInducementExpression([
                'type' => 'star_players',
                'roster' => $team->getRoster()
            ])
        ));
        return $this->getInducementTable()->matching($criteria)->toArray();
    }
}