Commit 76b3c02f authored by Laurent Lecluse's avatar Laurent Lecluse
Browse files

Introduction du client UnicaenVue, bugs & doc

parent 9df7ec13
Loading
Loading
Loading
Loading
Loading
+105 −3
Changes for doc/install.md: 105 added lines, 3 removed lines.
Original line number Diff line number Diff line
# Installation d'UnicaenVue

## Composer
L'installation & la configuration du module se font en 5 étapes.

## 1. Composer

UnicaenVue est disponible via le Packagist, comme les autres bibliothèques Unicaen.

@@ -14,9 +16,109 @@ UnicaenVue est disponible via le Packagist, comme les autres bibliothèques Unic
    ...
```

## Node.js
Lancez `composer update`

## 2. Node.js

UnicaenVue est aussi un module Node.

Après avoir installé Node sur la machine de développement, il faut ajouter
Après avoir installé Node & NPM sur la machine de développement, il faut ajouter la dépendance au fichier package.json à la racine du répertoire du projet.

Les scripts de dev et de build peuvent ausi être utiles. dev sert à lancer
le serveur Node pour le hot-loading, et build permet de compiler le front pour intégration au GIT et mise en production.

Voici un exemple complet de fichier package.json :

```json
{
  "name": "ose",
  "version": "21.0.0",
  "author": "Université de Caen Normandie",
  "description": "Organisation des Services d'Enseignement",
  "license": "ISC",
  "private": true,
  "scripts": {
    "dev": "APP_ENV=development vite dev",
    "build": "vite build"
  },
  "dependencies": {
    "sass": "^1.57.1",
    "unicaen-vue": "file:./vendor/unicaen/vue"
  }
}

```

Lancez `npx npm update` depuis le répertoire racine de votre application.

## 3. Vite

Un fichier de configuration pour Vite est également à ajouter dans le répertoire racin du projet.

En voici un exemple :

```javascript
import unicaenVue from 'unicaen-vue';
import path from 'path';

/**
 * @see https://vitejs.dev/config/
 *
 * la config transmise ci-dessous est surchargée par UnicaenVue.defineConfig, qui ajoute ses propres éléments
 * puis retourne vite.defineConfig
 */
export default unicaenVue.defineConfig({
    // répertoire où seront placés les fichiers *.vue des composants
    root: 'front',
    build: {
        // Répertoire où seront placés les fichiers issus du build et à ajouter au GIT
        outDir: path.resolve(__dirname, 'public/dist'),
    },
    server: {
        // port par défaut utilisé par Node pour communiquer les éléments en "hot-loading"
        // utile uniquement en mode dev, donc
        port: 5133
    },
    resolvers: [
        // Liste de resolvers pour faire de l'auto-import
    ],
});
```

Il n'est pas nécessaire de le modifier, à moins que vous ne souhaitiez ajouter des modules à Vite ou personnaliser votre configuration.

## 4. Répertoire front & fichier main.js

Créez un nouveau répertoire "front" à la racine de votre projet.
Ce répertorie contiendra tous vos composants Vue.

Un fichier "main.js" doit être aussi créé. Il sert à initialiser la partie front de l'application.

En voici le contenu :
```javascript
const vues = import.meta.glob('./**/*.vue', {eager: true});
import vueApp from 'unicaen-vue/js/Client/main'

vueApp.init(vues);
```

## 5. Lancement du front depuis le layout

Enfin, dernière étape, vous devez démarrer la partie "front".
Pour cela, vous devrez ajouter Vite au layout de votre application, dans le HEAD :
```html
<html lang="fr">
<head>
    ...
    <?= $this->vite()->head(); ?>
    ...
</head>
<body>
...

```


C'est prêt!!!
Il ne reste plus qu'à créer votre premier composant.
Un premier tuto est disponible [ici](tuto1.md)
 No newline at end of file

doc/tuto1.md

0 → 100644
+116 −0
Changes for doc/tuto1.md: 116 added lines, 0 removed lines.
Original line number Diff line number Diff line
# Premier tuto Unicaen/Vue

L'objectif est de créer un premier composant, de le lancer à partir d'une action de contrôleur, puis de récupérer des données à l'aide d'Axios et les afficher

## 1. Partie serveur

Dans un contrôleur, créez deux actions :

```php

...
use UnicaenVue\View\Model\AxiosModel;
use UnicaenVue\View\Model\VueModel;
...

    // Action qui va charger le composant MonTest
    public function testAction()
    {
        $data = [
            'monId' => 50,
        ];

        // On crée un VueModel et on lui transmet des données par défaut
        $vm = new VueModel($data);

        // On lui donne un template, c'est-à-dire le chemin et le nom du composant à utiliser
        // Le composant s'appelle MonTest se trouvera dans le fichier front/Exemple/MonTest.vue
        // Notez qu'on utilise par convention une syntaxe kebab-case pour le template et CamelCase pour les répertoires, & noms de composants Vue.
        $vm->setTemplate('exemple/mon-test');

        // On retourne le VueModel
        return $vm;
    }



    // Action qui envoie des données au composant
    public function testDataAction()
    {
        $monId = $this->params()->fromRoute('monId');

        // on récupère les données sur la base de l'ID récupéré
        $contacts = [
            50 => [
                ['nom' => 'monNom', 'prenom' => 'monPrenom'],
                ['nom' => 'monNom2', 'prenom' => 'monPrenom2'],
                ['nom' => 'monNom3', 'prenom' => 'monPrenom3'],
            ],
        ];

        // Petit msg d'info
        $this->flashMessenger()->addSuccessMessage('Tout va bien!');

        // Et on retourne un AxiosModel qui présente le tout au client
        return new AxiosModel($contacts[$monId]);
    }
...
```


## 2. Partie client

Créez, dans le fichier front/Exemple/MonTest, le composant suivant :

```vue
<template>
    <p>Mon ID : {{ monId }}</p>

    <h2>Contacts</h2>
    <table class="table table-bordered">
        <thead>
        <tr>
            <th>Nom</th>
            <th>Prénom</th>
        </tr>
        </thead>
        <tbody>
        <tr v-for="c in contacts">
            <td>{{ c.nom }}</td>
            <td>{{ c.prenom }}</td>
        </tr>
        </tbody>
    </table>
</template>

<script>
export default {
    name: "MonTest",
    props: {
        monId: {required: true, type: Number}
    },
    data()
    {
        return {
            contacts: []
        };
    },
    mounted()
    {
        // on utilise l'axios adapté d'UnicaenVue
        unicaenVue.axios.get(
            // unicaenVue.url permet de créer une URL à partir d'une route et de paramètres d'URL
            unicaenVue.url("mission/test-data/:monId", {monId: this.monId})
        ).then(response => {
            // response.data contient les données, on met à jour les contacts avec...
            this.contacts = response.data;
        });
    }
}

</script>

<style scoped>

</style>
```
 No newline at end of file
+2 −2
Changes for js/Client/flashMessenger.js: 2 added lines, 2 removed lines.
Original line number Diff line number Diff line
function alerts(messages)
{
    for (s in messages) {
        for (m in messages[s]) {
    for (let s in messages) {
        for (let m in messages[s]) {
            alert(messages[s][m], s);
        }
    }
+2 −2
Changes for js/Client/main.js: 2 added lines, 2 removed lines.
Original line number Diff line number Diff line
import {createApp} from 'vue';

// on met en place Axios
import axios from './axios';
// on met en place le client d'UnicaenVue
import unicaenVue from './unicaenVue';

function init(vues, options)
{
+6 −12
Changes for src/View/Helper/ViteViewHelper.php: 6 added lines, 12 removed lines.
Original line number Diff line number Diff line
@@ -33,13 +33,9 @@ class ViteViewHelper extends AbstractHtmlElement
     *
     * @return self|string
     */
    public function __invoke(?string $entry = null)
    public function __invoke()
    {
        if (!empty($entry)) {
            return $this->vite($entry);
        }

        return $this;
        return $this->render();
    }


@@ -63,11 +59,7 @@ class ViteViewHelper extends AbstractHtmlElement
     */
    public function render(): string
    {
        $r = '';

        /* Complétez */

        return $r;
        return $this->vite('main.js');
    }


@@ -111,9 +103,11 @@ class ViteViewHelper extends AbstractHtmlElement

    public function vite(string $entry): string
    {
        return "\n" . $this->jsTag($entry)
        $h =  "\n" . $this->jsTag($entry)
            . "\n" . $this->jsPreloadImports($entry)
            . "\n" . $this->cssTag($entry);
        $h .= '<script> window.__unicaenVueBaseUrl = '.json_encode($this->getView()->url('home')).'; </script>';
        return $h;
    }


Loading