d98088f6a6
Now site addons can return a ComponentRef instead of the component class in the getComponent functions of the delegates. This means they can create a new component on the fly using CoreCompileProvider.instantiateDynamicComponent
72 lines
2.6 KiB
TypeScript
72 lines
2.6 KiB
TypeScript
// (C) Copyright 2015 Martin Dougiamas
|
|
//
|
|
// 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, Injector } from '@angular/core';
|
|
import { CoreCourseModuleHandler, CoreCourseModuleHandlerData } from '@core/course/providers/module-delegate';
|
|
|
|
/**
|
|
* Handler to support label modules.
|
|
*/
|
|
@Injectable()
|
|
export class AddonModLabelModuleHandler implements CoreCourseModuleHandler {
|
|
name = 'label';
|
|
|
|
constructor() {
|
|
// Nothing to do.
|
|
}
|
|
|
|
/**
|
|
* Check if the handler is enabled on a site level.
|
|
*
|
|
* @return {boolean} Whether or not the handler is enabled on a site level.
|
|
*/
|
|
isEnabled(): boolean | Promise<boolean> {
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Get the data required to display the module in the course contents view.
|
|
*
|
|
* @param {any} module The module object.
|
|
* @param {number} courseId The course ID.
|
|
* @param {number} sectionId The section ID.
|
|
* @return {CoreCourseModuleHandlerData} Data to render the module.
|
|
*/
|
|
getData(module: any, courseId: number, sectionId: number): CoreCourseModuleHandlerData {
|
|
// Remove the description from the module so it isn't rendered twice.
|
|
const title = module.description;
|
|
module.description = '';
|
|
|
|
return {
|
|
icon: '',
|
|
title: title,
|
|
class: 'addon-mod-label-handler'
|
|
};
|
|
}
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @param {Injector} injector Injector.
|
|
* @param {any} course The course object.
|
|
* @param {any} module The module object.
|
|
* @return {any|Promise<any>} The component (or promise resolved with component) to use, undefined if not found.
|
|
*/
|
|
getMainComponent(injector: Injector, course: any, module: any): any | Promise<any> {
|
|
// There's no need to implement this because label cannot be used in singleactivity course format.
|
|
}
|
|
}
|