diff --git a/src/Bundle/ChillDocGeneratorBundle/Controller/DocGeneratorTemplateController.php b/src/Bundle/ChillDocGeneratorBundle/Controller/DocGeneratorTemplateController.php index 21a830bfd..9a4d28284 100644 --- a/src/Bundle/ChillDocGeneratorBundle/Controller/DocGeneratorTemplateController.php +++ b/src/Bundle/ChillDocGeneratorBundle/Controller/DocGeneratorTemplateController.php @@ -18,6 +18,7 @@ use Chill\DocGeneratorBundle\Context\DocGeneratorContextWithPublicFormInterface; use Chill\DocGeneratorBundle\Context\Exception\ContextNotFoundException; use Chill\DocGeneratorBundle\Entity\DocGeneratorTemplate; use Chill\DocGeneratorBundle\GeneratorDriver\DriverInterface; +use Chill\DocGeneratorBundle\GeneratorDriver\Exception\TemplateException; use Chill\DocGeneratorBundle\Repository\DocGeneratorTemplateRepository; use Chill\DocStoreBundle\Entity\StoredObject; use Chill\MainBundle\Pagination\PaginatorFactory; @@ -28,10 +29,15 @@ use GuzzleHttp\Exception\TransferException; use Psr\Log\LoggerInterface; use Symfony\Bundle\FrameworkBundle\Controller\AbstractController; +use Symfony\Component\Form\Extension\Core\Type\FileType; +use Symfony\Component\HttpFoundation\File\File; +use Symfony\Component\HttpFoundation\RedirectResponse; use Symfony\Component\HttpFoundation\Request; // TODO à mettre dans services use Symfony\Component\HttpFoundation\Response; +use Symfony\Component\HttpFoundation\StreamedResponse; +use Symfony\Component\HttpKernel\Exception\BadRequestHttpException; use Symfony\Component\HttpKernel\Exception\HttpException; use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; use Symfony\Component\HttpKernel\KernelInterface; @@ -78,6 +84,27 @@ final class DocGeneratorTemplateController extends AbstractController $this->client = $client; } + /** + * @Route( + * "{_locale}/admin/doc/gen/generate/test/from/{template}/for/{entityClassName}/{entityId}", + * name="chill_docgenerator_test_generate_from_template" + * ) + */ + public function adminTestGenerateDocFromTemplateAction( + DocGeneratorTemplate $template, + string $entityClassName, + int $entityId, + Request $request + ): Response { + return $this->generateDocFromTemplate( + $template, + $entityClassName, + $entityId, + $request, + true + ); + } + /** * @Route( * "{_locale}/doc/gen/generate/from/{template}/for/{entityClassName}/{entityId}", @@ -89,6 +116,81 @@ final class DocGeneratorTemplateController extends AbstractController string $entityClassName, int $entityId, Request $request + ): Response { + return $this->generateDocFromTemplate( + $template, + $entityClassName, + $entityId, + $request, + false + ); + } + + /** + * @Route( + * "/api/1.0/docgen/templates/by-entity/{entityClassName}", + * name="chill_docgenerator_templates_for_entity_api" + * ) + */ + public function listTemplateApiAction(string $entityClassName): Response + { + $nb = $this->docGeneratorTemplateRepository->countByEntity($entityClassName); + $paginator = $this->paginatorFactory->create($nb); + $entities = $this->docGeneratorTemplateRepository->findByEntity( + $entityClassName, + $paginator->getCurrentPageFirstItemNumber(), + $paginator->getItemsPerPage() + ); + + return $this->json( + new Collection($entities, $paginator), + Response::HTTP_OK, + [], + [AbstractNormalizer::GROUPS => ['read']] + ); + } + + /** + * @Route( + * "{_locale}/admin/doc/gen/generate/test/redirect", + * name="chill_docgenerator_test_generate_redirect" + * ) + * + * @return void + */ + public function redirectToTestGenerate(Request $request): RedirectResponse + { + $template = $request->query->getInt('template'); + + if (null === $template) { + throw new BadRequestHttpException('template parameter is missing'); + } + + $entityClassName = $request->query->get('entityClassName'); + + if (null === $entityClassName) { + throw new BadRequestHttpException('entityClassName is missing'); + } + + $entityId = $request->query->get('entityId'); + + if (null === $entityId) { + throw new BadRequestHttpException('entityId is missing'); + } + + return $this->redirectToRoute( + 'chill_docgenerator_test_generate_from_template', + ['template' => $template, 'entityClassName' => $entityClassName, 'entityId' => $entityId, + 'returnPath' => $request->query->get('returnPath', '/'), ] + ); + } + + private function generateDocFromTemplate( + DocGeneratorTemplate $template, + string $entityClassName, + int $entityId, + Request $request, + bool $isTest ): Response { try { $context = $this->contextManager->getContextByDocGeneratorTemplate($template); @@ -105,9 +207,25 @@ final class DocGeneratorTemplateController extends AbstractController $contextGenerationData = []; if ($context instanceof DocGeneratorContextWithPublicFormInterface - && $context->hasPublicForm($template, $entity)) { - $builder = $this->createFormBuilder($context->getFormData($template, $entity)); + && $context->hasPublicForm($template, $entity) || $isTest) { + if ($context instanceof DocGeneratorContextWithPublicFormInterface) { + $builder = $this->createFormBuilder( + array_merge( + $context->getFormData($template, $entity), + $isTest ? ['test_file' => null] : [] + ) + ); + } + $context->buildPublicForm($builder, $template, $entity); + + if ($isTest) { + $builder->add('test_file', FileType::class, [ + 'label' => 'Template file', + 'required' => false, + ]); + } + $form = $builder->getForm()->handleRequest($request); if ($form->isSubmitted() && $form->isValid()) { @@ -121,43 +239,72 @@ final class DocGeneratorTemplateController extends AbstractController } } - $getUrlGen = $this->tempUrlGenerator->generate( - 'GET', - $template->getFile()->getFilename() - ); + if ($isTest && null !== $contextGenerationData['test_file']) { + /** @var File $file */ + $file = $contextGenerationData['test_file']; + $templateResource = fopen($file->getPathname(), 'rb'); + } else { + $getUrlGen = $this->tempUrlGenerator->generate( + 'GET', + $template->getFile()->getFilename() + ); - $data = $this->client->request('GET', $getUrlGen->url); + $data = $this->client->request('GET', $getUrlGen->url); - $iv = $template->getFile()->getIv(); // iv as an Array - $ivGoodFormat = pack('C*', ...$iv); // iv as a String (ok for openssl_decrypt) + $iv = $template->getFile()->getIv(); // iv as an Array + $ivGoodFormat = pack('C*', ...$iv); // iv as a String (ok for openssl_decrypt) - $method = 'AES-256-CBC'; + $method = 'AES-256-CBC'; - $key = $template->getFile()->getKeyInfos()['k']; - $keyGoodFormat = Base64Url::decode($key); + $key = $template->getFile()->getKeyInfos()['k']; + $keyGoodFormat = Base64Url::decode($key); - $dataDecrypted = openssl_decrypt($data->getContent(), $method, $keyGoodFormat, 1, $ivGoodFormat); + $dataDecrypted = openssl_decrypt($data->getContent(), $method, $keyGoodFormat, 1, $ivGoodFormat); - if (false === $dataDecrypted) { - throw new Exception('Error during Decrypt ', 1); + if (false === $dataDecrypted) { + throw new Exception('Error during Decrypt ', 1); + } + + if (false === $templateResource = fopen('php://memory', 'r+b')) { + $this->logger->error('Could not write data to memory'); + + throw new HttpException(500); + } + fwrite($templateResource, $dataDecrypted); + rewind($templateResource); } - if (false === $templateResource = fopen('php://memory', 'r+b')) { - $this->logger->error('Could not write data to memory'); - - throw new HttpException(500); - } - - fwrite($templateResource, $dataDecrypted); - rewind($templateResource); - $datas = $context->getData($template, $entity, $contextGenerationData); dump('datas compiled', $datas); - $generatedResource = $this->driver->generateFromResource($templateResource, $template->getFile()->getType(), $datas, $template->getFile()->getFilename()); + try { + $generatedResource = $this->driver->generateFromResource($templateResource, $template->getFile()->getType(), $datas, $template->getFile()->getFilename()); + } catch (TemplateException $e) { + $msg = implode("\n", $e->getErrors()); + + return new Response($msg, 400, [ + 'Content-Type' => 'text/plain', + ]); + } fclose($templateResource); + if ($isTest) { + return new StreamedResponse( + static function () use ($generatedResource) { + fpassthru($generatedResource); + fclose($generatedResource); + }, + Response::HTTP_OK, + [ + 'Content-Transfer-Encoding', 'binary', + 'Content-Type' => 'application/vnd.oasis.opendocument.text', + 'Content-Disposition' => sprintf('attachment; filename="%s.odt"', 'generated'), + 'Content-Length' => fstat($generatedResource)['size'], + ], + ); + } + $genDocName = 'doc_' . sprintf('%010d', mt_rand()) . 'odt'; $getUrlGen = $this->tempUrlGenerator->generate( @@ -206,28 +353,4 @@ final class DocGeneratorTemplateController extends AbstractController throw new Exception('Unable to generate document.'); } - - /** - * @Route( - * "/api/1.0/docgen/templates/by-entity/{entityClassName}", - * name="chill_docgenerator_templates_for_entity_api" - * ) - */ - public function listTemplateApiAction(string $entityClassName): Response - { - $nb = $this->docGeneratorTemplateRepository->countByEntity($entityClassName); - $paginator = $this->paginatorFactory->create($nb); - $entities = $this->docGeneratorTemplateRepository->findByEntity( - $entityClassName, - $paginator->getCurrentPageFirstItemNumber(), - $paginator->getItemsPerPage() - ); - - return $this->json( - new Collection($entities, $paginator), - Response::HTTP_OK, - [], - [AbstractNormalizer::GROUPS => ['read']] - ); - } } diff --git a/src/Bundle/ChillDocGeneratorBundle/GeneratorDriver/Exception/TemplateException.php b/src/Bundle/ChillDocGeneratorBundle/GeneratorDriver/Exception/TemplateException.php new file mode 100644 index 000000000..38f71cbab --- /dev/null +++ b/src/Bundle/ChillDocGeneratorBundle/GeneratorDriver/Exception/TemplateException.php @@ -0,0 +1,34 @@ +errors = $errors; + } + + public function getErrors(): array + { + return $this->errors; + } +} diff --git a/src/Bundle/ChillDocGeneratorBundle/GeneratorDriver/RelatorioDriver.php b/src/Bundle/ChillDocGeneratorBundle/GeneratorDriver/RelatorioDriver.php index 8889e72b1..98c2ff17d 100644 --- a/src/Bundle/ChillDocGeneratorBundle/GeneratorDriver/RelatorioDriver.php +++ b/src/Bundle/ChillDocGeneratorBundle/GeneratorDriver/RelatorioDriver.php @@ -11,6 +11,7 @@ declare(strict_types=1); namespace Chill\DocGeneratorBundle\GeneratorDriver; +use Chill\DocGeneratorBundle\GeneratorDriver\Exception\TemplateException; use Psr\Log\LoggerInterface; use Symfony\Component\DependencyInjection\ParameterBag\ParameterBagInterface; use Symfony\Component\Mime\Part\DataPart; @@ -45,7 +46,7 @@ class RelatorioDriver implements DriverInterface 'template' => new DataPart($template, $templateName ?? uniqid('template_'), $resourceType), ]; $form = new FormDataPart($formFields); - +dump(json_encode($data)); try { $response = $this->relatorioClient->request('POST', $this->url, [ 'headers' => $form->getPreparedHeaders()->toArray(), @@ -54,10 +55,21 @@ class RelatorioDriver implements DriverInterface return $response->toStream(); } catch (HttpExceptionInterface $e) { + $content = $e->getResponse()->getContent(false); + + if (400 === $e->getResponse()->getStatusCode()) { + $content = json_decode($content, true); + $this->logger->error('relatorio: template error', [ + 'error' => $content['message'] ?? '_not defined', + ]); + + throw new TemplateException([$content['message']]); + } + $this->logger->error('relatorio: error while generating document', [ 'msg' => $e->getMessage(), 'response' => $e->getResponse()->getStatusCode(), - 'content' => $e->getResponse()->getContent(false), + 'content' => $content, ]); throw $e; diff --git a/src/Bundle/ChillDocGeneratorBundle/Resources/views/Admin/DocGeneratorTemplate/index.html.twig b/src/Bundle/ChillDocGeneratorBundle/Resources/views/Admin/DocGeneratorTemplate/index.html.twig index 1cdad36ff..29050ce02 100644 --- a/src/Bundle/ChillDocGeneratorBundle/Resources/views/Admin/DocGeneratorTemplate/index.html.twig +++ b/src/Bundle/ChillDocGeneratorBundle/Resources/views/Admin/DocGeneratorTemplate/index.html.twig @@ -6,6 +6,7 @@ {{ 'Title'|trans }} {{ 'docgen.Context'|trans }} + {{ 'docgen.test generate'|trans }} {{ 'Edit'|trans }} {% endblock %} @@ -13,8 +14,22 @@ {% for entity in entities %} {{ entity.id }} - {{ entity.name | localize_translatable_string }} + {{ entity.name|localize_translatable_string}} {{ contextManager.getContextByKey(entity.context).name|trans }} + +
+ + + + + + +
+ {{ 'Edit'|trans }} diff --git a/src/Bundle/ChillDocGeneratorBundle/Serializer/Normalizer/DocGenObjectNormalizer.php b/src/Bundle/ChillDocGeneratorBundle/Serializer/Normalizer/DocGenObjectNormalizer.php index 0583d981a..f97d90e66 100644 --- a/src/Bundle/ChillDocGeneratorBundle/Serializer/Normalizer/DocGenObjectNormalizer.php +++ b/src/Bundle/ChillDocGeneratorBundle/Serializer/Normalizer/DocGenObjectNormalizer.php @@ -98,8 +98,9 @@ class DocGenObjectNormalizer implements NormalizerAwareInterface, NormalizerInte if ($reflection->hasProperty($attribute->getName())) { if (!$reflection->getProperty($attribute->getName())->hasType()) { throw new \LogicException(sprintf( - 'Could not determine how the content is determined for the attribute %s. Add a type on this property', - $attribute->getName() + 'Could not determine how the content is determined for the attribute %s on class %s. Add a type on this property', + $attribute->getName(), + $reflection->getName() )); } @@ -107,8 +108,9 @@ class DocGenObjectNormalizer implements NormalizerAwareInterface, NormalizerInte } elseif ($reflection->hasMethod($method = 'get' . ucfirst($attribute->getName()))) { if (!$reflection->getMethod($method)->hasReturnType()) { throw new \LogicException(sprintf( - 'Could not determine how the content is determined for the attribute %s. Add a return type on the method', - $attribute->getName() + 'Could not determine how the content is determined for the attribute %s on class %s. Add a return type on the method', + $attribute->getName(), + $reflection->getName() )); } @@ -116,8 +118,9 @@ class DocGenObjectNormalizer implements NormalizerAwareInterface, NormalizerInte } elseif ($reflection->hasMethod($method = 'is' . ucfirst($attribute->getName()))) { if (!$reflection->getMethod($method)->hasReturnType()) { throw new \LogicException(sprintf( - 'Could not determine how the content is determined for the attribute %s. Add a return type on the method', - $attribute->getName() + 'Could not determine how the content is determined for the attribute %s on class %s. Add a return type on the method', + $attribute->getName(), + $reflection->getName() )); } @@ -125,8 +128,9 @@ class DocGenObjectNormalizer implements NormalizerAwareInterface, NormalizerInte } elseif ($reflection->hasMethod($attribute->getName())) { if (!$reflection->getMethod($attribute->getName())->hasReturnType()) { throw new \LogicException(sprintf( - 'Could not determine how the content is determined for the attribute %s. Add a return type on the method', - $attribute->getName() + 'Could not determine how the content is determined for the attribute %s on class %s. Add a return type on the method', + $attribute->getName(), + $reflection->getName() )); } diff --git a/src/Bundle/ChillDocStoreBundle/Form/AccompanyingCourseDocumentType.php b/src/Bundle/ChillDocStoreBundle/Form/AccompanyingCourseDocumentType.php index 12797da79..64a81e9c7 100644 --- a/src/Bundle/ChillDocStoreBundle/Form/AccompanyingCourseDocumentType.php +++ b/src/Bundle/ChillDocStoreBundle/Form/AccompanyingCourseDocumentType.php @@ -11,8 +11,9 @@ declare(strict_types=1); namespace Chill\DocStoreBundle\Form; +use Chill\DocStoreBundle\Entity\AccompanyingCourseDocument; use Chill\DocStoreBundle\Entity\Document; -use Chill\DocStoreBundle\Entity\PersonDocument; +use Chill\DocStoreBundle\Entity\DocumentCategory; use Chill\MainBundle\Entity\User; use Chill\MainBundle\Form\Type\ChillDateType; use Chill\MainBundle\Form\Type\ChillTextareaType; @@ -70,11 +71,11 @@ class AccompanyingCourseDocumentType extends AbstractType //TODO : adapt to using AccompanyingCourseDocument categories. Currently there are none... ->add('category', EntityType::class, [ 'placeholder' => 'Choose a document category', - 'class' => 'ChillDocStoreBundle:DocumentCategory', + 'class' => DocumentCategory::class, 'query_builder' => static function (EntityRepository $er) { return $er->createQueryBuilder('c') ->where('c.documentClass = :docClass') - ->setParameter('docClass', PersonDocument::class); + ->setParameter('docClass', AccompanyingCourseDocument::class); }, 'choice_label' => function ($entity = null) { return $entity ? $this->translatableStringHelper->localize($entity->getName()) : ''; diff --git a/src/Bundle/ChillDocStoreBundle/Resources/views/AccompanyingCourseDocument/edit.html.twig b/src/Bundle/ChillDocStoreBundle/Resources/views/AccompanyingCourseDocument/edit.html.twig index 088a351f3..e28611701 100644 --- a/src/Bundle/ChillDocStoreBundle/Resources/views/AccompanyingCourseDocument/edit.html.twig +++ b/src/Bundle/ChillDocStoreBundle/Resources/views/AccompanyingCourseDocument/edit.html.twig @@ -41,5 +41,6 @@ {% endblock %} {% block css %} + {{ parent() }} {{ encore_entry_link_tags('mod_async_upload') }} {% endblock %} diff --git a/src/Bundle/ChillDocStoreBundle/Resources/views/AccompanyingCourseDocument/new.html.twig b/src/Bundle/ChillDocStoreBundle/Resources/views/AccompanyingCourseDocument/new.html.twig index 713654739..d76e5a745 100644 --- a/src/Bundle/ChillDocStoreBundle/Resources/views/AccompanyingCourseDocument/new.html.twig +++ b/src/Bundle/ChillDocStoreBundle/Resources/views/AccompanyingCourseDocument/new.html.twig @@ -42,5 +42,6 @@ {% endblock %} {% block css %} + {{ parent() }} {{ encore_entry_link_tags('mod_async_upload') }} {% endblock %} diff --git a/src/Bundle/ChillDocStoreBundle/Resources/views/AccompanyingCourseDocument/show.html.twig b/src/Bundle/ChillDocStoreBundle/Resources/views/AccompanyingCourseDocument/show.html.twig index 90bb6289d..97299675a 100644 --- a/src/Bundle/ChillDocStoreBundle/Resources/views/AccompanyingCourseDocument/show.html.twig +++ b/src/Bundle/ChillDocStoreBundle/Resources/views/AccompanyingCourseDocument/show.html.twig @@ -14,6 +14,11 @@ {{ encore_entry_script_tags('mod_async_upload') }} {% endblock %} +{% block css %} + {{ parent() }} + {{ encore_entry_link_tags('mod_async_upload') }} +{% endblock %} + {% block content %}

{{ 'Document %title%' | trans({ '%title%': document.title }) }}

diff --git a/src/Bundle/ChillMainBundle/Entity/Center.php b/src/Bundle/ChillMainBundle/Entity/Center.php index 10584bea9..5b25ee119 100644 --- a/src/Bundle/ChillMainBundle/Entity/Center.php +++ b/src/Bundle/ChillMainBundle/Entity/Center.php @@ -38,8 +38,9 @@ class Center implements HasCenterInterface * @ORM\Id * @ORM\Column(name="id", type="integer") * @ORM\GeneratedValue(strategy="AUTO") + * @Serializer\Groups({"docgen:read"}) */ - private $id; + private ?int $id = null; /** * @ORM\Column(type="string", length=255) diff --git a/src/Bundle/ChillMainBundle/Entity/Civility.php b/src/Bundle/ChillMainBundle/Entity/Civility.php index 4fcad0db8..1821da79d 100644 --- a/src/Bundle/ChillMainBundle/Entity/Civility.php +++ b/src/Bundle/ChillMainBundle/Entity/Civility.php @@ -22,7 +22,7 @@ class Civility { /** * @ORM\Column(type="json") - * @Serializer\Groups({"read"}) + * @Serializer\Groups({"read", "docgen:read"}) */ private array $abbreviation = []; @@ -35,13 +35,13 @@ class Civility * @ORM\Id * @ORM\GeneratedValue * @ORM\Column(type="integer") - * @Serializer\Groups({"read"}) + * @Serializer\Groups({"read", "docgen:read"}) */ - private $id; + private ?int $id = null; /** * @ORM\Column(type="json") - * @Serializer\Groups({"read"}) + * @Serializer\Groups({"read", "docgen:read"}) */ private array $name = []; diff --git a/src/Bundle/ChillMainBundle/Entity/Scope.php b/src/Bundle/ChillMainBundle/Entity/Scope.php index fc6084883..df5deb7a2 100644 --- a/src/Bundle/ChillMainBundle/Entity/Scope.php +++ b/src/Bundle/ChillMainBundle/Entity/Scope.php @@ -28,24 +28,20 @@ use Symfony\Component\Serializer\Annotation\Groups; class Scope { /** - * @var int - * * @ORM\Id * @ORM\Column(name="id", type="integer") * @ORM\GeneratedValue(strategy="AUTO") * @Groups({"read", "docgen:read"}) */ - private $id; + private ?int $id = null; /** * translatable names. * - * @var array - * * @ORM\Column(type="json") * @Groups({"read", "docgen:read"}) */ - private $name = []; + private array $name = []; /** * @var Collection diff --git a/src/Bundle/ChillMainBundle/Entity/User.php b/src/Bundle/ChillMainBundle/Entity/User.php index 2ed451a92..f5be4793a 100644 --- a/src/Bundle/ChillMainBundle/Entity/User.php +++ b/src/Bundle/ChillMainBundle/Entity/User.php @@ -55,7 +55,6 @@ class User implements AdvancedUserInterface * @var string * * @ORM\Column(type="string", length=150, nullable=true) - * @Serializer\Groups({"docgen:read"}) */ private ?string $email = null; @@ -83,7 +82,6 @@ class User implements AdvancedUserInterface /** * @ORM\Column(type="string", length=200) - * @Serializer\Groups({"docgen:read"}) */ private string $label = ''; @@ -95,7 +93,6 @@ class User implements AdvancedUserInterface /** * @ORM\ManyToOne(targetEntity=Center::class) - * @Serializer\Groups({"docgen:read"}) */ private ?Center $mainCenter = null; diff --git a/src/Bundle/ChillMainBundle/Entity/UserJob.php b/src/Bundle/ChillMainBundle/Entity/UserJob.php index bccba10dd..5f0bea45d 100644 --- a/src/Bundle/ChillMainBundle/Entity/UserJob.php +++ b/src/Bundle/ChillMainBundle/Entity/UserJob.php @@ -32,14 +32,14 @@ class UserJob * @ORM\Id * @ORM\Column(name="id", type="integer") * @ORM\GeneratedValue(strategy="AUTO") - * @Serializer\Groups({"read"}) + * @Serializer\Groups({"read", "docgen:read"}) */ protected ?int $id = null; /** * @var array|string[]A * @ORM\Column(name="label", type="json") - * @Serializer\Groups({"read"}) + * @Serializer\Groups({"read", "docgen:read"}) */ protected array $label = []; diff --git a/src/Bundle/ChillMainBundle/Phonenumber/PhonenumberHelper.php b/src/Bundle/ChillMainBundle/Phonenumber/PhonenumberHelper.php index 0bf1cc8f4..08243e560 100644 --- a/src/Bundle/ChillMainBundle/Phonenumber/PhonenumberHelper.php +++ b/src/Bundle/ChillMainBundle/Phonenumber/PhonenumberHelper.php @@ -260,7 +260,7 @@ class PhonenumberHelper return null; } - $validation = json_decode($response->getBody())->carrier->type; + $validation = json_decode($response->getBody()->getContents())->carrier->type; $item ->set($validation) diff --git a/src/Bundle/ChillMainBundle/Serializer/Normalizer/UserNormalizer.php b/src/Bundle/ChillMainBundle/Serializer/Normalizer/UserNormalizer.php index 22219b108..3932bc5e8 100644 --- a/src/Bundle/ChillMainBundle/Serializer/Normalizer/UserNormalizer.php +++ b/src/Bundle/ChillMainBundle/Serializer/Normalizer/UserNormalizer.php @@ -11,18 +11,31 @@ declare(strict_types=1); namespace Chill\MainBundle\Serializer\Normalizer; +use Chill\MainBundle\Entity\Center; +use Chill\MainBundle\Entity\Scope; use Chill\MainBundle\Entity\User; +use Chill\MainBundle\Entity\UserJob; use Chill\MainBundle\Templating\Entity\UserRender; +use Symfony\Component\Serializer\Normalizer\ContextAwareNormalizerInterface; use Symfony\Component\Serializer\Normalizer\NormalizerAwareInterface; use Symfony\Component\Serializer\Normalizer\NormalizerAwareTrait; use Symfony\Component\Serializer\Normalizer\NormalizerInterface; -class UserNormalizer implements NormalizerAwareInterface, NormalizerInterface +class UserNormalizer implements ContextAwareNormalizerInterface, NormalizerAwareInterface { use NormalizerAwareTrait; private UserRender $userRender; + const NULL_USER = [ + 'type' => 'user', + 'id' => '', + 'username' => '', + 'text' => '', + 'label' => '', + 'email' => '', + ]; + public function __construct(UserRender $userRender) { $this->userRender = $userRender; @@ -31,20 +44,42 @@ class UserNormalizer implements NormalizerAwareInterface, NormalizerInterface public function normalize($user, ?string $format = null, array $context = []) { /** @var User $user */ + $userJobContext = array_merge( + $context, ['docgen:expects' => UserJob::class, 'groups' => 'docgen:read']); + $scopeContext = array_merge( + $context, ['docgen:expects' => Scope::class, 'groups' => 'docgen:read']); + $centerContext = array_merge( + $context, ['docgen:expects' => Center::class, 'groups' => 'docgen:read']); + + if (null === $user && 'docgen' === $format) { + return array_merge(self::NULL_USER, [ + 'user_job' => $this->normalizer->normalize(null, $format, $userJobContext), + 'main_center' => $this->normalizer->normalize(null, $format, $centerContext), + 'main_scope' => $this->normalizer->normalize(null, $format, $scopeContext), + ]); + } return [ 'type' => 'user', 'id' => $user->getId(), 'username' => $user->getUsername(), 'text' => $this->userRender->renderString($user, []), 'label' => $user->getLabel(), - 'user_job' => $this->normalizer->normalize($user->getUserJob(), $format, $context), - 'main_center' => $this->normalizer->normalize($user->getMainCenter(), $format, $context), - 'main_scope' => $this->normalizer->normalize($user->getMainScope(), $format, $context), + 'email' => $user->getEmail(), + 'user_job' => $this->normalizer->normalize($user->getUserJob(), $format, $userJobContext), + 'main_center' => $this->normalizer->normalize($user->getMainCenter(), $format, $centerContext), + 'main_scope' => $this->normalizer->normalize($user->getMainScope(), $format, $scopeContext), ]; } - public function supportsNormalization($data, ?string $format = null): bool + public function supportsNormalization($data, ?string $format = null, array $context = []): bool { - return $data instanceof User && ('json' === $format || 'docgen' === $format); + if ($data instanceof User && ('json' === $format || 'docgen' === $format)) { + return true; + } + if (null === $data && 'docgen' === $format && User::class === ($context['docgen:expects'] ?? null)) { + return true; + } + + return false; } } diff --git a/src/Bundle/ChillPersonBundle/Controller/RelationshipApiController.php b/src/Bundle/ChillPersonBundle/Controller/RelationshipApiController.php index 72e92ac92..271b0cff7 100644 --- a/src/Bundle/ChillPersonBundle/Controller/RelationshipApiController.php +++ b/src/Bundle/ChillPersonBundle/Controller/RelationshipApiController.php @@ -14,10 +14,10 @@ namespace Chill\PersonBundle\Controller; use Chill\MainBundle\CRUD\Controller\ApiController; use Chill\PersonBundle\Entity\Person; use Chill\PersonBundle\Repository\Relationships\RelationshipRepository; +use Chill\PersonBundle\Security\Authorization\PersonVoter; use Sensio\Bundle\FrameworkExtraBundle\Configuration\ParamConverter; use Symfony\Component\HttpFoundation\Response; use Symfony\Component\Validator\Validator\ValidatorInterface; -use function array_values; class RelationshipApiController extends ApiController { @@ -36,9 +36,10 @@ class RelationshipApiController extends ApiController */ public function getRelationshipsByPerson(Person $person) { - //TODO: add permissions? (voter?) + $this->denyAccessUnlessGranted(PersonVoter::SEE, $person); + $relationships = $this->repository->findByPerson($person); - return $this->json(array_values($relationships), Response::HTTP_OK, [], ['groups' => ['read']]); + return $this->json($relationships, Response::HTTP_OK, [], ['groups' => ['read']]); } } diff --git a/src/Bundle/ChillPersonBundle/Entity/Household/HouseholdMember.php b/src/Bundle/ChillPersonBundle/Entity/Household/HouseholdMember.php index 829bc3ade..22c33f85f 100644 --- a/src/Bundle/ChillPersonBundle/Entity/Household/HouseholdMember.php +++ b/src/Bundle/ChillPersonBundle/Entity/Household/HouseholdMember.php @@ -65,7 +65,7 @@ class HouseholdMember * @ORM\Column(type="integer") * @Serializer\Groups({"read", "docgen:read"}) */ - private $id; + private ?int $id = null; /** * @var Person @@ -73,6 +73,7 @@ class HouseholdMember * targetEntity="\Chill\PersonBundle\Entity\Person" * ) * @Serializer\Groups({"read", "docgen:read"}) + * @Serializer\Context({"docgen:person:with-household": false}) * @Assert\Valid(groups={"household_memberships"}) * @Assert\NotNull(groups={"household_memberships"}) */ diff --git a/src/Bundle/ChillPersonBundle/Entity/Household/Position.php b/src/Bundle/ChillPersonBundle/Entity/Household/Position.php index b8f707126..45eb21524 100644 --- a/src/Bundle/ChillPersonBundle/Entity/Household/Position.php +++ b/src/Bundle/ChillPersonBundle/Entity/Household/Position.php @@ -35,7 +35,7 @@ class Position * @ORM\Column(type="integer") * @Serializer\Groups({"read", "docgen:read"}) */ - private ?int $id; + private ?int $id = null; /** * @ORM\Column(type="json") diff --git a/src/Bundle/ChillPersonBundle/Entity/Person.php b/src/Bundle/ChillPersonBundle/Entity/Person.php index f58cee747..fb34a779a 100644 --- a/src/Bundle/ChillPersonBundle/Entity/Person.php +++ b/src/Bundle/ChillPersonBundle/Entity/Person.php @@ -588,8 +588,6 @@ class Person implements HasCenterInterface, TrackCreationInterface, TrackUpdateI return $this; } - // a period opened and another one after it - /** * Function used for validation that check if the accompanying periods of * the person are not collapsing (i.e. have not shared days) or having diff --git a/src/Bundle/ChillPersonBundle/Entity/Relationships/Relationship.php b/src/Bundle/ChillPersonBundle/Entity/Relationships/Relationship.php index 45cd546b0..d51881bb2 100644 --- a/src/Bundle/ChillPersonBundle/Entity/Relationships/Relationship.php +++ b/src/Bundle/ChillPersonBundle/Entity/Relationships/Relationship.php @@ -19,6 +19,7 @@ use DateTimeImmutable; use DateTimeInterface; use Doctrine\ORM\Mapping as ORM; use Doctrine\ORM\Mapping\DiscriminatorColumn; +use RuntimeException; use Symfony\Component\Serializer\Annotation as Serializer; use Symfony\Component\Serializer\Annotation\DiscriminatorMap; use Symfony\Component\Validator\Constraints as Assert; @@ -116,6 +117,27 @@ class Relationship implements TrackCreationInterface, TrackUpdateInterface return $this->id; } + /** + * Return the opposite person of the @see{counterpart} person. + * + * this is the from person if the given is associated to the To, + * or the To person otherwise. + * + * @throw RuntimeException if the counterpart is neither in the from or to person + */ + public function getOpposite(Person $counterpart): Person + { + if ($this->fromPerson !== $counterpart && $this->toPerson !== $counterpart) { + throw new RuntimeException('the counterpart is neither the from nor to person for this relationship'); + } + + if ($this->fromPerson === $counterpart) { + return $this->toPerson; + } + + return $this->fromPerson; + } + public function getRelation(): ?Relation { return $this->relation; diff --git a/src/Bundle/ChillPersonBundle/Repository/Relationships/RelationshipRepository.php b/src/Bundle/ChillPersonBundle/Repository/Relationships/RelationshipRepository.php index ab172e459..9549a4564 100644 --- a/src/Bundle/ChillPersonBundle/Repository/Relationships/RelationshipRepository.php +++ b/src/Bundle/ChillPersonBundle/Repository/Relationships/RelationshipRepository.php @@ -11,18 +11,31 @@ declare(strict_types=1); namespace Chill\PersonBundle\Repository\Relationships; +use Chill\PersonBundle\Entity\Person; use Chill\PersonBundle\Entity\Relationships\Relationship; use Doctrine\ORM\EntityManagerInterface; use Doctrine\ORM\EntityRepository; +use Doctrine\ORM\QueryBuilder; use Doctrine\Persistence\ObjectRepository; class RelationshipRepository implements ObjectRepository { + private EntityManagerInterface $em; + private EntityRepository $repository; public function __construct(EntityManagerInterface $em) { $this->repository = $em->getRepository(Relationship::class); + $this->em = $em; + } + + public function countByPerson(Person $person): int + { + return $this->buildQueryByPerson($person) + ->select('COUNT(p)') + ->getQuery() + ->getSingleScalarResult(); } public function find($id): ?Relationship @@ -40,15 +53,13 @@ class RelationshipRepository implements ObjectRepository return $this->repository->findBy($criteria, $orderBy, $limit, $offset); } - public function findByPerson($personId): array + /** + * @return array|Relationship[] + */ + public function findByPerson(Person $person): array { - // return all relationships of which person is part? or only where person is the fromPerson? - return $this->repository->createQueryBuilder('r') - ->select('r, t') // entity Relationship - ->join('r.relation', 't') - ->where('r.fromPerson = :val') - ->orWhere('r.toPerson = :val') - ->setParameter('val', $personId) + return $this->buildQueryByPerson($person) + ->select('r') ->getQuery() ->getResult(); } @@ -62,4 +73,20 @@ class RelationshipRepository implements ObjectRepository { return Relationship::class; } + + private function buildQueryByPerson(Person $person): QueryBuilder + { + $qb = $this->em->createQueryBuilder(); + $qb + ->from(Relationship::class, 'r') + ->where( + $qb->expr()->orX( + $qb->expr()->eq('r.fromPerson', ':person'), + $qb->expr()->eq('r.toPerson', ':person') + ) + ) + ->setParameter('person', $person); + + return $qb; + } } diff --git a/src/Bundle/ChillPersonBundle/Serializer/Normalizer/AccompanyingPeriodDocGenNormalizer.php b/src/Bundle/ChillPersonBundle/Serializer/Normalizer/AccompanyingPeriodDocGenNormalizer.php index 473f6d75d..3f46a83fe 100644 --- a/src/Bundle/ChillPersonBundle/Serializer/Normalizer/AccompanyingPeriodDocGenNormalizer.php +++ b/src/Bundle/ChillPersonBundle/Serializer/Normalizer/AccompanyingPeriodDocGenNormalizer.php @@ -16,6 +16,8 @@ use Chill\MainBundle\Entity\User; use Chill\MainBundle\Security\Resolver\ScopeResolverDispatcher; use Chill\MainBundle\Templating\TranslatableStringHelper; use Chill\PersonBundle\Entity\AccompanyingPeriod; +use Chill\PersonBundle\Entity\AccompanyingPeriodParticipation; +use Chill\PersonBundle\Entity\Person; use Chill\PersonBundle\Entity\SocialWork\SocialIssue; use Chill\PersonBundle\Templating\Entity\ClosingMotiveRender; use Chill\PersonBundle\Templating\Entity\SocialIssueRender; @@ -89,17 +91,6 @@ class AccompanyingPeriodDocGenNormalizer implements ContextAwareNormalizerInterf public function normalize($period, ?string $format = null, array $context = []) { if ($period instanceof AccompanyingPeriod) { - $ignored = $context[self::IGNORE_FIRST_PASS_KEY] ?? []; - $ignored[] = spl_object_hash($period); - $initial = - $this->normalizer->normalize($period, $format, array_merge( - $context, - [self::IGNORE_FIRST_PASS_KEY => $ignored, AbstractNormalizer::GROUPS => 'docgen:read'] - )); - - // some transformation - $user = $initial['user']; - unset($initial['user']); $scopes = $this->scopeResolverDispatcher->isConcerned($period) ? $this->scopeResolverDispatcher->resolveScope($period) : []; @@ -107,28 +98,45 @@ class AccompanyingPeriodDocGenNormalizer implements ContextAwareNormalizerInterf $scopes = [$scopes]; } - return array_merge( - // get a first default data - $initial, - // and add data custom - [ - 'intensity' => $this->translator->trans($period->getIntensity()), - 'step' => $this->translator->trans('accompanying_period.' . $period->getStep()), - 'emergencyText' => $period->isEmergency() ? $this->translator->trans('accompanying_period.emergency') : '', - 'confidentialText' => $period->isConfidential() ? $this->translator->trans('confidential') : '', - //'originText' => null !== $period->getOrigin() ? $this->translatableStringHelper->localize($period->getOrigin()->getLabel()) : '', - 'closingMotiveText' => null !== $period->getClosingMotive() ? - $this->closingMotiveRender->renderString($period->getClosingMotive(), []) : '', - 'ref' => $user, - 'socialIssuesText' => implode(', ', array_map(function (SocialIssue $s) { - return $this->socialIssueRender->renderString($s, []); - }, $period->getSocialIssues()->toArray())), - 'scopesText' => implode(', ', array_map(function (Scope $s) { - return $this->translatableStringHelper->localize($s->getName()); - }, $scopes)), - 'scopes' => $scopes, - ] - ); + $dateContext = array_merge($context, ['docgen:expects' => DateTime::class, 'groups' => 'docgen:read']); + $userContext = array_merge($context, ['docgen:expects' => User::class, 'groups' => 'docgen:read']); + $participationContext = array_merge($context, ['docgen:expects' => AccompanyingPeriodParticipation::class, 'groups' => 'docgen:read']); + + return [ + 'id' => $period->getId(), + 'closingDate' => $this->normalizer->normalize($period->getClosingDate(), $format, $dateContext), + 'confidential' => $period->isConfidential(), + 'createdAt' => $this->normalizer->normalize($period->getCreatedAt(), $format, $dateContext), + 'createdBy' => $this->normalizer->normalize($period->getCreatedBy(), $format, $userContext), + 'emergency' => $period->isEmergency(), + 'openingDate' => $this->normalizer->normalize($period->getOpeningDate(), $format, $dateContext), + 'origin' => $this->normalizer->normalize($period->getOrigin(), $format, array_merge($context, ['docgen:expects' => AccompanyingPeriod\Origin::class])), + 'participations' => $this->normalizer->normalize($period->getParticipations(), $format, $participationContext), + 'currentParticipations' => $this->normalizer->normalize($period->getCurrentParticipations(), $format, $participationContext), + 'requestorAnonymous' => $period->isRequestorAnonymous(), + 'requestor' => $this->normalizer->normalize($period->getRequestor(), $format, array_merge($context, ['docgen:expects' => Person::class])), + 'resources' => $this->normalizer->normalize($period->getResources(), $format, $context), + 'scopes' => $this->normalizer->normalize($period->getScopes(), $format, array_merge($context, ['docgen:expects' => Scope::class, 'groups' => 'docgen:read'])), + 'socialIssues' => $this->normalizer->normalize($period->getSocialIssues(), $format, $context), + 'intensity' => $this->translator->trans($period->getIntensity()), + 'step' => $this->translator->trans('accompanying_period.' . $period->getStep()), + 'emergencyText' => $period->isEmergency() ? $this->translator->trans('accompanying_period.emergency') : '', + 'confidentialText' => $period->isConfidential() ? $this->translator->trans('confidential') : '', + //'originText' => null !== $period->getOrigin() ? $this->translatableStringHelper->localize($period->getOrigin()->getLabel()) : '', + 'isClosed' => $period->getClosingDate() !== null, + 'closingMotiveText' => null !== $period->getClosingMotive() ? + $this->closingMotiveRender->renderString($period->getClosingMotive(), []) : '', + 'ref' => $this->normalizer->normalize($period->getUser(), $format, $userContext), + 'hasRef' => $period->getUser() !== null, + 'socialIssuesText' => implode(', ', array_map(function (SocialIssue $s) { + return $this->socialIssueRender->renderString($s, []); + }, $period->getSocialIssues()->toArray())), + 'scopesText' => implode(', ', array_map(function (Scope $s) { + return $this->translatableStringHelper->localize($s->getName()); + }, $scopes)), + //'scopes' => $scopes, + 'hasRequestor' => $period->getRequestor() !== null, + ]; } elseif (null === $period) { return self::PERIOD_NULL; } @@ -143,10 +151,10 @@ class AccompanyingPeriodDocGenNormalizer implements ContextAwareNormalizerInterf } if ($data instanceof AccompanyingPeriod) { - if (array_key_exists(self::IGNORE_FIRST_PASS_KEY, $context) + /*if (array_key_exists(self::IGNORE_FIRST_PASS_KEY, $context) && in_array(spl_object_hash($data), $context[self::IGNORE_FIRST_PASS_KEY], true)) { return false; - } + }*/ return true; } diff --git a/src/Bundle/ChillPersonBundle/Serializer/Normalizer/PersonDocGenNormalizer.php b/src/Bundle/ChillPersonBundle/Serializer/Normalizer/PersonDocGenNormalizer.php index c12f6f6a7..d7ae700db 100644 --- a/src/Bundle/ChillPersonBundle/Serializer/Normalizer/PersonDocGenNormalizer.php +++ b/src/Bundle/ChillPersonBundle/Serializer/Normalizer/PersonDocGenNormalizer.php @@ -13,8 +13,10 @@ namespace Chill\PersonBundle\Serializer\Normalizer; use Chill\DocGeneratorBundle\Serializer\Helper\NormalizeNullValueHelper; use Chill\MainBundle\Templating\TranslatableStringHelper; +use Chill\PersonBundle\Entity\Household\Household; use Chill\PersonBundle\Entity\Person; use Chill\PersonBundle\Entity\PersonAltName; +use Chill\PersonBundle\Repository\Relationships\RelationshipRepository; use Chill\PersonBundle\Templating\Entity\PersonRender; use DateTimeInterface; use Symfony\Component\Serializer\Normalizer\ContextAwareNormalizerInterface; @@ -33,16 +35,20 @@ class PersonDocGenNormalizer implements private PersonRender $personRender; + private RelationshipRepository $relationshipRepository; + private TranslatableStringHelper $translatableStringHelper; private TranslatorInterface $translator; public function __construct( PersonRender $personRender, + RelationshipRepository $relationshipRepository, TranslatorInterface $translator, TranslatableStringHelper $translatableStringHelper ) { $this->personRender = $personRender; + $this->relationshipRepository = $relationshipRepository; $this->translator = $translator; $this->translatableStringHelper = $translatableStringHelper; } @@ -57,7 +63,8 @@ class PersonDocGenNormalizer implements return $this->normalizeNullValue($format, $context); } - return [ + $data = [ + 'kind' => 'person', 'firstname' => $person->getFirstName(), 'lastname' => $person->getLastName(), 'altNames' => implode( @@ -84,6 +91,28 @@ class PersonDocGenNormalizer implements 'memo' => $person->getMemo(), 'numberOfChildren' => (string) $person->getNumberOfChildren(), ]; + + if ($context['docgen:person:with-household'] ?? false) { + $data['household'] = $this->normalizer->normalize( + $person->getCurrentHousehold(), + $format, + array_merge($context, ['docgen:expects' => Household::class]) + ); + } + + if ($context['docgen:person:with-relations'] ?? false) { + $data['relations'] = $this->normalizer->normalize( + $this->relationshipRepository->findByPerson($person), + $format, + array_merge($context, [ + 'docgen:person:with-household' => false, + 'docgen:person:with-relation' => false, + 'docgen:relationship:counterpart' => $person, + ]) + ); + } + + return $data; } public function supportsNormalization($data, ?string $format = null, array $context = []) diff --git a/src/Bundle/ChillPersonBundle/Serializer/Normalizer/RelationshipDocGenNormalizer.php b/src/Bundle/ChillPersonBundle/Serializer/Normalizer/RelationshipDocGenNormalizer.php new file mode 100644 index 000000000..35e7f1056 --- /dev/null +++ b/src/Bundle/ChillPersonBundle/Serializer/Normalizer/RelationshipDocGenNormalizer.php @@ -0,0 +1,90 @@ +translatableStringHelper = $translatableStringHelper; + } + + /** + * @param Relationship $relation + */ + public function normalize($relation, ?string $format = null, array $context = []) + { + $counterpart = $context['docgen:relationship:counterpart'] ?? null; + $contextPerson = array_merge($context, [ + 'docgen:person:with-relation' => false, + 'docgen:relationship:counterpart' => null, + 'docgen:expects' => Person::class, + ]); + + if (null !== $counterpart) { + $opposite = $relation->getOpposite($counterpart); + } else { + $opposite = null; + } + + if (null === $relation) { + return [ + 'id' => '', + 'fromPerson' => $nullPerson = $this->normalizer->normalize(null, $format, $contextPerson), + 'toPerson' => $nullPerson, + 'opposite' => $nullPerson, + 'text' => '', + 'relationId' => '', + ]; + } + + return [ + 'id' => $relation->getId(), + 'fromPerson' => $this->normalizer->normalize( + $relation->getFromPerson(), + $format, + $contextPerson + ), + 'toPerson' => $this->normalizer->normalize( + $relation->getToPerson(), + $format, + $contextPerson + ), + 'text' => $relation->getReverse() ? + $this->translatableStringHelper->localize($relation->getRelation()->getReverseTitle()) : + $this->translatableStringHelper->localize($relation->getRelation()->getTitle()), + 'opposite' => $this->normalizer->normalize($opposite, $format, $contextPerson), + 'relationId' => $relation->getRelation()->getId(), + ]; + } + + public function supportsNormalization($data, ?string $format = null, array $context = []) + { + if ('docgen' !== $format) { + return false; + } + + return $data instanceof Relationship || (null === $data + && Relationship::class === ($context['docgen:expects'] ?? null)); + } +} diff --git a/src/Bundle/ChillPersonBundle/Serializer/Normalizer/SocialActionNormalizer.php b/src/Bundle/ChillPersonBundle/Serializer/Normalizer/SocialActionNormalizer.php index 5fa12f741..1274b46b9 100644 --- a/src/Bundle/ChillPersonBundle/Serializer/Normalizer/SocialActionNormalizer.php +++ b/src/Bundle/ChillPersonBundle/Serializer/Normalizer/SocialActionNormalizer.php @@ -36,8 +36,8 @@ class SocialActionNormalizer implements NormalizerAwareInterface, NormalizerInte 'id' => $socialAction->getId(), 'type' => 'social_work_social_action', 'text' => $this->render->renderString($socialAction, []), - 'parent' => $this->normalizer->normalize($socialAction->getParent()), - 'desactivationDate' => $this->normalizer->normalize($socialAction->getDesactivationDate()), + 'parent' => $this->normalizer->normalize($socialAction->getParent(), $format, $context), + 'desactivationDate' => $this->normalizer->normalize($socialAction->getDesactivationDate(), $format, $context), 'title' => $socialAction->getTitle(), ]; diff --git a/src/Bundle/ChillPersonBundle/Service/DocGenerator/AccompanyingPeriodContext.php b/src/Bundle/ChillPersonBundle/Service/DocGenerator/AccompanyingPeriodContext.php index 10431d7aa..ae15f2292 100644 --- a/src/Bundle/ChillPersonBundle/Service/DocGenerator/AccompanyingPeriodContext.php +++ b/src/Bundle/ChillPersonBundle/Service/DocGenerator/AccompanyingPeriodContext.php @@ -68,6 +68,8 @@ class AccompanyingPeriodContext implements public function adminFormReverseTransform(array $data): array { + dump($data); + if (array_key_exists('category', $data)) { $data['category'] = [ 'idInsideBundle' => $data['category']->getIdInsideBundle(), @@ -80,7 +82,7 @@ class AccompanyingPeriodContext implements public function adminFormTransform(array $data): array { - $data = [ + $r = [ 'mainPerson' => $data['mainPerson'] ?? false, 'mainPersonLabel' => $data['mainPersonLabel'] ?? $this->translator->trans('docgen.Main person'), 'person1' => $data['person1'] ?? false, @@ -90,11 +92,11 @@ class AccompanyingPeriodContext implements ]; if (array_key_exists('category', $data)) { - $data['category'] = array_key_exists('category', $data) ? + $r['category'] = array_key_exists('category', $data) ? $this->documentCategoryRepository->find($data['category']) : null; } - return $data; + return $r; } public function buildAdminForm(FormBuilderInterface $builder): void @@ -169,11 +171,11 @@ class AccompanyingPeriodContext implements $options = $template->getOptions(); $data = []; - $data['course'] = $this->normalizer->normalize($entity, 'docgen', ['docgen:expects' => AccompanyingPeriod::class]); + $data['course'] = $this->normalizer->normalize($entity, 'docgen', ['docgen:expects' => AccompanyingPeriod::class, 'groups' => 'docgen:read']); foreach (['mainPerson', 'person1', 'person2'] as $k) { if ($options[$k]) { - $data[$k] = $this->normalizer->normalize($contextGenerationData[$k], 'docgen', ['docgen:expects' => Person::class]); + $data[$k] = $this->normalizer->normalize($contextGenerationData[$k], 'docgen', ['docgen:expects' => Person::class, 'groups' => 'docgen:read']); } } @@ -204,7 +206,7 @@ class AccompanyingPeriodContext implements public function getName(): string { - return 'Accompanying Period basic'; + return 'docgen.Accompanying Period basic'; } public function hasAdminForm(): bool @@ -231,7 +233,7 @@ class AccompanyingPeriodContext implements ->setCourse($entity) ->setObject($storedObject); - if (array_key_exists('category', $template->getOptions()['category'])) { + if (array_key_exists('category', $template->getOptions())) { $doc ->setCategory( $this->documentCategoryRepository->find( diff --git a/src/Bundle/ChillPersonBundle/Service/DocGenerator/AccompanyingPeriodWorkContext.php b/src/Bundle/ChillPersonBundle/Service/DocGenerator/AccompanyingPeriodWorkContext.php index 09d154900..b47c46b00 100644 --- a/src/Bundle/ChillPersonBundle/Service/DocGenerator/AccompanyingPeriodWorkContext.php +++ b/src/Bundle/ChillPersonBundle/Service/DocGenerator/AccompanyingPeriodWorkContext.php @@ -102,7 +102,7 @@ class AccompanyingPeriodWorkContext implements public function getName(): string { - return 'Accompanying period work'; + return 'docgen.Accompanying period work'; } public function hasAdminForm(): bool diff --git a/src/Bundle/ChillPersonBundle/Service/DocGenerator/AccompanyingPeriodWorkEvaluationContext.php b/src/Bundle/ChillPersonBundle/Service/DocGenerator/AccompanyingPeriodWorkEvaluationContext.php index 9c8d6172a..26004eee3 100644 --- a/src/Bundle/ChillPersonBundle/Service/DocGenerator/AccompanyingPeriodWorkEvaluationContext.php +++ b/src/Bundle/ChillPersonBundle/Service/DocGenerator/AccompanyingPeriodWorkEvaluationContext.php @@ -153,7 +153,7 @@ class AccompanyingPeriodWorkEvaluationContext implements public function getName(): string { - return 'Accompanying period work context'; + return 'docgen.Accompanying period work context'; } public function hasAdminForm(): bool diff --git a/src/Bundle/ChillPersonBundle/Tests/Controller/AccompanyingCourseApiControllerTest.php b/src/Bundle/ChillPersonBundle/Tests/Controller/AccompanyingCourseApiControllerTest.php index bcee2941a..cfd126ad2 100644 --- a/src/Bundle/ChillPersonBundle/Tests/Controller/AccompanyingCourseApiControllerTest.php +++ b/src/Bundle/ChillPersonBundle/Tests/Controller/AccompanyingCourseApiControllerTest.php @@ -388,7 +388,7 @@ final class AccompanyingCourseApiControllerTest extends WebTestCase $this->assertTrue(in_array($this->client->getResponse()->getStatusCode(), [200, 422], true)); - if ($response->getStatusCode() === 422) { + if ($this->client->getResponse()->getStatusCode() === 422) { $this->markTestSkipped('the next tests should appears only on valid accompanying period'); } @@ -522,7 +522,7 @@ final class AccompanyingCourseApiControllerTest extends WebTestCase $this->assertTrue(in_array($this->client->getResponse()->getStatusCode(), [200, 422], true)); - if ($response->getStatusCode() === 422) { + if ($this->client->getResponse()->getStatusCode() === 422) { $this->markTestSkipped('the next tests should appears only on valid accompanying period'); } diff --git a/src/Bundle/ChillPersonBundle/Tests/Serializer/Normalizer/PersonDocGenNormalizerTest.php b/src/Bundle/ChillPersonBundle/Tests/Serializer/Normalizer/PersonDocGenNormalizerTest.php index 64c7c5c5a..fea2cdc72 100644 --- a/src/Bundle/ChillPersonBundle/Tests/Serializer/Normalizer/PersonDocGenNormalizerTest.php +++ b/src/Bundle/ChillPersonBundle/Tests/Serializer/Normalizer/PersonDocGenNormalizerTest.php @@ -11,9 +11,21 @@ declare(strict_types=1); namespace Serializer\Normalizer; +use Chill\MainBundle\Templating\TranslatableStringHelper; +use Chill\MainBundle\Templating\TranslatableStringHelperInterface; +use Chill\PersonBundle\Entity\Household\Household; +use Chill\PersonBundle\Entity\Household\HouseholdMember; +use Chill\PersonBundle\Entity\Household\Position; use Chill\PersonBundle\Entity\Person; +use Chill\PersonBundle\Entity\Relationships\Relation; +use Chill\PersonBundle\Entity\Relationships\Relationship; +use Chill\PersonBundle\Repository\Relationships\RelationshipRepository; +use Chill\PersonBundle\Serializer\Normalizer\PersonDocGenNormalizer; +use Chill\PersonBundle\Templating\Entity\PersonRender; +use Prophecy\Argument; use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase; use Symfony\Component\Serializer\Normalizer\NormalizerInterface; +use Symfony\Contracts\Translation\TranslatorInterface; use function array_merge; /** @@ -77,8 +89,124 @@ final class PersonDocGenNormalizerTest extends KernelTestCase */ public function testNormalize(?Person $person, $expected, $msg) { - $normalized = $this->normalizer->normalize($person, 'docgen', ['docgen:expects' => Person::class]); + $normalized = $this->normalizer->normalize($person, 'docgen', [ + 'docgen:expects' => Person::class, + 'groups' => 'docgen:read', + ]); $this->assertEquals($expected, $normalized, $msg); } + + public function testNormalizePersonWithHousehold() + { + $household = new Household(); + $person = new Person(); + $person + ->setFirstName('Renaud') + ->setLastName('Mégane'); + $householdMember = new HouseholdMember(); + $householdMember + ->setPosition((new Position())->setAllowHolder(true)->setLabel(['fr' => 'position']) + ->setShareHousehold(true)) + ->setHolder(true); + $person->addHouseholdParticipation($householdMember); + $household->addMember($householdMember); + + $person = new Person(); + $person + ->setFirstName('Citroen') + ->setLastName('Xsara'); + $householdMember = new HouseholdMember(); + $householdMember + ->setPosition((new Position())->setAllowHolder(true)->setLabel(['fr' => 'position2']) + ->setShareHousehold(true)) + ->setHolder(false); + $person->addHouseholdParticipation($householdMember); + $household->addMember($householdMember); + + $actual = $this->normalizer->normalize($person, 'docgen', [ + 'groups' => 'docgen:read', + 'docgen:expects' => Person::class, + 'docgen:person:with-household' => true, + ]); + + $this->assertCount(2, $household->getMembers()); + $this->assertIsArray($actual); + $this->assertArrayHasKey('household', $actual); + $this->assertCount(2, $actual['household']['currentMembers']); + $this->assertCount(2, $actual['household']['members']); + } + + public function testNormalizePersonWithRelationships() + { + $person = (new Person())->setFirstName('Renaud')->setLastName('megane'); + $father = (new Person())->setFirstName('Clément')->setLastName('megane'); + $mother = (new Person())->setFirstName('Mireille')->setLastName('Mathieu'); + $sister = (new Person())->setFirstName('Callie')->setLastName('megane'); + + $relations = [ + (new Relationship())->setFromPerson($person)->setToPerson($father) + ->setReverse(false)->setRelation((new Relation())->setTitle(['fr' => 'Père']) + ->setReverseTitle(['fr' => 'Fils'])), + (new Relationship())->setFromPerson($person)->setToPerson($mother) + ->setReverse(false)->setRelation((new Relation())->setTitle(['fr' => 'Mère']) + ->setReverseTitle(['fr' => 'Fils'])), + (new Relationship())->setFromPerson($person)->setToPerson($sister) + ->setReverse(true)->setRelation((new Relation())->setTitle(['fr' => 'Frère']) + ->setReverseTitle(['fr' => 'Soeur'])), + ]; + + $repository = $this->prophesize(RelationshipRepository::class); + $repository->findByPerson($person)->willReturn($relations); + + $normalizer = $this->buildPersonNormalizer(null, $repository->reveal(), null, null); + + $actual = $normalizer->normalize($person, 'docgen', [ + 'groups' => 'docgen:read', + 'docgen:expects' => Person::class, + 'docgen:person:with-relations' => true, + ]); + + $this->assertIsArray($actual); + $this->assertArrayHasKey('relations', $actual); + $this->assertCount(3, $actual['relations']); + } + + private function buildPersonNormalizer( + ?PersonRender $personRender = null, + ?RelationshipRepository $relationshipRepository = null, + ?TranslatorInterface $translator = null, + ?TranslatableStringHelper $translatableStringHelper = null + ): PersonDocGenNormalizer { + $normalizer = new PersonDocGenNormalizer( + $personRender ?? self::$container->get(PersonRender::class), + $relationshipRepository ?? self::$container->get(RelationshipRepository::class), + $translator ?? self::$container->get(TranslatorInterface::class), + $translatableStringHelper ?? self::$container->get(TranslatableStringHelperInterface::class) + ); + $normalizerManager = $this->prophesize(NormalizerInterface::class); + $normalizerManager->supportsNormalization(Argument::any(), 'docgen', Argument::any())->willReturn(true); + $normalizerManager->normalize(Argument::type(Person::class), 'docgen', Argument::any()) + ->will(static function ($args) use ($normalizer) { + return $normalizer->normalize($args[0], $args[1], $args[2]); + }); + $normalizerManager->normalize(Argument::any(), 'docgen', Argument::any())->will( + static function ($args) { + if (is_iterable($args[0])) { + $r = []; + + foreach ($args[0] as $i) { + $r[] = ['fake' => true, 'hash' => spl_object_hash($i)]; + } + + return $r; + } + + return ['fake' => true, 'hash' => null !== $args[0] ? spl_object_hash($args[0]) : null]; + } + ); + $normalizer->setNormalizer($normalizerManager->reveal()); + + return $normalizer; + } } diff --git a/src/Bundle/ChillPersonBundle/Tests/Serializer/Normalizer/RelationshipDocGenNormalizerTest.php b/src/Bundle/ChillPersonBundle/Tests/Serializer/Normalizer/RelationshipDocGenNormalizerTest.php new file mode 100644 index 000000000..ea2da19a8 --- /dev/null +++ b/src/Bundle/ChillPersonBundle/Tests/Serializer/Normalizer/RelationshipDocGenNormalizerTest.php @@ -0,0 +1,158 @@ +buildNormalizer(); + + $this->assertTrue($normalizer->supportsNormalization($relationship, 'docgen', [ + 'docgen:expects' => Relationship::class, + ])); + $this->assertFalse($normalizer->supportsNormalization($relationship, 'docgen', [ + 'docgen:expects' => Person::class, + ])); + + $actual = $normalizer->normalize($relationship, 'docgen', [ + 'docgen:expects' => Relationship::class, + ]); + $this->assertIsArray($actual); + $this->assertEqualsCanonicalizing( + ['fromPerson', 'toPerson', 'id', 'relationId', 'text', 'opposite'], + array_keys($actual), + 'check that the expected keys are present' + ); + } + + public function testNormalizeRelationshipWithCounterPart() + { + $relationship = new Relationship(); + $relationship + ->setFromPerson($person1 = new Person()) + ->setToPerson($person2 = new Person()) + ->setRelation( + (new Relation())->setTitle(['fr' => 'title']) + ->setReverseTitle(['fr' => 'reverse title']) + ) + ->setReverse(false); + + $normalizer = $this->buildNormalizer(); + + $this->assertTrue($normalizer->supportsNormalization($relationship, 'docgen', [])); + $this->assertFalse($normalizer->supportsNormalization($person1, 'docgen', [])); + + $actual = $normalizer->normalize($relationship, 'docgen', [ + 'docgen:expects' => Relationship::class, + 'docgen:relationship:counterpart' => $person1, + ]); + + $this->assertIsArray($actual); + $this->assertEqualsCanonicalizing( + ['fromPerson', 'toPerson', 'id', 'relationId', 'text', 'opposite'], + array_keys($actual), + 'check that the expected keys are present' + ); + $this->assertEquals(spl_object_hash($person2), $actual['opposite']['hash']); + } + + public function testNormalizeRelationshipWithoutCounterPart() + { + $relationship = new Relationship(); + $relationship + ->setFromPerson($person1 = new Person()) + ->setToPerson($person2 = new Person()) + ->setRelation( + (new Relation())->setTitle(['fr' => 'title']) + ->setReverseTitle(['fr' => 'reverse title']) + ) + ->setReverse(false); + + $normalizer = $this->buildNormalizer(); + + $this->assertTrue($normalizer->supportsNormalization($relationship, 'docgen', [])); + $this->assertFalse($normalizer->supportsNormalization($person1, 'docgen', [])); + + $actual = $normalizer->normalize($relationship, 'docgen', [ + 'docgen:expects' => Relationship::class, + ]); + $this->assertIsArray($actual); + $this->assertEqualsCanonicalizing( + ['fromPerson', 'toPerson', 'id', 'relationId', 'text', 'opposite'], + array_keys($actual), + 'check that the expected keys are present' + ); + $this->assertEquals(null, $actual['opposite']); + } + + private function buildNormalizer(): RelationshipDocGenNormalizer + { + $translatableStringHelper = $this->prophesize(TranslatableStringHelperInterface::class); + $translatableStringHelper->localize(Argument::type('array'))->will( + static function ($args) { return $args[0][array_keys($args[0])[0]]; } + ); + + $normalizer = new RelationshipDocGenNormalizer( + $translatableStringHelper->reveal() + ); + + $normalizerManager = $this->prophesize(NormalizerInterface::class); + $normalizerManager->supportsNormalization(Argument::any(), 'docgen', Argument::any())->willReturn(true); + $normalizerManager->normalize(Argument::type(Relationship::class), 'docgen', Argument::any()) + ->will(static function ($args) use ($normalizer) { + return $normalizer->normalize($args[0], $args[1], $args[2]); + }); + $normalizerManager->normalize(Argument::any(), 'docgen', Argument::any())->will( + static function ($args) { + if (null === $args[0]) { + return null; + } + + if (is_iterable($args[0])) { + $r = []; + + foreach ($args[0] as $i) { + $r[] = ['fake' => true, 'hash' => spl_object_hash($i)]; + } + + return $r; + } + + if (is_object($args[0])) { + return ['fake' => true, 'hash' => null !== $args[0] ? spl_object_hash($args[0]) : null]; + } + + return $args[0]; + } + ); + $normalizer->setNormalizer($normalizerManager->reveal()); + + return $normalizer; + } +} diff --git a/src/Bundle/ChillPersonBundle/translations/messages.fr.yml b/src/Bundle/ChillPersonBundle/translations/messages.fr.yml index 0ca5ce19d..a37ee0f4e 100644 --- a/src/Bundle/ChillPersonBundle/translations/messages.fr.yml +++ b/src/Bundle/ChillPersonBundle/translations/messages.fr.yml @@ -455,13 +455,15 @@ see social issues: Voir les problématiques sociales see persons associated: Voir les usagers concernés docgen: + Accompanying Period basic: "Parcours d'accompagnement (basique)" + Accompanying period work: "Action d'accompagnement" + Accompanying period work context: "Evaluation des actions d'accompagnement" Main person: Personne principale person 1: Première personne person 2: Seconde personne Ask for main person: Demander à l'utilisateur de préciser la personne principale Ask for person 1: Demander à l'utilisateur de préciser la première personne Ask for person 2: Demander à l'utilisateur de préciser la seconde personne - Accompanying period work: Actions A basic context for accompanying period: Contexte pour les parcours A context for accompanying period work: Contexte pour les actions d'accompagnement A context for accompanying period work evaluation: Contexte pour les évaluations dans les actions d'accompagnement diff --git a/src/Bundle/ChillThirdPartyBundle/Entity/ThirdParty.php b/src/Bundle/ChillThirdPartyBundle/Entity/ThirdParty.php index 19f2062ee..28f1e7b22 100644 --- a/src/Bundle/ChillThirdPartyBundle/Entity/ThirdParty.php +++ b/src/Bundle/ChillThirdPartyBundle/Entity/ThirdParty.php @@ -63,7 +63,7 @@ class ThirdParty implements TrackCreationInterface, TrackUpdateInterface * @var string * @ORM\Column(name="acronym", type="string", length=64, nullable=true) * @Assert\Length(min="2") - * @Groups({"read", "write"}) + * @Groups({"read", "write", "docgen:read"}) */ private ?string $acronym = ''; @@ -78,7 +78,7 @@ class ThirdParty implements TrackCreationInterface, TrackUpdateInterface * @ORM\ManyToOne(targetEntity="\Chill\MainBundle\Entity\Address", * cascade={"persist", "remove"}) * @ORM\JoinColumn(nullable=true, onDelete="SET NULL") - * @Groups({"read", "write"}) + * @Groups({"read", "write", "docgen:read"}) */ private ?Address $address = null; @@ -97,6 +97,7 @@ class ThirdParty implements TrackCreationInterface, TrackUpdateInterface * @ORM\JoinTable(name="chill_3party.thirdparty_category", * joinColumns={@ORM\JoinColumn(name="thirdparty_id", referencedColumnName="id")}, * inverseJoinColumns={@ORM\JoinColumn(name="category_id", referencedColumnName="id")}) + * @Groups({"docgen:read"}) */ private Collection $categories; @@ -121,6 +122,7 @@ class ThirdParty implements TrackCreationInterface, TrackUpdateInterface * @var Civility * @ORM\ManyToOne(targetEntity=Civility::class) * ORM\JoinColumn(name="civility", referencedColumnName="id", nullable=true) + * @Groups({"docgen:read", "read"}) */ private ?Civility $civility = null; @@ -131,7 +133,7 @@ class ThirdParty implements TrackCreationInterface, TrackUpdateInterface /** * @ORM\Column(name="contact_data_anonymous", type="boolean", options={"default": false}) - * @Groups({"read"}) + * @Groups({"read", "docgen:read"}) */ private bool $contactDataAnonymous = false; @@ -149,7 +151,7 @@ class ThirdParty implements TrackCreationInterface, TrackUpdateInterface /** * @ORM\Column(name="email", type="string", length=255, nullable=true) * @Assert\Email(checkMX=false) - * @Groups({"read", "write"}) + * @Groups({"read", "write", "docgen:read"}) */ private ?string $email = null; @@ -158,6 +160,7 @@ class ThirdParty implements TrackCreationInterface, TrackUpdateInterface * @ORM\Column(name="id", type="integer") * @ORM\Id * @ORM\GeneratedValue(strategy="AUTO") + * @Groups({"read", "write", "docgen:read"}) */ private ?int $id = null; @@ -171,7 +174,7 @@ class ThirdParty implements TrackCreationInterface, TrackUpdateInterface * @var string * @ORM\Column(name="name", type="string", length=255) * @Assert\Length(min="2") - * @Groups({"read", "write"}) + * @Groups({"read", "write", "docgen:read"}) */ private ?string $name = ''; @@ -181,7 +184,7 @@ class ThirdParty implements TrackCreationInterface, TrackUpdateInterface * @var string * @ORM\Column(name="name_company", type="string", length=255, nullable=true) * @Assert\Length(min="3") - * @Groups({"read", "write"}) + * @Groups({"read", "write", "docgen:read"}) */ private ?string $nameCompany = ''; @@ -190,7 +193,7 @@ class ThirdParty implements TrackCreationInterface, TrackUpdateInterface * * @ORM\ManyToOne(targetEntity="Chill\ThirdPartyBundle\Entity\ThirdParty", inversedBy="children") * @ORM\JoinColumn(name="parent_id", referencedColumnName="id") - * @Groups({"read"}) + * @Groups({"read", "docgen:read"}) */ private ?ThirdParty $parent = null; @@ -200,6 +203,7 @@ class ThirdParty implements TrackCreationInterface, TrackUpdateInterface * @var ThirdPartyProfession * @ORM\ManyToOne(targetEntity="Chill\ThirdPartyBundle\Entity\ThirdPartyProfession") * ORM\JoinColumn(name="profession", referencedColumnName="id", nullable=true) + * @Groups({"docgen:read"}) */ private ?ThirdPartyProfession $profession = null; @@ -209,7 +213,7 @@ class ThirdParty implements TrackCreationInterface, TrackUpdateInterface * message="Invalid phone number: it should begin with the international prefix starting with ""+"", hold only digits and be smaller than 20 characters. Ex: +33123456789" * ) * @PhonenumberConstraint(type="any") - * @Groups({"read", "write"}) + * @Groups({"read", "write", "dogen:read"}) */ private ?string $telephone = null; @@ -495,7 +499,7 @@ class ThirdParty implements TrackCreationInterface, TrackUpdateInterface } /** - * @Groups({"read"}) + * @Groups({"read", "docgen:read"}) */ public function isChild(): bool { diff --git a/src/Bundle/ChillThirdPartyBundle/Entity/ThirdPartyCategory.php b/src/Bundle/ChillThirdPartyBundle/Entity/ThirdPartyCategory.php index 14cebcb84..7ce362360 100644 --- a/src/Bundle/ChillThirdPartyBundle/Entity/ThirdPartyCategory.php +++ b/src/Bundle/ChillThirdPartyBundle/Entity/ThirdPartyCategory.php @@ -13,6 +13,7 @@ namespace Chill\ThirdPartyBundle\Entity; use Chill\ThirdPartyBundle\Repository\ThirdPartyCategoryRepository; use Doctrine\ORM\Mapping as ORM; +use Symfony\Component\Serializer\Annotation as Serializer; /** * @ORM\Table(name="chill_3party.party_category") @@ -23,19 +24,21 @@ class ThirdPartyCategory /** * @ORM\Column(type="boolean") */ - private $active = true; + private bool $active = true; /** * @ORM\Id * @ORM\GeneratedValue * @ORM\Column(type="integer") + * @Serializer\Groups({"docgen:read"}) */ - private $id; + private ?int $id = null; /** * @ORM\Column(type="json") + * @Serializer\Groups({"docgen:read"}) */ - private $name = []; + private array $name = []; public function getActive(): ?bool { diff --git a/src/Bundle/ChillThirdPartyBundle/Entity/ThirdPartyProfession.php b/src/Bundle/ChillThirdPartyBundle/Entity/ThirdPartyProfession.php index e51111624..1963b34a7 100644 --- a/src/Bundle/ChillThirdPartyBundle/Entity/ThirdPartyProfession.php +++ b/src/Bundle/ChillThirdPartyBundle/Entity/ThirdPartyProfession.php @@ -13,6 +13,7 @@ namespace Chill\ThirdPartyBundle\Entity; use Chill\ThirdPartyBundle\Repository\ThirdPartyProfessionRepository; use Doctrine\ORM\Mapping as ORM; +use Symfony\Component\Serializer\Annotation as Serializer; /** * @ORM\Table(name="chill_3party.party_profession") @@ -23,19 +24,21 @@ class ThirdPartyProfession /** * @ORM\Column(type="boolean") */ - private $active = true; + private bool $active = true; /** * @ORM\Id * @ORM\GeneratedValue * @ORM\Column(type="integer") + * @Serializer\Groups({"docgen:read"}) */ - private $id; + private ?int $id = null; /** * @ORM\Column(type="json") + * @Serializer\Groups({"docgen:read"}) */ - private $name = []; + private array $name = []; public function getActive(): ?bool {