MOBILE-2344 label: Implement label addon

src/addon/mod/label/label.module.ts

@@ -0,0 +1,37 @@
+// (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 { NgModule } from '@angular/core';
+import { AddonModLabelModuleHandler } from './providers/module-handler';
+import { AddonModLabelLinkHandler } from './providers/link-handler';
+import { CoreCourseModuleDelegate } from '../../../core/course/providers/module-delegate';
+import { CoreContentLinksDelegate } from '../../../core/contentlinks/providers/delegate';
+
+@NgModule({
+    declarations: [
+    ],
+    imports: [
+    ],
+    providers: [
+        AddonModLabelModuleHandler,
+        AddonModLabelLinkHandler
+    ]
+})
+export class AddonModLabelModule {
+    constructor(moduleDelegate: CoreCourseModuleDelegate, moduleHandler: AddonModLabelModuleHandler,
+            contentLinksDelegate: CoreContentLinksDelegate, linkHandler: AddonModLabelLinkHandler) {
+        moduleDelegate.registerHandler(moduleHandler);
+        contentLinksDelegate.registerHandler(linkHandler);
+    }
+}

src/addon/mod/label/providers/link-handler.ts

@@ -0,0 +1,29 @@
+// (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 } from '@angular/core';
+import { CoreContentLinksModuleIndexHandler } from '../../../../core/contentlinks/classes/module-index-handler';
+import { CoreCourseHelperProvider } from '../../../../core/course/providers/helper';
+
+/**
+ * Handler to treat links to label.
+ */
+@Injectable()
+export class AddonModLabelLinkHandler extends CoreContentLinksModuleIndexHandler {
+    name = 'AddonModLabelLinkHandler';
+
+    constructor(courseHelper: CoreCourseHelperProvider) {
+        super(courseHelper, 'mmaModLabel', 'label');
+    }
+}

src/addon/mod/label/providers/module-handler.ts

@@ -0,0 +1,68 @@
+// (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 } 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.
+     *
+     * @param {any} course The course object.
+     * @param {any} module The module object.
+     * @return {any} The component to use, undefined if not found.
+     */
+    getMainComponent(course: any, module: any): any {
+        // There's no need to implement this because label cannot be used in singleactivity course format.
+    }
+}

src/app/app.module.ts

@@ -66,6 +66,7 @@ import { CoreUserModule } from '../core/user/user.module';
 import { AddonCalendarModule } from '../addon/calendar/calendar.module';
 import { AddonUserProfileFieldModule } from '../addon/userprofilefield/userprofilefield.module';
 import { AddonFilesModule } from '../addon/files/files.module';
+import { AddonModLabelModule } from '../addon/mod/label/label.module';
 
 // For translate loader. AoT requires an exported function for factories.
 export function createTranslateLoader(http: HttpClient): TranslateHttpLoader {
@@ -103,7 +104,8 @@ export function createTranslateLoader(http: HttpClient): TranslateHttpLoader {
         CoreUserModule,
         AddonCalendarModule,
         AddonUserProfileFieldModule,
-        AddonFilesModule
+        AddonFilesModule,
+        AddonModLabelModule
     ],
     bootstrap: [IonicApp],
     entryComponents: [