From 189a210d8b72989c4a1d8ba0c4405976a0caace0 Mon Sep 17 00:00:00 2001 From: Tom Udding Date: Wed, 11 Sep 2024 16:30:35 +0200 Subject: [PATCH] DRAFT: feat: improved --- .../src/Controller/ActivityController.php | 4 +- .../src/Controller/AdminController.php | 10 +- module/Activity/src/Model/Activity.php | 2 +- module/Activity/src/Service/Activity.php | 6 +- .../Activity/src/Service/ActivityCalendar.php | 2 +- .../admin-approval/view-proposal.phtml | 4 +- .../view/activity/admin-approval/view.phtml | 4 +- .../Activity/view/activity/admin/list.phtml | 6 +- .../src/Model/Enums/ApprovableStatus.php | 9 + .../src/Model/Traits/ApprovableTrait.php | 16 +- .../Model/Traits/UpdateProposableTrait.php | 10 + module/Application/view/partial/admin.phtml | 94 ++++++---- .../Controller/CompanyAccountController.php | 2 +- module/Company/src/Model/Company.php | 9 +- module/Company/src/Model/Job.php | 1 + .../Company/src/Model/Proposals/JobUpdate.php | 12 +- module/Company/src/Service/Company.php | 2 +- .../view/company/admin-approval/index.phtml | 2 +- .../company/admin-approval/job-approval.phtml | 6 +- .../company/admin-approval/job-proposal.phtml | 6 +- .../view/company/admin/edit-company.phtml | 4 +- .../view/company/admin/edit-package.phtml | 5 +- .../view/company/company-account/jobs.phtml | 6 +- module/Decision/config/module.config.php | 77 +++++++- .../OrganAdminApprovalControllerFactory.php | 29 +++ .../Factory/OrganAdminControllerFactory.php | 3 + .../OrganAdminApprovalController.php | 67 +++++++ .../src/Controller/OrganAdminController.php | 80 +++++++- module/Decision/src/Form/OrganInformation.php | 28 +-- .../src/Hydrator/OrganInformation.php | 65 +++++++ module/Decision/src/Mapper/Member.php | 40 +++- .../Decision/src/Mapper/OrganInformation.php | 45 +++++ .../src/Model/DecisionLocalisedText.php | 16 ++ module/Decision/src/Model/Organ.php | 55 +++++- .../Decision/src/Model/OrganInformation.php | 141 +++++++------- .../Proposals/OrganInformationUpdate.php | 76 ++++++++ module/Decision/src/Module.php | 14 +- module/Decision/src/Service/AclService.php | 9 +- module/Decision/src/Service/Organ.php | 173 ++++++++++-------- .../organ-admin-approval/approval.phtml | 0 .../decision/organ-admin-approval/index.phtml | 0 .../organ-admin-approval/proposal.phtml | 0 .../view/decision/organ-admin/edit.phtml | 135 +++++++++----- .../view/decision/organ-admin/index.phtml | 26 +-- .../view/frontpage/organ/organ.phtml | 40 ++-- .../Frontpage/view/partial/organ-card.phtml | 2 +- 46 files changed, 994 insertions(+), 349 deletions(-) create mode 100644 module/Decision/src/Controller/Factory/OrganAdminApprovalControllerFactory.php create mode 100644 module/Decision/src/Controller/OrganAdminApprovalController.php create mode 100644 module/Decision/src/Hydrator/OrganInformation.php create mode 100644 module/Decision/src/Mapper/OrganInformation.php create mode 100644 module/Decision/src/Model/DecisionLocalisedText.php create mode 100644 module/Decision/src/Model/Proposals/OrganInformationUpdate.php create mode 100644 module/Decision/view/decision/organ-admin-approval/approval.phtml create mode 100644 module/Decision/view/decision/organ-admin-approval/index.phtml create mode 100644 module/Decision/view/decision/organ-admin-approval/proposal.phtml diff --git a/module/Activity/src/Controller/ActivityController.php b/module/Activity/src/Controller/ActivityController.php index da2b9331a5..0f19f7e7d6 100644 --- a/module/Activity/src/Controller/ActivityController.php +++ b/module/Activity/src/Controller/ActivityController.php @@ -79,7 +79,7 @@ public function viewAction(): mixed } // If the Activity has a sign-up list always display it by redirecting the request. - if (0 !== $activity->getSignupLists()->count()) { + if (!$activity->getSignupLists()->isEmpty()) { return $this->forward()->dispatch( self::class, [ @@ -263,7 +263,7 @@ public function signupAction(): Response|ViewModel // Let user edit subscription details if (null !== ($signup = $this->signupMapper->getSignUp($signupList, $identity))) { - if (0 === $signupList->getFields()->count()) { + if ($signupList->getFields()->isEmpty()) { return $this->redirect()->toRoute( 'activity/view/signuplist', [ diff --git a/module/Activity/src/Controller/AdminController.php b/module/Activity/src/Controller/AdminController.php index ad38b2201b..c54c6156f5 100644 --- a/module/Activity/src/Controller/AdminController.php +++ b/module/Activity/src/Controller/AdminController.php @@ -96,7 +96,7 @@ public function updateAction(): Response|ViewModel throw new NotAllowedException($this->translator->translate('You are not allowed to update this activity')); } - if (0 !== $activity->getSignupLists()->count()) { + if (!$activity->getSignupLists()->isEmpty()) { $openingDates = []; $participants = 0; @@ -144,11 +144,11 @@ public function updateAction(): Response|ViewModel } } - $updateProposal = $activity->getUpdateProposal(); + $updateProposals = $activity->getUpdateProposals(); - if (0 !== $updateProposal->count()) { + if (!$updateProposals->isEmpty()) { // If there already is an update proposal for this activity, show that instead of the original activity. - $activity = $updateProposal->first()->getNew(); + $activity = $updateProposals->first()->getNew(); } $activityData = $activity->toArray(); @@ -213,7 +213,7 @@ public function participantsAction(): ViewModel // If the activity does not have any sign-up lists there is no need // to check the participants or any sign-up lists. - if (0 === $activity->getSignupLists()->count()) { + if ($activity->getSignupLists()->isEmpty()) { return $this->notFoundAction(); } diff --git a/module/Activity/src/Model/Activity.php b/module/Activity/src/Model/Activity.php index de69664014..1004ca3fc5 100644 --- a/module/Activity/src/Model/Activity.php +++ b/module/Activity/src/Model/Activity.php @@ -274,7 +274,7 @@ public function setStatus(int $status): void /** * @return Collection */ - public function getUpdateProposal(): Collection + public function getUpdateProposals(): Collection { return $this->updateProposal; } diff --git a/module/Activity/src/Service/Activity.php b/module/Activity/src/Service/Activity.php index bf2a04b738..a92e046914 100644 --- a/module/Activity/src/Service/Activity.php +++ b/module/Activity/src/Service/Activity.php @@ -140,7 +140,7 @@ protected function findOrgan(int $organId): OrganModel { $organ = $this->organService->getOrgan($organId); - if (!$this->organService->canEditOrgan($organ)) { + if (!$this->organService->canUseOrgan($organ)) { throw new NotAllowedException( $this->translator->translate('You are not allowed to create an activity for this organ'), ); @@ -446,8 +446,8 @@ public function createUpdateProposal( $em = $this->entityManager; - if (0 !== $currentActivity->getUpdateProposal()->count()) { - $proposal = $currentActivity->getUpdateProposal()->first(); + if (0 !== $currentActivity->getUpdateProposals()->count()) { + $proposal = $currentActivity->getUpdateProposals()->first(); //Remove old update proposal $oldUpdate = $proposal->getNew(); $proposal->setNew($newActivity); diff --git a/module/Activity/src/Service/ActivityCalendar.php b/module/Activity/src/Service/ActivityCalendar.php index 31ad91d787..5e129c0f0f 100644 --- a/module/Activity/src/Service/ActivityCalendar.php +++ b/module/Activity/src/Service/ActivityCalendar.php @@ -230,7 +230,7 @@ protected function canDeleteOption(ActivityCalendarOptionModel $option): bool $organ = $option->getProposal()->getOrgan(); - return null !== $organ && $this->organService->canEditOrgan($organ); + return null !== $organ && $this->organService->canUseOrgan($organ); } /** diff --git a/module/Activity/view/activity/admin-approval/view-proposal.phtml b/module/Activity/view/activity/admin-approval/view-proposal.phtml index e9577cb3dd..55c1404835 100644 --- a/module/Activity/view/activity/admin-approval/view-proposal.phtml +++ b/module/Activity/view/activity/admin-approval/view-proposal.phtml @@ -240,7 +240,7 @@ $this->breadcrumbs()
- getCategories()->count() !== 0 || $new->getCategories()->count() !== 0): ?> + getCategories()->isEmpty() || !$new->getCategories()->isEmpty()): ?>

translate('Activity Categories') ?>

@@ -267,7 +267,7 @@ $this->breadcrumbs() - getSignupLists()->count() !== 0 || $new->getSignupLists()->count() !== 0): ?> + getSignupLists()->isEmpty() || !$new->getSignupLists()->isEmpty()): ?>

translate('Sign-up Lists') ?>

diff --git a/module/Activity/view/activity/admin-approval/view.phtml b/module/Activity/view/activity/admin-approval/view.phtml index 9d64ec9825..9085f0839e 100644 --- a/module/Activity/view/activity/admin-approval/view.phtml +++ b/module/Activity/view/activity/admin-approval/view.phtml @@ -173,7 +173,7 @@ $this->breadcrumbs()
- getCategories()->count() > 0): ?> + getCategories()->isEmpty()): ?>

translate('Activity Categories') ?>

@@ -187,7 +187,7 @@ $this->breadcrumbs() - getSignupLists()->count() > 0): ?> + getSignupLists()->isEmpty()): ?>

translate('Sign-up Lists') ?>

diff --git a/module/Activity/view/activity/admin/list.phtml b/module/Activity/view/activity/admin/list.phtml index 5d740a1823..fbd3bc3897 100644 --- a/module/Activity/view/activity/admin/list.phtml +++ b/module/Activity/view/activity/admin/list.phtml @@ -46,10 +46,10 @@ use Laminas\View\Renderer\PhpRenderer; getCompany()) ? $this->translate('None') : $this->escapeHtml($activity->getCompany()->getName()) ?> escapeHtml($activity->getCreator()->getFullName()) ?> - getUpdateProposal()->count() === 0 ? '(-)' : - '' . $this->translate('Update pending') . '' ?> + getUpdateProposals()->count() === 0 ? '(-)' : + '' . $this->translate('Update pending') . '' ?> - getUpdateProposal()->count() === 0 ? '(-)' : $this->translate('Update pending') ?> + getUpdateProposals()->count() === 0 ? '(-)' : $this->translate('Update pending') ?> diff --git a/module/Application/src/Model/Enums/ApprovableStatus.php b/module/Application/src/Model/Enums/ApprovableStatus.php index 206be67d22..8853307516 100644 --- a/module/Application/src/Model/Enums/ApprovableStatus.php +++ b/module/Application/src/Model/Enums/ApprovableStatus.php @@ -13,4 +13,13 @@ enum ApprovableStatus: int case Unapproved = 0; case Approved = 1; case Rejected = 2; + + public function getIcon(): string + { + return match ($this) { + self::Unapproved => 'fa-circle-question', + self::Approved => 'fa-circle-check', + self::Rejected => 'fa-circle-xmark', + }; + } } diff --git a/module/Application/src/Model/Traits/ApprovableTrait.php b/module/Application/src/Model/Traits/ApprovableTrait.php index c60bc1a9aa..19a885071a 100644 --- a/module/Application/src/Model/Traits/ApprovableTrait.php +++ b/module/Application/src/Model/Traits/ApprovableTrait.php @@ -70,14 +70,24 @@ enumType: ApprovableStatus::class, )] protected ?ApprovableTextModel $approvableText = null; - public function getApproved(): ApprovableStatus + public function getApproval(): ApprovableStatus { return $this->approved; } public function isApproved(): bool { - return ApprovableStatus::Approved === $this->getApproved(); + return ApprovableStatus::Approved === $this->getApproval(); + } + + public function isRejected(): bool + { + return ApprovableStatus::Rejected === $this->getApproval(); + } + + public function isUnapproved(): bool + { + return ApprovableStatus::Unapproved === $this->getApproval(); } public function setApproved(ApprovableStatus $approved): void @@ -122,7 +132,7 @@ public function toGdprArray(): array { return [ 'id' => $this->getId(), - 'approved' => $this->getApproved()->value, + 'approved' => $this->getApproval()->value, 'approvedAt' => $this->getApprovedAt()?->format(DateTimeInterface::ATOM), 'approvableText' => $this->getApprovableText()?->getMessage(), ]; diff --git a/module/Application/src/Model/Traits/UpdateProposableTrait.php b/module/Application/src/Model/Traits/UpdateProposableTrait.php index 629e563af2..ad8d8b4825 100644 --- a/module/Application/src/Model/Traits/UpdateProposableTrait.php +++ b/module/Application/src/Model/Traits/UpdateProposableTrait.php @@ -4,12 +4,15 @@ namespace Application\Model\Traits; +use Doctrine\Common\Collections\Collection; use Doctrine\ORM\Mapping\Column; /** * A trait which provides basic (repeated) functionality for proposed update entities. * * TODO: Make activities also use this trait. + * + * @template T of object */ trait UpdateProposableTrait { @@ -42,4 +45,11 @@ public function setIsUpdate(bool $isUpdate): void { $this->isUpdate = $isUpdate; } + + /** + * Get update proposals for this entity. + * + * @psalm-return Collection + */ + abstract public function getUpdateProposals(): Collection; } diff --git a/module/Application/view/partial/admin.phtml b/module/Application/view/partial/admin.phtml index 4023a30623..5b13efe90a 100644 --- a/module/Application/view/partial/admin.phtml +++ b/module/Application/view/partial/admin.phtml @@ -40,31 +40,30 @@ use Laminas\View\Renderer\PhpRenderer; @@ -75,15 +74,13 @@ use Laminas\View\Renderer\PhpRenderer; translate('Career') ?>
    - acl('company_service_acl')->isAllowed('company', 'listAll')): ?> + acl('company_service_acl')->isAllowed('company', 'listAll')): ?>
  • translate('Companies') ?>
    • - + acl('company_service_acl')->isAllowed('company', 'approve') @@ -146,48 +143,73 @@ use Laminas\View\Renderer\PhpRenderer; acl('decision_service_acl')->isAllowed('decision_organ_admin', 'view')): ?> -
  • - - translate('Organs') ?> +
  • + +
    • acl('frontpage_service_acl')->isAllowed('news_item', 'create')): ?>
  • - translate('News') ?> + + translate('News') ?> +
    • acl('frontpage_service_acl')->isAllowed('page', 'create')): ?>
  • - translate('Pages') ?> + + translate('Pages') ?> +
    • acl('photo_service_acl')->isAllowed('photo_admin', 'view')): ?>
  • - translate('Photos') ?> + + translate('Photos') ?> +
    • acl('frontpage_service_acl')->isAllowed('poll', 'approve')): ?>
  • - translate('Polls') ?> + + translate('Polls') ?> +
    • acl('user_service_acl')->isAllowed('user_admin', 'view')): ?> @@ -231,7 +253,9 @@ use Laminas\View\Renderer\PhpRenderer;
    1. - translate('Admin') ?> + + translate('Admin') ?> +
      2. breadcrumbs() ?>
    diff --git a/module/Company/src/Controller/CompanyAccountController.php b/module/Company/src/Controller/CompanyAccountController.php index 82658a2f4b..998bc1366b 100644 --- a/module/Company/src/Controller/CompanyAccountController.php +++ b/module/Company/src/Controller/CompanyAccountController.php @@ -289,7 +289,7 @@ public function editJobAction(): Response|ViewModel $isJobRejected = false; $jobRejectedMessage = null; - if (ApprovableStatus::Rejected === $job->getApproved()) { + if (ApprovableStatus::Rejected === $job->getApproval()) { $isJobRejected = true; $jobRejectedMessage = $job->getApprovableText()?->getMessage(); } diff --git a/module/Company/src/Model/Company.php b/module/Company/src/Model/Company.php index 400442e79c..294d0725c8 100644 --- a/module/Company/src/Model/Company.php +++ b/module/Company/src/Model/Company.php @@ -10,7 +10,7 @@ use Application\Model\Traits\UpdateProposableTrait; use Company\Model\Enums\CompanyPackageTypes; use Company\Model\JobCategory as JobCategoryModel; -use Company\Model\Proposals\CompanyUpdate as CompanyUpdateProposal; +use Company\Model\Proposals\CompanyUpdate as CompanyUpdateProposalModel; use Doctrine\Common\Collections\ArrayCollection; use Doctrine\Common\Collections\Collection; use Doctrine\ORM\Mapping\Column; @@ -38,6 +38,7 @@ class Company implements ResourceInterface use IdentifiableTrait; use TimestampableTrait; use ApprovableTrait; + /** @use UpdateProposableTrait */ use UpdateProposableTrait; /** @@ -175,10 +176,10 @@ class Company implements ResourceInterface /** * Proposed updates to this company. * - * @var Collection + * @var Collection */ #[OneToMany( - targetEntity: CompanyUpdateProposal::class, + targetEntity: CompanyUpdateProposalModel::class, mappedBy: 'original', fetch: 'EXTRA_LAZY', )] @@ -448,7 +449,7 @@ public function getNumberOfPackages(): int } /** - * @return Collection + * @return Collection */ public function getUpdateProposals(): Collection { diff --git a/module/Company/src/Model/Job.php b/module/Company/src/Model/Job.php index 844cfdcd44..82369ec8d9 100644 --- a/module/Company/src/Model/Job.php +++ b/module/Company/src/Model/Job.php @@ -34,6 +34,7 @@ class Job implements ResourceInterface use IdentifiableTrait; use TimestampableTrait; use ApprovableTrait; + /** @use UpdateProposableTrait */ use UpdateProposableTrait; /** diff --git a/module/Company/src/Model/Proposals/JobUpdate.php b/module/Company/src/Model/Proposals/JobUpdate.php index efde12658d..7de6f2c638 100644 --- a/module/Company/src/Model/Proposals/JobUpdate.php +++ b/module/Company/src/Model/Proposals/JobUpdate.php @@ -17,7 +17,7 @@ class JobUpdate use IdentifiableTrait; /** - * The current job, to which an update is proposed. + * The current {@link JobModel}, for which an update is proposed. */ #[ManyToOne( targetEntity: JobModel::class, @@ -30,7 +30,7 @@ class JobUpdate protected JobModel $original; /** - * The proposed update of the company. + * The proposed update of the {@link JobModel}. */ #[OneToOne( targetEntity: JobModel::class, @@ -43,7 +43,7 @@ class JobUpdate protected JobModel $proposal; /** - * Get the original `Job`. + * Get the original {@link JobModel}. */ public function getOriginal(): JobModel { @@ -51,7 +51,7 @@ public function getOriginal(): JobModel } /** - * Set the original `Job`. + * Set the original {@link JobModel}. */ public function setOriginal(JobModel $original): void { @@ -59,7 +59,7 @@ public function setOriginal(JobModel $original): void } /** - * Get the proposed update of `$original`. + * Get the proposed update of {@link JobUpdate::$original}. */ public function getProposal(): JobModel { @@ -67,7 +67,7 @@ public function getProposal(): JobModel } /** - * Set the proposed update for `$original`. + * Set the proposed update for {@link JobUpdate::$original}. */ public function setProposal(JobModel $proposal): void { diff --git a/module/Company/src/Service/Company.php b/module/Company/src/Service/Company.php index 909dfbd674..c67732fad2 100644 --- a/module/Company/src/Service/Company.php +++ b/module/Company/src/Service/Company.php @@ -614,7 +614,7 @@ public function createJob( $job->setPackage($package); $package->addJob($job); - // If the user can approve (changed to) jobs, directly approve the job. + // If the user can approve (changes to) jobs, directly approve the job. if ($this->aclService->isAllowed('approve', 'job')) { $job->setApproved(ApprovableStatus::Approved); $job->setApprovedAt(new DateTime()); diff --git a/module/Company/view/company/admin-approval/index.phtml b/module/Company/view/company/admin-approval/index.phtml index bfe1fb71e1..d61fddd4ea 100644 --- a/module/Company/view/company/admin-approval/index.phtml +++ b/module/Company/view/company/admin-approval/index.phtml @@ -73,7 +73,7 @@ $this->breadcrumbs() escapeHtml($job->getName()->getValueEN()) ?> escapeHtml($job->getPackage()->getCompany()->getName())?> - getUpdateProposals()->count()): ?> + getUpdateProposals()->isEmpty()): ?>

    isPublished()): ?> @@ -305,7 +305,7 @@ $this->breadcrumbs() echo $this->form()->closeTag(); ?>

    - getApproved()): ?> + getApproval()): ?>

    breadcrumbs() echo $this->form()->closeTag(); ?>

    - getApproved()): ?> + getApproval()): ?>

    breadcrumbs() ->addBreadcrumb($this->translate('Proposals'), true, $this->url('company_admin_approval')) ->addBreadcrumb($this->escapeHtml($this->localiseText($original->getName()))); -$originalApprovalState = $original->getApproved(); +$originalApprovalState = $original->getApproval(); ?>

    @@ -282,8 +282,8 @@ $originalApprovalState = $original->getApproved();
    getLabels()->count() !== 0 - || $proposed->getLabels()->count() !== 0 + !$original->getLabels()->isEmpty() + || !$proposed->getLabels()->isEmpty() ): ?> setAttribute('class', 'form-company'); translate('Add Banner Package'); ?>
    - getPackages()->count() > 0): - ?> + getPackages()->isEmpty()): ?>
    diff --git a/module/Company/view/company/admin/edit-package.phtml b/module/Company/view/company/admin/edit-package.phtml index bc9183af8c..ac8b01bdd4 100644 --- a/module/Company/view/company/admin/edit-package.phtml +++ b/module/Company/view/company/admin/edit-package.phtml @@ -91,9 +91,8 @@ $form->setAttribute('class', 'form-company');
    escapeHtml($this->localiseText($job->getName())) ?> isActive() ? $this->translate('Yes') : $this->translate('No') ?> - - - getUpdateProposals()->count()): ?> + + getUpdateProposals()->isEmpty()): ?>
    @@ -214,10 +215,7 @@ if (isset($packages)) { isActive() ? $this->translate('Yes') : $this->translate('No') ?>
    		- - + getUpdateProposals()->count()): ?> (translate('Yes') ?>) diff --git a/module/Decision/config/module.config.php b/module/Decision/config/module.config.php index 0ad5802ac3..e3a8ed972f 100644 --- a/module/Decision/config/module.config.php +++ b/module/Decision/config/module.config.php @@ -11,9 +11,11 @@ use Decision\Controller\Factory\AdminMemberControllerFactory; use Decision\Controller\Factory\DecisionControllerFactory; use Decision\Controller\Factory\MemberControllerFactory; +use Decision\Controller\Factory\OrganAdminApprovalControllerFactory; use Decision\Controller\Factory\OrganAdminControllerFactory; use Decision\Controller\Factory\OrganControllerFactory; use Decision\Controller\MemberController; +use Decision\Controller\OrganAdminApprovalController; use Decision\Controller\OrganAdminController; use Decision\Controller\OrganController; use Doctrine\ORM\Mapping\Driver\AttributeDriver; @@ -369,29 +371,87 @@ ], 'may_terminate' => true, 'child_routes' => [ - 'default' => [ + 'edit' => [ 'type' => Segment::class, 'options' => [ - 'route' => '[/:action]', + 'route' => '[/:organ_id]/edit', 'constraints' => [ - 'action' => '[a-zA-Z][a-zA-Z0-9_-]*', + 'organ_id' => '[0-9]+', + ], + 'defaults' => [ + 'action' => 'edit', ], ], ], - 'edit' => [ + ], + 'priority' => 100, + ], + 'admin_organ_approval' => [ + 'type' => Literal::class, + 'options' => [ + 'route' => '/admin/organ/approval', + 'defaults' => [ + 'controller' => OrganAdminApprovalController::class, + 'action' => 'index', + ], + ], + 'may_terminate' => true, + 'child_routes' => [ + 'approval' => [ 'type' => Segment::class, 'options' => [ - 'route' => '[/:organ_id]/edit', + 'route' => '/organ-information/:organInformationId', + 'defaults' => [ + 'action' => 'approval', + ], 'constraints' => [ - 'organ_id' => '[0-9]+', + 'organInformationId' => '\d+', ], + ], + 'may_terminate' => true, + 'child_routes' => [ + 'update' => [ + 'type' => Segment::class, + 'options' => [ + 'route' => '/:type', + 'defaults' => [ + 'action' => 'changeApprovalStatus', + ], + 'constraints' => [ + 'type' => '(approve|disapprove|reset)', + ], + ], + ], + ], + ], + 'proposal' => [ + 'type' => Segment::class, + 'options' => [ + 'route' => '/organ-information/proposal/:proposalId', 'defaults' => [ - 'action' => 'edit', + 'action' => 'proposal', + ], + 'constraints' => [ + 'proposalId' => '\d+', + ], + ], + 'may_terminate' => true, + 'child_routes' => [ + 'update' => [ + 'type' => Segment::class, + 'options' => [ + 'route' => '/:type', + 'defaults' => [ + 'action' => 'changeProposalStatus', + ], + 'constraints' => [ + 'type' => '(apply|cancel)', + ], + ], ], ], ], ], - 'priority' => 100, ], ], ], @@ -401,6 +461,7 @@ AdminMemberController::class => AdminMemberControllerFactory::class, DecisionController::class => DecisionControllerFactory::class, MemberController::class => MemberControllerFactory::class, + OrganAdminApprovalController::class => OrganAdminApprovalControllerFactory::class, OrganAdminController::class => OrganAdminControllerFactory::class, OrganController::class => OrganControllerFactory::class, ], diff --git a/module/Decision/src/Controller/Factory/OrganAdminApprovalControllerFactory.php b/module/Decision/src/Controller/Factory/OrganAdminApprovalControllerFactory.php new file mode 100644 index 0000000000..6dc4d3c22f --- /dev/null +++ b/module/Decision/src/Controller/Factory/OrganAdminApprovalControllerFactory.php @@ -0,0 +1,29 @@ +get('decision_service_acl'), + $container->get(MvcTranslator::class), + $container->get('decision_mapper_organInformation'), + $container->get('decision_service_organ'), + ); + } +} diff --git a/module/Decision/src/Controller/Factory/OrganAdminControllerFactory.php b/module/Decision/src/Controller/Factory/OrganAdminControllerFactory.php index d4b5b06cdc..035d6b13f4 100644 --- a/module/Decision/src/Controller/Factory/OrganAdminControllerFactory.php +++ b/module/Decision/src/Controller/Factory/OrganAdminControllerFactory.php @@ -5,6 +5,7 @@ namespace Decision\Controller\Factory; use Decision\Controller\OrganAdminController; +use Laminas\Mvc\I18n\Translator as MvcTranslator; use Laminas\ServiceManager\Factory\FactoryInterface; use Psr\Container\ContainerInterface; @@ -19,6 +20,8 @@ public function __invoke( ?array $options = null, ): OrganAdminController { return new OrganAdminController( + $container->get('decision_service_acl'), + $container->get(MvcTranslator::class), $container->get('decision_service_organ'), ); } diff --git a/module/Decision/src/Controller/OrganAdminApprovalController.php b/module/Decision/src/Controller/OrganAdminApprovalController.php new file mode 100644 index 0000000000..3df13547e2 --- /dev/null +++ b/module/Decision/src/Controller/OrganAdminApprovalController.php @@ -0,0 +1,67 @@ +aclService->isAllowed('approve', 'organInformation')) { + throw new NotAllowedException( + $this->translator->translate('You are not allowed to view the approval status of organs'), + ); + } + + return new ViewModel( + [ + 'organInformations' => $this->organInformationMapper->findProposals(), + ], + ); + } + + public function approvalAction(): ViewModel + { + // TODO: implement + } + + public function changeApprovalStatusAction(): Response|ViewModel + { + // TODO: implement + } + + public function proposalAction(): ViewModel + { + // TODO: implement + } + + public function changeProposalStatusAction(): Response|ViewModel + { + // TODO: implement + } +} diff --git a/module/Decision/src/Controller/OrganAdminController.php b/module/Decision/src/Controller/OrganAdminController.php index 7fa50cc6a0..91fc028601 100644 --- a/module/Decision/src/Controller/OrganAdminController.php +++ b/module/Decision/src/Controller/OrganAdminController.php @@ -4,26 +4,39 @@ namespace Decision\Controller; +use Decision\Model\OrganInformation as OrganInformationModel; +use Decision\Service\AclService; use Decision\Service\Organ as OrganService; use Laminas\Form\FormInterface; use Laminas\Http\Request; use Laminas\Http\Response; use Laminas\Mvc\Controller\AbstractActionController; +use Laminas\Mvc\I18n\Translator; use Laminas\View\Model\ViewModel; +use User\Permissions\NotAllowedException; use function array_merge_recursive; class OrganAdminController extends AbstractActionController { - public function __construct(private readonly OrganService $organService) - { + public function __construct( + private readonly AclService $aclService, + private readonly Translator $translator, + private readonly OrganService $organService, + ) { } /** - * Index action, shows all active organs. + * Index action, shows all active organs filtered for the user. */ public function indexAction(): ViewModel { + if (!$this->aclService->isAllowed('view', 'decision_organ_admin')) { + throw new NotAllowedException( + $this->translator->translate('You are not allowed to administer organs'), + ); + } + return new ViewModel( [ 'organs' => $this->organService->getEditableOrgans(), @@ -32,17 +45,73 @@ public function indexAction(): ViewModel } /** - * Show an organ. + * Route to create/propose a new {@link OrganInformationModel} iff none exists. + */ + public function createAction(): Response|ViewModel + { + $organId = (int) $this->params()->fromRoute('organ_id'); + $organ = $this->organService->getOrgan($organId); + + if (null === $organ) { + return $this->notFoundAction(); + } + + if (!$this->organService->canUseOrgan($organ)) { + throw new NotAllowedException( + $this->translator->translate('You are not allowed to create organ information for this organ'), + ); + } + + $form = $this->organService->getOrganInformationForm(); + + /** @var Request $request */ + $request = $this->getRequest(); + + if ($request->isPost()) { + $post = array_merge_recursive( + $request->getPost()->toArray(), + $request->getFiles()->toArray(), + ); + $form->setData($post); + + if ($form->isValid()) { + if (null !== ($organInformation = $this->organService->createOrganInformation($organ, $post))) { + return $this->redirect()->toUrl($this->url()->fromRoute('admin_organ')); + } + } + } + + return new ViewModel( + [ + 'form' => $form, + ], + ); + } + + /** + * Route to propose a change to an {@link OrganInformationModel}. */ public function editAction(): Response|ViewModel { $organId = (int) $this->params()->fromRoute('organ_id'); - $organInformation = $this->organService->getEditableOrganInformation($organId); + $organ = $this->organService->getOrgan($organId); + + if (null === $organ) { + return $this->notFoundAction(); + } + + $organInformation = $this->organService->getEditableOrganInformation($organ); if (false === $organInformation) { return $this->notFoundAction(); } + if (!$this->aclService->isAllowed('edit', $organInformation)) { + throw new NotAllowedException( + $this->translator->translate('You are not allowed to edit organ information'), + ); + } + $form = $this->organService->getOrganInformationForm($organInformation); /** @var Request $request */ @@ -70,6 +139,7 @@ public function editAction(): Response|ViewModel return new ViewModel( [ 'form' => $form, + 'organ' => $organ, ], ); } diff --git a/module/Decision/src/Form/OrganInformation.php b/module/Decision/src/Form/OrganInformation.php index 68aaff9298..32e89b6beb 100644 --- a/module/Decision/src/Form/OrganInformation.php +++ b/module/Decision/src/Form/OrganInformation.php @@ -46,40 +46,40 @@ public function __construct(Translator $translator) $this->add( [ - 'name' => 'shortDutchDescription', + 'name' => 'tagline', 'type' => Text::class, 'options' => [ - 'label' => $translator->translate('Short dutch description'), + 'label' => $translator->translate('Tagline'), ], ], ); $this->add( [ - 'name' => 'shortEnglishDescription', + 'name' => 'taglineEn', 'type' => Text::class, 'options' => [ - 'label' => $translator->translate('Short english description'), + 'label' => $translator->translate('Tagline'), ], ], ); $this->add( [ - 'name' => 'dutchDescription', + 'name' => 'description', 'type' => Textarea::class, 'options' => [ - 'label' => $translator->translate('Long dutch description'), + 'label' => $translator->translate('Description'), ], ], ); $this->add( [ - 'name' => 'englishDescription', + 'name' => 'descriptionEn', 'type' => Textarea::class, 'options' => [ - 'label' => $translator->translate('Long english description'), + 'label' => $translator->translate('Description'), ], ], ); @@ -139,7 +139,7 @@ public function getInputFilterSpecification(): array 'email' => [ 'required' => false, ], - 'shortDutchDescription' => [ + 'tagline' => [ 'required' => false, 'validators' => [ [ @@ -150,7 +150,7 @@ public function getInputFilterSpecification(): array ], ], ], - 'shortEnglishDescription' => [ + 'taglineEn' => [ 'required' => false, 'validators' => [ [ @@ -161,8 +161,8 @@ public function getInputFilterSpecification(): array ], ], ], - 'dutchDescription' => [ - 'required' => false, + 'description' => [ + 'required' => true, 'validators' => [ [ 'name' => StringLength::class, @@ -172,8 +172,8 @@ public function getInputFilterSpecification(): array ], ], ], - 'englishDescription' => [ - 'required' => false, + 'descriptionEn' => [ + 'required' => true, 'validators' => [ [ 'name' => StringLength::class, diff --git a/module/Decision/src/Hydrator/OrganInformation.php b/module/Decision/src/Hydrator/OrganInformation.php new file mode 100644 index 0000000000..55506a6843 --- /dev/null +++ b/module/Decision/src/Hydrator/OrganInformation.php @@ -0,0 +1,65 @@ + $object->getEmail(), + 'website' => $object->getWebsite(), + 'tagline' => $object->getTagline()->getValueNL(), + 'taglineEn' => $object->getTagline()->getValueEN(), + 'description' => $object->getDescription()->getValueNL(), + 'descriptionEn' => $object->getDescription()->getValueEN(), + ]; + } + + public function hydrate( + array $data, + object $object, + ): OrganInformationModel { + if (!$object instanceof OrganInformationModel) { + throw new InvalidArgumentException('Object is not an instance of Decision\Model\OrganInformation.'); + } + + if (isset($data['email'])) { + $object->setEmail($data['email']); + } + + if (isset($data['website'])) { + $object->setWebsite($data['website']); + } + + $shortDescription = $object->getTagline() ?? new DecisionLocalisedTextModel(); + $shortDescription->updateValues( + $data['taglineEn'] ?? null, + $data['tagline'] ?? null, + ); + $object->setTagline($shortDescription); + + $description = $object->getDescription() ?? new DecisionLocalisedTextModel(); + $description->updateValues( + $data['descriptionEn'] ?? null, + $data['description'] ?? null, + ); + $object->setDescription($description); + + return $object; + } +} diff --git a/module/Decision/src/Mapper/Member.php b/module/Decision/src/Mapper/Member.php index 313c1dff2c..9ea22c124c 100644 --- a/module/Decision/src/Mapper/Member.php +++ b/module/Decision/src/Mapper/Member.php @@ -13,6 +13,7 @@ use Doctrine\ORM\Query\ResultSetMappingBuilder; use User\Model\User as UserModel; use User\Model\UserRole as UserRoleModel; +use Doctrine\ORM\QueryBuilder; use function strtolower; @@ -117,12 +118,12 @@ public function findBirthdayMembers(int $days): array } /** - * Find all organs of this member. - * - * @return OrganModel[] + * Creates a `QueryBuilder` that returns all organs the member is in or a specific organ the member is in. */ - public function findOrgans(MemberModel $member): array - { + private function createOrganMembershipQuery( + MemberModel $member, + ?OrganModel $organ = null, + ): QueryBuilder { $qb = $this->getEntityManager()->createQueryBuilder(); $qb->select('DISTINCT o') ->from(OrganModel::class, 'o') @@ -137,9 +138,38 @@ public function findOrgans(MemberModel $member): array $qb->setParameter('lidnr', $member->getLidnr()) ->setParameter('now', new DateTime()); + if ($organ !== null) { + $qb->andWhere('o.id = :organId') + ->setParameter('organId', $organ->getId()); + } + + return $qb; + } + + /** + * Find all organs of this member. + * + * @return OrganModel[] + */ + public function findOrgans(MemberModel $member): array + { + $qb = $this->createOrganMembershipQuery($member); + return $qb->getQuery()->getResult(); } + /** + * Check if a member is in a specific organ. + */ + public function isMemberOfOrgan( + MemberModel $member, + OrganModel $organ, + ): bool { + $qb = $this->createOrganMembershipQuery($member, $organ); + + return !empty($qb->getQuery()->getResult()); + } + /** * Find all active installations of a member. * diff --git a/module/Decision/src/Mapper/OrganInformation.php b/module/Decision/src/Mapper/OrganInformation.php new file mode 100644 index 0000000000..d1d63002e4 --- /dev/null +++ b/module/Decision/src/Mapper/OrganInformation.php @@ -0,0 +1,45 @@ + + */ +class OrganInformation extends BaseMapper +{ + /** + * @return OrganInformationModel[] + */ + public function findProposals(): array + { + $qb = $this->getRepository()->createQueryBuilder('oi'); + $qb->where('(oi.approved = :approved AND oi.isUpdate = :isUpdate)'); + + $qbu = $this->getEntityManager()->createQueryBuilder(); + $qbu->select('IDENTITY(u.original)')->distinct() + ->from(OrganInformationUpdateModel::class, 'u') + ->innerJoin('u.proposal', 'p') + ->where('p.approved = :approved') + ->orderBy('u.id', 'DESC'); + + $qb->orWhere($qb->expr()->in('oi.id', $qbu->getDQL())) + ->orderBy('oi.id', 'DESC'); + + $qb->setParameter('approved', ApprovableStatus::Unapproved) + ->setParameter('isUpdate', false); + + return $qb->getQuery()->getResult(); + } + + protected function getRepositoryName(): string + { + return OrganInformationModel::class; + } +} diff --git a/module/Decision/src/Model/DecisionLocalisedText.php b/module/Decision/src/Model/DecisionLocalisedText.php new file mode 100644 index 0000000000..429d018031 --- /dev/null +++ b/module/Decision/src/Model/DecisionLocalisedText.php @@ -0,0 +1,16 @@ + 'DESC'])] protected Collection $organInformation; public function __construct() @@ -339,13 +342,63 @@ public function getOrganInformation(): Collection return $this->organInformation; } + /** + * Get the different versions of {@link OrganInformation} for this organ. + * + * @return Collection + */ + private function getOrganInformationWithoutProposals(): Collection + { + return $this->organInformation->filter(static function (OrganInformation $organInformation) { + return !$organInformation->isUpdate(); + }); + } + + /** + * Get the displayable organ information with its status and proposal updates. + */ + public function getDisplayableOrganInformation(): ?OrganInformation + { + $filtered = $this->getOrganInformationWithoutProposals(); + + // Check for the last approved OrganInformation. + $approved = $filtered->filter(static function (OrganInformation $organInformation) { + return $organInformation->isApproved(); + })->last(); + + if (false !== $approved) { + return $approved; + } + + // Check for the last rejected OrganInformation. + $rejected = $filtered->filter(static function (OrganInformation $organInformation) { + return $organInformation->isRejected(); + })->last(); + + if (false !== $rejected) { + return $rejected; + } + + // Check for any creation proposals. + $creationProposal = $this->organInformation->filter(static function (OrganInformation $organInformation) { + return $organInformation->isUnapproved(); + })->last(); + + if (false !== $creationProposal) { + return $creationProposal; + } + + return null; + } + + /** * Returns the approved information for an organ. */ public function getApprovedOrganInformation(): ?OrganInformation { foreach ($this->organInformation as $information) { - if (null !== $information->getApprover()) { + if ($information->isApproved()) { return $information; } } diff --git a/module/Decision/src/Model/OrganInformation.php b/module/Decision/src/Model/OrganInformation.php index bfe6c15c7b..8f070be0fd 100644 --- a/module/Decision/src/Model/OrganInformation.php +++ b/module/Decision/src/Model/OrganInformation.php @@ -4,20 +4,32 @@ namespace Decision\Model; +use Application\Model\Traits\ApprovableTrait; use Application\Model\Traits\IdentifiableTrait; -use Decision\Model\Member as MemberModel; +use Application\Model\Traits\TimestampableTrait; +use Application\Model\Traits\UpdateProposableTrait; +use Decision\Model\Proposals\OrganInformationUpdate as OrganInformationUpdateProposalModel; +use Doctrine\Common\Collections\ArrayCollection; +use Doctrine\Common\Collections\Collection; use Doctrine\ORM\Mapping\Column; use Doctrine\ORM\Mapping\Entity; use Doctrine\ORM\Mapping\JoinColumn; use Doctrine\ORM\Mapping\ManyToOne; +use Doctrine\ORM\Mapping\OneToMany; +use Doctrine\ORM\Mapping\OneToOne; +use User\Permissions\Resource\OrganResourceInterface; /** * Organ information. */ #[Entity] -class OrganInformation +class OrganInformation implements OrganResourceInterface { use IdentifiableTrait; + use TimestampableTrait; + use ApprovableTrait; + /** @use UpdateProposableTrait */ + use UpdateProposableTrait; #[ManyToOne( targetEntity: Organ::class, @@ -49,40 +61,34 @@ class OrganInformation protected ?string $website = null; /** - * A short description of the organ in Dutch. + * The short description of the organ which is shown in cards. */ - #[Column( - type: 'string', - nullable: true, + #[OneToOne( + targetEntity: DecisionLocalisedText::class, + cascade: ['persist', 'remove'], + orphanRemoval: true, )] - protected ?string $shortDutchDescription = null; - - /** - * A description of the organ in Dutch. - */ - #[Column( - type: 'text', - nullable: true, + #[JoinColumn( + name: 'tagline_id', + referencedColumnName: 'id', + nullable: false, )] - protected ?string $dutchDescription = null; + protected DecisionLocalisedText $tagline; /** - * A short description of the organ in English. + * The full description of the organ. */ - #[Column( - type: 'string', - nullable: true, + #[OneToOne( + targetEntity: DecisionLocalisedText::class, + cascade: ['persist', 'remove'], + orphanRemoval: true, )] - protected ?string $shortEnglishDescription = null; - - /** - * A description of the organ in English. - */ - #[Column( - type: 'text', - nullable: true, + #[JoinColumn( + name: 'description_id', + referencedColumnName: 'id', + nullable: false, )] - protected ?string $englishDescription = null; + protected DecisionLocalisedText $description; /** * The cover photo to display for this organ. @@ -103,11 +109,21 @@ class OrganInformation protected ?string $thumbnailPath = null; /** - * Who was the last one to approve this information. If null then nobody approved it. + * Proposed updates to this organ information. */ - #[ManyToOne(targetEntity: MemberModel::class)] - #[JoinColumn(referencedColumnName: 'lidnr')] - protected ?MemberModel $approver = null; + #[OneToMany( + targetEntity: OrganInformationUpdateProposalModel::class, + mappedBy: 'original', + cascade: ['persist', 'remove'], + orphanRemoval: true, + fetch: 'EXTRA_LAZY', + )] + protected Collection $updateProposals; + + public function __construct() + { + $this->updateProposals = new ArrayCollection(); + } public function getOrgan(): Organ { @@ -139,54 +155,24 @@ public function setWebsite(?string $website): void $this->website = $website; } - public function getShortDutchDescription(): ?string + public function getTagline(): DecisionLocalisedText { - return $this->shortDutchDescription; + return $this->tagline; } - public function setShortDutchDescription(?string $shortDutchDescription): void + public function setTagline(DecisionLocalisedText $tagline): void { - $this->shortDutchDescription = $shortDutchDescription; + $this->tagline = $tagline; } - public function getDutchDescription(): ?string + public function getDescription(): DecisionLocalisedText { - return $this->dutchDescription; + return $this->description; } - public function setDutchDescription(?string $dutchDescription): void + public function setDescription(DecisionLocalisedText $description): void { - $this->dutchDescription = $dutchDescription; - } - - public function getShortEnglishDescription(): ?string - { - return $this->shortEnglishDescription; - } - - public function setShortEnglishDescription(?string $shortEnglishDescription): void - { - $this->shortEnglishDescription = $shortEnglishDescription; - } - - public function getEnglishDescription(): ?string - { - return $this->englishDescription; - } - - public function setEnglishDescription(?string $englishDescription): void - { - $this->englishDescription = $englishDescription; - } - - public function getApprover(): ?MemberModel - { - return $this->approver; - } - - public function setApprover(?MemberModel $approver): void - { - $this->approver = $approver; + $this->description = $description; } public function getCoverPath(): ?string @@ -209,8 +195,23 @@ public function setThumbnailPath(?string $thumbnailPath): void $this->thumbnailPath = $thumbnailPath; } + public function getUpdateProposals(): Collection + { + return $this->updateProposals; + } + public function __clone() { $this->id = null; } + + public function getResourceOrgan(): ?Organ + { + return $this->getOrgan(); + } + + public function getResourceId(): string + { + return 'organInformation'; + } } diff --git a/module/Decision/src/Model/Proposals/OrganInformationUpdate.php b/module/Decision/src/Model/Proposals/OrganInformationUpdate.php new file mode 100644 index 0000000000..e6fb8459e5 --- /dev/null +++ b/module/Decision/src/Model/Proposals/OrganInformationUpdate.php @@ -0,0 +1,76 @@ +original; + } + + /** + * Set the original {@link OrganInformationModel}. + */ + public function setOriginal(OrganInformationModel $original): void + { + $this->original = $original; + } + + /** + * Get the proposed update of {@link OrganInformationUpdate::$original}. + */ + public function getProposal(): OrganInformationModel + { + return $this->proposal; + } + + /** + * Set the proposed update for {@link OrganInformationUpdate::$original}. + */ + public function setProposal(OrganInformationModel $proposal): void + { + $this->proposal = $proposal; + } +} diff --git a/module/Decision/src/Module.php b/module/Decision/src/Module.php index 057667dd5d..d18ce4d965 100644 --- a/module/Decision/src/Module.php +++ b/module/Decision/src/Module.php @@ -12,6 +12,7 @@ use Decision\Form\OrganInformation as OrganInformationForm; use Decision\Form\ReorderDocument as ReorderDocumentForm; use Decision\Form\SearchDecision as SearchDecisionForm; +use Decision\Hydrator\OrganInformation as OrganInformationHydrator; use Decision\Mapper\Authorization as AuthorizationMapper; use Decision\Mapper\Decision as DecisionMapper; use Decision\Mapper\Meeting as MeetingMapper; @@ -19,6 +20,7 @@ use Decision\Mapper\MeetingMinutes as MeetingMinutesMapper; use Decision\Mapper\Member as MemberMapper; use Decision\Mapper\Organ as OrganMapper; +use Decision\Mapper\OrganInformation as OrganInformationMapper; use Decision\Mapper\SubDecision as SubDecisionMapper; use Decision\Service\Decision as DecisionService; use Decision\Service\Gdpr as GdprService; @@ -58,6 +60,7 @@ public function getServiceConfig(): array $storageService = $container->get('application_service_storage'); $emailService = $container->get('application_service_email'); $memberMapper = $container->get('decision_mapper_member'); + $organInformationMapper = $container->get('decision_mapper_organ_information'); $organMapper = $container->get('decision_mapper_organ'); $organInformationForm = $container->get('decision_form_organ_information'); $organInformationConfig = $container->get('config')['organ_information']; @@ -69,6 +72,7 @@ public function getServiceConfig(): array $storageService, $emailService, $memberMapper, + $organInformationMapper, $organMapper, $organInformationForm, $organInformationConfig, @@ -194,6 +198,11 @@ public function getServiceConfig(): array $container->get('doctrine.entitymanager.orm_default'), ); }, + 'decision_mapper_organ_information' => static function (ContainerInterface $container) { + return new OrganInformationMapper( + $container->get('doctrine.entitymanager.orm_default'), + ); + }, 'decision_mapper_meeting' => static function (ContainerInterface $container) { return new MeetingMapper( $container->get('doctrine.entitymanager.orm_default'), @@ -253,7 +262,7 @@ public function getServiceConfig(): array $form = new OrganInformationForm( $container->get(MvcTranslator::class), ); - $form->setHydrator($container->get('decision_hydrator')); + $form->setHydrator($container->get('decision_hydrator_organ_information')); return $form; }, @@ -269,6 +278,9 @@ public function getServiceConfig(): array $container->get('doctrine.entitymanager.orm_default'), ); }, + 'decision_hydrator_organ_information' => static function (ContainerInterface $container) { + return new OrganInformationHydrator(); + }, 'decision_fileReader' => function (ContainerInterface $container) { //NB: The returned object should implement the FileReader Interface. $config = $container->get('config'); diff --git a/module/Decision/src/Service/AclService.php b/module/Decision/src/Service/AclService.php index ee4c88e421..4ede07b0b3 100644 --- a/module/Decision/src/Service/AclService.php +++ b/module/Decision/src/Service/AclService.php @@ -5,6 +5,7 @@ namespace Decision\Service; use Laminas\Permissions\Acl\Resource\GenericResource as Resource; +use User\Permissions\Assertion\IsOrganMember; class AclService extends \User\Service\AclService { @@ -14,6 +15,7 @@ protected function createAcl(): void // add resources for this module $this->acl->addResource(new Resource('organ')); + $this->acl->addResource(new Resource('organInformation')); $this->acl->addResource(new Resource('member')); $this->acl->addResource(new Resource('decision')); $this->acl->addResource(new Resource('meeting')); @@ -30,7 +32,12 @@ protected function createAcl(): void $this->acl->allow('user', 'organ', 'view'); // Organ members are allowed to edit organ information of their own organs - $this->acl->allow('active_member', 'organ', 'edit'); + $this->acl->allow( + 'active_member', + 'organInformation', + ['create', 'edit'], + new IsOrganMember(), + ); $this->acl->allow('active_member', 'decision_organ_admin', 'view'); // users are allowed to view and search members diff --git a/module/Decision/src/Service/Organ.php b/module/Decision/src/Service/Organ.php index 2c6e7cef30..4ced740afa 100644 --- a/module/Decision/src/Service/Organ.php +++ b/module/Decision/src/Service/Organ.php @@ -4,11 +4,14 @@ namespace Decision\Service; +use Application\Model\Enums\ApprovableStatus; use Application\Service\Email as EmailService; use Application\Service\FileStorage as FileStorageService; +use DateTime; use Decision\Form\OrganInformation as OrganInformationForm; use Decision\Mapper\Member as MemberMapper; use Decision\Mapper\Organ as OrganMapper; +use Decision\Mapper\OrganInformation as OrganInformationMapper; use Decision\Model\Enums\OrganTypes; use Decision\Model\Member as MemberModel; use Decision\Model\Organ as OrganModel; @@ -59,6 +62,7 @@ public function __construct( private readonly FileStorageService $storageService, private readonly EmailService $emailService, private readonly MemberMapper $memberMapper, + private readonly OrganInformationMapper $organInformationMapper, private readonly OrganMapper $organMapper, private readonly OrganInformationForm $organInformationForm, private readonly array $organInformationConfig, @@ -102,12 +106,6 @@ public function getOrgan(int $id): ?OrganModel */ public function getEditableOrgans(): array { - if (!$this->aclService->isAllowed('edit', 'organ')) { - throw new NotAllowedException( - $this->translator->translate('You are not allowed to edit organ information'), - ); - } - if ($this->aclService->isAllowed('editall', 'organ')) { return array_merge( $this->findActiveOrgansByType(OrganTypes::Committee), @@ -123,26 +121,18 @@ public function getEditableOrgans(): array } /** - * Checks if the current user is allowed to edit the given organ. + * Checks if the current user is allowed to use the given organ. */ - public function canEditOrgan(OrganModel $organ): bool + public function canUseOrgan(OrganModel $organ): bool { - if (!$this->aclService->isAllowed('edit', 'organ')) { - return false; - } - if ($this->aclService->isAllowed('editall', 'organ')) { return true; } - $organs = $this->memberMapper->findOrgans($this->aclService->getUserIdentityOrThrowException()->getMember()); - foreach ($organs as $memberOrgan) { - if ($memberOrgan->getId() === $organ->getId()) { - return true; - } - } - - return false; + return $this->memberMapper->isMemberOfOrgan( + $this->aclService->getUserIdentityOrThrowException()->getMember(), + $organ, + ); } /** @@ -192,9 +182,50 @@ public function findOrganByAbbr( ); } + /** + * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingTraversableTypeHintSpecification + */ + public function createOrganInformation( + OrganModel $organ, + array $data, + ): ?OrganInformationModel { + $form = $this->getOrganInformationForm(); + $form->setData($data); + $form->bind(new OrganInformationModel()); + + if (!$form->isValid()) { + return null; + } + + /** @var OrganInformationModel $organInformation */ + $organInformation = $form->getData(); + $organInformation->setOrgan($organ); + + $this->updateOrganInformationImages($organInformation, $data); + + // Automatically approve if a board member creates the organ information. + if ($this->aclService->isAllowed('approve', 'organ')) { + $organInformation->setApproved(ApprovableStatus::Approved); + $organInformation->setApprovedAt(new DateTime()); + $organInformation->setApprover($this->aclService->getUserIdentityOrThrowException()->getMember()); + } else { + $organInformation->setApproved(ApprovableStatus::Unapproved); + + $this->emailService->sendEmail( + 'organ_update', + 'email/organ-update', + 'Organ Profile Update', + ['organ' => $organInformation->getOrgan()], + ); + } + + $this->organInformationMapper->persist($organInformation); + + return $organInformation; + } + /** * @throws ORMException - * @throws ImagickException * * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingTraversableTypeHintSpecification */ @@ -202,10 +233,42 @@ public function updateOrganInformation( OrganInformationModel $organInformation, array $data, ): bool { + if ($this->aclService->isAllowed('approve', 'organ')) { + $organInformation->setApproved(ApprovableStatus::Approved); + $organInformation->setApprovedAt(new DateTime()); + $organInformation->setApprover($this->aclService->getUserIdentityOrThrowException()->getMember()); + } else { + $organInformation = clone $organInformation; + $organInformation->setApproved(ApprovableStatus::Unapproved); + $organInformation->setIsUpdate(true); + } + + // Update after the approval check to ensure we always have the correct `$organInformation`. + $this->updateOrganInformationImages($organInformation, $data); + + $this->entityManager->flush(); + + $this->emailService->sendEmail( + 'organ_update', + 'email/organ-update', + 'Organ Profile Update', + ['organ' => $organInformation->getOrgan()], + ); + + return true; + } + + /** + * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingTraversableTypeHintSpecification + */ + private function updateOrganInformationImages( + OrganInformationModel $organInformation, + array $data, + ): void { $config = $this->organInformationConfig; if ($data['cover']['size'] > 0) { - $coverPath = $this->makeOrganInformationImage( + $coverPath = $this->generateOrganInformationImage( $data['cover']['tmp_name'], floatval($data['coverCropX']), floatval($data['coverCropY']), @@ -219,7 +282,7 @@ public function updateOrganInformation( } if ($data['thumbnail']['size'] > 0) { - $thumbnailPath = $this->makeOrganInformationImage( + $thumbnailPath = $this->generateOrganInformationImage( $data['thumbnail']['tmp_name'], floatval($data['thumbnailCropX']), floatval($data['thumbnailCropY']), @@ -231,21 +294,6 @@ public function updateOrganInformation( $organInformation->setThumbnailPath($thumbnailPath); } - - $this->entityManager->flush(); - - if ($this->aclService->isAllowed('approve', 'organ')) { - $this->approveOrganInformation($organInformation); - } - - $this->emailService->sendEmail( - 'organ_update', - 'email/organ-update', - 'Organ Profile Update', - ['organ' => $organInformation->getOrgan()], - ); - - return true; } /** @@ -255,7 +303,7 @@ public function updateOrganInformation( * @param float $x The start x position in the image * @param float $y The start y position in the image * @param float $width The width of the area to crop - * @param float $height The height of the are to crop + * @param float $height The height of the area to crop * @param int $thumbWidth The width of the final thumbnail * @param int $thumbHeight The height of the final thumbnail * @@ -263,7 +311,7 @@ public function updateOrganInformation( * * @throws ImagickException */ - public function makeOrganInformationImage( + private function generateOrganInformationImage( string $file, float $x, float $y, @@ -290,36 +338,19 @@ public function makeOrganInformationImage( return $this->storageService->storeFile($tempFileName); } - /** - * @throws ORMException - */ - public function approveOrganInformation(OrganInformationModel $organInformation): void - { - $em = $this->entityManager; - $oldInformation = $organInformation->getOrgan()->getApprovedOrganInformation(); - - if (null !== $oldInformation) { - $em->remove($oldInformation); - } - - $user = $this->aclService->getUserIdentityOrThrowException()->getMember(); - $organInformation->setApprover($user); - $em->flush(); - } - /** * Get the OrganInformation form. */ - public function getOrganInformationForm(OrganInformationModel $organInformation): OrganInformationForm + public function getOrganInformationForm(?OrganModel $organ = null): OrganInformationForm { - if (!$this->canEditOrgan($organInformation->getOrgan())) { - throw new NotAllowedException( - $this->translator->translate('You are not allowed to edit this organ\'s information'), - ); + $form = $this->organInformationForm; + + if (null === $organ) { + return $form; } - $form = $this->organInformationForm; - $form->bind($organInformation); + // TODO: change this to be either the approved one or the latest update. + $form->bind($organ->getApprovedOrganInformation()); return $form; } @@ -327,14 +358,8 @@ public function getOrganInformationForm(OrganInformationModel $organInformation) /** * @throws ORMException */ - public function getEditableOrganInformation(int $organId): OrganInformationModel|bool + public function getEditableOrganInformation(OrganModel $organ): ?OrganInformationModel { - $organ = $this->getOrgan($organId); //TODO: catch exception - - if (null === $organ) { - return false; - } - $em = $this->entityManager; $organInformation = null; @@ -381,12 +406,16 @@ public function getEditableOrganInformation(int $organId): OrganInformationModel */ public function getOrganMemberInformation(OrganModel $organ): array { + $now = new DateTime(); $activeMembers = []; $inactiveMembers = []; $oldMembers = []; foreach ($organ->getMembers() as $install) { - if (null === $install->getDischargeDate()) { + if ( + null === $install->getDischargeDate() + || $install->getDischargeDate() > $now + ) { // current member if ('Inactief Lid' === $install->getFunction()) { // inactive diff --git a/module/Decision/view/decision/organ-admin-approval/approval.phtml b/module/Decision/view/decision/organ-admin-approval/approval.phtml new file mode 100644 index 0000000000..e69de29bb2 diff --git a/module/Decision/view/decision/organ-admin-approval/index.phtml b/module/Decision/view/decision/organ-admin-approval/index.phtml new file mode 100644 index 0000000000..e69de29bb2 diff --git a/module/Decision/view/decision/organ-admin-approval/proposal.phtml b/module/Decision/view/decision/organ-admin-approval/proposal.phtml new file mode 100644 index 0000000000..e69de29bb2 diff --git a/module/Decision/view/decision/organ-admin/edit.phtml b/module/Decision/view/decision/organ-admin/edit.phtml index dab3e9ae4d..a459ec3120 100644 --- a/module/Decision/view/decision/organ-admin/edit.phtml +++ b/module/Decision/view/decision/organ-admin/edit.phtml @@ -4,14 +4,17 @@ declare(strict_types=1); use Application\View\HelperTrait; use Decision\Form\OrganInformation as OrganInformationForm; +use Decision\Model\Organ as OrganModel; use Laminas\View\Renderer\PhpRenderer; /** * @var PhpRenderer|HelperTrait $this * @var OrganInformationForm $form + * @var OrganModel $organ */ -$lang = $this->plugin('translate')->getTranslator()->getLocale(); +$translator = $this->plugin('translate')->getTranslator(); +$lang = $translator->getLocale(); $this->headScript() ->appendFile( @@ -93,47 +96,90 @@ $form->setAttribute('id', 'editForm'); formElementErrors($element); ?> -
    - get('shortDutchDescription'); - $element->setAttribute('class', 'form-control'); - ?> - formLabel($element); ?> - formText($element); ?> - formElementErrors($element); ?> -
    - -
    - get('shortEnglishDescription'); - $element->setAttribute('class', 'form-control'); - ?> - formLabel($element); ?> - formText($element); ?> - formElementErrors($element); ?> -
    - -
    - get('dutchDescription'); - $element->setAttribute('id', 'dutch-description') - ->setAttribute('class', 'form-control'); - ?> - formLabel($element); ?> - formTextArea($element); ?> - formElementErrors($element); ?> +
    +
    +

    translate('Information') ?>

    +

    + translate('What is your %s about? Fill in the blanks below.'), + $organ->getType()->getName($translator), + ) ?> +

    +
    +
    +
    + +
    +
    + get('tagline') + ->setAttribute('class', 'form-control form-control-dutch') + ->setAttribute('id', 'tagline-nl'); + $tagline->setValue($this->localisedTextElement($tagline)); + ?> +
    + + formText($tagline) ?> + formElementErrors($tagline) ?> +
    + get('description') + ->setAttribute('class', 'form-control form-control-dutch') + ->setAttribute('style', 'width:100%; height:10em; resize:none') + ->setAttribute('id', 'description-nl'); + $description->setValue($this->localisedTextElement($description)); + ?> +
    + + formTextarea($description) ?> + formElementErrors($description) ?> +
    +
    +
    +
    + +
    +
    + get('taglineEn') + ->setAttribute('class', 'form-control form-control-english') + ->setAttribute('id', 'tagline-en'); + $taglineEn->setValue($this->localisedTextElement($taglineEn)); + ?> +
    + + formText($taglineEn) ?> + formElementErrors($taglineEn) ?> +
    + get('description') + ->setAttribute('class', 'form-control form-control-english') + ->setAttribute('style', 'width:100%; height:10em; resize:none') + ->setAttribute('id', 'description-en'); + $descriptionEn->setValue($this->localisedTextElement($descriptionEn)); + ?> +
    + + formTextarea($descriptionEn) ?> + formElementErrors($descriptionEn) ?> +
    +
    -
    - get('englishDescription'); - $element->setAttribute('id', 'english-description') - ->setAttribute('class', 'form-control'); - ?> - formLabel($element); ?> - formTextArea($element); ?> - formElementErrors($element); ?> -
    get('thumbnail'); @@ -176,7 +222,7 @@ foreach (['cover', 'thumbnail'] as $type) { ?> get('submit'); -$approve = $this->acl('decision_service_acl')->isAllowed('organ', 'approve') ? ' / ' . $this->translate('Approve') : ''; +$approve = $this->acl('decision_service_acl')->isAllowed('organInformation', 'approve') ? ' & ' . $this->translate('Approve') : ''; $submit->setLabel($this->translate('Save') . $approve); $submit->setAttribute('class', 'btn btn-primary'); ?> @@ -185,7 +231,7 @@ $submit->setAttribute('class', 'btn btn-primary'); form()->closeTag(); ?>