* @license http://www.gnu.org/licenses/gpl-2.0.html GPL version 2
* @category Stud.IP
* @since 4.1
*/
class GlobalSearchMyCourses extends GlobalSearchModule
{
/**
* Returns the displayname for this module
*
* @return string
*/
public static function getName()
{
return _('Meine Veranstaltungen');
}
/**
* Returns the filters that are displayed in the sidebar of the global search.
*
* @return array Filters for this class.
*/
public static function getFilters()
{
return ['semester', 'institute', 'seminar_type'];
}
/**
* 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)
{
if (!$search) {
return null;
}
// generate SQL for the given sidebar filter (semester, institute, seminar_type)
$semester_join = '';
$institute_condition = '';
$seminar_type_condition = '';
$semester_condition = '';
if ($filter['category'] === self::class || $filter['category'] == 'show_all_categories') {
if (!empty($filter['semester'])) {
if ($filter['semester'] === 'future') {
$semester = Semester::findCurrent();
$next_semester = Semester::findNext();
$semester_ids = [$semester->id];
if ($next_semester) {
$semester_ids[] = $next_semester->id;
}
} else {
$semester = Semester::findByTimestamp($filter['semester']);
$semester_ids = [$semester->id];
}
$semester_join = "LEFT JOIN semester_courses ON (courses.Seminar_id = semester_courses.course_id) ";
$semester_condition = "
AND (
semester_courses.semester_id IS NULL OR semester_courses.semester_id IN (" . join(',', array_map([DBManager::get(), 'quote'], $semester_ids)) . ")
) ";
}
if (!empty($filter['institute'])) {
$institutes = self::getInstituteIdsForSQL($filter['institute']);
$institute_condition = " AND `courses`.`Institut_id` IN (" .DBManager::get()->quote($institutes). ") ";
}
if (!empty($filter['seminar_type'])) {
$seminar_types = self::getSeminarTypesForSQL($filter['seminar_type']);
$seminar_type_condition = " AND `courses`.`status` IN (" .DBManager::get()->quote($seminar_types). ") ";
}
}
$search = str_replace(" ", "% ", $search);
$query = DBManager::get()->quote("%{$search}%");
$user_id = DBManager::get()->quote($GLOBALS['user']->id);
$sql = "SELECT SQL_CALC_FOUND_ROWS courses.*
FROM `seminare` AS courses
JOIN `seminar_user` USING (`Seminar_id`)
JOIN `sem_types` ON (courses.`status` = `sem_types`.`id`)
{$semester_join}
WHERE `user_id` = {$user_id}
AND (courses.`Name` LIKE {$query}
OR courses.`VeranstaltungsNummer` LIKE {$query}
OR CONCAT_WS(' ', `sem_types`.`name`, courses.`Name`) LIKE {$query}
)
{$institute_condition}
{$seminar_type_condition}
{$semester_condition}
GROUP BY courses.Seminar_id
ORDER BY `start_time` DESC
LIMIT " . $limit;
return $sql;
}
/**
* 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 $data
* @param string $search
* @return array
*/
public static function filter($data, $search)
{
$course = Course::buildExisting($data);
$seminar = new Seminar($course);
$turnus_string = $seminar->getDatesExport([
'short' => true,
'shrink' => true,
]);
//Shorten, if string too long (add link for details.php)
if (mb_strlen($turnus_string) > 70) {
$turnus_string = htmlReady(mb_substr($turnus_string, 0, mb_strpos(mb_substr($turnus_string, 70, mb_strlen($turnus_string)), ',') + 71));
$turnus_string .= ' ... (' . _('mehr') . ')';
} else {
$turnus_string = htmlReady($turnus_string);
}
$lecturers = $course->getMembersWithStatus('dozent');
$semester = $course->start_semester;
// If you are not root, perhaps not all available subcourses are visible.
$visibleChildren = $course->children;
if (!$GLOBALS['perm']->have_perm(Config::get()->SEM_VISIBILITY_PERM)) {
$visibleChildren = $visibleChildren->filter(function($c) {
return $c->visible;
});
}
$result_children = [];
foreach($visibleChildren as $child) {
$result_children[] = self::filter($child, $search);
}
$result = [
'id' => $course->id,
'number' => self::mark($course->veranstaltungsnummer, $search),
'name' => self::mark($course->getFullName(), $search),
'url' => URLHelper::getURL('seminar_main.php', ['cid' => $course->id], true),
'date' => htmlReady($semester->short_name),
'dates' => $turnus_string,
'has_children' => count($course->children) > 0,
'children' => $result_children,
'additional' => implode(', ',
array_filter(
array_map(
function ($lecturer, $index) use ($search, $course) {
if ($index < 3) {
return '' . self::mark($lecturer->getUserFullname(), $search) . '';
} else if ($index == 3) {
return '... (' . _('mehr') . ') ';
}
},
$lecturers,
array_keys($lecturers)
)
)
),
'expand' => self::getSearchURL($search),
];
if ($course->getSemClass()->offsetGet('studygroup_mode')) {
$avatar = StudygroupAvatar::getAvatar($course->id);
} else {
$avatar = CourseAvatar::getAvatar($course->id);
}
$result['img'] = $avatar->getUrl(Avatar::MEDIUM);
return $result;
}
/**
* 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
]);
}
}