bsiggel
127fa6503b
- Updated copyright headers in 3,055 core application files - Changed 'Copyright (C) 2014-2025' to 'Copyright (C) 2014-2026' - Added 123 new files from EspoCRM core updates - Removed 4 deprecated files - Total changes: 61,637 insertions, 54,283 deletions This is a routine maintenance update for the new year 2026.
128 lines
4.3 KiB
PHP
128 lines
4.3 KiB
PHP
<?php
|
||
/************************************************************************
|
||
* This file is part of EspoCRM.
|
||
*
|
||
* EspoCRM – Open Source CRM application.
|
||
* Copyright (C) 2014-2026 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\Acl\Table;
|
||
use Espo\Core\AclManager;
|
||
use Espo\Core\Exceptions\BadRequest;
|
||
use Espo\Core\Exceptions\Error;
|
||
use Espo\Core\Exceptions\Forbidden;
|
||
use Espo\Core\Exceptions\ForbiddenSilent;
|
||
use Espo\Core\InjectableFactory;
|
||
use Espo\Core\Select\SearchParams;
|
||
use Espo\Core\Utils\Config;
|
||
use Espo\Core\Utils\Metadata;
|
||
use Espo\Entities\User;
|
||
|
||
class KanbanService
|
||
{
|
||
public function __construct(
|
||
private User $user,
|
||
private AclManager $aclManager,
|
||
private InjectableFactory $injectableFactory,
|
||
private Config $config,
|
||
private Metadata $metadata,
|
||
private Orderer $orderer
|
||
) {}
|
||
|
||
/**
|
||
* @throws Error
|
||
* @throws Forbidden
|
||
* @throws BadRequest
|
||
*/
|
||
public function getData(string $entityType, SearchParams $searchParams): Result
|
||
{
|
||
$this->processAccessCheck($entityType);
|
||
|
||
$disableCount = $this->metadata
|
||
->get(['entityDefs', $entityType, 'collection', 'countDisabled']) ?? false;
|
||
|
||
$orderDisabled = $this->metadata
|
||
->get(['scopes', $entityType, 'kanbanOrderDisabled']) ?? false;
|
||
|
||
$maxOrderNumber = $this->config->get('kanbanMaxOrderNumber');
|
||
|
||
return $this->createKanban()
|
||
->setEntityType($entityType)
|
||
->setSearchParams($searchParams)
|
||
->setCountDisabled($disableCount)
|
||
->setOrderDisabled($orderDisabled)
|
||
->setUserId($this->user->getId())
|
||
->setMaxOrderNumber($maxOrderNumber)
|
||
->getResult();
|
||
}
|
||
|
||
/**
|
||
* @param string[] $ids
|
||
* @throws Forbidden
|
||
* @throws Error
|
||
*/
|
||
public function order(string $entityType, string $group, array $ids): void
|
||
{
|
||
$this->processAccessCheck($entityType);
|
||
|
||
if ($this->user->isPortal()) {
|
||
throw new ForbiddenSilent("Kanban order is not allowed for portal users.");
|
||
}
|
||
|
||
$maxOrderNumber = $this->config->get('kanbanMaxOrderNumber');
|
||
|
||
$this->orderer
|
||
->setEntityType($entityType)
|
||
->setGroup($group)
|
||
->setUserId($this->user->getId())
|
||
->setMaxNumber($maxOrderNumber)
|
||
->order($ids);
|
||
}
|
||
|
||
private function createKanban(): Kanban
|
||
{
|
||
return $this->injectableFactory->create(Kanban::class);
|
||
}
|
||
|
||
/**
|
||
* @throws ForbiddenSilent
|
||
*/
|
||
private function processAccessCheck(string $entityType): void
|
||
{
|
||
if (!$this->metadata->get(['scopes', $entityType, 'object'])) {
|
||
throw new ForbiddenSilent("Non-object entities are not supported.");
|
||
}
|
||
|
||
if ($this->metadata->get(['recordDefs', $entityType, 'kanbanDisabled'])) {
|
||
throw new ForbiddenSilent("Kanban is disabled for '$entityType'.");
|
||
}
|
||
|
||
if (!$this->aclManager->check($this->user, $entityType, Table::ACTION_READ)) {
|
||
throw new ForbiddenSilent();
|
||
}
|
||
}
|
||
}
|