Skip to content

EspoCRM – Open Source CRM Application

kanban support options reference

Yuri Kuznetsov3e23994991cf
diff --git a/application/Espo/Tools/Kanban/Kanban.php b/application/Espo/Tools/Kanban/Kanban.php
index 5206d73503..3db9e0c238 100644
--- a/application/Espo/Tools/Kanban/Kanban.php
+++ b/application/Espo/Tools/Kanban/Kanban.php
@@ -39,7 +39,6 @@ use Espo\Core\Record\Select\ApplierClassNameListProvider;
use Espo\Core\Record\ServiceContainer as RecordServiceContainer;
use Espo\Core\Select\SearchParams;
use Espo\Core\Select\SelectBuilderFactory;
-use Espo\Core\Utils\Metadata;
use Espo\ORM\Entity;
use Espo\ORM\EntityManager;
@@ -56,12 +55,12 @@ class Kanban
private int $maxOrderNumber = self::DEFAULT_MAX_ORDER_NUMBER;
public function __construct(
- private Metadata $metadata,
private SelectBuilderFactory $selectBuilderFactory,
private EntityManager $entityManager,
private ListLoadProcessor $listLoadProcessor,
private RecordServiceContainer $recordServiceContainer,
private ApplierClassNameListProvider $applierClassNameListProvider,
+ private MetadataProvider $metadataProvider,
) {}
public function setEntityType(string $entityType): self
@@ -149,9 +148,9 @@ class Kanban
)
->build();
- $statusField = $this->getStatusField();
- $statusList = $this->getStatusList();
- $statusIgnoreList = $this->getStatusIgnoreList();
+ $statusField = $this->metadataProvider->getStatusField($this->entityType);
+ $statusList = $this->metadataProvider->getStatusList($this->entityType);
+ $statusIgnoreList = $this->metadataProvider->getStatusIgnoreList($this->entityType);
$groupList = [];
@@ -246,49 +245,4 @@ class Kanban
return new Result($groupList, $total);
}
-
- /**
- * @throws Error
- */
- private function getStatusField(): string
- {
- assert(is_string($this->entityType));
-
- $statusField = $this->metadata->get(['scopes', $this->entityType, 'statusField']);
-
- if (!$statusField) {
- throw new Error("No status field for entity type '$this->entityType'.");
- }
-
- return $statusField;
- }
-
- /**
- * @return string[]
- * @throws Error
- */
- private function getStatusList(): array
- {
- assert(is_string($this->entityType));
-
- $statusField = $this->getStatusField();
-
- $statusList = $this->metadata->get(['entityDefs', $this->entityType, 'fields', $statusField, 'options']);
-
- if (empty($statusList)) {
- throw new Error("No options for status field for entity type '$this->entityType'.");
- }
-
- return $statusList;
- }
-
- /**
- * @return string[]
- */
- private function getStatusIgnoreList(): array
- {
- assert(is_string($this->entityType));
-
- return $this->metadata->get(['scopes', $this->entityType, 'kanbanStatusIgnoreList'], []);
- }
}
diff --git a/application/Espo/Tools/Kanban/KanbanService.php b/application/Espo/Tools/Kanban/KanbanService.php
index a59f05e71f..f7a15b50af 100644
--- a/application/Espo/Tools/Kanban/KanbanService.php
+++ b/application/Espo/Tools/Kanban/KanbanService.php
@@ -82,6 +82,7 @@ class KanbanService
/**
* @param string[] $ids
* @throws Forbidden
+ * @throws Error
*/
public function order(string $entityType, string $group, array $ids): void
{
diff --git a/application/Espo/Tools/Kanban/MetadataProvider.php b/application/Espo/Tools/Kanban/MetadataProvider.php
new file mode 100644
index 0000000000..fe5d012da4
--- /dev/null
+++ b/application/Espo/Tools/Kanban/MetadataProvider.php
@@ -0,0 +1,87 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM – Open Source CRM application.
+ * Copyright (C) 2014-2025 EspoCRM, Inc.
+ * Website: https://www.espocrm.com
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://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 Affero General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
+ * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
+ ************************************************************************/
+
+namespace Espo\Tools\Kanban;
+
+use Espo\Core\Exceptions\Error;
+use Espo\Core\Utils\Metadata;
+
+class MetadataProvider
+{
+ public function __construct(
+ private Metadata $metadata,
+ ) {}
+
+
+ /**
+ * @return string[]
+ * @throws Error
+ */
+ public function getStatusList(string $entityType): array
+ {
+ $field = $this->getStatusField($entityType);
+
+ $statusList = $this->metadata->get("entityDefs.$entityType.fields.$field.options");
+ $optionsReference = $this->metadata->get("entityDefs.$entityType.fields.$field.optionsReference");
+
+ if (is_string($optionsReference) && str_contains($optionsReference, '.')) {
+ [$refEntityType, $refField] = explode('.', $optionsReference);
+
+ $statusList = $this->metadata->get("entityDefs.$refEntityType.fields.$refField.options");
+ }
+
+ if (!$statusList) {
+ throw new Error("No options for status field for entity type '$entityType'.");
+ }
+
+ return $statusList;
+ }
+
+ /**
+ * @throws Error
+ */
+ public function getStatusField(string $entityType): string
+ {
+ $statusField = $this->metadata->get("scopes.$entityType.statusField");
+
+ if (!$statusField) {
+ throw new Error("No status field for entity type '$entityType'.");
+ }
+
+ return $statusField;
+ }
+
+ /**
+ * @return string[]
+ */
+ public function getStatusIgnoreList(string $entityType): array
+ {
+ return $this->metadata->get("scopes.$entityType.kanbanStatusIgnoreList") ?? [];
+ }
+}
diff --git a/application/Espo/Tools/Kanban/Orderer.php b/application/Espo/Tools/Kanban/Orderer.php
index d17ea5a98c..57c6e6fad8 100644
--- a/application/Espo/Tools/Kanban/Orderer.php
+++ b/application/Espo/Tools/Kanban/Orderer.php
@@ -38,7 +38,8 @@ class Orderer
public function __construct(
private EntityManager $entityManager,
private Metadata $metadata,
- private RecordIdGenerator $idGenerator
+ private RecordIdGenerator $idGenerator,
+ private MetadataProvider $metadataProvider,
) {}
public function setEntityType(string $entityType): OrdererProcessor
@@ -64,9 +65,10 @@ class Orderer
public function createProcessor(): OrdererProcessor
{
return new OrdererProcessor(
- $this->entityManager,
- $this->metadata,
- $this->idGenerator
+ entityManager: $this->entityManager,
+ metadata: $this->metadata,
+ idGenerator: $this->idGenerator,
+ metadataProvider: $this->metadataProvider,
);
}
}
diff --git a/application/Espo/Tools/Kanban/OrdererProcessor.php b/application/Espo/Tools/Kanban/OrdererProcessor.php
index d9f044f460..625c317140 100644
--- a/application/Espo/Tools/Kanban/OrdererProcessor.php
+++ b/application/Espo/Tools/Kanban/OrdererProcessor.php
@@ -29,6 +29,8 @@
namespace Espo\Tools\Kanban;
+use Espo\Core\Exceptions\Error;
+use Espo\Core\Exceptions\ForbiddenSilent;
use Espo\Core\Utils\Id\RecordIdGenerator;
use Espo\Entities\KanbanOrder;
use Espo\Core\ORM\EntityManager;
@@ -50,7 +52,8 @@ class OrdererProcessor
public function __construct(
private EntityManager $entityManager,
private Metadata $metadata,
- private RecordIdGenerator $idGenerator
+ private RecordIdGenerator $idGenerator,
+ private MetadataProvider $metadataProvider,
) {}
public function setEntityType(string $entityType): self
@@ -89,6 +92,9 @@ class OrdererProcessor
/**
* @param string[] $ids
+ *
+ * @throws ForbiddenSilent
+ * @throws Error
*/
public function order(array $ids): void
{
@@ -194,21 +200,25 @@ class OrdererProcessor
->commit();
}
+ /**
+ * @throws Error
+ * @throws ForbiddenSilent
+ */
private function validate(): void
{
- if (! $this->entityType) {
+ if (!$this->entityType) {
throw new LogicException("No entity type.");
}
- if (! $this->group) {
+ if (!$this->group) {
throw new LogicException("No group.");
}
- if (! $this->userId) {
+ if (!$this->userId) {
throw new LogicException("No user ID.");
}
- if (! $this->metadata->get(['scopes', $this->entityType, 'object'])) {
+ if (!$this->metadata->get(['scopes', $this->entityType, 'object'])) {
throw new LogicException("Not allowed entity type.");
}
@@ -218,17 +228,16 @@ class OrdererProcessor
throw new LogicException("Order is disabled.");
}
- $statusField = $this->metadata->get(['scopes', $this->entityType, 'statusField']);
+ $statusField = $this->metadataProvider->getStatusField($this->entityType);
- if (! $statusField) {
+ if (!$statusField) {
throw new LogicException("Not status field.");
}
- $statusList = $this->metadata
- ->get(['entityDefs', $this->entityType, 'fields', $statusField, 'options']) ?? [];
+ $statusList = $this->metadataProvider->getStatusList($this->entityType);
if (!in_array($this->group, $statusList)) {
- throw new LogicException("Group is not available in status list.");
+ throw new ForbiddenSilent("Group is not available in status list.");
}
}
}
diff --git a/client/src/views/admin/entity-manager/record/edit.js b/client/src/views/admin/entity-manager/record/edit.js
index d5271f8c1c..7bc7f79770 100644
--- a/client/src/views/admin/entity-manager/record/edit.js
+++ b/client/src/views/admin/entity-manager/record/edit.js
@@ -168,8 +168,18 @@ export default class EntityManagerEditRecordView extends EditRecordView {
setKanbanStatusIgnoreListOptions() {
const statusField = this.model.get('statusField');
- const optionList =
- this.getMetadata().get(['entityDefs', this.subjectEntityType, 'fields', statusField, 'options']) || [];
+ let optionList = this.getMetadata()
+ .get(`entityDefs.${this.subjectEntityType}.fields.${statusField}.options`) ?? [];
+
+ const optionsReference = this.getMetadata()
+ .get(`entityDefs.${this.subjectEntityType}.fields.${statusField}.optionsReference`);
+
+ if (optionsReference) {
+ const [entityType, field] = optionsReference.split('.');
+
+ optionList = this.getMetadata()
+ .get(`entityDefs.${entityType}.fields.${field}.options`) ?? [];
+ }
this.setFieldOptionList('kanbanStatusIgnoreList', optionList);
diff --git a/client/src/views/record/kanban.js b/client/src/views/record/kanban.js
index 68a9672b06..7c3d568911 100644
--- a/client/src/views/record/kanban.js
+++ b/client/src/views/record/kanban.js
@@ -90,6 +90,12 @@ class KanbanRecordView extends ListRecordView {
*/
seedCollection
+ /**
+ * @private
+ * @type {Record.<string, string>}
+ */
+ styleMap
+
/**
* Layout item definitions.
*
@@ -364,12 +370,7 @@ class KanbanRecordView extends ListRecordView {
this.orderDisabled = true;
}
}
-
- this.statusField = this.options.statusField || this.getMetadata().get(['scopes', this.scope, 'statusField']);
-
- if (!this.statusField) {
- throw new Error(`No status field for entity type '${this.scope}'.`);
- }
+ this.setupStatusField();
this.seedCollection = this.collection.clone();
this.seedCollection.reset();
@@ -441,6 +442,30 @@ class KanbanRecordView extends ListRecordView {
this.hasStars = this.getMetadata().get(`scopes.${this.entityType}.stars`) || false;
}
+ /**
+ * @private
+ */
+ setupStatusField() {
+ this.statusField = this.options.statusField || this.getMetadata().get(['scopes', this.scope, 'statusField']);
+
+ if (!this.statusField) {
+ throw new Error(`No status field for entity type '${this.scope}'.`);
+ }
+
+ this.styleMap = /** @type {Record.<string, string>} */
+ this.getMetadata().get(`entityDefs.${this.scope}.fields.${this.statusField}.style`) ?? {};
+
+ const optionsReference =
+ this.getMetadata().get(`entityDefs.${this.scope}.fields.${this.statusField}.optionsReference`);
+
+ if (optionsReference) {
+ const [entityType, field] = optionsReference.split('.');
+
+ this.styleMap = /** @type {Record.<string, string>} */
+ this.getMetadata().get(`entityDefs.${entityType}.fields.${field}.style`) ?? {};
+ }
+ }
+
afterRender() {
const $window = $(window);
@@ -955,8 +980,7 @@ class KanbanRecordView extends ListRecordView {
});
});
- const style = item.style ||
- this.getMetadata().get(`entityDefs.${this.scope}.fields.${this.statusField}.style.${item.name}`);
+ const style = item.style || this.styleMap[item.name];
const label = item.label ||
this.getLanguage().translateOption(item.name, this.statusField, this.scope);