2018-01-16 15:52:07 +01:00
|
|
|
// (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.
|
|
|
|
|
2018-03-02 15:25:00 +01:00
|
|
|
import { Injectable, Injector } from '@angular/core';
|
2018-03-01 16:55:49 +01:00
|
|
|
import { CoreDelegate, CoreDelegateHandler } from '@classes/delegate';
|
|
|
|
import { CoreLoggerProvider } from '@providers/logger';
|
|
|
|
import { CoreSitesProvider } from '@providers/sites';
|
|
|
|
import { CoreEventsProvider } from '@providers/events';
|
2018-01-16 15:52:07 +01:00
|
|
|
|
2018-01-29 10:05:20 +01:00
|
|
|
export interface CoreUserProfileFieldHandler extends CoreDelegateHandler {
|
2018-01-16 15:52:07 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Return the Component to use to display the user profile field.
|
2018-03-02 15:25:00 +01:00
|
|
|
* It's recommended to return the class of the component, but you can also return an instance of the component.
|
2018-01-16 15:52:07 +01:00
|
|
|
*
|
2018-03-02 15:25:00 +01:00
|
|
|
* @param {Injector} injector Injector.
|
|
|
|
* @return {any|Promise<any>} The component (or promise resolved with component) to use, undefined if not found.
|
2018-01-16 15:52:07 +01:00
|
|
|
*/
|
2018-03-02 15:25:00 +01:00
|
|
|
getComponent(injector: Injector): any | Promise<any>;
|
2018-01-16 15:52:07 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the data to send for the field based on the input data.
|
|
|
|
* @param {any} field User field to get the data for.
|
|
|
|
* @param {boolean} signup True if user is in signup page.
|
|
|
|
* @param {string} [registerAuth] Register auth method. E.g. 'email'.
|
2018-01-18 16:38:41 +01:00
|
|
|
* @param {any} formValues Form Values.
|
2018-01-16 15:52:07 +01:00
|
|
|
* @return {Promise<CoreUserProfileFieldHandlerData>|CoreUserProfileFieldHandlerData} Data to send for the field.
|
|
|
|
*/
|
2018-01-18 16:38:41 +01:00
|
|
|
getData?(field: any, signup: boolean, registerAuth: string, formValues: any):
|
2018-01-16 15:52:07 +01:00
|
|
|
Promise<CoreUserProfileFieldHandlerData> | CoreUserProfileFieldHandlerData;
|
2018-01-29 10:05:20 +01:00
|
|
|
}
|
2018-01-16 15:52:07 +01:00
|
|
|
|
|
|
|
export interface CoreUserProfileFieldHandlerData {
|
|
|
|
/**
|
|
|
|
* Name to display.
|
|
|
|
* @type {string}
|
|
|
|
*/
|
|
|
|
name: string;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Field type.
|
|
|
|
* @type {string}
|
|
|
|
*/
|
|
|
|
type?: string;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Value of the field.
|
|
|
|
* @type {any}
|
|
|
|
*/
|
|
|
|
value: any;
|
2018-01-29 10:05:20 +01:00
|
|
|
}
|
2018-01-16 15:52:07 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Service to interact with user profile fields. Provides functions to register a plugin.
|
|
|
|
*/
|
|
|
|
@Injectable()
|
|
|
|
export class CoreUserProfileFieldDelegate extends CoreDelegate {
|
2018-01-29 10:05:20 +01:00
|
|
|
protected handlers: { [s: string]: CoreUserProfileFieldHandler } = {};
|
|
|
|
protected enabledHandlers: { [s: string]: CoreUserProfileFieldHandler } = {};
|
2018-01-16 15:52:07 +01:00
|
|
|
|
|
|
|
constructor(protected loggerProvider: CoreLoggerProvider, protected sitesProvider: CoreSitesProvider,
|
|
|
|
protected eventsProvider: CoreEventsProvider) {
|
|
|
|
super('CoreUserProfileFieldDelegate', loggerProvider, sitesProvider, eventsProvider);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the component to use to display an user field.
|
|
|
|
*
|
2018-03-02 15:25:00 +01:00
|
|
|
* @param {Injector} injector Injector.
|
2018-01-16 15:52:07 +01:00
|
|
|
* @param {any} field User field to get the directive for.
|
|
|
|
* @param {boolean} signup True if user is in signup page.
|
2018-03-02 15:25:00 +01:00
|
|
|
* @return {Promise<any>} Promise resolved with component to use, undefined if not found.
|
2018-01-16 15:52:07 +01:00
|
|
|
*/
|
2018-03-02 15:25:00 +01:00
|
|
|
getComponent(injector: Injector, field: any, signup: boolean): Promise<any> {
|
2018-01-29 10:05:20 +01:00
|
|
|
const type = field.type || field.datatype;
|
2018-03-02 15:25:00 +01:00
|
|
|
let result;
|
2018-01-18 16:38:41 +01:00
|
|
|
if (signup) {
|
2018-03-02 15:25:00 +01:00
|
|
|
result = this.executeFunction(type, 'getComponent', [injector]);
|
2018-01-18 16:38:41 +01:00
|
|
|
} else {
|
2018-03-02 15:25:00 +01:00
|
|
|
result = this.executeFunctionOnEnabled(type, 'getComponent', [injector]);
|
2018-01-18 16:38:41 +01:00
|
|
|
}
|
2018-03-02 15:25:00 +01:00
|
|
|
|
|
|
|
return Promise.resolve(result).catch((err) => {
|
|
|
|
this.logger.error('Error getting component for field', type, err);
|
|
|
|
});
|
2018-01-16 15:52:07 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the data to send for a certain field based on the input data.
|
|
|
|
*
|
|
|
|
* @param {any} field User field to get the data for.
|
|
|
|
* @param {boolean} signup True if user is in signup page.
|
|
|
|
* @param {string} registerAuth Register auth method. E.g. 'email'.
|
2018-01-18 16:38:41 +01:00
|
|
|
* @param {any} formValues Form values.
|
2018-01-16 15:52:07 +01:00
|
|
|
* @return {Promise<any>} Data to send for the field.
|
|
|
|
*/
|
2018-01-18 16:38:41 +01:00
|
|
|
getDataForField(field: any, signup: boolean, registerAuth: string, formValues: any): Promise<any> {
|
2018-01-29 10:05:20 +01:00
|
|
|
const type = field.type || field.datatype,
|
2018-02-01 10:14:47 +01:00
|
|
|
handler = <CoreUserProfileFieldHandler> this.getHandler(type, !signup);
|
|
|
|
|
2018-01-16 15:52:07 +01:00
|
|
|
if (handler) {
|
2018-01-29 10:05:20 +01:00
|
|
|
const name = 'profile_field_' + field.shortname;
|
2018-01-16 15:52:07 +01:00
|
|
|
if (handler.getData) {
|
2018-01-18 16:38:41 +01:00
|
|
|
return Promise.resolve(handler.getData(field, signup, registerAuth, formValues));
|
|
|
|
} else if (field.shortname && typeof formValues[name] != 'undefined') {
|
|
|
|
// Handler doesn't implement the function, but the form has data for the field.
|
2018-01-16 15:52:07 +01:00
|
|
|
return Promise.resolve({
|
2018-01-18 16:38:41 +01:00
|
|
|
type: type,
|
2018-01-16 15:52:07 +01:00
|
|
|
name: name,
|
2018-01-18 16:38:41 +01:00
|
|
|
value: formValues[name]
|
2018-01-16 15:52:07 +01:00
|
|
|
});
|
|
|
|
}
|
|
|
|
}
|
2018-01-29 10:05:20 +01:00
|
|
|
|
2018-01-16 15:52:07 +01:00
|
|
|
return Promise.reject(null);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the data to send for a list of fields based on the input data.
|
|
|
|
*
|
|
|
|
* @param {any[]} fields User fields to get the data for.
|
|
|
|
* @param {boolean} [signup] True if user is in signup page.
|
|
|
|
* @param {string} [registerAuth] Register auth method. E.g. 'email'.
|
2018-01-18 16:38:41 +01:00
|
|
|
* @param {any} formValues Form values.
|
2018-01-16 15:52:07 +01:00
|
|
|
* @return {Promise<any>} Data to send.
|
|
|
|
*/
|
2018-01-29 10:05:20 +01:00
|
|
|
getDataForFields(fields: any[], signup: boolean = false, registerAuth: string = '', formValues: any): Promise<any> {
|
|
|
|
const result = [],
|
2018-01-16 15:52:07 +01:00
|
|
|
promises = [];
|
|
|
|
|
|
|
|
fields.forEach((field) => {
|
2018-01-18 16:38:41 +01:00
|
|
|
promises.push(this.getDataForField(field, signup, registerAuth, formValues).then((data) => {
|
|
|
|
if (data) {
|
|
|
|
result.push(data);
|
|
|
|
}
|
2018-01-16 15:52:07 +01:00
|
|
|
}).catch(() => {
|
|
|
|
// Ignore errors.
|
2018-01-18 16:38:41 +01:00
|
|
|
}));
|
2018-01-16 15:52:07 +01:00
|
|
|
});
|
|
|
|
|
|
|
|
return Promise.all(promises).then(() => {
|
|
|
|
return result;
|
|
|
|
});
|
|
|
|
}
|
|
|
|
}
|