<?php
/**
 * Global search module for calendar.
 *
 * @author      Thomas Hackl <thomas.hackl@uni-passau.de>
 * @license     http://www.gnu.org/licenses/gpl-2.0.html GPL version 2
 * @category    Stud.IP
 * @since       4.1
 */
class GlobalSearchCalendar extends GlobalSearchModule
{
    /**
     * Returns the displayname for this module
     *
     * @return string
     */
    public static function getName()
    {
        return _('Termine');
    }

    /**
     * Returns the URL that can be called for a full search.
     *
     * @param string $searchterm what to search for?
     * @return string URL to the full search, containing the searchterm and the category
     */
    public static function getSearchURL($searchterm)
    {
        return URLHelper::getURL('dispatch.php/search/globalsearch', [
            'q'        => $searchterm,
            'category' => self::class
        ], true);
    }

    /**
     * Transforms the search request into an sql statement, that provides the id (same as getId) as type and
     * the object id, that is later passed to the filter.
     *
     * This function is required to make use of the mysql union parallelism
     *
     * @param string $search the input query string
     * @param array $filter an array with search limiting filter information (e.g. 'category', 'semester', etc.)
     * @return string SQL Query to discover elements for the search
     */
    public static function getSQL($search, $filter, $limit)
    {
        $time    = strtotime($search);

        if ($time === false) {
            return '';
        }

        $endtime = $time + 24 * 60 * 60;
        $user_id = DBManager::get()->quote($GLOBALS['user']->id);

        return "SELECT SQL_CALC_FOUND_ROWS `date`, `end_time`, `seminar_id`
                FROM `termine`
                JOIN `seminar_user` ON (`range_id` = `seminar_id`)
                WHERE `user_id` = {$user_id}
                  AND `date` BETWEEN {$time} AND {$endtime}
                ORDER BY `date`
                LIMIT " . $limit;
    }

    /**
     * Returns an array of information for the found element. Following informations (key: description) are necessary
     *
     * - name: The name of the object
     * - url: The url to send the user to when he clicks the link
     *
     * Additional informations are:
     *
     * - additional: Subtitle for the hit
     * - expand: Url if the user further expands the search
     * - img: Avatar for the
     *
     * @param array $termin
     * @param string $search
     * @return array
     */
    public static function filter($termin, $search)
    {
        $additional  = strftime('%H:%M', $termin['date']) . ' - ';
        $additional .= strftime('%H:%M', $termin['end_time']) . ', ';
        $additional .= strftime('%x', $termin['date']);

        return [
            'name'       => $additional,
            'url'        => URLHelper::getURL(
                'dispatch.php/course/details',
                [
                    'cid' => $termin['seminar_id']
                ]
            ),
            'img'        => Icon::create('schedule')->asImagePath(),
            'additional' => '',
            'expand'     => self::getSearchURL($search),
        ];
    }
}