Instructions du Mod

Les instructions présentes dans le Mod sont définies par une syntaxe spécifique et indique les actions à effectuer et comment, comme la recherche de texte, son remplacement, la copie de fichier, etc...


Chaque instruction doit être écrite en majuscule, comprise entre crochés, et avec un seul espace avant et après.


#

#-----[ INSTRUCTION ]---------------------------------------------

#


Les instructions possibles sont décrites plus loin dans ce document.

COPY

L'instruction COPY indique qufil y a des fichiers à copier. Plusieurs syntaxes sont possibles, l'ordre des fichiers étant toujours la source puis la destination.

Une instruction peut contenir plusieurs fichiers à copier, chacun sur une ligne distincte.

Le chemin du fichier source est relatif à l'emplacement du fichier texte du Mod, le chemin de destination se réfère à la racine de Phenix. Le fichier de destination peut quand à lui ne pas être indiqué, le nom du fichier source étant alors repris.

Exemple :

#

#-----[ COPY ]---------------------------------------------

#


  copy scinder.gif to image/scinder.gif

  fr_mod-scission.php ---> lang/mods/fr_mod-scission.php

  en_mod-scission.php ---> lang/mods/

SQL

L'instruction SQL indique qufune requête doit être exécutée. La syntaxe étant celle de MySQL, la ligne doit se terminé par un point-virgule.

Plusieurs requêtes sont possibles à l'intérieur d'une même instruction, si elle commence chacune sur une nouvelle ligne.

Une particularité est que les tables de Phenix possède un préfix paramétrable lors de l'instillation, les requêtes doivent donc en tenir compte avec la variable ${prefix}


Exemple :

#

#-----[ SQL ]---------------------------------------------

#


  INSERT INTO ${prefix}configuration VALUES (‘’, ‘’, 0);

  ALTER TABLE ${prefix}utilisateur ADD util_subst_id SMALLINT( 5 ) NOT NULL;

DIY INSTRUCTIONS

Une instruction DIY signifie « A faire vous-même » (Do It Yourself). Elle est en général utilisée pour donner des informations complémentaires sur le Mod, son installation, ou son utilisation. Elle peut être utilisée également pour demander à l'utilisateur d'effectuer des actions que les instructions actuelles ne permettent pas.

Cette instruction peut contenir autant de lignes nécessaires, y compris des lignes vierges.

Exemple :

#

#-----[ DIY INSTRUCTIONS ]---------------------------------------------

#


Pour activer le mod, une fois l'installation terminée, vous devez vous rendre sur la page d'administration, dans le menu options générales.

OPEN

L'instruction OPEN sert à ouvrir un fichier afin de modifier son contenu. Un seul nom de fichier doit être fourni, son chemin devant être relatif à la racine de Phenix et comportait uniquement des slashs (/) et non des antislashs (\).

Cette instruction est obligatoire avant toute instruction FIND.

Exemple :

#

#-----[ OPEN ]---------------------------------------------

#


  agenda_hebdomadaire.php


#

#-----[ OPEN ]---------------------------------------------

#


  lang/fr.php

FIND

Une instruction FIND est utilisée pour rechercher une portion de code dans un fichier afin de modifier ou ajouter du code autour de cet emplacement.

La recherche est effectuée de manière exacte et non partielle, c'est-à-dire que toute divergence dans le code recherché n'est permise.

Dans certains cas, il peut être nécessaire d'utiliser l'instruction FIND BEGINNING WITH décrit plus loin.

Exemple :

#

#-----[ FIND ]---------------------------------------------

#


              if ($enr['age_ape_id']!=1) {

AFTER, ADD

L'instruction AFTER, ADD indique que le texte qui suit doit être ajouté après la dernière ligne de code de l'instruction FIND précédente.

Une instruction FIND est donc obligatoire juste avant.

Exemple :

#

#-----[ AFTER, ADD ]---------------------------------------------

#


  // MOD Scission de note

  if ($enr['age_mere_id'])

    $sOption .= "&nbsp;<A href=\"javascript: scindeOcc('".$enr['age_id']."'></A> ";

  // Fin MOD Scission de note

BEFORE, ADD

Lfinstruction BEFORE, ADD sert à ajouter du code juste avant la première ligne trouvée par l'instruction FIND qui précède.

Une instruction FIND est par conséquent obligatoire juste avant.

Exemple :

#

#-----[ BEFORE, ADD ]---------------------------------------------

#


  // MOD Scission de note

  elseif ($ztAction == "DIVIDE" && $idAge) {

    // Recuperation des infos sur la note mere et la fin des occurences

REPLACE WITH

Une instruction REPLACE WITH permet de remplacer l'intégralité du code trouvé par l'instruction FIND qui précède. Le code de remplacement pouvant comporter plus ou moins de ligne que le code recherché.

Cette instruction doit impérativement suivre une instruction FIND

Exemple :

#

#-----[ REPLACE WITH ]---------------------------------------------

#


            if ($enr['age_ape_id']!=1 && $enr['age_ape_id']!=2) {

IN-LINE FIND

L'instruction IN-LINE FIND est utilisée pour rechercher la position d'une élément dans une ligne afin de modifier ou d'ajouter du code à cet emplacement.

Une instruction FIND est nécessaire avant celle-ci.

Cette instruction devrait être utilisée en conjonction avec FIND BEGINNING WITH pour améliorer l'interaction entre les Mods.

Exemple :

#

#-----[ IN-LINE FIND ]---------------------------------------------

#


$enr['age_ape_id']!=1


IN-LINE AFTER, ADD

L'instruction IN-LINE AFTER, ADD sert à ajouter une portion de code après le dernier caractère de la recherche IN-LINE FIND. Cela permet d'éviter le remplacement de l'intégralité d'une ligne qui pourrait s'avérer incohérent avec d'autre Mods.

Une instruction IN-LINE FIND doit précéder cette instruction.

Exemple :

#

#-----[ IN-LINE AFTER, ADD ]---------------------------------------------

#


&& $enr['age_ape_id']!=2

IN-LINE REPLACE WITH

L'instruction IN-LINE REPLACE WITH est utilisée pour remplacer une portion de code trouvé par l'instruction IN-LINE FIND.

Cette instruction doit être précédée dfune instruction IN-LINE FIND.

Exemple :

#

#-----[ IN-LINE REPLACE WITH ]---------------------------------------------

#


$enr['age_ape_id']!=1 && $enr['age_ape_id']!=2

FIND BEGINNING WITH

Cette instruction FIND BEGINNING WITH permet comme l'instruction FIND de rechercher du code mais cette fois cfest le début des lignes qui est recherché et non l'intégralité.

Dans certains cas, il est préférable dfutiliser cette instruction, notamment pour rendre compatible plusieurs Mods entre eux, ou bien permettre au Mod de sfinstaller sur plusieurs versions de Phenix.

Exemple :

#

#-----[ FIND BEGINNING WITH ]---------------------------------------------

#


  if ($enr['age_ape_id']

SAVE/CLOSE ALL FILES

Un fichier Mod doit toujours se terminer par une instruction SAVE/CLOSE ALL FILES pour garantir que le fichier nfa pas été tronqué lors du téléchargement, suivie de EoM qui signifie «Fin du Mod» (End of Mod).

#

#-----[ SAVE/CLOSE ALL FILES ]---------------------------------------------

#


# EoM

Copyright © 2008 - Stéphane Teil

This help file has been generated by the freeware version of HelpNDoc