<?php

/**
 * @package     Joomla.Administrator
 * @subpackage  com_finder
 *
 * @copyright   (C) 2011 Open Source Matters, Inc. <https://www.joomla.org>
 * @license     GNU General Public License version 2 or later; see LICENSE.txt
 */

namespace Joomla\Component\Finder\Administrator\Service\HTML;

use Joomla\CMS\Factory;
use Joomla\CMS\Language\Text;
use Joomla\Component\Finder\Administrator\Helper\LanguageHelper;
use Joomla\Component\Finder\Administrator\Indexer\Query as IndexerQuery;

// phpcs:disable PSR1.Files.SideEffects
\defined('_JEXEC') or die;
// phpcs:enable PSR1.Files.SideEffects

/**
 * Query HTML behavior class for Finder.
 *
 * @since  2.5
 */
class Query
{
    /**
     * Method to get the explained (human-readable) search query.
     *
     * @param   IndexerQuery  $query  A IndexerQuery object to explain.
     *
     * @return  mixed  String if there is data to explain, null otherwise.
     *
     * @since   2.5
     */
    public static function explained(IndexerQuery $query)
    {
        $parts = array();

        // Process the required tokens.
        foreach ($query->included as $token) {
            if ($token->required && (!isset($token->derived) || $token->derived == false)) {
                $parts[] = '<span class="query-required">' . Text::sprintf('COM_FINDER_QUERY_TOKEN_REQUIRED', $token->term) . '</span>';
            }
        }

        // Process the optional tokens.
        foreach ($query->included as $token) {
            if (!$token->required && (!isset($token->derived) || $token->derived == false)) {
                $parts[] = '<span class="query-optional">' . Text::sprintf('COM_FINDER_QUERY_TOKEN_OPTIONAL', $token->term) . '</span>';
            }
        }

        // Process the excluded tokens.
        foreach ($query->excluded as $token) {
            if (!isset($token->derived) || $token->derived === false) {
                $parts[] = '<span class="query-excluded">' . Text::sprintf('COM_FINDER_QUERY_TOKEN_EXCLUDED', $token->term) . '</span>';
            }
        }

        // Process the start date.
        if ($query->date1) {
            $date = Factory::getDate($query->date1)->format(Text::_('DATE_FORMAT_LC'));
            $datecondition = Text::_('COM_FINDER_QUERY_DATE_CONDITION_' . strtoupper($query->when1));
            $parts[] = '<span class="query-start-date">' . Text::sprintf('COM_FINDER_QUERY_START_DATE', $datecondition, $date) . '</span>';
        }

        // Process the end date.
        if ($query->date2) {
            $date = Factory::getDate($query->date2)->format(Text::_('DATE_FORMAT_LC'));
            $datecondition = Text::_('COM_FINDER_QUERY_DATE_CONDITION_' . strtoupper($query->when2));
            $parts[] = '<span class="query-end-date">' . Text::sprintf('COM_FINDER_QUERY_END_DATE', $datecondition, $date) . '</span>';
        }

        // Process the taxonomy filters.
        if (!empty($query->filters)) {
            // Get the filters in the request.
            $t = Factory::getApplication()->input->request->get('t', array(), 'array');

            // Process the taxonomy branches.
            foreach ($query->filters as $branch => $nodes) {
                // Process the taxonomy nodes.
                $lang = Factory::getLanguage();

                foreach ($nodes as $title => $id) {
                    // Translate the title for Types
                    $key = LanguageHelper::branchPlural($title);

                    if ($lang->hasKey($key)) {
                        $title = Text::_($key);
                    }

                    // Don't include the node if it is not in the request.
                    if (!in_array($id, $t)) {
                        continue;
                    }

                    // Add the node to the explanation.
                    $parts[] = '<span class="query-taxonomy">'
                        . Text::sprintf('COM_FINDER_QUERY_TAXONOMY_NODE', $title, Text::_(LanguageHelper::branchSingular($branch)))
                        . '</span>';
                }
            }
        }

        // Build the interpreted query.
        return count($parts) ? implode(Text::_('COM_FINDER_QUERY_TOKEN_GLUE'), $parts) : null;
    }

    /**
     * Method to get the suggested search query.
     *
     * @param   IndexerQuery  $query  A IndexerQuery object.
     *
     * @return  mixed  String if there is a suggestion, false otherwise.
     *
     * @since   2.5
     */
    public static function suggested(IndexerQuery $query)
    {
        $suggested = false;

        // Check if the query input is empty.
        if (empty($query->input)) {
            return $suggested;
        }

        // Check if there were any ignored or included keywords.
        if (count($query->ignored) || count($query->included)) {
            $suggested = $query->input;

            // Replace the ignored keyword suggestions.
            foreach (array_reverse($query->ignored) as $token) {
                if (isset($token->suggestion)) {
                    $suggested = str_ireplace($token->term, $token->suggestion, $suggested);
                }
            }

            // Replace the included keyword suggestions.
            foreach (array_reverse($query->included) as $token) {
                if (isset($token->suggestion)) {
                    $suggested = str_ireplace($token->term, $token->suggestion, $suggested);
                }
            }

            // Check if we made any changes.
            if ($suggested == $query->input) {
                $suggested = false;
            }
        }

        return $suggested;
    }
}