Taras Machyshyn
139 lines
4.5 KiB
PHP
139 lines
4.5 KiB
PHP
<?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\Tools\Kanban;
|
|
|
|
use Espo\Core\Acl\Table;
|
|
use Espo\Core\AclManager;
|
|
use Espo\Core\Exceptions\Error;
|
|
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
|
|
{
|
|
private User $user;
|
|
private AclManager $aclManager;
|
|
private InjectableFactory $injectableFactory;
|
|
private Config $config;
|
|
private Metadata $metadata;
|
|
private Orderer $orderer;
|
|
|
|
public function __construct(
|
|
User $user,
|
|
AclManager $aclManager,
|
|
InjectableFactory $injectableFactory,
|
|
Config $config,
|
|
Metadata $metadata,
|
|
Orderer $orderer
|
|
) {
|
|
$this->user = $user;
|
|
$this->aclManager = $aclManager;
|
|
$this->injectableFactory = $injectableFactory;
|
|
$this->config = $config;
|
|
$this->metadata = $metadata;
|
|
$this->orderer = $orderer;
|
|
}
|
|
|
|
/**
|
|
* @throws Error
|
|
* @throws ForbiddenSilent
|
|
*/
|
|
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 ForbiddenSilent
|
|
*/
|
|
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();
|
|
}
|
|
}
|
|
}
|