Feature: [docgen][person] add a new context to generate document with a

third party

This allow to prepare, for instance, mail (letters) to a thirdparty
about a Person
This commit is contained in:
Julien Fastré 2022-10-19 14:16:59 +02:00
parent 1b5d5a28fd
commit ea5f8c9d08
6 changed files with 291 additions and 1 deletions

View File

@ -2,6 +2,14 @@
{% block title 'docgen.Generate a document'|trans %}
{% block js %}
{{ encore_entry_script_tags('mod_pickentity_type') }}
{% endblock %}
{% block css %}
{{ encore_entry_link_tags('mod_pickentity_type') }}
{% endblock %}
{% block content %}
<div class="col-md-10 col-xxl">
<h1>{{ block('title') }}</h1>

View File

@ -0,0 +1,55 @@
<?php
declare(strict_types=1);
/*
* Chill is a software for social workers
*
* For the full copyright and license information, please view
* the LICENSE file that was distributed with this source code.
*/
namespace Chill\PersonBundle\Service\DocGenerator;
use Chill\DocGeneratorBundle\Context\DocGeneratorContextWithAdminFormInterface;
use Chill\DocGeneratorBundle\Context\DocGeneratorContextWithPublicFormInterface;
use Chill\DocGeneratorBundle\Entity\DocGeneratorTemplate;
use Chill\DocStoreBundle\Entity\StoredObject;
use Chill\PersonBundle\Entity\Person;
use Symfony\Component\Form\FormBuilderInterface;
interface PersonContextInterface extends DocGeneratorContextWithAdminFormInterface, DocGeneratorContextWithPublicFormInterface
{
public function adminFormReverseTransform(array $data): array;
public function adminFormTransform(array $data): array;
public function buildAdminForm(FormBuilderInterface $builder): void;
/**
* @param Person $entity
*/
public function buildPublicForm(FormBuilderInterface $builder, DocGeneratorTemplate $template, $entity): void;
public function getData(DocGeneratorTemplate $template, $entity, array $contextGenerationData = []): array;
public function getDescription(): string;
public function getEntityClass(): string;
public function getFormData(DocGeneratorTemplate $template, $entity): array;
public function getName(): string;
public function hasAdminForm(): bool;
/**
* @param Person $entity
*/
public function hasPublicForm(DocGeneratorTemplate $template, $entity): bool;
/**
* @param Person $entity
*/
public function storeGenerated(DocGeneratorTemplate $template, StoredObject $storedObject, object $entity, array $contextGenerationData): void;
}

View File

@ -0,0 +1,130 @@
<?php
declare(strict_types=1);
/*
* Chill is a software for social workers
*
* For the full copyright and license information, please view
* the LICENSE file that was distributed with this source code.
*/
namespace Chill\PersonBundle\Service\DocGenerator;
use Chill\DocGeneratorBundle\Context\DocGeneratorContextWithAdminFormInterface;
use Chill\DocGeneratorBundle\Context\DocGeneratorContextWithPublicFormInterface;
use Chill\DocGeneratorBundle\Entity\DocGeneratorTemplate;
use Chill\DocStoreBundle\Entity\StoredObject;
use Chill\ThirdPartyBundle\Entity\ThirdParty;
use Chill\ThirdPartyBundle\Form\Type\PickThirdpartyDynamicType;
use Symfony\Component\Form\Extension\Core\Type\TextType;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
/**
* Context to generate a document with a destinee (i.e. generate a letter).
*/
class PersonContextWithThirdParty implements DocGeneratorContextWithAdminFormInterface, DocGeneratorContextWithPublicFormInterface
{
private NormalizerInterface $normalizer;
private PersonContextInterface $personContext;
public function __construct(
PersonContextInterface $personContext,
NormalizerInterface $normalizer
) {
$this->personContext = $personContext;
$this->normalizer = $normalizer;
}
public function adminFormReverseTransform(array $data): array
{
return array_merge(
$this->personContext->adminFormReverseTransform($data),
['label' => $data['label']]
);
}
public function adminFormTransform(array $data): array
{
return array_merge(
$this->personContext->adminFormTransform($data),
['label' => $data['label'] ?? '']
);
}
public function buildAdminForm(FormBuilderInterface $builder): void
{
$this->personContext->buildAdminForm($builder);
$builder->add('label', TextType::class, [
'label' => 'docgen.Label for third party',
'required' => true,
]);
}
public function buildPublicForm(FormBuilderInterface $builder, DocGeneratorTemplate $template, $entity): void
{
$this->personContext->buildPublicForm($builder, $template, $entity);
$builder->add('thirdParty', PickThirdpartyDynamicType::class, [
'multiple' => false,
'label' => $template->getOptions()['label'] ?? 'ThirdParty',
'validation_groups' => ['__none__'],
]);
}
public function getData(DocGeneratorTemplate $template, $entity, array $contextGenerationData = []): array
{
$data = $this->personContext->getData($template, $entity, $contextGenerationData);
$data['thirdParty'] = $this->normalizer->normalize(
$contextGenerationData['thirdParty'],
'docgen',
['docgen:expects' => ThirdParty::class, 'groups' => ['docgen:read']]
);
return $data;
}
public function getDescription(): string
{
return 'docgen.A context for person with a third party (for sending mail)';
}
public function getEntityClass(): string
{
return $this->personContext->getEntityClass();
}
public function getFormData(DocGeneratorTemplate $template, $entity): array
{
return $this->personContext->getFormData($template, $entity);
}
public static function getKey(): string
{
return self::class;
}
public function getName(): string
{
return 'docgen.Person with third party';
}
public function hasAdminForm(): bool
{
return true;
}
public function hasPublicForm(DocGeneratorTemplate $template, $entity): bool
{
return true;
}
public function storeGenerated(DocGeneratorTemplate $template, StoredObject $storedObject, object $entity, array $contextGenerationData): void
{
$this->personContext->storeGenerated($template, $storedObject, $entity, $contextGenerationData);
}
}

View File

@ -0,0 +1,93 @@
<?php
declare(strict_types=1);
/*
* Chill is a software for social workers
*
* For the full copyright and license information, please view
* the LICENSE file that was distributed with this source code.
*/
namespace Service\DocGenerator;
use Chill\DocGeneratorBundle\Entity\DocGeneratorTemplate;
use Chill\PersonBundle\Entity\Person;
use Chill\PersonBundle\Service\DocGenerator\PersonContextInterface;
use Chill\PersonBundle\Service\DocGenerator\PersonContextWithThirdParty;
use Chill\ThirdPartyBundle\Entity\ThirdParty;
use Prophecy\Argument;
use Prophecy\PhpUnit\ProphecyTrait;
use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
/**
* @internal
* @coversNothing
*/
final class PersonContextWithThirdPartyTest extends KernelTestCase
{
use ProphecyTrait;
public function testAdminFormReverseTransform()
{
$personContext = $this->buildPersonContextWithThirdParty();
$actual = $personContext->adminFormReverseTransform(['label' => 'bloup']);
$this->assertArrayHasKey('category', $actual);
$this->assertArrayHasKey('label', $actual);
$this->assertEquals('bloup', $actual['label']);
}
public function testAdminFormTransform()
{
$personContext = $this->buildPersonContextWithThirdParty();
$actual = $personContext->adminFormTransform(['label' => 'bloup']);
$this->assertArrayHasKey('from_person', $actual);
$this->assertArrayHasKey('label', $actual);
$this->assertEquals('bloup', $actual['label']);
}
public function testGetData()
{
$personContext = $this->buildPersonContextWithThirdParty();
$actual = $personContext->getData(
(new DocGeneratorTemplate())->setOptions(['label' => 'bloup']),
new Person(),
['thirdParty' => $tp = new ThirdParty()]
);
$this->assertArrayHasKey('person', $actual);
$this->assertArrayHasKey('thirdParty', $actual);
$this->assertEquals(spl_object_hash($tp), $actual['thirdParty']['hash']);
}
private function buildPersonContextWithThirdParty(): PersonContextWithThirdParty
{
$normalizer = $this->prophesize(NormalizerInterface::class);
$normalizer->normalize(Argument::type(ThirdParty::class), 'docgen', Argument::type('array'))
->will(static function ($args): array {
return ['class' => '3party', 'hash' => spl_object_hash($args[0])];
});
$personContext = $this->prophesize(PersonContextInterface::class);
$personContext->adminFormReverseTransform(Argument::type('array'))->willReturn(
['category' => ['idInsideBundle' => 1, 'bundleId' => 'abc']]
);
$personContext->adminFormTransform(Argument::type('array'))->willReturn(
['from_person' => 'kept']
);
$personContext->getData(Argument::type(DocGeneratorTemplate::class), Argument::type(Person::class), Argument::type('array'))
->willReturn(['person' => 'data']);
return new PersonContextWithThirdParty(
$personContext->reveal(),
$normalizer->reveal()
);
}
}

View File

@ -858,6 +858,10 @@ docgen:
A context for accompanying period work evaluation: Contexte pour les évaluations dans les actions d'accompagnement
Person basic: Personne (basique)
A basic context for person: Contexte pour les personnes
Person with third party: Personne avec choix d'un tiers
A context for person with a third party (for sending mail): Un contexte d'une personne avec un tiers (pour envoyer un courrier à ce tiers, par exemple)
Label for third party: Label à afficher aux utilisateurs
Document title: Titre du document généré
period_notification:
period_designated_subject: Vous êtes référent d'un parcours d'accompagnement

View File

@ -214,7 +214,7 @@ class ThirdParty implements TrackCreationInterface, TrackUpdateInterface
/**
* @ORM\Column(name="kind", type="string", length="20", options={"default": ""})
* @Groups({"write"})
* @Groups({"write", "docgen:read", "docgen:read:3party:parent"})
*/
private ?string $kind = '';