Differences

This shows you the differences between two versions of the page.

--- start [2019/09/03 15:19]
188.165.109.105
+++ start [2019/10/15 15:10] (current)
188.165.109.105
@@ Line 1: / Line 1: @@
-====== secom.io ======
+====== Structure du projet ======
-===== structure du projet =====
+Le projet comporte l'arborescence suivante :
-Le projet comporte les répertoires suivants :
   secom.io
   ├── cli [ **Scripts lancés en ligne de commande** ]
   │   ├── directus.php
-  │   ├── myzen.php
+  │   ├── myzen.prod.php
-  │   └── test_myzen.php
+  │   └── myzen.dev.php
   ├── config [ **Fichiers de configuration des différentes entités sur les différents environnements** ]
   │   ├── myzen.cfg.php
@@ Line 70: / Line 68: @@
   │   ├── directus_myzen.class.php
   │   └── myzen.class.php
+  ├── interfaces [ **Contient les sources des interfaces custom** ]
+  ├── pages [ **Contient les sources des pages custom** ]
   ├── sites [ **Sites annexes** ]
   │   └── directus.secom.io [ **Site permettant d'explorer les collections d'un instance Directus**]
@@ Line 84: / Line 84: @@
           └── ...
-===== Connection aux API =====
+====== Connection aux API ======
 Les APIs Chyro et Directus ont quelques points communs : en particulier elles fonctionnent en REST et retournent principalement du JSON.
-Les classes PHP développées pour utiliser ces APIs tentent de mutualiser le code des déverses fonctionnalités de ces API au travers du principe d'héritage. De même, les particularités des différentes entités utilisant Chyro pourront se retrouver dans des classes spécifique dérivant d'une même classe mère contenant un socle commun.
-Au fur et à mesure des développement, certaines méthodes seront sans doute amenées à être plus ou moins déplacées entre les parties communes ou plus spécifiques du code.
-==== Principales classes ====
+Les classes PHP développées pour utiliser ces APIs tentent de mutualiser le code des diverses fonctionnalités de ces API au travers du principe d'héritage. De même, les particularités des différentes entités utilisant Chyro pourront se retrouver dans des classes spécifiques dérivant d'une même classe mère délimitant un socle commun.
+Au fur et à mesure des développements, certaines méthodes seront sans doute amenées à être déplacées entre les parties communes ou plus spécifiques du code.
 Les principales classes de connection aux API s'organisent à travers le schéma d'héritage suivant :
@@ Line 99: / Line 99: @@
      └─ Directus_Myzen
-=== Classe API ===
+===== Classe API =====
 Cette classe gère principalement les connections HTTP avec les APIs à travers la librairie Curl.
 Elle gère également la récupération des données dans les objets PHP ou Json.
-== Instanciation ==
-Cette classe n'est pas faite pour être instancée directement. Toutefois, il est prévu que son constructeur soit utilisé par les classes qui en dérivent. Celui-ci prend en argument un tableau associatif contenant les paramètres de configuration propre à la classe fille.
+==== Instanciation ====
+Cette classe n'est pas faite pour être instancée directement. Toutefois, il est prévu que son constructeur soit utilisé par les classes qui en dérivent. Celui-ci prend en argument un tableau associatif contenant les paramètres de configuration propres à la classe fille.
 Le paramètre 'host' est obligatoire.
-== Mode debug ==
+==== Mode debug ====
 Si le tableau passé en paramètre au constructeur contient
@@ Line 120: / Line 121: @@
-== Principales méthodes ==
+==== Principales méthodes ====
-  cfg($key, [$needed = false])
+=== cfg($key, [$needed = false]) ===
 Permet d'accéder aux paramètres de configurations passés au constructeur.
@@ Line 129: / Line 130: @@
-  add_get_params(&$url)
+=== add_get_params(&$url) ===
-Cette méthode ajoute des paramètres GET à une $url passée en paramètres
+Cette méthode ajoute des paramètres GET à une $url passée en paramètres.
-  curl($params)
+=== curl($params) ===
 Cette méthode permet d'effectuer une requête Curl sur l'API accessible sur le serveur correspondant au paramètre 'host'.
@@ Line 149: / Line 150: @@
   * cookie => (array) (les données du tableau associatif passé en paramètre seront définies en tant que cookie)
-Si le mode debug est activé lors de l'instanciation de l'objet, les requêtes et réponses Curl faites à l'API
+Si le mode debug est activé lors de l'instanciation de l'objet, les requêtes et réponses Curl faites à l'API seront affichées sur la sortie standard.
+=== from_object($object, $key) ===
+Cette méthode permet de récupérer une donnée dans l'objet (ou le tableau associatif) passé en paramètre.
+  * Si $key vaut NULL, la méthode retournera tout l'objet.
+  * Si $key est une string, la méthode renverra la propriété de l'objet (ou la valeur du tableau associatif) correspondant à cette clé.
+  * Si $key est un array de string, la méthode descendra dans l'objet (ou le tableau associatif) en suivant la liste des clés dans $key et retournera la partie de l'objet (ou du tableau) finalement atteinte.
-== Méthodes statiques ==
+Une erreur sera produite si l'on tente d'accéder à une clé qui n'existe pas.
-Deux méthodes statiques de cette classe sont utilent pour le débuggage :
+=== from_json($json, $key) ===
+Même fonctionnement que from_object, mais à partir d'une chaîne au format JSON.
+==== Méthodes statiques ====
+Deux méthodes statiques de cette classe sont utiles pour le débuggage :
-  API::inspect($var, [$fold_limit=9])
+=== API::inspect($var, [$fold_limit]) ===
 Cette méthode permet de retourner une chaine de caractères représentant un objet PHP issu du JSON reçu en réponse des APIs.
@@ Line 166: / Line 181: @@
-  API::dump($var, [$fold_limit=9])
+=== API::dump($var, [$fold_limit]) ===
 Cette méthode affiche le résultat la méthode inspect sur la sorite standard au lieu de le retourner dans une chaîne de caractères.
-=== Classe Chyro ===
+===== Classe Chyro =====
 Cette classe comporte les fonctionnalités propres à l'API Chyro.
 Si de nouvelles instances de Chyro doivent être prises en charge et que leur API s'avère différente, il faudra sans doute dériver cette classe pour rendre compte de ces spécificités.
-== Instantiation ==
+==== Instantiation ====
 L'objet se construit de la façon suivante :
@@ Line 193: / Line 209: @@
   * auto_reconnect => (bool) (En cas de réponse vide de l'API Chyro obtenue par la méthode 'get', une tentative de reconnection a lieu, avant que la méthode 'get' soit invoquée de nouveau.)
-== Principales méthodes ==
+==== Principales méthodes ====
-  login()
+=== login() ===
 Permet de se connecter à l'API Chyro, récupère et enregistre l'id de session PHP qui servira aux requêtes ultérieures.
-  logout()
+=== logout() ===
 Appelle le endpoint auth/deltoken de l'API Chyro, censée invalider le token (ne semble pas fonctionner : au départ, un paramètre de configuration auto_logout était disponible, déclenchant l'appel automatique de cette méthode dans le destructeur de l'objet, mais ce code a été retiré car il semblait inutile.)
-  get($action, $key = null, $params = [], $format = "/format/json")
+=== get($action, $key = null, $params = [], $format = "/format/json") ===
 Cette méthode permet de faire une requête générique sur l'API Chyro.
-Le paramètre 'action' correspond à l'action (endpoint) de l'API Chyro.
+Le paramètre 'action' correspond à l'action de l'API Chyro.
-Le paramètre 'key' permet
+Le paramètre 'key' permet d'extraire une partie de la réponse (cf. API::from_json)
+Le paramètre 'params' contient les paramètres qui seront passés à API::curl
+Le paramètre $format correspond au format tel que spécifié par l'API Chyro (pour le moment uniquement testé avec "/format/json")
+=== get_programs ===
+Récupère l'ensemble des programmes classés par ordre croissants de date d'update.
-  get_program
-  get_programs
+=== get_program($id_program) ===
+Récupère un programme d'après son ID.
+=== create_program($fields) ===
+Crée un programme avec les champs du tableau associatif passé en paramètre.
+=== update_program($fields) ===
+Met à jour un programme avec les champs du tableau associatif passé en paramètre.
+L'ID du programme doit être contenu dans la clé 'id' de $fields.
+===== Classe Directus =====
+Cette classe comporte les fonctionnalités propres à l'API Directus et communes aux différentes entités.
+==== Instantiation ====
+L'objet se construit de la façon suivante :
+  $directus = new Directus($params);
+où $params est un tableau associatif contenant obligatoirement les clés suivantes :
+  * host => (string) (URL de l'API Directus)
+  * email => (string) (Email du compte utilisateur Directus)
+  * password => (string) (Mot de passe du compte utilisateur)
+En outre, le tableau passé au constructeur peut contenir les clés optionnelles suivantes :
+  * token => (string) (Pour réutiliser un token. Vide par défaut, le token sera alors obtenu automatiquement)
+  * auto_login => (bool) (la méthode 'login' sera automatiquement appelée au premier appel de la méthode 'get'. TRUE par défaut)
+  * auto_reconnect => (bool) (En cas de réponse false de l'API Directus obtenue par la méthode 'get', une tentative de reconnection a lieu, avant que la méthode 'get' soit invoquée de nouveau.)
+==== Principales méthodes ====
+=== login() ===
+Appelle connect() si l'objet n'a pas de token.
+=== connect() ===
+Appelle get_token() et stocke le résultat dans l'objet.
+=== get_token() ===
+Obtient un nouveau token.
+=== get($endpoint, $key = null, $params = []) ===
+Cette méthode permet de faire une requête générique sur l'API Directus.
+Le paramètre 'endpoint' correspond au endpoint de l'API Directus.
+Le paramètre 'key' permet d'extraire une partie de la réponse (cf. API::from_json)
+Le paramètre 'params' contient les paramètres passés à API::curl
+=== get_first($endpoint, $key = null, $params = []) ===
+Idem que 'get' mais en ajoutant automatiquement
+  $params['?']['limit'] = 1;
+et en retournant le premier élément seulement du 'data' obtenu en réponse si celui-ci est un tableau (sinon, la méthode équivaut à un 'get' classique, avec toutefois un limit=1.)
+=== get_all($endpoint, $key = null, $params = []) ===
+Par défaut, les résultats de type liste renvoyés par Directus sont limités en nombre d'items.
+Cette méthode permet d'aggréger les résultats de plusieurs appels à l'API Directus en faisant varier automatiquement le paramètre 'offset' afin d'être sûr de récupérer tout ce qui est en base de donnée.
+Les paramètres s'utilisent de la même façon que pour un 'get' classique.
+=== get_id($endpoint, $data) ===
+Récupère la valeur du champ 'id' de ce qui serait retourné par un 'get_first', le paramètre $data permettant de définir des filtres.
+Typiquement, si un item de collection peut être identifié à partir d'un certain nombre de champs autres que son ID, cette méthode permet de retrouver l'ID de l'item à partir de ces champs.
+=== save($collection, $object) ===
+Permet de créer ou modifier un item dans une collection.
+Le paramètre $object peut être un objet PHP ou un tableau associatif.
+Si la propriété 'id' est définie, la méthode procèdera à une modification (PATCH) sinon à une création (POST).
+=== save_with_strcut($collection, $object) ===
+Idem que la méthode 'save', mais en réalisant une troncature des chaînes de caractères contenues dans $object en fonction de la longueur des champs retournés par la méthode 'fields_lengths'
+=== save_if_unique($collection, $object = [], $save_method = "save") ===
+Idem que la méthode 'save', mais capture une éventuelle erreur Directus de type "Duplicate Item" et ne fait rien dans ce cas. Cette méthode permet de créer un item seulement si il n'existe pas déjà, puis éventuellement de le modifier (tant que les contraintes d'unicités des champs sont respectées).
+Le dernier paramètre, s'il est spécifié avec "save_with_strcut" au lieu du "save" par défaut, permet par exemple de combiner les spécificités des méthode "save_if_unique" et "save_with_strcut".
+=== fields_lengths($collection) ===
+Cette méthode renvoie un tableau associatif contenant les longeurs des champs d'une collection.
+Les champs de type "translation" sont gérés, et les champs de la table de traduction sont alors contenus dans un sous-tableau.
+=== primary_key($collection) ===
+Cette méthode retourne le nom du champ de type 'primary_key' (souvent 'id' mais il y a des exceptions, comme pour la tble des langues.)
+Les clés primaires sur plusieurs champs ne sont pas gérées (est-ce que ça peut exister dans Directus ?)
+=== collections() ===
+Retourne la liste des collections, en excluant les collections "internes" de directus (préfixées par "directus_").
+=== relations() ===
+Retourne la liste des relations entre collections.
+=== related($attr, $params) ===
+Récupère la collection correspondant à l'attribut $attr, dans la relation spécifiée par $params.
+Par exemple, pour une collection 'programs' qui aurait un champ 'program_info' de type 'translation', en relation avec la collection 'programs_translations' :
+  $api_directus->related("collection_many", [
+    'collection_one' => "programs",
+    'field_one' => "program_info",
+  ]);
+permet de retrouver la collection "programs_translations" en relation avec "programs".
+=== import_collections($dir) ===
+Permet d'importer les collections définies par les fichiers JSON contenus dans $dir.
+Les relations contenues dans un éventuel fichier 'directus_relations.json' seront aussi importées.
+=== import_items($collection, $dir) ===
+Recherche un fichier "$collection.json" dans $dir et réalise un 'save_if_unique' sur tous les éléments du tableau JSON contenu dans ce fichier pour la collection donnée.
+=== delete_item($collection, $id) ===
+Supprime de la collection $collection l'item correspondant à l'id $id.
+=== delete_items($collection, [$filters]) ===
+Supprime tous les élements d'une collection.
+Si le paramètre optionnel $filter est précisé, il permet de limiter le delete aux items vérifiant les propriétés spécifiées dans ce tableau.
+===== Classe Directus_Myzen =====
+==== Pricipales méthodes ====
+=== get_chyro_install_id($ref) ===
+Récupère l'id d'une chyro_install en fonction de la référence passée en paramètre.
+=== create_or_get_chyro_install_id($ref) ===
+Crée une install chyro de référence $ref si elle n'existe pas déjà, et retourne son ID.
+=== get_chyro_programs([$fields]) ===
+Récupère l'ensemble des chyro_programs.
+Si le paramètres $fields est spécifié, seuls certains champs apparaitront dans la réponse.
+$fields peut être un tableau ou une chaîne de caractère sous la forme d'une liste de champs séparés par une virgule.
+=== get_chyro_program($id) ===
+Récupère un chyro_program en fonction de l'ID spécifié.
+=== get_program($id) ===
+Récupère un program en fonction de l'ID spécifié.
+====== Fonctionnalités CLI ======
+Un certain nombre de fonctionnalités sont disponibles à partir de scripts exécutables en ligne de commande. Ceux-ci sont rangés dans le répertoire 'cli'.
+Ces scripts instancient des objets de type bot, dont les classes sont définies dans les fichiers préfixés par "bot_", et ils utilisent un fichier de configuration parmi ceux rangés dans le répertoire 'config'.
+Lorsqu'ils sont lancés sans argument, ou avec '--help', ces scripts affichent la liste des méthodes disponibles.
+===== Script cli/directus.php =====
+Ce script execute les méthodes de la classe Bot_Directus (dédinie dans le fichier inc/bot_directus.php).
+Ce bot contient les méthodes maintenance de l'installation de Directus.
+==== Méthodes de Bot_Directus ====
+=== php cli/directus.php --install ===
+Lance l'installation de Directus et effectue les tâches de la méthode update.
+=== php cli/directus.php --update ===
+Cette commande effectue :
+- un git pull du dépot principal
+- la création dans Directus les liens symboliques vers les fichiers de configuration PHP contenus dans les dossiers 'config' du répertoire 'env'
+- la compilation des interfaces et des pages custom et la création des liens symboliques correspondants dans Directus.
+=== php cli/directus.php --upgrade ===
+Cette commande permet de mettre à jour Directus en effectuant les opérations suivantes :
+  - Mise à jour du code de Directus avec Git
+  - Lancement de l'upgrade de base de donnée de Directus pour tous les "projets" configurés
+  - Propriété et droit d'écriture sur les fichiers donnés à l'utilisateur et au groupe www
+===== Script cli/myzen.php =====
+Ce script éxecute les méthodes de Bot_Myzen qui étend les fonctionnalités de Bot_Entity (qui contiendra les fonctionnalités communes aux différentes entités).
+Le script se décline en réalité selon les environnements en myzen.prod.php, myzen.dev.php, etc.
+Pour simplifier, nous utiliserons ci-dessous cli/myzen.php.
+La plupart des méthodes peuvent être lancées en rajoutant l'option --debug qui rajoute alors automatiquement la propriété debug => true aux configurations utilisées, ce qui affiche par exemple sur la sortie standard les requêtes et réponses Curl de communication à travers les APIs Directus et Chyro.
+==== Méthodes de Bot_Entity ====
+=== php cli/myzen.php --install ===
+Installe la base de données (collections et items) d'après les fichiers du répertoire db.
+=== php cli/myzen.php --show_collections ===
+Affiche le liste des collections.
+=== php cli/myzen.php --empty_collection --collection=<collection> ===
+Permet de vider une collection.
+==== Méthodes de Bot_Myzen ====
+=== php cli/myzen.php --import_chyro_programs ===
+Importe les chyro_programs depuis les instances de Chyro configurées. (Utilisé dans le processus de synchro.)
+=== php cli/myzen.php --import_programs ===
+Importe les programs à partir des chyro_programs. (Utilisé dans le processus de synchro.)
-=== Classe Directus ===
-Cette classe comporte les fonctionnalités propres à l'API Directus et c

DokuWiki

Site Tools

Differences

Page Tools