Skip to content

Latest commit

 

History

History
95 lines (64 loc) · 5.33 KB

README_events.md

File metadata and controls

95 lines (64 loc) · 5.33 KB
Raw

Documentation Française

Récupérateur d'Événements

Le script eventPreAnalyser.py extrait les évènements de Thelia ainsi que certaines de leurs informations et les écrits dans un fichier texte généré. Celui-ci est formaté pour être exploité par le script python eventAnalyser.py. Ce dernier permet d'obtenir des informations sur les constantes des événements Thelia, puis de mettre en forme les données collectées dans un fichier markdown.

Fonctionnalités de eventPreAnalyser.py

  • Détection des Classes dépréciées : Identifie les classes marquées comme dépréciées (grâce à la mention @deprecated) et fournit le chemin d'accès de l'évènement le remplacement (grâce au commentaire suivant @deprecated).
  • Extraction des arguments de constructeur : Extrait les arguments des constructeurs des évènements et les liste aux côtés des noms de l'évènement correspondant.
  • Formatage de la sortie : Créé un fichier texte contenant des tableaux de tableaux contenant les évènements triés par dossier et par ordre alphabétique.
    • Le texte est écrit sous format markdown afin d'être affiché par la suite.
    • Les fichiers à la racines du dossier 'Event' se trouvent dans le premier tableau qui est nommé 'no_category'.
    • Si un fichier ne contient pas de constructeur, le message 'no constructor found in this file' remplace les arguments.
      Exemple de sortie:
      [[no_category, event1 -> $argument1 $argument2\n ],[nomDossier1,- event1 -> $argument1 \n- Event2 -> no constructor found in this file\n]]

Utilisation de eventPreAnalyser.py

Ce script ne peut pas être utilisé en ligne de commande. Vous devez utiliser thelia-doc.py

Fonctionnalités de eventAnalyser.py

  • Récupère les catégories et les constantes associées.
  • Récupère les commentaires éventuels au dessus de chaque constante.
  • Tri les catégories par ordre alphabétique.``
  • Convertit le fichier généré par eventPreAnalyser.py en tableau python.
  • Fusionne les constantes avec les données de eventPreAnalyser.py.
  • Génère un fichier markdown mettant en page toutes ces données.
  • Modifie directement la documentation des événements de Thelia.

Utilisation de eventAnalyser.py

Pour obtenir le résultat de l'analyse dans le fichier que vous voulez :
python3 eventAnalyser.py [FICHIER SOURCE] [FICHIER DESTINATION]

Pour obtenir le résultat de l'analyse dans le fichier par défaut 'parsedEvents2.md' dans le même répertoire que eventAnalyser.py :
python3 eventAnalyser.py [FICHIER SOURCE]

Le fichier source doit être le fichier TheliaEvents.php.
Vous devez inclure le chemin d'accès du fichier (nom du fichier inclu).
Le fichier dataArrayEvent.txt généré par eventPreAnalyser.py doit exister dans le repertoire courant.

Les options -het --help permettent d'accéder rapidement à cette description (en anglais uniquement).

Le script demandera le fichier de documentation des événements Thelia qui sera modifié.

English documentation

Event Extractor

The eventPreAnalyser.py script extracts events from Thelia along with some of their information and writes them into a generated text file. This is formatted for use by the python script eventAnalyser.py. This provides information on Thelia event constants, and then formats the collected data in a markdown file.

eventPreAnalyser.py features

  • Deprecated Class Detection: Identifies classes marked as deprecated (using the @deprecated annotation) and provides the replacement event path (through the comment following @deprecated).
  • Constructor Arguments Extraction: Extracts constructor arguments of the events and lists them alongside the corresponding event names.
  • Output Formatting: Generates a text file containing arrays of arrays containing events sorted by folder and alphabetically.
    • The text is written in markdown format for later display.
    • Files at the root of the 'Event' folder are placed in the first array named 'no_category'.
    • If a file does not contain a constructor, the message 'no constructor found in this file' replaces the arguments.

Example output:

[[no_category, event1 -> $argument1 $argument2\n ],[folderName1,- event1 -> $argument1 \n- Event2 -> no constructor found in this file\n]]

eventPreAnalyser.py usage

This script cannot be used on the command line. You must use thelia-doc.py

eventAnalyser.py features

  • Retrieves categories and associated constants.
  • Retrieves any comments above each constant.
  • Sort categories alphabetically.
  • Converts the file generated by eventPreAnalyser.py into a python array.
  • Merges constants with eventPreAnalyser.py data.
  • Generates a Markdown file displaying all this data.
  • Directly modifies Thelia event documentation.

eventAnalyser.py usage

To get the parsing result in the file you want :
python3 eventAnalyser.py [SOURCE FILE] [DESTINATION FILE]

To get the parsing result in the default file 'parsedEvents.md' in the same repository as eventAnalyser.py :
python3 eventAnalyser.py [SOURCE FILE]

The source file should be the TheliaEvents.php file.
You should include absolute path in the files names.
The dataArrayEvent.txt file generated by eventPreAnalyser.py must exist in the current directory.

The -hand --help options provide quick access to this description.

The script will ask the Thelia events documentation file which will be modified.