nystudio107\similar\services\Similar::find()

Complexity

Conditions	18
Paths	262

Size

Total Lines	118
Code Lines	59

Duplication

Lines	0
Ratio	0 %

Importance

Changes	10
Bugs	0	Features	0

<?php
    public function find($data)
    {
        if (!isset($data['element'])) {
            throw new Exception('Required parameter `element` was not supplied to `craft.similar.find`.');
        }

        if (!isset($data['context'])) {
            throw new Exception('Required parameter `context` was not supplied to `craft.similar.find`.');
        }

        /** @var Element $element */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

        $element = $data['element'];
        $context = $data['context'];
        $criteria = $data['criteria'] ?? [];

        if (\is_object($criteria)) {
            /** @var ElementQueryInterface $criteria */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

            $criteria = $criteria->toArray();
        }

        // Get an ElementQuery for this Element
        $elementClass = \is_object($element) ? \get_class($element) : $element;
        /** @var EntryQuery $query */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

        $query = $this->getElementQuery($elementClass, $criteria);

        // If the $query is null, just return an empty Entry
        if (!$query) { // no results

$query is of type craft\elements\db\EntryQuery, thus it always evaluated to true.

            return new Entry();
        }

        // Stash any orderBy directives from the $query for our anonymous function
        $this->preOrder = $query->orderBy;
        $this->limit = $query->limit;

It seems like $query->limit can also be of type yii\db\ExpressionInterface. However, the property $limit is declared as type integer. Maybe add an additional type check?

        // Extract the $tagIds from the $context
        if (\is_array($context)) {
            $tagIds = $context;
        } else {
            /** @var ElementQueryInterface $context */

The open comment tag must be the only content on the line

The close comment tag must be the only content on the line

Missing short description in doc comment

            $tagIds = $context->ids();
        }
        $this->targetElements = $tagIds;

        // We need to modify the actual craft\db\Query after the ElementQuery has been prepared
        $query->on(ElementQuery::EVENT_AFTER_PREPARE, [$this, 'eventAfterPrepareHandler']);
        // Return the data as an array, and only fetch the `id` and `siteId`
        $query->asArray(true);
        $query->select(['elements.id', 'elements_sites.siteId']);
        $query->andWhere(['not', ['elements.id' => $element->id]]);

        // Unless site criteria is provided, force the element's site.
        if (empty($criteria['siteId']) && empty($criteria['site'])) {
            $query->andWhere(['elements_sites.siteId' => $element->siteId]);
        }

        $query->andWhere(['in', 'relations.targetId', $tagIds]);
        $query->leftJoin(['relations' => Table::RELATIONS], '[[elements.id]] = [[relations.sourceId]]');
        $results = $query->all();

        // Fetch the elements based on the returned `id` and `siteId`
        $elements = Craft::$app->getElements();

The assignment to $elements is dead and can be removed.

        $models = [];

The assignment to $models is dead and can be removed.

        $queryConditions = [];
        $similarCounts = [];

        // Build the query conditions for a new element query.
        // The reason we have to do it in two steps is because the `count` property is added by a behavior after element creation
        // So if we just try to tack that on in the original query, it will throw an error on element creation
        foreach ($results as $config) {
            $siteId = $config['siteId'];
            $elementId = $config['id'];

            if ($elementId && $siteId) {
                if (empty($queryConditions[$siteId])) {
                    $queryConditions[$siteId] = [];
                }

                // Write down elements per site and similar counts
                $queryConditions[$siteId][] = $elementId;
                $key = $siteId . '-' . $elementId;
                $similarCounts[$key] = $config['count'];
            }
        }

        if (empty($results)) {
            return [];
        }
        
        // Fetch all the elements in one fell swoop, including any preset eager-loaded conditions
        $query = $this->getElementQuery($elementClass, $criteria);

        // Make sure we fetch the elements that are similar only
        $query->on(ElementQuery::EVENT_AFTER_PREPARE, function (CancelableEvent $event) use ($queryConditions) {

The opening parenthesis of a multi-line function call should be the last content on the line.

The method on() does not exist on craft\elements\db\ElementQueryInterface. Did you maybe mean one()?

            /** @var ElementQuery $query */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

            $query = $event->sender;
            $first = true;

            foreach ($queryConditions as $siteId => $elementIds) {
                $method = $first ? 'where' : 'orWhere';
                $query->subQuery->$method(['and', [

The opening parenthesis of a multi-line function call should be the last content on the line.

                    'elements_sites.siteId' => $siteId,
                    'elements.id' => $elementIds]
                ]);

For multi-line function calls, the closing parenthesis should be on a new line.

            }
        });

For multi-line function calls, the closing parenthesis should be on a new line.

        $elements = $query->all();

        foreach ($elements as $element) {
            // The `count` property is added dynamically by our CountBehavior behavior
            $key = $element->siteId . '-' . $element->id;

Accessing siteId on the interface craft\base\ElementInterface suggest that you code against a concrete implementation. How about adding an instanceof check?

Accessing id on the interface craft\base\ElementInterface suggest that you code against a concrete implementation. How about adding an instanceof check?

            if (!empty($similarCounts[$key])) {
                /** @noinspection PhpUndefinedFieldInspection */

Missing short description in doc comment

The close comment tag must be the only content on the line

The open comment tag must be the only content on the line

                $element->count = $similarCounts[$key];

Accessing count on the interface craft\base\ElementInterface suggest that you code against a concrete implementation. How about adding an instanceof check?

            }
        }

        return $elements;
    }