mirror of
https://github.com/Karaka-Management/oms-ContractManagement.git
synced 2026-01-11 09:38:41 +00:00
436 lines
14 KiB
PHP
Executable File
436 lines
14 KiB
PHP
Executable File
<?php
|
|
/**
|
|
* Jingga
|
|
*
|
|
* PHP Version 8.2
|
|
*
|
|
* @package Modules\ContractManagement
|
|
* @copyright Dennis Eichhorn
|
|
* @license OMS License 2.2
|
|
* @version 1.0.0
|
|
* @link https://jingga.app
|
|
*/
|
|
declare(strict_types=1);
|
|
|
|
namespace Modules\ContractManagement\Controller;
|
|
|
|
use Modules\Admin\Models\NullAccount;
|
|
use Modules\ContractManagement\Models\Contract;
|
|
use Modules\ContractManagement\Models\ContractMapper;
|
|
use Modules\ContractManagement\Models\PermissionCategory;
|
|
use Modules\Media\Models\PathSettings;
|
|
use Modules\Organization\Models\NullUnit;
|
|
use phpOMS\Account\PermissionType;
|
|
use phpOMS\Localization\NullBaseStringL11nType;
|
|
use phpOMS\Message\Http\RequestStatusCode;
|
|
use phpOMS\Message\NotificationLevel;
|
|
use phpOMS\Message\RequestAbstract;
|
|
use phpOMS\Message\ResponseAbstract;
|
|
|
|
/**
|
|
* Api controller for the contracts module.
|
|
*
|
|
* @package Modules\ContractManagement
|
|
* @license OMS License 2.2
|
|
* @link https://jingga.app
|
|
* @since 1.0.0
|
|
*
|
|
* @feature Create task/message if a contracts term runs out
|
|
* https://github.com/Karaka-Management/oms-ContractManagement/issues/4
|
|
*
|
|
* @feature Create job which informs people about contract end of life
|
|
* https://github.com/Karaka-Management/oms-ContractManagement/issues/3
|
|
*
|
|
* @feature Setting to change responsible person/group A to B (e.g. person leaves company)
|
|
* https://github.com/Karaka-Management/oms-ContractManagement/issues/2
|
|
*/
|
|
final class ApiController extends Controller
|
|
{
|
|
/**
|
|
* Api method to create a contract
|
|
*
|
|
* @param RequestAbstract $request Request
|
|
* @param ResponseAbstract $response Response
|
|
* @param array $data Generic data
|
|
*
|
|
* @return void
|
|
*
|
|
* @api
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public function apiContractCreate(RequestAbstract $request, ResponseAbstract $response, array $data = []) : void
|
|
{
|
|
if (!empty($val = $this->validateContractCreate($request))) {
|
|
$response->header->status = RequestStatusCode::R_400;
|
|
$this->createInvalidCreateResponse($request, $response, $val);
|
|
|
|
return;
|
|
}
|
|
|
|
$contract = $this->createContractFromRequest($request);
|
|
$this->createModel($request->header->account, $contract, ContractMapper::class, 'contract', $request->getOrigin());
|
|
$this->createStandardCreateResponse($request, $response, $contract);
|
|
}
|
|
|
|
/**
|
|
* Validate contract create request
|
|
*
|
|
* @param RequestAbstract $request Request
|
|
*
|
|
* @return array<string, bool>
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
private function validateContractCreate(RequestAbstract $request) : array
|
|
{
|
|
$val = [];
|
|
if (($val['title'] = !$request->hasData('title'))
|
|
|| ($val['type'] = !$request->hasData('type'))
|
|
) {
|
|
return $val;
|
|
}
|
|
|
|
return [];
|
|
}
|
|
|
|
/**
|
|
* Create media directory path
|
|
*
|
|
* @param Contract $contract Contract
|
|
*
|
|
* @return string
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
private function createContractDir(Contract $contract) : string
|
|
{
|
|
return '/Modules/ContractManagement/Contract/'
|
|
. $contract->id;
|
|
}
|
|
|
|
/**
|
|
* Method to create item l11n from request.
|
|
*
|
|
* @param RequestAbstract $request Request
|
|
*
|
|
* @return Contract
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
private function createContractFromRequest(RequestAbstract $request) : Contract
|
|
{
|
|
$contract = new Contract();
|
|
$contract->title = $request->getDataString('title') ?? '';
|
|
$contract->description = $request->getDataString('description') ?? '';
|
|
$contract->type = new NullBaseStringL11nType($request->getDataInt('type') ?? 0);
|
|
$contract->start = $request->getDataDateTime('start') ?? new \DateTime('now');
|
|
$contract->account = new NullAccount($request->getDataInt('account') ?? 0);
|
|
$contract->renewal = $request->getDataInt('renewal') ?? 0;
|
|
$contract->autoRenewal = $request->getDataBool('autorenewal') ?? false;
|
|
$contract->isTemplate = $request->getDataBool('template') ?? false;
|
|
$contract->unit = new NullUnit($request->getDataInt('unit') ?? 0);
|
|
$contract->end = $request->getDataDateTime('end');
|
|
$contract->parent = $request->getDataInt('parent');
|
|
|
|
return $contract;
|
|
}
|
|
|
|
/**
|
|
* Api method to create a contract document
|
|
*
|
|
* @param RequestAbstract $request Request
|
|
* @param ResponseAbstract $response Response
|
|
* @param array $data Generic data
|
|
*
|
|
* @return void
|
|
*
|
|
* @api
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public function apiContractDocumentCreate(RequestAbstract $request, ResponseAbstract $response, array $data = []) : void
|
|
{
|
|
if (empty($request->files)) {
|
|
$response->header->status = RequestStatusCode::R_400;
|
|
$this->createInvalidCreateResponse($request, $response, $request->files);
|
|
|
|
return;
|
|
}
|
|
|
|
/** @var \Modules\ContractManagement\Models\Contract */
|
|
$contract = ContractMapper::get()
|
|
->where('id', $request->getDataInt('ref'))
|
|
->execute();
|
|
|
|
$path = $this->createContractDir($contract);
|
|
|
|
$uploaded = $this->app->moduleManager->get('Media', 'Api')->uploadFiles(
|
|
names: $request->getDataList('names'),
|
|
fileNames: $request->getDataList('filenames'),
|
|
files: $request->files,
|
|
account: $request->header->account,
|
|
basePath: __DIR__ . '/../../../Modules/Media/Files' . $path,
|
|
virtualPath: $path,
|
|
pathSettings: PathSettings::FILE_PATH,
|
|
readContent: true,
|
|
tag: $request->getDataInt('tag'),
|
|
rel: $contract->id,
|
|
mapper: ContractMapper::class,
|
|
field: 'files'
|
|
);
|
|
|
|
if (empty($uploaded->sources)) {
|
|
$this->createInvalidAddResponse($request, $response, []);
|
|
|
|
return;
|
|
}
|
|
|
|
$this->createStandardUpdateResponse($request, $response, $uploaded->sources);
|
|
}
|
|
|
|
/**
|
|
* Api method to update Contract
|
|
*
|
|
* @param RequestAbstract $request Request
|
|
* @param ResponseAbstract $response Response
|
|
* @param array $data Generic data
|
|
*
|
|
* @return void
|
|
*
|
|
* @api
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public function apiContractUpdate(RequestAbstract $request, ResponseAbstract $response, array $data = []) : void
|
|
{
|
|
if (!empty($val = $this->validateContractUpdate($request))) {
|
|
$response->header->status = RequestStatusCode::R_400;
|
|
$this->createInvalidUpdateResponse($request, $response, $val);
|
|
|
|
return;
|
|
}
|
|
|
|
/** @var \Modules\ContractManagement\Models\Contract $old */
|
|
$old = ContractMapper::get()->where('id', $request->getDataInt('id') ?? 0)->execute();
|
|
$new = $this->updateContractFromRequest($request, clone $old);
|
|
|
|
$this->updateModel($request->header->account, $old, $new, ContractMapper::class, 'contract', $request->getOrigin());
|
|
$this->createStandardUpdateResponse($request, $response, $new);
|
|
}
|
|
|
|
/**
|
|
* Method to update Contract from request.
|
|
*
|
|
* @param RequestAbstract $request Request
|
|
* @param Contract $new Model to modify
|
|
*
|
|
* @return Contract
|
|
*
|
|
* @todo Implement API update function
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public function updateContractFromRequest(RequestAbstract $request, Contract $new) : Contract
|
|
{
|
|
$new->title = $request->getDataString('title') ?? $new->title;
|
|
$new->description = $request->getDataString('description') ?? $new->description;
|
|
$new->type = $request->hasData('type') ? new NullBaseStringL11nType($request->getDataInt('type') ?? 0) : $new->type;
|
|
$new->start = $request->getDataDateTime('start') ?? $new->start;
|
|
$new->account = $request->hasData('account') ? new NullAccount($request->getDataInt('account') ?? 0) : $new->account;
|
|
$new->renewal = $request->getDataInt('renewal') ?? $new->renewal;
|
|
$new->autoRenewal = $request->getDataBool('autorenewal') ?? $new->autoRenewal;
|
|
$new->unit = $request->hasData('unit') ? new NullUnit($request->getDataInt('unit') ?? 0) : $new->unit;
|
|
$new->end = $request->getDataDateTime('end') ?? $new->end;
|
|
|
|
return $new;
|
|
}
|
|
|
|
/**
|
|
* Validate Contract update request
|
|
*
|
|
* @param RequestAbstract $request Request
|
|
*
|
|
* @return array<string, bool>
|
|
*
|
|
* @todo Implement API validation function
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
private function validateContractUpdate(RequestAbstract $request) : array
|
|
{
|
|
$val = [];
|
|
if (($val['id'] = !$request->hasData('id'))) {
|
|
return $val;
|
|
}
|
|
|
|
return [];
|
|
}
|
|
|
|
/**
|
|
* Api method to delete Contract
|
|
*
|
|
* @param RequestAbstract $request Request
|
|
* @param ResponseAbstract $response Response
|
|
* @param array $data Generic data
|
|
*
|
|
* @return void
|
|
*
|
|
* @api
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public function apiContractDelete(RequestAbstract $request, ResponseAbstract $response, array $data = []) : void
|
|
{
|
|
if (!empty($val = $this->validateContractDelete($request))) {
|
|
$response->header->status = RequestStatusCode::R_400;
|
|
$this->createInvalidDeleteResponse($request, $response, $val);
|
|
|
|
return;
|
|
}
|
|
|
|
/** @var \Modules\ContractManagement\Models\Contract $contract */
|
|
$contract = ContractMapper::get()->where('id', $request->getDataInt('id') ?? 0)->execute();
|
|
$this->deleteModel($request->header->account, $contract, ContractMapper::class, 'contract', $request->getOrigin());
|
|
$this->createStandardDeleteResponse($request, $response, $contract);
|
|
}
|
|
|
|
/**
|
|
* Validate Contract delete request
|
|
*
|
|
* @param RequestAbstract $request Request
|
|
*
|
|
* @return array<string, bool>
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
private function validateContractDelete(RequestAbstract $request) : array
|
|
{
|
|
$val = [];
|
|
if (($val['id'] = !$request->hasData('id'))) {
|
|
return $val;
|
|
}
|
|
|
|
return [];
|
|
}
|
|
|
|
/**
|
|
* Api method to create Note
|
|
*
|
|
* @param RequestAbstract $request Request
|
|
* @param ResponseAbstract $response Response
|
|
* @param array $data Generic data
|
|
*
|
|
* @return void
|
|
*
|
|
* @api
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public function apiNoteCreate(RequestAbstract $request, ResponseAbstract $response, array $data = []) : void
|
|
{
|
|
if (!empty($val = $this->validateNoteCreate($request))) {
|
|
$response->header->status = RequestStatusCode::R_400;
|
|
$this->createInvalidCreateResponse($request, $response, $val);
|
|
|
|
return;
|
|
}
|
|
|
|
$request->setData('virtualpath', '/Modules/ContractManagement/Contracts/' . $request->getData('ref'), true);
|
|
$this->app->moduleManager->get('Editor', 'Api')->apiEditorCreate($request, $response, $data);
|
|
|
|
if ($response->header->status !== RequestStatusCode::R_200) {
|
|
return;
|
|
}
|
|
|
|
$responseData = $response->getDataArray($request->uri->__toString());
|
|
if (!\is_array($responseData)) {
|
|
return;
|
|
}
|
|
|
|
$model = $responseData['response'];
|
|
$this->createModelRelation($request->header->account, (int) $request->getData('ref'), $model->id, ContractMapper::class, 'notes', '', $request->getOrigin());
|
|
}
|
|
|
|
/**
|
|
* Validate note create request
|
|
*
|
|
* @param RequestAbstract $request Request
|
|
*
|
|
* @return array<string, bool>
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
private function validateNoteCreate(RequestAbstract $request) : array
|
|
{
|
|
$val = [];
|
|
if (($val['ref'] = !$request->hasData('ref'))
|
|
) {
|
|
return $val;
|
|
}
|
|
|
|
return [];
|
|
}
|
|
|
|
/**
|
|
* Api method to update Note
|
|
*
|
|
* @param RequestAbstract $request Request
|
|
* @param ResponseAbstract $response Response
|
|
* @param array $data Generic data
|
|
*
|
|
* @return void
|
|
*
|
|
* @api
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public function apiNoteUpdate(RequestAbstract $request, ResponseAbstract $response, array $data = []) : void
|
|
{
|
|
$accountId = $request->header->account;
|
|
if (!$this->app->accountManager->get($accountId)->hasPermission(
|
|
PermissionType::MODIFY, $this->app->unitId, $this->app->appId, self::NAME, PermissionCategory::NOTE, $request->getDataInt('id'))
|
|
) {
|
|
$this->fillJsonResponse(
|
|
$request, $response,
|
|
NotificationLevel::ERROR, '',
|
|
$this->app->l11nManager->getText($response->header->l11n->language, '0', '0', 'InvalidPermission'),
|
|
[]
|
|
);
|
|
$response->header->status = RequestStatusCode::R_403;
|
|
|
|
return;
|
|
}
|
|
|
|
$this->app->moduleManager->get('Editor', 'Api')->apiEditorUpdate($request, $response, $data);
|
|
}
|
|
|
|
/**
|
|
* Api method to delete Note
|
|
*
|
|
* @param RequestAbstract $request Request
|
|
* @param ResponseAbstract $response Response
|
|
* @param array $data Generic data
|
|
*
|
|
* @return void
|
|
*
|
|
* @api
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public function apiNoteDelete(RequestAbstract $request, ResponseAbstract $response, array $data = []) : void
|
|
{
|
|
$accountId = $request->header->account;
|
|
if (!$this->app->accountManager->get($accountId)->hasPermission(
|
|
PermissionType::DELETE, $this->app->unitId, $this->app->appId, self::NAME, PermissionCategory::NOTE, $request->getDataInt('id'))
|
|
) {
|
|
$this->fillJsonResponse($request, $response, NotificationLevel::HIDDEN, '', '', []);
|
|
$response->header->status = RequestStatusCode::R_403;
|
|
|
|
return;
|
|
}
|
|
|
|
$this->app->moduleManager->get('Editor', 'Api')->apiEditorDelete($request, $response, $data);
|
|
}
|
|
}
|