opportunity contact role converter

This commit is contained in:
Yuri Kuznetsov
2023-07-13 14:16:49 +03:00
parent b80fb7c817
commit ec0303ab09
3 changed files with 158 additions and 139 deletions
@@ -0,0 +1,144 @@
<?php
/************************************************************************
* 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.
************************************************************************/
namespace Espo\Classes\FieldConverters;
use Espo\Core\Utils\Database\Orm\Defs\AttributeDefs;
use Espo\Core\Utils\Database\Orm\Defs\EntityDefs;
use Espo\Core\Utils\Database\Orm\FieldConverter;
use Espo\ORM\Defs\FieldDefs;
use Espo\ORM\Type\AttributeType;
use RuntimeException;
class RelationshipRole implements FieldConverter
{
public function convert(FieldDefs $fieldDefs, string $entityType): EntityDefs
{
$name = $fieldDefs->getName();
$attributeDefs = AttributeDefs::create($name)
->withType(AttributeType::VARCHAR)
->withNotStorable();
$attributeDefs = $this->addWhere($attributeDefs, $fieldDefs);
return EntityDefs::create()
->withAttribute($attributeDefs);
}
private function addWhere(AttributeDefs $attributeDefs, FieldDefs $fieldDefs): AttributeDefs
{
$data = $fieldDefs->getParam('converterData');
if (!is_array($data)) {
throw new RuntimeException("No `converterData` in field defs.");
}
/** @var ?string $column */
$column = $data['column'] ?? null;
/** @var ?string $link */
$link = $data['link'] ?? null;
/** @var ?string $relationName */
$relationName = $data['relationName'] ?? null;
/** @var ?string $nearKey */
$nearKey = $data['nearKey'] ?? null;
if (!$column || !$link || !$relationName || !$nearKey) {
throw new RuntimeException("Bad `converterData`.");
}
$midTable = ucfirst($relationName);
return $attributeDefs->withParamsMerged([
'where' => [
'=' => [
'leftJoins' => [$link],
'whereClause' => ["{$link}Middle.$column" => '{value}'],
'distinct' => true,
],
'<>' => [
'whereClause' => [
'id!=s' => [
'from' => $midTable,
'select' => [$nearKey],
'whereClause' => [
'deleted' => false,
$column => '{value}',
],
],
],
],
'IN' => [
'leftJoins' => [$link],
'whereClause' => ["{$link}Middle.$column" => '{value}'],
'distinct' => true,
],
'NOT IN' => [
'whereClause' => [
'id!=s' => [
'from' => $midTable,
'select' => [$nearKey],
'whereClause' => [
'deleted' => false,
$column => '{value}',
],
],
],
],
'LIKE' => [
'leftJoins' => [$link],
'whereClause' => ["{$link}Middle.$column*" => '{value}'],
'distinct' => true,
],
'NOT LIKE' => [
'leftJoins' => [$link],
'whereClause' => ["{$link}Middle.$column!*" => '{value}'],
'distinct' => true,
],
'IS NULL' => [
'leftJoins' => [$link],
'whereClause' => ["{$link}Middle.$column" => null],
'distinct' => true,
],
'IS NOT NULL' => [
'whereClause' => [
'id!=s' => [
'from' => $midTable,
'select' => [$nearKey],
'whereClause' => [
'deleted' => false,
$column => null,
],
],
],
],
],
]);
}
}
@@ -329,78 +329,12 @@
"customizationIsSortedDisabled": true,
"customizationAuditedDisabled": true,
"customizationReadOnlyDisabled": true,
"where": {
"=": {
"whereClause": {
"opportunitiesMiddle.role": "{value}"
},
"leftJoins": ["opportunities"],
"distinct": true
},
"<>": {
"whereClause": {
"id!=s": {
"from": "ContactOpportunity",
"select": ["contactId"],
"whereClause": {
"deleted": false,
"role": "{value}"
}
}
}
},
"IN": {
"leftJoins": ["opportunities"],
"whereClause": {
"opportunitiesMiddle.role": "{value}"
},
"distinct": true
},
"NOT IN": {
"whereClause": {
"id!=s": {
"from": "ContactOpportunity",
"select": ["contactId"],
"whereClause": {
"deleted": false,
"role": "{value}"
}
}
}
},
"LIKE": {
"leftJoins": ["opportunities"],
"whereClause": {
"opportunitiesMiddle.role*": "{value}"
},
"distinct": true
},
"NOT LIKE": {
"leftJoins": ["opportunities"],
"whereClause": {
"opportunitiesMiddle.role!*": "{value}"
},
"distinct": true
},
"IS NULL": {
"leftJoins": ["opportunities"],
"whereClause": {
"opportunitiesMiddle.role": null
},
"distinct": true
},
"IS NOT NULL": {
"whereClause": {
"id!=s": {
"from": "ContactOpportunity",
"select": ["contactId"],
"whereClause": {
"deleted": false,
"role": null
}
}
}
}
"converterClassName": "Espo\\Classes\\FieldConverters\\RelationshipRole",
"converterData": {
"column": "role",
"link": "opportunities",
"relationName": "contactOpportunity",
"nearKey": "contactId"
},
"view": "crm:views/contact/fields/opportunity-role"
},
@@ -231,74 +231,15 @@
"customizationIsSortedDisabled": true,
"customizationAuditedDisabled": true,
"customizationReadOnlyDisabled": true,
"where": {
"=": {
"leftJoins": ["contacts"],
"whereClause": {
"contactsMiddle.role": "{value}"
},
"distinct": true
},
"<>": {
"whereClause": {
"id!=s": {
"from": "ContactOpportunity",
"select": ["opportunityId"],
"whereClause": {
"deleted": false,
"role": "{value}"
}
}
}
},
"IN": {
"leftJoins": ["contacts"],
"whereClause": {
"contactsMiddle.role": "{value}"
},
"distinct": true
},
"NOT IN": {
"whereClause": {
"id!=s": {
"from": "ContactOpportunity",
"select": ["opportunityId"],
"whereClause": {
"deleted": false,
"role": "{value}"
}
}
}
},
"LIKE": {
"leftJoins": ["contacts"],
"whereClause": {
"contactsMiddle.role*": "{value}"
},
"distinct": true
},
"IS NULL": {
"leftJoins": ["contacts"],
"whereClause": {
"contactsMiddle.role": null
},
"distinct": true
},
"IS NOT NULL": {
"whereClause": {
"id!=s": {
"from": "ContactOpportunity",
"select": ["opportunityId"],
"whereClause": {
"deleted": false,
"role": null
}
}
}
}
"customizationOptionsDisabled": true,
"converterClassName": "Espo\\Classes\\FieldConverters\\RelationshipRole",
"converterData": {
"column": "role",
"link": "contacts",
"relationName": "contactOpportunity",
"nearKey": "opportunityId"
},
"view": "crm:views/opportunity/fields/contact-role",
"customizationOptionsDisabled": true
"view": "crm:views/opportunity/fields/contact-role"
},
"createdAt": {
"type": "datetime",