This repository has been archived on 2026-07-19. You can view files and clone it. You cannot open issues or pull requests or push a commit.
Files
espocrm-base/client/src/views/fields/link-parent.js
T
Yuri Kuznetsov 8a4fd72261 ref
2023-06-15 14:09:38 +03:00

706 lines
19 KiB
JavaScript

/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM - Open Source CRM application.
* Copyright (C) 2014-2023 Yurii Kuznietsov, Taras Machyshyn, Oleksii Avramenko
* Website: https://www.espocrm.com
*
* EspoCRM is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* EspoCRM is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with EspoCRM. If not, see http://www.gnu.org/licenses/.
*
* The interactive user interfaces in modified source and object code versions
* of this program must display Appropriate Legal Notices, as required under
* Section 5 of the GNU General Public License version 3.
*
* In accordance with Section 7(b) of the GNU General Public License version 3,
* these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
************************************************************************/
/** @module views/fields/link-parent */
import BaseFieldView from 'views/fields/base';
import RecordModal from 'helpers/record-modal';
import Select from 'ui/select';
/**
* A link-parent field (belongs-to-parent relation).
*/
class LinkParentFieldView extends BaseFieldView {
type = 'linkParent'
listTemplate = 'fields/link-parent/list'
detailTemplate = 'fields/link-parent/detail'
editTemplate = 'fields/link-parent/edit'
searchTemplate = 'fields/link-parent/search'
listLinkTemplate = 'fields/link-parent/list-link'
/**
* A name attribute name.
*
* @type {string}
*/
nameName = null
/**
* An ID attribute name.
*
* @type {string}
*/
idName = null
/**
* A type attribute name.
*
* @type {string}
*/
typeName = null
/**
* A current foreign entity type.
*
* @type {string|null}
*/
foreignScope = null
/**
* A foreign entity type list.
*
* @type {string[]}
*/
foreignScopeList = null
/**
* Autocomplete disabled.
*
* @protected
* @type {boolean}
*/
autocompleteDisabled = false
/**
* A select-record view.
*
* @protected
* @type {string}
*/
selectRecordsView = 'views/modals/select-records'
/**
* Create disabled.
*
* @protected
* @type {boolean}
*/
createDisabled = false
/**
* A search type list.
*
* @protected
* @type {string[]}
*/
searchTypeList = [
'is',
'isEmpty',
'isNotEmpty',
]
/**
* A select primary filter.
*
* @protected
* @type {string|null}
*/
selectPrimaryFilterName = null
/**
* A select bool filter list.
*
* @protected
* @type {string[]|null}
*/
selectBoolFilterList = null
/**
* An autocomplete max record number.
*
* @protected
* @type {number|null}
*/
autocompleteMaxCount = null
/**
* Select all attributes.
*
* @protected
* @type {boolean}
*/
forceSelectAllAttributes = false
/**
* Mandatory select attributes.
*
* @protected
* @type {string[]|null}
*/
mandatorySelectAttributeList = null
/** @inheritDoc */
initialSearchIsNotIdle = true
/** @inheritDoc */
events = {
/** @this LinkParentFieldView */
'auxclick a[href]:not([role="button"])': function (e) {
if (!this.isReadMode()) {
return;
}
let isCombination = e.button === 1 && (e.ctrlKey || e.metaKey);
if (!isCombination) {
return;
}
e.preventDefault();
e.stopPropagation();
this.quickView();
},
}
data() {
let nameValue = this.model.get(this.nameName);
if (!nameValue && this.model.get(this.idName) && this.model.get(this.typeName)) {
nameValue = this.translate(this.model.get(this.typeName), 'scopeNames');
}
let iconHtml = null;
if (
(
this.mode === this.MODE_DETAIL ||
this.mode === this.MODE_LIST && this.displayScopeColorInListMode
) &&
this.foreignScope
) {
iconHtml = this.getHelper().getScopeColorIconHtml(this.foreignScope);
}
return {
...super.data(),
idName: this.idName,
nameName: this.nameName,
typeName: this.typeName,
idValue: this.model.get(this.idName),
nameValue: nameValue,
typeValue: this.model.get(this.typeName),
foreignScope: this.foreignScope,
foreignScopeList: this.foreignScopeList,
valueIsSet: this.model.has(this.idName) || this.model.has(this.typeName),
iconHtml: iconHtml,
displayEntityType: this.displayEntityType && this.model.get(this.typeName),
};
}
/**
* Get advanced filters (field filters) to be applied when select a record.
* Can be extended.
*
* @protected
* @return {Object.<string,module:search-manager~advancedFilter>|null}
*/
getSelectFilters() {
return null;
}
/**
* Get a select bool filter list. Applied when select a record.
* Can be extended.
*
* @protected
* @return {string[]|null}
*/
getSelectBoolFilterList() {
return this.selectBoolFilterList;
}
/**
* Get a select primary filter. Applied when select a record.
* Can be extended.
*
* @protected
* @return {string|null}
*/
getSelectPrimaryFilterName() {
return this.selectPrimaryFilterName;
}
/**
* Attributes to pass to a model when creating a new record.
* Can be extended.
*
* @return {Object.<string,*>|null}
*/
getCreateAttributes() {
return null;
}
/** @inheritDoc */
setup() {
this.nameName = this.name + 'Name';
this.typeName = this.name + 'Type';
this.idName = this.name + 'Id';
this.foreignScopeList = this.options.foreignScopeList || this.foreignScopeList;
this.foreignScopeList = this.foreignScopeList ||
this.params.entityList ||
this.model.getLinkParam(this.name, 'entityList') || [];
this.foreignScopeList = Espo.Utils.clone(this.foreignScopeList).filter(item => {
if (!this.getMetadata().get(['scopes', item, 'disabled'])) {
return true;
}
});
this.foreignScope = this.model.get(this.typeName) || this.foreignScopeList[0];
if (this.foreignScope && !~this.foreignScopeList.indexOf(this.foreignScope)) {
this.foreignScopeList.unshift(this.foreignScope);
}
this.listenTo(this.model, 'change:' + this.typeName, () => {
this.foreignScope = this.model.get(this.typeName) || this.foreignScopeList[0];
});
if ('createDisabled' in this.options) {
this.createDisabled = this.options.createDisabled;
}
if (!this.isListMode()) {
this.addActionHandler('selectLink', () => {
Espo.Ui.notify(' ... ');
let viewName = this.getMetadata()
.get('clientDefs.' + this.foreignScope + '.modalViews.select') ||
this.selectRecordsView;
let createButton = !this.createDisabled && this.isEditMode();
this.createView('dialog', viewName, {
scope: this.foreignScope,
createButton: createButton,
filters: this.getSelectFilters(),
boolFilterList: this.getSelectBoolFilterList(),
primaryFilterName: this.getSelectPrimaryFilterName(),
createAttributes: createButton ? this.getCreateAttributes() : null,
mandatorySelectAttributeList: this.getMandatorySelectAttributeList(),
forceSelectAllAttributes: this.isForceSelectAllAttributes(),
}, dialog => {
dialog.render();
Espo.Ui.notify(false);
this.listenToOnce(dialog, 'select', (model) => {
this.clearView('dialog');
this.select(model);
});
});
});
this.addActionHandler('clearLink', () => {
if (this.foreignScopeList.length) {
this.foreignScope = this.foreignScopeList[0];
Select.setValue(this.$elementType, this.foreignScope);
}
this.$elementName.val('');
this.$elementId.val('');
this.trigger('change');
});
this.events['change select[data-name="'+this.typeName+'"]'] = (e) => {
this.foreignScope = e.currentTarget.value;
this.$elementName.val('');
this.$elementId.val('');
};
}
}
/** @inheritDoc */
setupSearch() {
let type = this.getSearchParamsData().type;
if (type === 'is' || !type) {
this.searchData.idValue = this.getSearchParamsData().idValue ||
this.searchParams.valueId;
this.searchData.nameValue = this.getSearchParamsData().nameValue ||
this.searchParams.valueName;
this.searchData.typeValue = this.getSearchParamsData().typeValue ||
this.searchParams.valueType;
}
this.events['change select.search-type'] = e => {
let type = $(e.currentTarget).val();
this.handleSearchType(type);
};
}
/**
* Handle a search type.
*
* @protected
* @param {string} type A type.
*/
handleSearchType(type) {
if (~['is'].indexOf(type)) {
this.$el.find('div.primary').removeClass('hidden');
} else {
this.$el.find('div.primary').addClass('hidden');
}
}
/**
* Select.
*
* @param {module:model} model A model.
* @protected
*/
select(model) {
this.$elementName.val(model.get('name') || model.id);
this.$elementId.val(model.get('id'));
this.trigger('change');
}
/**
* Attributes to select regardless availability on a list layout.
* Can be extended.
*
* @protected
* @return {string[]|null}
*/
getMandatorySelectAttributeList() {
return this.mandatorySelectAttributeList;
}
/**
* Select all attributes. Can be extended.
*
* @protected
* @return {boolean}
*/
isForceSelectAllAttributes() {
return this.forceSelectAllAttributes;
}
/**
* Get an autocomplete max record number. Can be extended.
*
* @protected
* @return {number}
*/
getAutocompleteMaxCount() {
if (this.autocompleteMaxCount) {
return this.autocompleteMaxCount;
}
return this.getConfig().get('recordsPerPage');
}
/**
* Compose an autocomplete URL. Can be extended.
*
* @protected
* @return {string}
*/
getAutocompleteUrl() {
let url = this.foreignScope + '?maxSize=' + this.getAutocompleteMaxCount();
if (!this.isForceSelectAllAttributes()) {
let select = ['id', 'name'];
if (this.getMandatorySelectAttributeList()) {
select = select.concat(this.getMandatorySelectAttributeList());
}
url += '&select=' + select.join(',');
}
let boolList = this.getSelectBoolFilterList();
if (boolList) {
url += '&' + $.param({'boolFilterList': boolList});
}
let primary = this.getSelectPrimaryFilterName();
if (primary) {
url += '&' + $.param({'primaryFilter': primary});
}
return url;
}
afterRender() {
if (this.isEditMode() || this.isSearchMode()) {
this.$elementId = this.$el.find('input[data-name="' + this.idName + '"]');
this.$elementName = this.$el.find('input[data-name="' + this.nameName + '"]');
this.$elementType = this.$el.find('select[data-name="' + this.typeName + '"]');
this.$elementName.on('change', () => {
if (this.$elementName.val() === '') {
this.$elementName.val('');
this.$elementId.val('');
this.trigger('change');
}
});
this.$elementType.on('change', () => {
this.$elementName.val('');
this.$elementId.val('');
this.trigger('change');
});
this.$elementName.on('blur', e => {
setTimeout(() => {
if (this.mode === this.MODE_EDIT) {
e.currentTarget.value = this.model.get(this.nameName) || '';
}
}, 100);
if (!this.autocompleteDisabled) {
setTimeout(() => this.$elementName.autocomplete('clear'), 300);
}
});
if (!this.autocompleteDisabled) {
this.$elementName.autocomplete({
serviceUrl: (q) => {
return this.getAutocompleteUrl(q);
},
minChars: 1,
paramName: 'q',
noCache: true,
triggerSelectOnValidInput: false,
autoSelectFirst: true,
beforeRender: ($c) => {
if (this.$elementName.hasClass('input-sm')) {
$c.addClass('small');
}
},
formatResult: (suggestion) => {
return this.getHelper().escapeString(suggestion.name);
},
transformResult: (response) => {
response = JSON.parse(response);
let list = [];
response.list.forEach(item => {
list.push({
id: item.id,
name: item.name || item.id,
data: item.id,
value: item.name || item.id,
attributes: item,
});
});
return {suggestions: list};
},
onSelect: (s) => {
this.getModelFactory().create(this.foreignScope, (model) => {
model.set(s.attributes);
this.select(model);
this.$elementName.focus();
});
},
});
this.$elementName.off('focus.autocomplete');
this.$elementName.on('focus', () => this.$elementName.get(0).select());
this.$elementName.attr('autocomplete', 'espo-' + this.name);
Select.init(this.$elementType, {});
}
let $elementName = this.$elementName;
this.once('render', () => {
$elementName.autocomplete('dispose');
});
this.once('remove', () => {
$elementName.autocomplete('dispose');
});
}
if (this.mode === 'search') {
let type = this.$el.find('select.search-type').val();
this.handleSearchType(type);
this.$el.find('select.search-type').on('change', () => {
this.trigger('change');
});
}
}
/** @inheritDoc */
getValueForDisplay() {
return this.model.get(this.nameName);
}
/** @inheritDoc */
validateRequired() {
if (this.isRequired()) {
if (this.model.get(this.idName) === null || !this.model.get(this.typeName)) {
let msg = this.translate('fieldIsRequired', 'messages')
.replace('{field}', this.getLabelText());
this.showValidationMessage(msg);
return true;
}
}
}
/** @inheritDoc */
fetch() {
let data = {};
data[this.typeName] = this.$elementType.val() || null;
data[this.nameName] = this.$elementName.val() || null;
data[this.idName] = this.$elementId.val() || null;
if (data[this.idName] === null) {
data[this.typeName] = null;
}
return data;
}
/** @inheritDoc */
fetchSearch() {
let type = this.$el.find('select.search-type').val();
if (type === 'isEmpty') {
return {
type: 'isNull',
field: this.idName,
data: {
type: type,
}
};
}
if (type === 'isNotEmpty') {
return {
type: 'isNotNull',
field: this.idName,
data: {
type: type,
}
};
}
let entityType = this.$elementType.val();
let entityName = this.$elementName.val()
let entityId = this.$elementId.val();
if (!entityType) {
return null;
}
if (entityId) {
return {
type: 'and',
attribute: this.idName,
value: [
{
type: 'equals',
field: this.idName,
value: entityId,
},
{
type: 'equals',
field: this.typeName,
value: entityType,
}
],
data: {
type: 'is',
idValue: entityId,
nameValue: entityName,
typeValue: entityType,
}
};
}
return {
type: 'and',
attribute: this.idName,
value: [
{
type: 'isNotNull',
field: this.idName,
},
{
type: 'equals',
field: this.typeName,
value: entityType,
}
],
data: {
type: 'is',
typeValue: entityType,
}
};
}
/** @inheritDoc */
getSearchType() {
return this.getSearchParamsData().type || this.searchParams.typeFront;
}
/**
* @protected
*/
quickView() {
let id = this.model.get(this.idName);
let entityType = this.model.get(this.typeName);
if (!id || !entityType) {
return;
}
let helper = new RecordModal(this.getMetadata(), this.getAcl());
helper.showDetail(this, {
id: id,
scope: entityType,
});
}
}
export default LinkParentFieldView;