forked from CIT/Vmeda.Online
57 lines
1.9 KiB
TypeScript
57 lines
1.9 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 { Injector } from '@angular/core';
|
|
import { CoreBlockHandler, CoreBlockHandlerData } from '../providers/delegate';
|
|
|
|
/**
|
|
* Base handler for blocks.
|
|
*
|
|
* This class is needed because parent classes cannot have @Injectable in Angular v6, so the default handler cannot be a
|
|
* parent class.
|
|
*/
|
|
export class CoreBlockBaseHandler implements CoreBlockHandler {
|
|
name = 'CoreBlockBase';
|
|
blockName = 'base';
|
|
|
|
constructor() {
|
|
// Nothing to do.
|
|
}
|
|
|
|
/**
|
|
* Whether or not the handler is enabled on a site level.
|
|
*
|
|
* @return {boolean|Promise<boolean>} True or promise resolved with true if enabled.
|
|
*/
|
|
isEnabled(): boolean | Promise<boolean> {
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Returns the data needed to render the block.
|
|
*
|
|
* @param {Injector} injector Injector.
|
|
* @param {any} block The block to render.
|
|
* @param {string} contextLevel The context where the block will be used.
|
|
* @param {number} instanceId The instance ID associated with the context level.
|
|
* @return {CoreBlockHandlerData|Promise<CoreBlockHandlerData>} Data or promise resolved with the data.
|
|
*/
|
|
getDisplayData?(injector: Injector, block: any, contextLevel: string, instanceId: number)
|
|
: CoreBlockHandlerData | Promise<CoreBlockHandlerData> {
|
|
|
|
// To be overridden.
|
|
return;
|
|
}
|
|
}
|