// (C) Copyright 2015 Moodle Pty Ltd. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. import { Injectable, Type } from '@angular/core'; import { AddonModBookIndexComponent } from '../../components/index'; import { AddonModBook } from '../book'; import { CoreCourse, CoreCourseAnyModuleData } from '@features/course/services/course'; import { CoreNavigationOptions, CoreNavigator } from '@services/navigator'; import { CoreCourseModule } from '@features/course/services/course-helper'; import { CoreConstants } from '@/core/constants'; import { CoreCourseModuleHandler, CoreCourseModuleHandlerData } from '@features/course/services/module-delegate'; import { makeSingleton } from '@singletons'; /** * Handler to support book modules. */ @Injectable({ providedIn: 'root' }) export class AddonModBookModuleHandlerService implements CoreCourseModuleHandler { static readonly PAGE_NAME = 'mod_book'; name = 'AddonModBook'; modName = 'book'; supportedFeatures = { [CoreConstants.FEATURE_MOD_ARCHETYPE]: CoreConstants.MOD_ARCHETYPE_RESOURCE, [CoreConstants.FEATURE_GROUPS]: false, [CoreConstants.FEATURE_GROUPINGS]: false, [CoreConstants.FEATURE_MOD_INTRO]: true, [CoreConstants.FEATURE_COMPLETION_TRACKS_VIEWS]: true, [CoreConstants.FEATURE_GRADE_HAS_GRADE]: false, [CoreConstants.FEATURE_GRADE_OUTCOMES]: false, [CoreConstants.FEATURE_BACKUP_MOODLE2]: true, [CoreConstants.FEATURE_SHOW_DESCRIPTION]: true, }; /** * Check if the handler is enabled on a site level. * * @return Whether or not the handler is enabled on a site level. */ isEnabled(): Promise { return AddonModBook.instance.isPluginEnabled(); } /** * Get the data required to display the module in the course contents view. * * @param module The module object. * @param courseId The course ID. * @param sectionId The section ID. * @return Data to render the module. */ getData(module: CoreCourseAnyModuleData): CoreCourseModuleHandlerData { return { icon: CoreCourse.instance.getModuleIconSrc(this.modName, 'modicon' in module ? module.modicon : undefined), title: module.name, class: 'addon-mod_book-handler', showDownloadButton: true, action(event: Event, module: CoreCourseModule, courseId: number, options?: CoreNavigationOptions): void { options = options || {}; options.params = options.params || {}; Object.assign(options.params, { module }); const routeParams = '/' + courseId + '/' + module.id; CoreNavigator.instance.navigateToSitePath(AddonModBookModuleHandlerService.PAGE_NAME + routeParams, options); }, }; } /** * Get the component to render the module. This is needed to support singleactivity course format. * The component returned must implement CoreCourseModuleMainComponent. * It's recommended to return the class of the component, but you can also return an instance of the component. * * @return The component (or promise resolved with component) to use, undefined if not found. */ async getMainComponent(): Promise | undefined> { return AddonModBookIndexComponent; } } export class AddonModBookModuleHandler extends makeSingleton(AddonModBookModuleHandlerService) {}