Commit 0e588abb authored by Laurent Lecluse's avatar Laurent Lecluse
Browse files

doc

parent c06deaa4
Loading
Loading
Loading
Loading
Loading
+312 −8
Changes for doc/serveur.md: 312 added lines, 8 removed lines.
Original line number Diff line number Diff line
@@ -106,7 +106,7 @@ $inputData = $this->axios()->fromPost();

### Envoi de données via Axios

Les données renvoyées doivent être encalsupées dans un `AxiosModel`.
Les données renvoyées doivent être encapsulées dans un `AxiosModel`.
Ce dernier va :
- utiliser [AxiosExtractor](#axiosextractor) pour convertir les données
- collecter les éventuels messages issus du `flashMessenger`
@@ -249,8 +249,6 @@ class Adresse {
    {
        return $this->ville;
    }


}

class Personne
@@ -291,7 +289,6 @@ class Personne
    }
}

$personne = new Personne;
```

#### Extraction avec des propriétées données explicitement
@@ -322,12 +319,12 @@ Les propriétés doivent avoir des accesseurs, par exemple pour la propriété a
- isAge()
- hasAge()

Pour l'adresse, comme il s'agit d'une entité, on doit fournir un tableau ayany deux valeurs : `['nom de la propriété', [...liste des propriétés de la sous-entité]]`.
Pour l'adresse, comme il s'agit d'une entité, on doit fournir un tableau ayant deux valeurs : `['nom de la propriété', [...liste des propriétés de la sous-entité]]`.

#### Extraction sur un objet implémentant AxiosExtractorInterface

Si des propriétés sont explicitement transmises en second paramètre d'extract, alors elles sont utilisées en priorité.
A défaut, AxiosExtractor peut extraire la liste des propriétés si les objets implémentent UnicaenVue\Axios\AxiosExtractorInterface
A défaut, AxiosExtractor peut extraire la liste des propriétés si les objets implémentent `UnicaenVue\Axios\AxiosExtractorInterface`

Cela peut être utile pour des objets dont nous avons toujours besoin de renvoyer les mêmes propriétés.

@@ -340,7 +337,7 @@ class Adresse implements \UnicaenVue\Axios\AxiosExtractorInterface

    public function axiosDefinition(): array
    {
        // par défaut, les extractions de Adresse auront donc les deux propriétés co et ville
        // par défaut, les extractions de Adresse auront donc les deux propriétés cp et ville
        return ['cp', 'ville'];
    }
}
@@ -366,4 +363,311 @@ var_dump($extracted);

### Depuis Doctrine

@todo
 No newline at end of file
Axios peut également prendre en entrée des requêtes Doctrine `Doctrine\ORM\Query`.

Exemple : 

```php

// Dans une action de contrôleur :
// On crée une requête DQL qui va chercher toutes les données dont nous avons besoin
// L'objectif est ici de récupérer une liste de missions 
$dql = "
    SELECT 
      m, tm, str, tr, valid, vh, vvh, ctr
    FROM 
      " . Mission::class . " m
      JOIN m.typeMission tm
      JOIN m.structure str
      JOIN m.tauxRemu tr
      JOIN " . TypeVolumeHoraire::class . " tvh WITH tvh.code = :typeVolumeHorairePrevu
      LEFT JOIN m.validations valid WITH valid.histoDestruction IS NULL
      LEFT JOIN m.volumesHoraires vh WITH vh.histoDestruction IS NULL AND vh.typeVolumeHoraire = tvh
      LEFT JOIN vh.validations vvh WITH vvh.histoDestruction IS NULL
      LEFT JOIN vh.contrat ctr WITH ctr.histoDestruction IS NULL
    WHERE 
      m.histoDestruction IS NULL 
    ORDER BY
      m.dateDebut,
      vh.histoCreation
    ";

    $parameters = [
        'typeVolumeHorairePrevu' => TypeVolumeHoraire::CODE_PREVU,
    ];

    $query = $this->getEntityManager()->createQuery($dql)->setParameters($parameters);

    // On donne $query, de type Doctrine\ORM\Query à l'AxiosModal, qui la transmet à l'AxiosExtractor pour traitement
    // Ici, les propriétés ne sont pas définies, dont l'entité Mission doit implémenter `UnicaenVue\Axios\AxiosExtractorInterface`
    // Idem pour les autres entités remontées.
    // Les donnnées transmises au client seront une liste de missions, avec toutes les données et sous-entités afférentes converties en objets JSON
    return new AxiosModel($query);
```

Et voici le résultat final récupéré dans le composant Vue avec Axios :
```json
[
    {
        "id"             : 36,
        "typeMission"    : {
            "id"     : 316,
            "libelle": "Référent étudiant en résidence universitaire Crous"
        },
        "dateDebut"      : "1980-02-02T00:00:00.000000Z",
        "dateFin"        : "1980-03-03T00:00:00.000000Z",
        "structure"      : {
            "id"     : 173,
            "libelle": "Dir Communication"
        },
        "tauxRemu"       : {
            "id"     : 1,
            "libelle": "Taux 1"
        },
        "description"    : "dd",
        "histoCreation"  : "2023-02-01T13:53:04.000000Z",
        "histoCreateur"  : {
            "id"         : 999999999,
            "email"      : "laurent.lecluse@unicaen.fr",
            "displayName": "Laurent Local"
        },
        "heures"         : 60,
        "heuresValidees" : 0,
        "volumesHoraires": [
            {
                "id"           : 15,
                "heures"       : 50,
                "valide"       : false,
                "validation"   : null,
                "histoCreation": "2023-02-01T13:53:04.000000Z",
                "histoCreateur": {
                    "id"         : 999999999,
                    "email"      : "laurent.lecluse@unicaen.fr",
                    "displayName": "Laurent Local"
                },
                "canValider"   : true,
                "canDevalider" : false,
                "canSupprimer" : true
            },
            {
                "id"           : 16,
                "heures"       : 10,
                "valide"       : false,
                "validation"   : null,
                "histoCreation": "2023-02-01T14:08:35.000000Z",
                "histoCreateur": {
                    "id"         : 999999999,
                    "email"      : "laurent.lecluse@unicaen.fr",
                    "displayName": "Laurent Local"
                },
                "canValider"   : true,
                "canDevalider" : false,
                "canSupprimer" : true
            },
            {
                "id"           : 34,
                "heures"       : -1,
                "valide"       : false,
                "validation"   : null,
                "histoCreation": "2023-03-02T10:41:31.000000Z",
                "histoCreateur": {
                    "id"         : 999999999,
                    "email"      : "laurent.lecluse@unicaen.fr",
                    "displayName": "Laurent Local"
                },
                "canValider"   : true,
                "canDevalider" : false,
                "canSupprimer" : true
            },
            {
                "id"           : 35,
                "heures"       : 1,
                "valide"       : false,
                "validation"   : null,
                "histoCreation": "2023-03-02T10:41:50.000000Z",
                "histoCreateur": {
                    "id"         : 999999999,
                    "email"      : "laurent.lecluse@unicaen.fr",
                    "displayName": "Laurent Local"
                },
                "canValider"   : true,
                "canDevalider" : false,
                "canSupprimer" : true
            }
        ],
        "contrat"        : false,
        "valide"         : false,
        "validation"     : null,
        "canSaisie"      : true,
        "canValider"     : true,
        "canDevalider"   : false,
        "canSupprimer"   : true
    },
    {
        "id"             : 37,
        "typeMission"    : {
            "id"     : 1,
            "libelle": "Accompagnement des étudiants en situation de handicap"
        },
        "dateDebut"      : "1980-03-02T00:00:00.000000Z",
        "dateFin"        : "1980-03-03T00:00:00.000000Z",
        "structure"      : {
            "id"     : 173,
            "libelle": "Dir Communication"
        },
        "tauxRemu"       : {
            "id"     : 1,
            "libelle": "Taux 1"
        },
        "description"    : "Test",
        "histoCreation"  : "2023-02-02T09:49:45.000000Z",
        "histoCreateur"  : {
            "id"         : 999999999,
            "email"      : "laurent.lecluse@unicaen.fr",
            "displayName": "Laurent Local"
        },
        "heures"         : 80,
        "heuresValidees" : 80,
        "volumesHoraires": [
            {
                "id"           : 29,
                "heures"       : 80,
                "valide"       : true,
                "validation"   : {
                    "id"           : 269874,
                    "histoCreation": "2023-02-02T09:50:29.000000Z",
                    "histoCreateur": {
                        "id"         : 999999999,
                        "email"      : "laurent.lecluse@unicaen.fr",
                        "displayName": "Laurent Local"
                    }
                },
                "histoCreation": "2023-02-02T09:49:45.000000Z",
                "histoCreateur": {
                    "id"         : 999999999,
                    "email"      : "laurent.lecluse@unicaen.fr",
                    "displayName": "Laurent Local"
                },
                "canValider"   : false,
                "canDevalider" : false,
                "canSupprimer" : false
            }
        ],
        "contrat"        : false,
        "valide"         : true,
        "validation"     : {
            "id"           : 269874,
            "histoCreation": "2023-02-02T09:50:29.000000Z",
            "histoCreateur": {
                "id"         : 999999999,
                "email"      : "laurent.lecluse@unicaen.fr",
                "displayName": "Laurent Local"
            }
        },
        "canSaisie"      : false,
        "canValider"     : false,
        "canDevalider"   : true,
        "canSupprimer"   : false
    },
    {
        "id"             : 14,
        "typeMission"    : {
            "id"     : 2,
            "libelle": "Appui aux personnels des bibliothèques"
        },
        "dateDebut"      : "2022-01-01T00:00:00.000000Z",
        "dateFin"        : "2022-01-02T00:00:00.000000Z",
        "structure"      : {
            "id"     : 175,
            "libelle": "DEVE"
        },
        "tauxRemu"       : {
            "id"     : 1,
            "libelle": "Taux 1"
        },
        "description"    : "dvfdd",
        "histoCreation"  : "2023-01-26T10:53:19.000000Z",
        "histoCreateur"  : {
            "id"         : 999999999,
            "email"      : "laurent.lecluse@unicaen.fr",
            "displayName": "Laurent Local"
        },
        "heures"         : 12,
        "heuresValidees" : 0,
        "volumesHoraires": [
            {
                "id"           : 12,
                "heures"       : 12,
                "valide"       : false,
                "validation"   : null,
                "histoCreation": "2023-01-31T10:25:56.000000Z",
                "histoCreateur": {
                    "id"         : 999999999,
                    "email"      : "laurent.lecluse@unicaen.fr",
                    "displayName": "Laurent Local"
                },
                "canValider"   : true,
                "canDevalider" : false,
                "canSupprimer" : true
            }
        ],
        "contrat"        : false,
        "valide"         : false,
        "validation"     : null,
        "canSaisie"      : true,
        "canValider"     : true,
        "canDevalider"   : false,
        "canSupprimer"   : true
    },
    {
        "id"             : 31,
        "typeMission"    : {
            "id"     : 395,
            "libelle": "Tutorat au bénéfice des étudiants de première année"
        },
        "dateDebut"      : "2023-01-27T00:00:00.000000Z",
        "dateFin"        : "2023-01-27T00:00:00.000000Z",
        "structure"      : {
            "id"     : 173,
            "libelle": "Dir Communication"
        },
        "tauxRemu"       : {
            "id"     : 1,
            "libelle": "Taux 1"
        },
        "description"    : "Test de saisie de VH Prév",
        "histoCreation"  : "2023-01-27T16:06:35.000000Z",
        "histoCreateur"  : {
            "id"         : 999999999,
            "email"      : "laurent.lecluse@unicaen.fr",
            "displayName": "Laurent Local"
        },
        "heures"         : 15,
        "heuresValidees" : 0,
        "volumesHoraires": [
            {
                "id"           : 13,
                "heures"       : 15,
                "valide"       : false,
                "validation"   : null,
                "histoCreation": "2023-01-31T10:26:27.000000Z",
                "histoCreateur": {
                    "id"         : 999999999,
                    "email"      : "laurent.lecluse@unicaen.fr",
                    "displayName": "Laurent Local"
                },
                "canValider"   : true,
                "canDevalider" : false,
                "canSupprimer" : true
            }
        ],
        "contrat"        : false,
        "valide"         : false,
        "validation"     : null,
        "canSaisie"      : true,
        "canValider"     : true,
        "canDevalider"   : false,
        "canSupprimer"   : true
    }
]
```
 No newline at end of file
+2 −2
Changes for src/Axios/AxiosExtractor.php: 2 added lines, 2 removed lines.
Original line number Diff line number Diff line
@@ -12,9 +12,9 @@ class AxiosExtractor

    public static function extract($data, array $properties = [])
    {
        $axiosModel = new self;
        $axios = new self;

        return $axiosModel->extractData($data, $properties);
        return $axios->extractData($data, $properties);
    }