nystudio107 / craft-similar

src/services/Similar.php

<?php
/**
 * Similar plugin for Craft CMS 3.x
 *
 * Similar for Craft lets you find elements, Entries, Categories, Commerce
 * Products, etc, that are similar, based on... other related elements.
 *
 * @link      https://nystudio107.com/

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) 2018 nystudio107.com

@copyright tag must contain a year and the name of the copyright holder

 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

namespace nystudio107\similar\services;

use Craft;
use craft\base\Component;
use craft\base\Element;
use craft\base\ElementInterface;

The type craft\base\ElementInterface was not found. Maybe you did not declare it correctly or list all dependencies?

use craft\db\Table;
use craft\elements\db\ElementQuery;
use craft\elements\db\ElementQueryInterface;
use craft\elements\db\EntryQuery;
use craft\elements\db\OrderByPlaceholderExpression;
use craft\events\CancelableEvent;
use yii\base\Exception;
use function is_array;
use function is_object;

/**

Missing short description in doc comment

 * @author    nystudio107.com

The tag in position 1 should be the @package tag

Content of the @author tag must be in the form "Display Name <username@example.com>"

Tag value for @author tag indented incorrectly; expected 2 spaces but found 4

 * @package   Similar

Tag value for @package tag indented incorrectly; expected 1 spaces but found 3

 * @since     1.0.0

The tag in position 3 should be the @author tag

Tag value for @since tag indented incorrectly; expected 3 spaces but found 5

 */

Missing @category tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class Similar extends Component
{
    // Public Properties
    // =========================================================================

    /**

Missing short description in doc comment

     * @var string|array The previous order in the query
     */
    public string|array $preOrder = [];

    /**

Missing short description in doc comment

     * @var ?int
     */
    public ?int $limit = null;

    /**

Missing short description in doc comment

     * @var Element[]
     */
    public array $targetElements = [];

    // Public Methods
    // =========================================================================

    /**

Missing short description in doc comment

     * @param array $data

Missing parameter comment

     *
     * @return array|ElementInterface
     * @throws Exception
     */
    public function find(array $data): array|ElementInterface
    {
        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 class-string|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([], [], false);
        }

        // Get an ElementQuery for this Element
        $elementClass = is_object($element) ? $element::class : $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);

        // 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|null. 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

Missing short description in doc comment

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

            $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, fn(CancelableEvent $event) => $this->eventAfterPrepareHandler($event));
        // 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->getId()]]);

        // 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`
        $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): void {

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

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

Expected 1 space after FUNCTION keyword; 0 found

            /** @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';
                $first = false;
                $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();

        /** @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

        foreach ($elements as $element) {
            // The `count` property is added dynamically by our CountBehavior behavior
            $key = $element->siteId . '-' . $element->id;
            if (!empty($similarCounts[$key])) {
                /** @phpstan-ignore-next-line */

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->count = $similarCounts[$key];
            }
        }

        if (empty($criteria['orderBy'])) {
            /** @phpstan-ignore-next-line */

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

            usort($elements, static fn($a, $b) => $a->count < $b->count ? 1 : ($a->count == $b->count ? 0 : -1));
        }

        return $elements;
    }

    protected function eventAfterPrepareHandler(CancelableEvent $event): void

Missing doc comment for function eventAfterPrepareHandler()

    {
        /** @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;
        // Add in the `count` param so we know how many were fetched
        $query->query->addSelect(['COUNT(*) as count']);

The method addSelect() does not exist on null.

        if (is_array($this->preOrder)) {
            $this->preOrder = array_filter($this->preOrder, fn($value) => !$value instanceof OrderByPlaceholderExpression);
            $query->query->orderBy(array_merge([

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

                'count' => 'DESC',
            ], $this->preOrder));

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

        } elseif (is_string($this->preOrder)) {

The condition is_string($this->preOrder) is always true.

            $query->query->orderBy('count DESC, ' . str_replace('`', '', $this->preOrder));
        }

        $query->query->groupBy(['relations.sourceId', 'elements.id', 'elements_sites.siteId']);

        $query->query->andWhere(['in', 'relations.targetId', $this->targetElements]);

        $query->subQuery->limit(null); // inner limit to null -> fetch all possible entries, sort them afterwards

The method limit() does not exist on null.

        $query->query->limit($this->limit); // or whatever limit is set

        $query->subQuery->groupBy(['elements.id', 'elements_sites.id']);

        if ($query instanceof EntryQuery) {
            $query->subQuery->addGroupBy(['entries.postDate']);
        }

        if ($query->withStructure || ($query->withStructure !== false && $query->structureId)) {
            $query->subQuery->addGroupBy(['structureelements.structureId', 'structureelements.lft']);
        }

        $event->isValid = true;
    }

    /**
     * Returns the element query based on $elementType and $criteria
     *
     * @param string|ElementInterface $elementType

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param array $criteria

Missing parameter comment

Expected 19 spaces after parameter type; 1 found

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return ElementQueryInterface

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    protected function getElementQuery(string|ElementInterface $elementType, array $criteria): ElementQueryInterface
    {
        /** @var string|ElementInterface $elementType */

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 = $elementType::find();
        Craft::configure($query, $criteria);

        return $query;
    }
}