jjsm01/kimai2
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

split timesheet validator to simplify imports (#3974)

Browse Source
This commit is contained in:
Kevin Papst
2023-04-27 13:56:07 +02:00
committed by GitHub
parent 046ed313c9
commit f60065d089
11 changed files with 213 additions and 77 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
src/Entity/Timesheet.php
View File

@@ -45,6 +45,7 @@ use Symfony\Component\Validator\Constraints as Assert;
#[Serializer\VirtualProperty('UserAsId', exp: 'object.getUser().getId()', options: [new Serializer\SerializedName('user'), new Serializer\Type(name: 'integer'), new Serializer\Groups(['Not_Expanded'])])]
#[Serializer\VirtualProperty('TagsAsArray', exp: 'object.getTagsAsArray()', options: [new Serializer\SerializedName('tags'), new Serializer\Type(name: 'array<string>'), new Serializer\Groups(['Default'])])]
#[Constraints\Timesheet]
#[Constraints\TimesheetDeactivated]
class Timesheet implements EntityWithMetaFields, ExportableItem
{
/**

6
src/Validator/Constraints/TimesheetBasic.php
View File

@@ -16,9 +16,6 @@ final class TimesheetBasic extends TimesheetConstraint
public const MISSING_ACTIVITY_ERROR = 'kimai-timesheet-84';
public const MISSING_PROJECT_ERROR = 'kimai-timesheet-85';
public const ACTIVITY_PROJECT_MISMATCH_ERROR = 'kimai-timesheet-86';
public const DISABLED_ACTIVITY_ERROR = 'kimai-timesheet-87';
public const DISABLED_PROJECT_ERROR = 'kimai-timesheet-88';
public const DISABLED_CUSTOMER_ERROR = 'kimai-timesheet-89';
public const PROJECT_NOT_STARTED = 'kimai-timesheet-91';
public const PROJECT_ALREADY_ENDED = 'kimai-timesheet-92';
public const PROJECT_DISALLOWS_GLOBAL_ACTIVITY = 'kimai-timesheet-93';
@@ -29,9 +26,6 @@ final class TimesheetBasic extends TimesheetConstraint
self::MISSING_ACTIVITY_ERROR => 'An activity needs to be selected.',
self::MISSING_PROJECT_ERROR => 'A project needs to be selected.',
self::ACTIVITY_PROJECT_MISMATCH_ERROR => 'Project mismatch, project specific activity and timesheet project are different.',
self::DISABLED_ACTIVITY_ERROR => 'Cannot start a disabled activity.',
self::DISABLED_PROJECT_ERROR => 'Cannot start a disabled project.',
self::DISABLED_CUSTOMER_ERROR => 'Cannot start a disabled customer.',
self::PROJECT_NOT_STARTED => 'The project has not started at that time.',
self::PROJECT_ALREADY_ENDED => 'The project is finished at that time.',
self::PROJECT_DISALLOWS_GLOBAL_ACTIVITY => 'Global activities are forbidden for the selected project.',

27
src/Validator/Constraints/TimesheetBasicValidator.php
View File

@@ -102,33 +102,6 @@ final class TimesheetBasicValidator extends ConstraintValidator
->addViolation();
}
$timesheetEnd = $timesheet->getEnd();
$newOrStarted = null === $timesheetEnd || $timesheet->getId() === null;
if ($newOrStarted && $hasActivity && !$activity->isVisible()) {
$context->buildViolation(TimesheetBasic::getErrorName(TimesheetBasic::DISABLED_ACTIVITY_ERROR))
->atPath('activity')
->setTranslationDomain('validators')
->setCode(TimesheetBasic::DISABLED_ACTIVITY_ERROR)
->addViolation();
}
if ($newOrStarted && !$project->isVisible()) {
$context->buildViolation(TimesheetBasic::getErrorName(TimesheetBasic::DISABLED_PROJECT_ERROR))
->atPath('project')
->setTranslationDomain('validators')
->setCode(TimesheetBasic::DISABLED_PROJECT_ERROR)
->addViolation();
}
if ($newOrStarted && !$project->getCustomer()->isVisible()) {
$context->buildViolation(TimesheetBasic::getErrorName(TimesheetBasic::DISABLED_CUSTOMER_ERROR))
->atPath('customer')
->setTranslationDomain('validators')
->setCode(TimesheetBasic::DISABLED_CUSTOMER_ERROR)
->addViolation();
}
if ($hasActivity && !$project->isGlobalActivities() && $activity->isGlobal()) {
$context->buildViolation(TimesheetBasic::getErrorName(TimesheetBasic::PROJECT_DISALLOWS_GLOBAL_ACTIVITY))
->atPath('activity')

33
src/Validator/Constraints/TimesheetDeactivated.php Normal file
View File

@@ -0,0 +1,33 @@
<?php
/*
* This file is part of the Kimai time-tracking app.
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace App\Validator\Constraints;
use Symfony\Component\Validator\Constraint;
#[\Attribute(\Attribute::TARGET_CLASS)]
final class TimesheetDeactivated extends Constraint
{
public const DISABLED_ACTIVITY_ERROR = 'kimai-timesheet-deactivated-activity';
public const DISABLED_PROJECT_ERROR = 'kimai-timesheet-deactivated-project';
public const DISABLED_CUSTOMER_ERROR = 'kimai-timesheet-deactivated-customer';
protected const ERROR_NAMES = [
self::DISABLED_ACTIVITY_ERROR => 'Cannot start a disabled activity.',
self::DISABLED_PROJECT_ERROR => 'Cannot start a disabled project.',
self::DISABLED_CUSTOMER_ERROR => 'Cannot start a disabled customer.',
];
public string $message = 'This timesheet has invalid settings.';
public function getTargets(): string|array
{
return self::CLASS_CONSTRAINT;
}
}

84
src/Validator/Constraints/TimesheetDeactivatedValidator.php Normal file
View File

@@ -0,0 +1,84 @@
<?php
/*
* This file is part of the Kimai time-tracking app.
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace App\Validator\Constraints;
use App\Entity\Timesheet as TimesheetEntity;
use Symfony\Component\Validator\Constraint;
use Symfony\Component\Validator\ConstraintValidator;
use Symfony\Component\Validator\Context\ExecutionContextInterface;
use Symfony\Component\Validator\Exception\UnexpectedTypeException;
/**
* This validator is separate, so it can be easily deactivated in import scenarios.
*/
final class TimesheetDeactivatedValidator extends ConstraintValidator
{
public function validate(mixed $value, Constraint $constraint): void
{
if (!($constraint instanceof TimesheetDeactivated)) {
throw new UnexpectedTypeException($constraint, TimesheetDeactivated::class);
}
if (!\is_object($value) || !($value instanceof TimesheetEntity)) {
throw new UnexpectedTypeException($value, TimesheetEntity::class);
}
$this->validateActivityAndProject($value, $this->context);
}
/**
* @param TimesheetEntity $timesheet
* @param ExecutionContextInterface $context
*/
protected function validateActivityAndProject(TimesheetEntity $timesheet, ExecutionContextInterface $context): void
{
$timesheetEnd = $timesheet->getEnd();
$newOrStarted = null === $timesheetEnd || $timesheet->getId() === null;
if (!$newOrStarted) {
return;
}
$activity = $timesheet->getActivity();
if (null !== $activity && !$activity->isVisible()) {
$context->buildViolation(TimesheetDeactivated::getErrorName(TimesheetDeactivated::DISABLED_ACTIVITY_ERROR))
->atPath('activity')
->setTranslationDomain('validators')
->setCode(TimesheetDeactivated::DISABLED_ACTIVITY_ERROR)
->addViolation();
}
$project = $timesheet->getProject();
if ($project === null) {
return;
}
if (!$project->isVisible()) {
$context->buildViolation(TimesheetDeactivated::getErrorName(TimesheetDeactivated::DISABLED_PROJECT_ERROR))
->atPath('project')
->setTranslationDomain('validators')
->setCode(TimesheetDeactivated::DISABLED_PROJECT_ERROR)
->addViolation();
}
$customer = $project->getCustomer();
if ($customer === null) {
return;
}
if (!$customer->isVisible()) {
$context->buildViolation(TimesheetDeactivated::getErrorName(TimesheetDeactivated::DISABLED_CUSTOMER_ERROR))
->atPath('customer')
->setTranslationDomain('validators')
->setCode(TimesheetDeactivated::DISABLED_CUSTOMER_ERROR)
->addViolation();
}
}
}

7
src/Validator/Constraints/TimesheetValidator.php
View File

@@ -38,11 +38,16 @@ final class TimesheetValidator extends ConstraintValidator
throw new UnexpectedTypeException($timesheet, TimesheetEntity::class);
}
$groups = [Constraint::DEFAULT_GROUP];
if ($this->context->getGroup() !== null) {
$groups = [$this->context->getGroup()];
}
foreach ($this->constraints as $innerConstraint) {
$this->context
->getValidator()
->inContext($this->context)
->validate($timesheet, $innerConstraint, [Constraint::DEFAULT_GROUP]);
->validate($timesheet, $innerConstraint, $groups);
}
}
}