Merge pull request #8475 from christianbeeznest/fixes-plugin-searchcourse01

Plugin: Improve SearchCourse plugin integration

Author: christianbeeznest

public/main/admin/settings.lib.php

@@ -333,6 +333,7 @@ function getStablePluginAllowList(): array
         'UserRemoteService',
         'MigrationMoodle',
         'EmbedRegistry',
+        'SearchCourse',
     ];
 }
 

public/plugin/SearchCourse/README.md

@@ -1,4 +1,14 @@
 Search courses plugin
 ===
 
-Search courses in the main catalogue and register.
+This plugin provides a course catalogue search page and can also be rendered as a portal/home block through Chamilo plugin regions.
+
+Usage
+---
+
+1. Install and activate the plugin.
+2. Go to `Administration > Settings > Plugins > Plugin regions`.
+3. Assign `SearchCourse` to a visible region such as `content_top`, `main_top` or `main_bottom`.
+4. The region renders a search box. Submitting the form opens `/plugin/SearchCourse/index.php` with the search results.
+
+The plugin does not create a course tool because it searches courses globally. It should be used as a portal/home block, not inside a specific course.

public/plugin/SearchCourse/index.php

@@ -1,4 +1,55 @@
 <?php
+/* For licensing terms, see /license.txt */
 
-$widget = new SearchCourseWidget();
-$widget->run();
+if (!function_exists('api_get_path')) {
+    require_once __DIR__.'/../../main/inc/global.inc.php';
+}
+
+require_once __DIR__.'/lib/search_course_plugin.class.php';
+require_once __DIR__.'/lib/register_course_widget.class.php';
+require_once __DIR__.'/lib/search_course_widget.class.php';
+
+$plugin = SearchCoursePlugin::create();
+$widget = SearchCourseWidget::factory();
+
+$isDirectRequest = isset($_SERVER['SCRIPT_FILENAME'])
+    && realpath((string) $_SERVER['SCRIPT_FILENAME']) === realpath(__FILE__);
+
+$isRenderingOwnFullPage = defined('SEARCH_COURSE_FULL_PAGE_RENDERING')
+    && SEARCH_COURSE_FULL_PAGE_RENDERING;
+
+if (!$plugin->isEnabled()) {
+    if ($isDirectRequest && !$isRenderingOwnFullPage) {
+        api_not_allowed(true);
+    }
+
+    return;
+}
+
+if ($isRenderingOwnFullPage) {
+    return;
+}
+
+if (!$isDirectRequest) {
+    echo $widget->renderBlock();
+
+    return;
+}
+
+define('SEARCH_COURSE_FULL_PAGE_RENDERING', true);
+
+$content = '
+    <style>
+        body.search-course-full-page [data-search-course-region-block="1"] {
+            display: none !important;
+        }
+    </style>
+    <script>
+        document.body.classList.add("search-course-full-page");
+    </script>';
+$content .= $widget->run();
+
+$template = new Template($plugin->get_title());
+$template->assign('header', $plugin->get_title());
+$template->assign('content', $content);
+$template->display_one_col_template();

public/plugin/SearchCourse/lang/en_US.php

@@ -1,8 +1,18 @@
 <?php
-/**
- * @copyright (c) 2012 University of Geneva
- * @license GNU General Public License - http://www.gnu.org/copyleft/gpl.html
- * @author Laurent Opprecht <laurent@opprecht.info>
- */
+/* For licensing terms, see /license.txt */
+
 $strings['plugin_title'] = 'Search Course';
-$strings['plugin_comment'] = 'Allow to search the course catalog and register to courses.';
+$strings['plugin_comment'] = 'Allow users to search the course catalog and subscribe to available courses.';
+$strings['CourseCatalog'] = 'Course catalog';
+$strings['Search courses'] = 'Search courses';
+$strings['SearchCourseIntro'] = 'Search public and available platform courses by title, code or teacher.';
+$strings['SearchByCourseTitleCodeOrTeacher'] = 'Course title, code or teacher';
+$strings['SearchResults'] = 'Search results';
+$strings['Search results for:'] = 'Search results for: %s';
+$strings['CoursesFound'] = '%d course(s) found.';
+$strings['Already subscribed'] = 'Already subscribed';
+$strings['Subscribing not allowed'] = 'Subscribing not allowed';
+$strings['Public'] = 'Public';
+$strings['PlatformUsers'] = 'Platform users';
+$strings['RegistrationAllowed'] = 'Registration allowed';
+$strings['SearchCourseRegionHelp'] = 'Type a keyword to open the course search page with matching results.';

public/plugin/SearchCourse/lang/es.php

@@ -1,8 +1,18 @@
 <?php
-/**
- * @copyright (c) 2012 University of Geneva
- * @license GNU General Public License - http://www.gnu.org/copyleft/gpl.html
- * @author Laurent Opprecht <laurent@opprecht.info>
- */
+/* For licensing terms, see /license.txt */
+
 $strings['plugin_title'] = 'Buscar curso';
-$strings['plugin_comment'] = 'Permite buscar en el catálogo de cursos e inscribirse en cursos.';
+$strings['plugin_comment'] = 'Permite a los usuarios buscar en el catálogo de cursos e inscribirse en cursos disponibles.';
+$strings['CourseCatalog'] = 'Catálogo de cursos';
+$strings['Search courses'] = 'Buscar cursos';
+$strings['SearchCourseIntro'] = 'Busca cursos públicos y disponibles de la plataforma por título, código o profesor.';
+$strings['SearchByCourseTitleCodeOrTeacher'] = 'Título, código o profesor del curso';
+$strings['SearchResults'] = 'Resultados de búsqueda';
+$strings['Search results for:'] = 'Resultados de búsqueda para: %s';
+$strings['CoursesFound'] = '%d curso(s) encontrado(s).';
+$strings['Already subscribed'] = 'Ya inscrito';
+$strings['Subscribing not allowed'] = 'Inscripción no permitida';
+$strings['Public'] = 'Público';
+$strings['PlatformUsers'] = 'Usuarios de la plataforma';
+$strings['RegistrationAllowed'] = 'Inscripción permitida';
+$strings['SearchCourseRegionHelp'] = 'Escribe una palabra clave para abrir la página de búsqueda de cursos con resultados relacionados.';