forked from CIT/Vmeda.Online
107 lines
4.2 KiB
TypeScript
107 lines
4.2 KiB
TypeScript
// (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 { CoreContentLinksHandlerBase } from './base-handler';
|
|
import { Params } from '@angular/router';
|
|
import { CoreContentLinksAction } from '../services/contentlinks-delegate';
|
|
|
|
/**
|
|
* Handler to handle URLs pointing to the index of a module.
|
|
*/
|
|
export class CoreContentLinksModuleIndexHandler extends CoreContentLinksHandlerBase {
|
|
|
|
/**
|
|
* If this boolean is set to true, the app will retrieve all modules with this modName with a single WS call.
|
|
* This reduces the number of WS calls, but it isn't recommended for modules that can return a lot of contents.
|
|
*/
|
|
protected useModNameToGetModule = false;
|
|
|
|
/**
|
|
* Construct the handler.
|
|
*
|
|
* @param addon Name of the addon as it's registered in course delegate. It'll be used to check if it's disabled.
|
|
* @param modName Name of the module (assign, book, ...).
|
|
* @param instanceIdParam Param name for instance ID gathering. Only if set.
|
|
*/
|
|
constructor(
|
|
public addon: string,
|
|
public modName: string,
|
|
protected instanceIdParam?: string,
|
|
) {
|
|
super();
|
|
|
|
const pattern = instanceIdParam ?
|
|
'/mod/' + modName + '/view.php.*([&?](' + instanceIdParam + '|id)=\\d+)' :
|
|
'/mod/' + modName + '/view.php.*([&?]id=\\d+)';
|
|
|
|
// Match the view.php URL with an id param.
|
|
this.pattern = new RegExp(pattern);
|
|
this.featureName = 'CoreCourseModuleDelegate_' + addon;
|
|
}
|
|
|
|
/**
|
|
* Get the mod params necessary to open an activity.
|
|
*
|
|
* @param url The URL to treat.
|
|
* @param params The params of the URL. E.g. 'mysite.com?id=1' -> {id: 1}
|
|
* @param courseId Course ID related to the URL. Optional but recommended.
|
|
* @return List of params to pass to navigateToModule / navigateToModuleByInstance.
|
|
*/
|
|
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
getPageParams(url: string, params: Params, courseId?: number): Params {
|
|
return [];
|
|
}
|
|
|
|
/**
|
|
* Get the list of actions for a link (url).
|
|
*
|
|
* @param siteIds List of sites the URL belongs to.
|
|
* @param url The URL to treat.
|
|
* @param params The params of the URL. E.g. 'mysite.com?id=1' -> {id: 1}
|
|
* @param courseId Course ID related to the URL. Optional but recommended.
|
|
* @return List of (or promise resolved with list of) actions.
|
|
*/
|
|
getActions(
|
|
siteIds: string[], // eslint-disable-line @typescript-eslint/no-unused-vars
|
|
url: string, // eslint-disable-line @typescript-eslint/no-unused-vars
|
|
params: Params, // eslint-disable-line @typescript-eslint/no-unused-vars
|
|
courseId?: number, // eslint-disable-line @typescript-eslint/no-unused-vars
|
|
): CoreContentLinksAction[] | Promise<CoreContentLinksAction[]> {
|
|
return [];
|
|
/*
|
|
courseId = courseId || params.courseid || params.cid;
|
|
const pageParams = this.getPageParams(url, params, courseId);
|
|
|
|
if (this.instanceIdParam && typeof params[this.instanceIdParam] != 'undefined') {
|
|
const instanceId = parseInt(params[this.instanceIdParam], 10);
|
|
|
|
return [{
|
|
action: (siteId): void => {
|
|
this.courseHelper.navigateToModuleByInstance(instanceId, this.modName, siteId, courseId, undefined,
|
|
this.useModNameToGetModule, pageParams);
|
|
},
|
|
}];
|
|
}
|
|
|
|
return [{
|
|
action: (siteId): void => {
|
|
this.courseHelper.navigateToModule(parseInt(params.id, 10), siteId, courseId, undefined,
|
|
this.useModNameToGetModule ? this.modName : undefined, pageParams);
|
|
},
|
|
}];
|
|
*/
|
|
}
|
|
|
|
}
|