imanaging-document / check-format-bundle

v2.0 2022-06-08 14:07 UTC

Requires

• php: ^7.1.3
• symfony/templating: ^5.2
• twig/twig: ^3.3
• viest/php-ext-xlswriter-ide-helper: dev-master

MIT

• Rémi Zanzi
• Antonin Auffray

Published on Packagist.org on 2022-06-24 07:35 UTC

README

This bundle is a tool that allows you to check arrays format.

You have to provide a structure, which describe the format you want to check, and the datas you want to check. It can be simple array, or array of array.

A mapping function is available inside this bundle, you have to implement some required interfaces to make it works. You will find more information about how to use it in this readme.

This bundle should be used inside an imanaging-document application.

Install the bundle with:

$ composer require imanaging-document/check-format-bundle

Configuration

You have to create a config/packages/imanaging_check_format.yaml file:

imanaging_check_format:
    bar: ~

This configuration is optionnal.

Check Format

Usage

You can access two statics methods named checkFormatFile and getObjLine where you need it in your project juste like this :

use Imanaging\CheckFormatBundle\CheckFormatFile;

class MyBeautifulService
{  
  /**
   * ...
   */
  public function myBeautifulFunction(...){
    ...
    $result = CheckFormatFile::checkFormatLine($structureDescription, $myLineToCheckFormat));
    ...
  }
  ...
}

Examples

Checking a line structure

$structure = [
  // Type, Column Name, Nullable
  new FieldCheckFormat("string", "Name", false),
  new FieldCheckFormat("integer", "Age", true),
  new FieldCheckFormat("integer", "Height", true),
  new FieldCheckFormat("string", "City", true),
];

$myLine = ['Rémi', '26', '170', 'San Francisco'];
$result = CheckFormatFile::checkFormatLine($structure, $myLine));

// In this case, error equals false and the errors list is empty because there is no error
// $result['error'] = false;
// $result['errors_list'] = [];

Checking a file structure

$structure = [
  // Type, Column Name, Nullable
  new FieldCheckFormat("string", "Name", false),
  new FieldCheckFormat("integer", "Age", true),
  new FieldCheckFormat("integer", "Height", true),
  new FieldCheckFormat("string", "City", true),
];

$lines = [
  ['Rémi', '26', '170', 'San Francisco'],
  ['Antonin', '26', '181', 'Miami'],
];
$result = CheckFormatFile::checkFormatFile($structure, $lines));

// In this case, error equals false and the errors list is empty because there is no error
// $result['error'] = false;
// $result['errors_list'] = [];

Mapping

Requirements

• Symfony 4
• JQuery
• Bootstrap 4
• FontAwesome

Configuration

Interfaces

You have to implements the following interfaces in your config/packages/doctrine.yaml file :

Imanaging\CheckFormatBundle\Interfaces\MappingConfigurationInterface: App\Entity\MappingConfiguration
    Imanaging\CheckFormatBundle\Interfaces\MappingConfigurationTypeInterface: App\Entity\MappingConfigurationType
    Imanaging\CheckFormatBundle\Interfaces\MappingChampPossibleInterface: App\Entity\MappingChampPossible
    Imanaging\CheckFormatBundle\Interfaces\MappingConfigurationValueAvanceFileInterface: App\Entity\MappingConfigurationValueAvanceFile
    Imanaging\CheckFormatBundle\Interfaces\MappingConfigurationValueAvanceInterface: App\Entity\MappingConfigurationValueAvance
    Imanaging\CheckFormatBundle\Interfaces\MappingConfigurationValueAvanceTextInterface: App\Entity\MappingConfigurationValueAvanceText
    Imanaging\CheckFormatBundle\Interfaces\MappingConfigurationValueAvanceTypeInterface: App\Entity\MappingConfigurationValueAvanceType
    Imanaging\CheckFormatBundle\Interfaces\MappingConfigurationValueInterface: App\Entity\MappingConfigurationValue
    Imanaging\CheckFormatBundle\Interfaces\MappingConfigurationValueTransformationInterface: App\Entity\MappingConfigurationValueTransformation
    Imanaging\CheckFormatBundle\Interfaces\MappingConfigurationValueTranslationInterface: App\Entity\MappingConfigurationValueTranslation

Usage and examples

You can call a mapping page with an ajax call :

<div id="mappingDiv">
    <div class="text-center mt-5">
      <h4><i class="fa fa-spinner fa-spin fa-fw"></i>Chargement en cours ...</h4>
    </div>
</div>

let data = {files_directory: '/public/database/attestation/fichier_client*.csv', next_step_route: 'hephaistos_administration_import_fichier_client',
  mapping_configuration_type: 'integration_client'};
$.ajax({
  url: "{{ path('check_format_mapping_page') }}",
  type: 'POST',
  data: data,
  success: function (data) {
    $("#mappingDiv").html(data);
  },
  error: function () {
    Toast.fire({type: 'error', title: 'Error'});
  }
});

Convertir un nombre décimal en entier

La transformation decimal_to_integer est disponible dans les mappings XML et CSV. Elle retourne une chaîne représentant un entier, sans conversion flottante : 000.000.281,57 devient 28157, -000.004.128,56 devient -412856. Le type du champ de destination reste indépendant de cette transformation.

Options enregistrées dans transformation_options :

{"decimal_separator": ",", "thousands_separator": ".", "decimal_places": 2}

• decimal_separator : , ou . (défaut : ,).
• thousands_separator : ., ,, espace ou chaîne vide (défaut : .). Le séparateur décimal et celui de milliers doivent être différents. Avec l'espace, les espaces insécables et fines insécables sont aussi acceptées.
• decimal_places : entier positif ou nul (défaut : 2). Avec 2, 281,5 devient 28150 et 281 devient 28100.

Les signes initiaux sont acceptés, les zéros inutiles supprimés et -0,00 devient 0. Les valeurs vides et nulles restent soumises aux règles de champ obligatoire. Les séparateurs de milliers doivent grouper trois chiffres. Une valeur invalide ou comportant trop de décimales produit une erreur de contrôle du champ et de la ligne, sans arrondi ni troncature.

Les réglages sont conservés lors de l'export et du réimport des configurations. Aucune migration de base de données n'est nécessaire.

Inverser le signe

La transformation invert_sign est disponible en XML et CSV, sans paramètre. Elle inverse le signe du nombre en conservant ses chiffres et ses séparateurs, sans conversion flottante : 28157 devient -28157, -412856 devient 412856 et +28157 devient -28157. Zéro reste 0 ; les valeurs vides et nulles restent vides ou nulles. Une valeur non numérique produit une erreur de contrôle.

Pour les soldes formatés du client, ajouter les transformations dans cet ordre :

1. Convertir un nombre décimal en entier (virgule, point, 2 décimales).
2. Inverser le signe.

Ainsi 000.000.281,57 devient -28157 et -000.004.128,56 devient 412856. L'inversion s'applique uniquement aux champs des mappings où elle est ajoutée.