Merge branch 'features/new-phones' into 'master'

Features/new phones

See merge request Chill-Projet/chill-bundles!5
This commit is contained in:
Julien Fastré 2021-04-02 12:11:20 +00:00
commit 34e5fbedf2
14 changed files with 502 additions and 123 deletions

View File

@ -36,27 +36,22 @@ use Psr\Cache\CacheItemPoolInterface;
class PhonenumberHelper
{
/**
*
* @var Client
* Twilio client
*/
protected $twilioClient;
protected Client $twilioClient;
/**
*
* @var LoggerInterface
* TRUE if the client is properly configured
*/
protected $logger;
protected bool $isConfigured = false;
/**
*
* @var CacheItemPoolInterface
*/
protected $cachePool;
protected LoggerInterface $logger;
protected CacheItemPoolInterface $cachePool;
const LOOKUP_URI = 'https://lookups.twilio.com/v1/PhoneNumbers/%s';
const FORMAT_URI = 'https://lookups.twilio.com/v1/PhoneNumbers/%s';
public function __construct(
CacheItemPoolInterface $cachePool,
$config,
@ -67,12 +62,16 @@ class PhonenumberHelper
if (\array_key_exists('twilio_sid', $config)
&& !empty($config['twilio_sid'])
&& strlen($config['twilio_sid']) > 2
&& \array_key_exists('twilio_secret', $config)
&& !empty($config['twilio_secret'])) {
&& !empty($config['twilio_secret'])
&& strlen($config['twilio_secret']) > 2
) {
$this->twilioClient = new Client([
'auth' => [ $config['twilio_sid'], $config['twilio_secret'] ]
]);
$this->isConfigured = TRUE;
}
}
@ -84,11 +83,11 @@ class PhonenumberHelper
*/
public function isPhonenumberValidationConfigured() : bool
{
return NULL !== $this->twilioClient;
return $this->isConfigured;
}
/**
* REturn true if the phoennumber is a mobile phone. Return always false
* REturn true if the phoennumber is a mobile phone. Return always true
* if the validation is not configured.
*
* @param string $phonenumber
@ -96,17 +95,21 @@ class PhonenumberHelper
*/
public function isValidPhonenumberMobile($phonenumber) : bool
{
if (FALSE === $this->isPhonenumberValidationConfigured()) {
return true;
}
$validation = $this->performTwilioLookup($phonenumber);
if (NULL === $validation) {
return false;
return true;
}
return $validation === 'mobile';
}
/**
* Return true if the phonenumber is a landline or voip phone. Return always false
* Return true if the phonenumber is a landline or voip phone. Return always true
* if the validation is not configured.
*
* @param string $phonenumber
@ -114,17 +117,21 @@ class PhonenumberHelper
*/
public function isValidPhonenumberLandOrVoip($phonenumber) : bool
{
if (FALSE === $this->isPhonenumberValidationConfigured()) {
return true;
}
$validation = $this->performTwilioLookup($phonenumber);
if (NULL === $validation) {
return false;
return true;
}
return \in_array($validation, [ 'landline', 'voip' ]);
}
/**
* Return true if the phonenumber is a landline or voip phone. Return always false
* Return true if the phonenumber is a landline or voip phone. Return always true
* if the validation is not configured.
*
* @param string $phonenumber
@ -132,8 +139,11 @@ class PhonenumberHelper
*/
public function isValidPhonenumberAny($phonenumber) : bool
{
if (FALSE === $this->isPhonenumberValidationConfigured()) {
return true;
}
$validation = $this->performTwilioLookup($phonenumber);
;
if (NULL === $validation) {
return false;
}
@ -141,6 +151,18 @@ class PhonenumberHelper
return \in_array($validation, [ 'landline', 'voip', 'mobile' ]);
}
/**
* Get type (mobile, landline, ...) for phone number
*
* @param string $phonenumber
*
* @return string
*/
public function getType(string $phonenumber): string
{
return $this->performTwilioLookup($phonenumber) ?? 'unknown';
}
public function format($phonenumber)
{
return $this->performTwilioFormat($phonenumber);
@ -221,7 +243,7 @@ class PhonenumberHelper
$item = $this->cachePool->getItem('pnum_'.$filtered);
if ($item->isHit()) {
return $item->get();
//return $item->get();
}
try {

View File

@ -148,7 +148,6 @@ form {
li {
label {
display: inline-block;
font-weight: normal;
}
}
}

View File

@ -59,7 +59,6 @@ class PersonController extends AbstractController
*/
protected $translator;
/**
* @var EventDispatcherInterface
*/

View File

@ -177,6 +177,18 @@ class Person implements HasCenterInterface
*/
private $mobilenumber = '';
/**
* @var Collection
*
* @ORM\OneToMany(
* targetEntity="Chill\PersonBundle\Entity\PersonPhone",
* mappedBy="person",
* cascade={"persist", "remove", "merge", "detach"},
* orphanRemoval=true
* )
*/
private $otherPhoneNumbers;
//TO-ADD caseOpeningDate
//TO-ADD nativeLanguag
@ -256,7 +268,6 @@ class Person implements HasCenterInterface
*/
private $fullnameCanonical;
/**
* Person constructor.
*
@ -268,6 +279,7 @@ class Person implements HasCenterInterface
$this->spokenLanguages = new ArrayCollection();
$this->addresses = new ArrayCollection();
$this->altNames = new ArrayCollection();
$this->otherPhoneNumbers = new ArrayCollection();
if ($opening === null) {
$opening = new \DateTime();
@ -864,6 +876,52 @@ class Person implements HasCenterInterface
return $this->mobilenumber;
}
/**
* @return Collection
*/
public function getOtherPhoneNumbers(): Collection
{
return $this->otherPhoneNumbers;
}
/**
* @param Collection $otherPhoneNumbers
* @return $this
*/
public function setOtherPhoneNumbers(Collection $otherPhoneNumbers)
{
$this->otherPhoneNumbers = $otherPhoneNumbers;
return $this;
}
/**
* @param PersonPhone $otherPhoneNumber
* @return $this
*/
public function addOtherPhoneNumber(PersonPhone $otherPhoneNumber)
{
if (false === $this->otherPhoneNumbers->contains($otherPhoneNumber)) {
$otherPhoneNumber->setPerson($this);
$this->otherPhoneNumbers->add($otherPhoneNumber);
}
return $this;
}
/**
* @param PersonPhone $otherPhoneNumber
* @return $this
*/
public function removeOtherPhoneNumber(PersonPhone $otherPhoneNumber)
{
if ($this->otherPhoneNumbers->contains($otherPhoneNumber)) {
$this->otherPhoneNumbers->removeElement($otherPhoneNumber);
}
return $this;
}
/**
* @return string
*/

View File

@ -0,0 +1,115 @@
<?php
namespace Chill\PersonBundle\Entity;
use Chill\PersonBundle\Entity\Person;
use Doctrine\ORM\Mapping as ORM;
/**
* Person Phones
*
* @ORM\Entity()
* @ORM\Table(name="chill_person_phone")
*/
class PersonPhone
{
/**
* @ORM\Id
* @ORM\Column(name="id", type="integer")
* @ORM\GeneratedValue(strategy="AUTO")
*/
private ?int $id;
/**
* @ORM\ManyToOne(
* targetEntity="Chill\PersonBundle\Entity\Person",
* inversedBy="otherPhoneNumbers"
* )
*/
private Person $person;
/**
* @ORM\Column(type="text", length=40, nullable=true)
*/
private ?string $type;
/**
* @ORM\Column(type="text", length=40, nullable=false)
*/
private string $phonenumber = '';
/**
* @ORM\Column(type="text", nullable=true)
*/
private ?string $description = null;
/**
* @ORM\Column(type="datetime", nullable=false)
*/
private \DateTime $date;
public function __construct()
{
$this->date = new \DateTime();
}
public function getId(): int
{
return $this->id;
}
public function getPerson(): Person
{
return $this->person;
}
public function setPerson(Person $person): void
{
$this->person = $person;
}
public function getType(): string
{
return $this->type;
}
public function setType(string $type): void
{
$this->type = $type;
}
public function getPhonenumber(): string
{
return $this->phonenumber;
}
public function setPhonenumber(string $phonenumber): void
{
$this->phonenumber = $phonenumber;
}
public function getDescription(): ?string
{
return $this->description;
}
public function setDescription(?string $description): void
{
$this->description = $description;
}
public function getDate(): \DateTime
{
return $this->date;
}
public function setDate(\DateTime $date): void
{
$this->date = $date;
}
public function isEmpty(): bool
{
return empty($this->getDescription()) && empty($this->getPhonenumber());
}
}

View File

@ -21,21 +21,24 @@
namespace Chill\PersonBundle\Form;
use Chill\CustomFieldsBundle\Form\Type\CustomFieldType;
use Chill\MainBundle\Form\Type\ChillCollectionType;
use Chill\MainBundle\Form\Type\ChillTextareaType;
use Chill\MainBundle\Form\Type\Select2CountryType;
use Chill\MainBundle\Form\Type\Select2LanguageType;
use Chill\PersonBundle\Config\ConfigPersonAltNamesHelper;
use Chill\PersonBundle\Form\Type\GenderType;
use Chill\PersonBundle\Form\Type\PersonAltNameType;
use Chill\PersonBundle\Form\Type\PersonPhoneType;
use Chill\PersonBundle\Entity\PersonPhone;
use Chill\PersonBundle\Form\Type\Select2MaritalStatusType;
use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\OptionsResolver\OptionsResolver;
use Symfony\Component\Form\Extension\Core\Type\TextType;
use Symfony\Component\Form\Extension\Core\Type\DateType;
use Symfony\Component\Form\Extension\Core\Type\EmailType;
use Symfony\Component\Form\Extension\Core\Type\TelType;
use Chill\PersonBundle\Form\Type\GenderType;
use Chill\MainBundle\Form\Type\Select2CountryType;
use Chill\MainBundle\Form\Type\Select2LanguageType;
use Chill\CustomFieldsBundle\Form\Type\CustomFieldType;
use Chill\PersonBundle\Form\Type\Select2MaritalStatusType;
use Chill\PersonBundle\Config\ConfigPersonAltNamesHelper;
use Chill\PersonBundle\Form\Type\PersonAltNameType;
use Chill\MainBundle\Form\Type\ChillTextareaType;
use Symfony\Component\Form\Extension\Core\Type\TextType;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\OptionsResolver\OptionsResolver;
class PersonType extends AbstractType
{
@ -109,6 +112,20 @@ class PersonType extends AbstractType
$builder->add('mobilenumber', TelType::class, array('required' => false));
}
$builder->add('otherPhoneNumbers', ChillCollectionType::class, [
'entry_type' => PersonPhoneType::class,
'button_add_label' => 'Add new phone',
'button_remove_label' => 'Remove phone',
'required' => false,
'allow_add' => true,
'allow_delete' => true,
'by_reference' => false,
'label' => false,
'delete_empty' => function(PersonPhone $pp = null) {
return NULL === $pp || $pp->isEmpty();
}
]);
if ($this->config['email'] === 'visible') {
$builder->add('email', EmailType::class, array('required' => false));
}
@ -153,7 +170,7 @@ class PersonType extends AbstractType
{
$resolver->setDefaults(array(
'data_class' => 'Chill\PersonBundle\Entity\Person',
'validation_groups' => array('general', 'creation')
'validation_groups' => array('general', 'creation'),
));
$resolver->setRequired(array(

View File

@ -0,0 +1,65 @@
<?php
namespace Chill\PersonBundle\Form\Type;
use Chill\MainBundle\Phonenumber\PhonenumberHelper;
use Chill\PersonBundle\Entity\PersonPhone;
use Doctrine\ORM\EntityManagerInterface;
use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\Extension\Core\Type\TelType;
use Symfony\Component\Form\Extension\Core\Type\TextType;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\Form\FormEvent;
use Symfony\Component\Form\FormEvents;
use Symfony\Component\Form\FormInterface;
use Symfony\Component\Form\FormView;
use Symfony\Component\OptionsResolver\OptionsResolver;
class PersonPhoneType extends AbstractType
{
private PhonenumberHelper $phonenumberHelper;
private EntityManagerInterface $em;
public function __construct(PhonenumberHelper $phonenumberHelper, EntityManagerInterface $em)
{
$this->phonenumberHelper = $phonenumberHelper;
$this->em = $em;
}
public function buildForm(FormBuilderInterface $builder, array $options)
{
$builder->add('phonenumber', TelType::class, [
'label' => 'Other phonenumber',
'required' => true,
]);
$builder->add('description', TextType::class, [
'required' => false,
]);
$builder->addEventListener(FormEvents::POST_SUBMIT, function(FormEvent $event) {
if (NULL === $event->getData()) {
return;
}
$oldPersonPhone = $this->em->getUnitOfWork()
->getOriginalEntityData($event->getData());
if ($oldPersonPhone['phonenumber'] ?? null !== $event->getForm()->getData()->getPhonenumber()) {
$type = $this->phonenumberHelper->getType($event->getData()->getPhonenumber());
$event->getData()->setType($type);
}
});
}
public function configureOptions(OptionsResolver $resolver)
{
$resolver
->setDefaults([
'data_class' => PersonPhone::class,
'validation_groups' => ['general', 'creation'],
])
;
}
}

View File

@ -83,6 +83,9 @@
{%- if form.mobilenumber is defined -%}
{{ form_row(form.mobilenumber, {'label': 'Mobilenumber'}) }}
{%- endif -%}
{%- if form.otherPhoneNumbers is defined -%}
{{ form_widget(form.otherPhoneNumbers) }}
{%- endif -%}
{%- if form.contactInfo is defined -%}
{{ form_row(form.contactInfo, {'label': 'Notes on contact information'}) }}
{%- endif -%}

View File

@ -227,6 +227,17 @@ This view should receive those arguments:
<dd>{% if person.mobilenumber is not empty %}<a href="tel:{{ person.mobilenumber }}"><pre>{{ person.mobilenumber|chill_format_phonenumber }}</pre></a>{% else %}<span class="chill-no-data-statement">{{ 'No data given'|trans }}{% endif %}</dd>
</dl>
{% endif %}
{% for pp in person.otherPhoneNumbers %}
<dt>{{ 'Other phonenumber'|trans }}&nbsp;:</dt>
<dd>
<a href="tel:{{ pp.phoneNumber }}"><pre>{{ pp.phoneNumber|chill_format_phonenumber }}</pre></a>
{% if pp.description is not empty %}
<blockquote class="chill-user-quote">
{{ pp.description|nl2br }}
{% endif %}
</blockquote>
</dd>
{% endfor %}
{%- if chill_person.fields.contact_info == 'visible' -%}
<dl>
<dt>{{ 'Notes on contact information'|trans }}&nbsp;:</dt>

View File

@ -46,3 +46,10 @@ services:
$translatableStringHelper: '@chill.main.helper.translatable_string'
tags:
- { name: form.type }
Chill\PersonBundle\Form\Type\PersonPhoneType:
arguments:
$phonenumberHelper: '@Chill\MainBundle\Phonenumber\PhonenumberHelper'
$em: '@Doctrine\ORM\EntityManagerInterface'
tags:
- { name: form.type }

View File

@ -51,8 +51,9 @@ Chill\PersonBundle\Entity\Person:
- Chill\MainBundle\Validation\Constraint\PhonenumberConstraint:
type: mobile
groups: [ general, creation ]
otherPhoneNumbers:
- Valid:
traverse: true
constraints:
- Callback:
callback: isAccompanyingPeriodValid
@ -77,3 +78,14 @@ Chill\PersonBundle\Entity\AccompanyingPeriod:
constraints:
- Callback:
callback: isDateConsistent
Chill\PersonBundle\Entity\PersonPhone:
properties:
phonenumber:
- Regex:
pattern: '/^([\+{1}])([0-9\s*]{4,20})$/'
groups: [ general, creation ]
message: 'Invalid phone number: it should begin with the international prefix starting with "+", hold only digits and be smaller than 20 characters. Ex: +33123456789'
- Chill\MainBundle\Validation\Constraint\PhonenumberConstraint:
type: any
groups: [ general, creation ]

View File

@ -0,0 +1,36 @@
<?php
declare(strict_types=1);
namespace Chill\Migrations\Person;
use Doctrine\DBAL\Schema\Schema;
use Doctrine\Migrations\AbstractMigration;
/**
* Auto-generated Migration: Please modify to your needs!
*/
final class Version20210318095831 extends AbstractMigration
{
public function getDescription() : string
{
return '';
}
public function up(Schema $schema) : void
{
// this up() migration is auto-generated, please modify it to your needs
$this->addSql('CREATE SEQUENCE chill_person_phone_id_seq INCREMENT BY 1 MINVALUE 1 START 1');
$this->addSql('CREATE TABLE chill_person_phone (id INT NOT NULL, person_id INT DEFAULT NULL, phonenumber TEXT NOT NULL, description TEXT DEFAULT NULL, date TIMESTAMP(0) WITHOUT TIME ZONE NOT NULL, PRIMARY KEY(id))');
$this->addSql('CREATE INDEX IDX_72C1F87217BBB47 ON chill_person_phone (person_id)');
$this->addSql('ALTER TABLE chill_person_phone ADD CONSTRAINT FK_72C1F87217BBB47 FOREIGN KEY (person_id) REFERENCES chill_person_person (id) NOT DEFERRABLE INITIALLY IMMEDIATE');
}
public function down(Schema $schema) : void
{
// this down() migration is auto-generated, please modify it to your needs
$this->addSql('DROP SEQUENCE chill_person_phone_id_seq CASCADE');
$this->addSql('DROP TABLE chill_person_phone');
}
}

View File

@ -0,0 +1,31 @@
<?php
declare(strict_types=1);
namespace Chill\Migrations\Person;
use Doctrine\DBAL\Schema\Schema;
use Doctrine\Migrations\AbstractMigration;
/**
* Auto-generated Migration: Please modify to your needs!
*/
final class Version20210325141540 extends AbstractMigration
{
public function getDescription() : string
{
return '';
}
public function up(Schema $schema) : void
{
// this up() migration is auto-generated, please modify it to your needs
$this->addSql('ALTER TABLE chill_person_phone ADD type TEXT DEFAULT NULL');
}
public function down(Schema $schema) : void
{
// this down() migration is auto-generated, please modify it to your need
$this->addSql('ALTER TABLE chill_person_phone DROP type');
}
}

View File

@ -40,6 +40,10 @@ Phonenumber: 'Numéro de téléphone'
phonenumber: numéro de téléphone
Mobilenumber: 'Numéro de téléphone portable'
mobilenumber: numéro de téléphone portable
Other phonenumber: Autre numéro de téléphone
Description: description
Add new phone: Ajouter un numéro de téléphone
Remove phone: Supprimer
'Notes on contact information': 'Remarques sur les informations de contact'
'Remarks': 'Remarques'
'{0} Born the %date% | {1} Born the %date%': '{0} Né le %date% | {1} Née le %date%'