Initial commit
This commit is contained in:
87
application/Espo/Modules/Crm/Tools/Activities/Api/Get.php
Normal file
87
application/Espo/Modules/Crm/Tools/Activities/Api/Get.php
Normal file
@@ -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\Modules\Crm\Tools\Activities\Api;
|
||||
|
||||
use Espo\Core\Acl;
|
||||
use Espo\Core\Api\Action;
|
||||
use Espo\Core\Api\Request;
|
||||
use Espo\Core\Api\Response;
|
||||
use Espo\Core\Api\ResponseComposer;
|
||||
use Espo\Core\Exceptions\BadRequest;
|
||||
use Espo\Core\Exceptions\Forbidden;
|
||||
use Espo\Core\Record\SearchParamsFetcher;
|
||||
use Espo\Modules\Crm\Tools\Activities\FetchParams as ActivitiesFetchParams;
|
||||
use Espo\Modules\Crm\Tools\Activities\Service as Service;
|
||||
|
||||
/**
|
||||
* Activities related to a record.
|
||||
*/
|
||||
class Get implements Action
|
||||
{
|
||||
public function __construct(
|
||||
private SearchParamsFetcher $searchParamsFetcher,
|
||||
private Service $service,
|
||||
private Acl $acl
|
||||
) {}
|
||||
|
||||
public function process(Request $request): Response
|
||||
{
|
||||
if (!$this->acl->check('Activities')) {
|
||||
throw new Forbidden();
|
||||
}
|
||||
|
||||
$parentType = $request->getRouteParam('parentType');
|
||||
$id = $request->getRouteParam('id');
|
||||
$type = $request->getRouteParam('type');
|
||||
|
||||
if (
|
||||
!$parentType ||
|
||||
!$id ||
|
||||
!in_array($type, ['activities', 'history'])
|
||||
) {
|
||||
throw new BadRequest();
|
||||
}
|
||||
|
||||
$searchParams = $this->searchParamsFetcher->fetch($request);
|
||||
|
||||
$offset = $searchParams->getOffset();
|
||||
$maxSize = $searchParams->getMaxSize();
|
||||
|
||||
$targetEntityType = $request->getQueryParam('entityType');
|
||||
|
||||
$fetchParams = new ActivitiesFetchParams($maxSize, $offset, $targetEntityType);
|
||||
|
||||
$result = $type === 'history' ?
|
||||
$this->service->getHistory($parentType, $id, $fetchParams) :
|
||||
$this->service->getActivities($parentType, $id, $fetchParams);
|
||||
|
||||
return ResponseComposer::json($result->toApiOutput());
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,91 @@
|
||||
<?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\Modules\Crm\Tools\Activities\Api;
|
||||
|
||||
use Espo\Core\Acl;
|
||||
use Espo\Core\Api\Action;
|
||||
use Espo\Core\Api\Request;
|
||||
use Espo\Core\Api\Response;
|
||||
use Espo\Core\Api\ResponseComposer;
|
||||
use Espo\Core\Exceptions\BadRequest;
|
||||
use Espo\Core\Exceptions\Forbidden;
|
||||
use Espo\Core\Exceptions\NotFound;
|
||||
use Espo\Modules\Crm\Tools\Activities\ComposeEmailService;
|
||||
use Espo\ORM\Entity;
|
||||
use Espo\ORM\EntityManager;
|
||||
|
||||
/**
|
||||
* @noinspection PhpUnused
|
||||
*/
|
||||
class GetComposeAddressList implements Action
|
||||
{
|
||||
public function __construct(
|
||||
private Acl $acl,
|
||||
private EntityManager $entityManager,
|
||||
private ComposeEmailService $service
|
||||
) {}
|
||||
|
||||
public function process(Request $request): Response
|
||||
{
|
||||
$parentType = $request->getRouteParam('parentType');
|
||||
$id = $request->getRouteParam('id');
|
||||
|
||||
if (!$parentType || !$id) {
|
||||
throw new BadRequest();
|
||||
}
|
||||
|
||||
$entity = $this->fetchEntity($parentType, $id);
|
||||
|
||||
$list = $this->service->getEmailAddressList($entity);
|
||||
|
||||
return ResponseComposer::json(
|
||||
array_map(fn ($item) => $item->getValueMap(), $list)
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws Forbidden
|
||||
* @throws NotFound
|
||||
*/
|
||||
private function fetchEntity(string $parentType, string $id): Entity
|
||||
{
|
||||
$entity = $this->entityManager->getEntityById($parentType, $id);
|
||||
|
||||
if (!$entity) {
|
||||
throw new NotFound();
|
||||
}
|
||||
|
||||
if (!$this->acl->checkEntityRead($entity)) {
|
||||
throw new Forbidden();
|
||||
}
|
||||
|
||||
return $entity;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,86 @@
|
||||
<?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\Modules\Crm\Tools\Activities\Api;
|
||||
|
||||
use Espo\Core\Api\Action;
|
||||
use Espo\Core\Api\Request;
|
||||
use Espo\Core\Api\Response;
|
||||
use Espo\Core\Api\ResponseComposer;
|
||||
use Espo\Core\Exceptions\BadRequest;
|
||||
use Espo\Core\Record\SearchParamsFetcher;
|
||||
use Espo\Modules\Crm\Tools\Activities\Service as Service;
|
||||
|
||||
/**
|
||||
* Activities of specific entity type related to a record.
|
||||
*/
|
||||
class GetListTyped implements Action
|
||||
{
|
||||
public function __construct(
|
||||
private SearchParamsFetcher $searchParamsFetcher,
|
||||
private Service $service
|
||||
) {}
|
||||
|
||||
public function process(Request $request): Response
|
||||
{
|
||||
$parentType = $request->getRouteParam('parentType');
|
||||
$id = $request->getRouteParam('id');
|
||||
$type = $request->getRouteParam('type');
|
||||
$targetType = $request->getRouteParam('targetType');
|
||||
|
||||
if (
|
||||
!$parentType ||
|
||||
!$id ||
|
||||
!$type ||
|
||||
!$targetType
|
||||
) {
|
||||
throw new BadRequest();
|
||||
}
|
||||
|
||||
if ($type === 'activities') {
|
||||
$isHistory = false;
|
||||
} else if ($type === 'history') {
|
||||
$isHistory = true;
|
||||
} else {
|
||||
throw new BadRequest("Bad type.");
|
||||
}
|
||||
|
||||
$searchParams = $this->searchParamsFetcher->fetch($request);
|
||||
|
||||
$result = $this->service->findActivitiesEntityType(
|
||||
$parentType,
|
||||
$id,
|
||||
$targetType,
|
||||
$isHistory,
|
||||
$searchParams
|
||||
);
|
||||
|
||||
return ResponseComposer::json($result->toApiOutput());
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,106 @@
|
||||
<?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\Modules\Crm\Tools\Activities\Api;
|
||||
|
||||
use Espo\Core\Api\Action;
|
||||
use Espo\Core\Api\Request;
|
||||
use Espo\Core\Api\Response;
|
||||
use Espo\Core\Api\ResponseComposer;
|
||||
use Espo\Core\Exceptions\BadRequest;
|
||||
use Espo\Core\Exceptions\Forbidden;
|
||||
use Espo\Core\Record\SearchParamsFetcher;
|
||||
use Espo\Entities\User;
|
||||
use Espo\Modules\Crm\Tools\Activities\Upcoming\Params;
|
||||
use Espo\Modules\Crm\Tools\Activities\UpcomingService;
|
||||
|
||||
/**
|
||||
* Upcoming activities.
|
||||
*
|
||||
* @noinspection PhpUnused
|
||||
*/
|
||||
class GetUpcoming implements Action
|
||||
{
|
||||
public function __construct(
|
||||
private User $user,
|
||||
private SearchParamsFetcher $searchParamsFetcher,
|
||||
private UpcomingService $service
|
||||
) {}
|
||||
|
||||
public function process(Request $request): Response
|
||||
{
|
||||
$userId = $request->getQueryParam('userId') ?? $this->user->getId();
|
||||
|
||||
$params = $this->fetchParams($request);
|
||||
|
||||
$result = $this->service->get($userId, $params);
|
||||
|
||||
return ResponseComposer::json($result->toApiOutput());
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws BadRequest
|
||||
* @throws Forbidden
|
||||
*/
|
||||
private function fetchParams(Request $request): Params
|
||||
{
|
||||
$entityTypeList = $this->fetchEntityTypeList($request);
|
||||
$futureDays = $request->hasQueryParam('futureDays') ? intval($request->getQueryParam('futureDays')) : null;
|
||||
$searchParams = $this->searchParamsFetcher->fetch($request);
|
||||
|
||||
return new Params(
|
||||
offset: $searchParams->getOffset(),
|
||||
maxSize: $searchParams->getMaxSize(),
|
||||
futureDays: $futureDays,
|
||||
entityTypeList: $entityTypeList,
|
||||
includeShared: $request->getQueryParam('includeShared') === 'true',
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* @return ?string[]
|
||||
* @throws BadRequest
|
||||
*/
|
||||
private function fetchEntityTypeList(Request $request): ?array
|
||||
{
|
||||
$entityTypeList = $request->getQueryParams()['entityTypeList'] ?? null;
|
||||
|
||||
if (!is_array($entityTypeList) && $entityTypeList !== null) {
|
||||
throw new BadRequest("Bad entityTypeList.");
|
||||
}
|
||||
|
||||
foreach ($entityTypeList ?? [] as $it) {
|
||||
if (!is_string($it)) {
|
||||
throw new BadRequest("Bad item in entityTypeList.");
|
||||
}
|
||||
}
|
||||
|
||||
return $entityTypeList;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user