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

API: changed date-format, camelCase instead of snake_case, null values, update and create for customer and project (#718)

Browse Source
This commit is contained in:
Kevin Papst
2019-04-24 18:13:33 +02:00
committed by GitHub
parent 215d4fc8bf
commit 460391136f
61 changed files with 2304 additions and 505 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
src/Form/ActivityEditForm.php
View File

@@ -11,13 +11,14 @@ namespace App\Form;
use App\Entity\Activity;
use App\Form\Type\CustomerType;
use App\Form\Type\FixedRateType;
use App\Form\Type\HourlyRateType;
use App\Form\Type\ProjectType;
use App\Form\Type\YesNoType;
use App\Repository\CustomerRepository;
use App\Repository\ProjectRepository;
use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\Extension\Core\Type\CheckboxType;
use Symfony\Component\Form\Extension\Core\Type\MoneyType;
use Symfony\Component\Form\Extension\Core\Type\TextareaType;
use Symfony\Component\Form\Extension\Core\Type\TextType;
use Symfony\Component\Form\FormBuilderInterface;
@@ -66,18 +67,23 @@ class ActivityEditForm extends AbstractType
'label' => 'label.comment',
'required' => false,
])
->add('customer', CustomerType::class, [
'label' => 'label.customer',
'query_builder' => function (CustomerRepository $repo) use ($customer) {
return $repo->builderForEntityType($customer);
},
'data' => $customer ? $customer : null,
'required' => false,
'mapped' => false,
'project_enabled' => true,
])
;
if ($options['customer']) {
$builder
->add('customer', CustomerType::class, [
'query_builder' => function (CustomerRepository $repo) use ($customer) {
return $repo->builderForEntityType($customer);
},
'data' => $customer ? $customer : null,
'required' => false,
'mapped' => false,
'project_enabled' => true,
]);
}
$builder
->add('project', ProjectType::class, [
'label' => 'label.project',
'required' => false,
'query_builder' => function (ProjectRepository $repo) use ($project, $customer) {
return $repo->builderForEntityType($project, $customer);
@@ -103,14 +109,10 @@ class ActivityEditForm extends AbstractType
);
$builder
->add('fixedRate', MoneyType::class, [
'label' => 'label.fixedRate',
'required' => false,
->add('fixedRate', FixedRateType::class, [
'currency' => $currency,
])
->add('hourlyRate', MoneyType::class, [
'label' => 'label.hourlyRate',
'required' => false,
->add('hourlyRate', HourlyRateType::class, [
'currency' => $currency,
])
// boolean
@@ -119,7 +121,7 @@ class ActivityEditForm extends AbstractType
])
;
if (null === $id) {
if (null === $id && $options['create_more']) {
$builder->add('create_more', CheckboxType::class, [
'label' => 'label.create_more',
'required' => false,
@@ -138,6 +140,8 @@ class ActivityEditForm extends AbstractType
'csrf_protection' => true,
'csrf_field_name' => '_token',
'csrf_token_id' => 'admin_activity_edit',
'create_more' => false,
'customer' => false,
]);
}
}

24
src/Form/CustomerEditForm.php
View File

@@ -10,12 +10,13 @@
namespace App\Form;
use App\Entity\Customer;
use App\Form\Type\FixedRateType;
use App\Form\Type\HourlyRateType;
use App\Form\Type\YesNoType;
use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\Extension\Core\Type\CountryType;
use Symfony\Component\Form\Extension\Core\Type\CurrencyType;
use Symfony\Component\Form\Extension\Core\Type\EmailType;
use Symfony\Component\Form\Extension\Core\Type\MoneyType;
use Symfony\Component\Form\Extension\Core\Type\TelType;
use Symfony\Component\Form\Extension\Core\Type\TextareaType;
use Symfony\Component\Form\Extension\Core\Type\TextType;
@@ -34,8 +35,13 @@ class CustomerEditForm extends AbstractType
*/
public function buildForm(FormBuilderInterface $builder, array $options)
{
/** @var Customer $customer */
$customer = $options['data'];
$currency = false;
if (isset($options['data'])) {
/** @var Customer $customer */
$customer = $options['data'];
$currency = $customer->getCurrency();
}
$builder
->add('name', TextType::class, [
@@ -95,15 +101,11 @@ class CustomerEditForm extends AbstractType
->add('timezone', TimezoneType::class, [
'label' => 'label.timezone',
])
->add('fixedRate', MoneyType::class, [
'label' => 'label.fixedRate',
'required' => false,
'currency' => $customer->getCurrency() ?? false,
->add('fixedRate', FixedRateType::class, [
'currency' => $currency ?? false,
])
->add('hourlyRate', MoneyType::class, [
'label' => 'label.hourlyRate',
'required' => false,
'currency' => $customer->getCurrency() ?? false,
->add('hourlyRate', HourlyRateType::class, [
'currency' => $currency ?? false,
])
->add('visible', YesNoType::class, [
'label' => 'label.visible',

30
src/Form/ProjectEditForm.php
View File

@@ -12,6 +12,8 @@ namespace App\Form;
use App\Entity\Customer;
use App\Entity\Project;
use App\Form\Type\CustomerType;
use App\Form\Type\FixedRateType;
use App\Form\Type\HourlyRateType;
use App\Form\Type\YesNoType;
use App\Repository\CustomerRepository;
use Symfony\Component\Form\AbstractType;
@@ -32,15 +34,19 @@ class ProjectEditForm extends AbstractType
*/
public function buildForm(FormBuilderInterface $builder, array $options)
{
/** @var Project $entry */
$entry = $options['data'];
$customer = null;
$currency = false;
$id = null;
if ($entry->getId() !== null) {
$customer = $entry->getCustomer();
$currency = $customer->getCurrency();
if (isset($options['data'])) {
/** @var Project $entry */
$entry = $options['data'];
$id = $entry->getId();
if ($id !== null) {
$customer = $entry->getCustomer();
$currency = $customer->getCurrency();
}
}
$builder
@@ -59,19 +65,14 @@ class ProjectEditForm extends AbstractType
'required' => false,
])
->add('customer', CustomerType::class, [
'label' => 'label.customer',
'query_builder' => function (CustomerRepository $repo) use ($customer) {
return $repo->builderForEntityType($customer);
},
])
->add('fixedRate', MoneyType::class, [
'label' => 'label.fixedRate',
'required' => false,
->add('fixedRate', FixedRateType::class, [
'currency' => $currency,
])
->add('hourlyRate', MoneyType::class, [
'label' => 'label.hourlyRate',
'required' => false,
->add('hourlyRate', HourlyRateType::class, [
'currency' => $currency,
])
->add('budget', MoneyType::class, [
@@ -84,7 +85,7 @@ class ProjectEditForm extends AbstractType
])
;
if ($entry->getId() === null) {
if (null === $id && $options['create_more']) {
$builder->add('create_more', CheckboxType::class, [
'label' => 'label.create_more',
'required' => false,
@@ -104,6 +105,7 @@ class ProjectEditForm extends AbstractType
'csrf_field_name' => '_token',
'csrf_token_id' => 'admin_project_edit',
'currency' => Customer::DEFAULT_CURRENCY,
'create_more' => false,
]);
}
}

77
src/Form/TimesheetEditForm.php
View File

@@ -15,6 +15,8 @@ use App\Form\Type\ActivityType;
use App\Form\Type\CustomerType;
use App\Form\Type\DateTimePickerType;
use App\Form\Type\DurationType;
use App\Form\Type\FixedRateType;
use App\Form\Type\HourlyRateType;
use App\Form\Type\ProjectType;
use App\Form\Type\UserType;
use App\Form\Type\YesNoType;
@@ -23,7 +25,6 @@ use App\Repository\CustomerRepository;
use App\Repository\ProjectRepository;
use App\Timesheet\UserDateTimeFactory;
use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\Extension\Core\Type\MoneyType;
use Symfony\Component\Form\Extension\Core\Type\TextareaType;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\Form\FormEvent;
@@ -77,6 +78,7 @@ class TimesheetEditForm extends AbstractType
$currency = false;
$end = null;
$begin = null;
$customerCount = $this->customers->countCustomer(true);
if (isset($options['data'])) {
/** @var Timesheet $entry */
@@ -104,12 +106,20 @@ class TimesheetEditForm extends AbstractType
$timezone = $begin->getTimezone()->getName();
}
$dateTimeOptions = [
'model_timezone' => $timezone,
'view_timezone' => $timezone,
];
// primarily for API usage, where we cannot use a user/locale specific format
if (null !== $options['date_format']) {
$dateTimeOptions['format'] = $options['date_format'];
}
if (null === $end || !$this->configuration->isDurationOnly()) {
$builder->add('begin', DateTimePickerType::class, [
'label' => 'label.begin',
'model_timezone' => $timezone,
'view_timezone' => $timezone,
]);
$builder->add('begin', DateTimePickerType::class, array_merge($dateTimeOptions, [
'label' => 'label.begin'
]));
}
if ($this->configuration->isDurationOnly()) {
@@ -126,7 +136,7 @@ class TimesheetEditForm extends AbstractType
function (FormEvent $event) {
/** @var Timesheet $data */
$data = $event->getData();
if (null === $data->getEnd()) {
if (null === $data || null === $data->getEnd()) {
$event->getForm()->get('duration')->setData(null);
}
}
@@ -148,24 +158,19 @@ class TimesheetEditForm extends AbstractType
}
);
} else {
$builder->add('end', DateTimePickerType::class, [
$builder->add('end', DateTimePickerType::class, array_merge($dateTimeOptions, [
'label' => 'label.end',
'model_timezone' => $timezone,
'view_timezone' => $timezone,
'required' => false,
]);
]));
}
$projectOptions = [];
if ($this->customers->countCustomer(true) > 1) {
if ($customerCount < 2) {
$projectOptions['group_by'] = null;
} elseif ($options['customer']) {
$builder
->add('customer', CustomerType::class, [
// documentation is for NelmioApiDocBundle
'documentation' => [
'type' => 'integer',
'description' => 'Customer ID',
],
'query_builder' => function (CustomerRepository $repo) use ($customer) {
return $repo->builderForEntityType($customer);
},
@@ -175,8 +180,6 @@ class TimesheetEditForm extends AbstractType
'mapped' => false,
'project_enabled' => true,
]);
} else {
$projectOptions['group_by'] = null;
}
if ($this->projects->countProject(true) <= 1) {
@@ -188,16 +191,11 @@ class TimesheetEditForm extends AbstractType
'project',
ProjectType::class,
array_merge($projectOptions, [
'placeholder' => '',
'activity_enabled' => true,
// documentation is for NelmioApiDocBundle
'documentation' => [
'type' => 'integer',
'description' => 'Project ID',
],
'query_builder' => function (ProjectRepository $repo) use ($project, $customer) {
return $repo->builderForEntityType($project, $customer);
},
'placeholder' => '',
'activity_enabled' => true,
'query_builder' => function (ProjectRepository $repo) use ($project, $customer) {
return $repo->builderForEntityType($project, $customer);
},
])
);
@@ -223,12 +221,7 @@ class TimesheetEditForm extends AbstractType
$builder
->add('activity', ActivityType::class, [
// documentation is for NelmioApiDocBundle
'placeholder' => '',
'documentation' => [
'type' => 'integer',
'description' => 'Activity ID',
],
'query_builder' => function (ActivityRepository $repo) use ($activity, $project) {
return $repo->builderForEntityType($activity, $project);
},
@@ -262,20 +255,10 @@ class TimesheetEditForm extends AbstractType
if ($options['include_rate']) {
$builder
->add('fixedRate', MoneyType::class, [
'documentation' => [
'type' => 'float'
],
'label' => 'label.fixedRate',
'required' => false,
->add('fixedRate', FixedRateType::class, [
'currency' => $currency,
])
->add('hourlyRate', MoneyType::class, [
'documentation' => [
'type' => 'float'
],
'label' => 'label.hourlyRate',
'required' => false,
->add('hourlyRate', HourlyRateType::class, [
'currency' => $currency,
]);
}
@@ -306,6 +289,8 @@ class TimesheetEditForm extends AbstractType
'include_rate' => true,
'docu_chapter' => 'timesheet.html',
'method' => 'POST',
'date_format' => null,
'customer' => false,
]);
}
}

5
src/Form/Type/ActivityType.php
View File

@@ -67,6 +67,11 @@ class ActivityType extends AbstractType
public function configureOptions(OptionsResolver $resolver)
{
$resolver->setDefaults([
// documentation is for NelmioApiDocBundle
'documentation' => [
'type' => 'integer',
'description' => 'Activity ID',
],
'label' => 'label.activity',
'class' => Activity::class,
'choice_label' => [$this, 'choiceLabel'],

5
src/Form/Type/CustomerType.php
View File

@@ -28,6 +28,11 @@ class CustomerType extends AbstractType
public function configureOptions(OptionsResolver $resolver)
{
$resolver->setDefaults([
// documentation is for NelmioApiDocBundle
'documentation' => [
'type' => 'integer',
'description' => 'Customer ID',
],
'label' => 'label.customer',
'class' => Customer::class,
'choice_label' => 'name',

6
src/Form/Type/DateTimePickerType.php
View File

@@ -9,6 +9,7 @@
namespace App\Form\Type;
use App\API\BaseApiController;
use App\Timesheet\UserDateTimeFactory;
use App\Utils\LocaleSettings;
use Symfony\Component\Form\AbstractType;
@@ -50,6 +51,11 @@ class DateTimePickerType extends AbstractType
$timezone = $this->dateTime->getTimezone()->getName();
$resolver->setDefaults([
'documentation' => [
'type' => 'string',
'format' => 'date-time',
'example' => (new \DateTime())->format(BaseApiController::DATE_FORMAT_PHP),
],
'label' => 'label.begin',
'widget' => 'single_text',
'html5' => false,

44
src/Form/Type/FixedRateType.php Normal file
View File

@@ -0,0 +1,44 @@
<?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\Form\Type;
use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\Extension\Core\Type\MoneyType;
use Symfony\Component\OptionsResolver\OptionsResolver;
/**
* Custom form field type to set the fixed rate.
*/
class FixedRateType extends AbstractType
{
/**
* {@inheritdoc}
*/
public function configureOptions(OptionsResolver $resolver)
{
$resolver->setDefaults([
// documentation is for NelmioApiDocBundle
'documentation' => [
'type' => 'number',
'description' => 'Fixed rate',
],
'required' => false,
'label' => 'label.fixedRate',
]);
}
/**
* {@inheritdoc}
*/
public function getParent()
{
return MoneyType::class;
}
}

44
src/Form/Type/HourlyRateType.php Normal file
View File

@@ -0,0 +1,44 @@
<?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\Form\Type;
use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\Extension\Core\Type\MoneyType;
use Symfony\Component\OptionsResolver\OptionsResolver;
/**
* Custom form field type to set the hourly rate.
*/
class HourlyRateType extends AbstractType
{
/**
* {@inheritdoc}
*/
public function configureOptions(OptionsResolver $resolver)
{
$resolver->setDefaults([
// documentation is for NelmioApiDocBundle
'documentation' => [
'type' => 'number',
'description' => 'Hourly rate',
],
'required' => false,
'label' => 'label.hourlyRate',
]);
}
/**
* {@inheritdoc}
*/
public function getParent()
{
return MoneyType::class;
}
}

5
src/Form/Type/ProjectType.php
View File

@@ -49,6 +49,11 @@ class ProjectType extends AbstractType
public function configureOptions(OptionsResolver $resolver)
{
$resolver->setDefaults([
// documentation is for NelmioApiDocBundle
'documentation' => [
'type' => 'integer',
'description' => 'Project ID',
],
'label' => 'label.project',
'class' => Project::class,
'choice_label' => 'name',

2
src/Form/UserEditType.php
View File

@@ -16,14 +16,12 @@ use Symfony\Component\Form\Extension\Core\Type\EmailType;
use Symfony\Component\Form\Extension\Core\Type\TextType;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\OptionsResolver\OptionsResolver;
use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;
/**
* Defines the form used to edit the profile of a User.
*/
class UserEditType extends AbstractType
{
/**
* {@inheritdoc}
*/