Smile-SA/elasticsuite

<?php
/**
 * DISCLAIMER
 *
 * Do not edit or add to this file if you wish to upgrade Smile ElasticSuite to newer
 * versions in the future.
 *
 * @category  Smile
 * @package   Smile\ElasticsuiteAnalytics
 * @author    Aurelien FOUCRET <aurelien.foucret@smile.fr>
 * @copyright 2020 Smile
 * @license   Open Software License ("OSL") v. 3.0
 */
namespace Smile\ElasticsuiteAnalytics\Block\Adminhtml\Search\Usage;

/**
 * Block used to display search terms in the search usage dashboard.
 *
 * @category Smile
 * @package  Smile\ElasticsuiteAnalytics
 */
class SearchTerms extends \Magento\Backend\Block\Template
{
    /**
     * Constant for the max visible terms when the report is first displayed.
     */
    const MAX_VISIBLE_TERMS = 15;

    /**
     * @var \Magento\Search\Model\QueryFactory
     */
    private $queryFactory;

    /**
     * SearchTerms constructor.
     * @param \Magento\Backend\Block\Template\Context $context      Context.
     * @param \Magento\Search\Model\QueryFactory      $queryFactory Query factory.
     * @param array                                   $data         Data.
     */
    public function __construct(
        \Magento\Backend\Block\Template\Context $context,
        \Magento\Search\Model\QueryFactory $queryFactory,
        array $data = []
    ) {
        parent::__construct($context, $data);
        $this->queryFactory = $queryFactory;
    }

    /**
     * Get terms data from the report.
     *
     * @return mixed
     */
    public function getTermsData()
    {
        $data = [];

        try {
            $data = $this->getReport()->getData();
        } catch (\LogicException $e) {
            ;
        }

        foreach ($data as &$value) {
            $value['url'] = $this->getMerchandiserUrl($value['term']);
        }

        return $data;
    }

    /**
     * Return the number of max initially visible terms.
     *
     * @return int
     */
    public function getMaxVisibleTerms()
    {
        return self::MAX_VISIBLE_TERMS;
    }

    /**
     * Get the term merchandiser URL for a given search term.
     *
     * @param string $term Search term.
     *
     * @return null|string
     */
    private function getMerchandiserUrl($term)
    {
        $url = null;

        $query = $this->queryFactory->create();
        $query->loadByQueryText($term);
        if ($query->getId()) {
            $url = $this->getUrl('search/term/edit', ['id' => $query->getId()]);
        }

        return $url;
    }
}