TBFramework - v0.4
\

\Script

Script est une classe abstraite qui doit être implémenté par les classes éxecutant des scripts en ligne de commande.

Summary

Methods
Properties
Constants
__construct()
executer()
No public properties found
MSG_LOG
MSG_ERREUR
MSG_AVERTISSEMENT
MSG_INFO
getScriptNom()
getScriptChemin()
getParametre()
traiterErreur()
traiterAvertissement()
traiterInfo()
formaterMsg()
afficherAvancement()
$parametres_autorises
$parametres
N/A
getMsgNiveauTxt()
chargerParametresAutorises()
chargerParametres()
traiterMessage()
$msg_niveaux_txt
$script_nom
$parametres_autorises_defaut
$parametres_cli
$avancement
$parametres_obligatoires
N/A

Constants

MSG_LOG

MSG_LOG

Niveau de message de type LOG

MSG_ERREUR

MSG_ERREUR

Niveau de message de type ERREUR

MSG_AVERTISSEMENT

MSG_AVERTISSEMENT

Niveau de message de type AVERTISSEMENT

MSG_INFO

MSG_INFO

Niveau de message de type INFORMATION

Properties

$parametres_autorises

$parametres_autorises : array

Paramêtres autorisés par le script.

le tableau est de la forme suivante :

  • clé = nom du paramêtre '-foo'
  • value = contient un nouveau tableau composé de cette façon :
    • booléen: true si le paramêtre est obligatoire
    • booléen ou var : true si le paramêtre nécessite un valeur à sa suite ou la valeur par défaut
    • string: description du contenu du paramêtre Les paramêtres optionels devraient être déclaré à la fin du tableau. Le dernier parametre du tableau peut avoir la valeur '...', il contiendra alors l'ensemble des paramêtres suivant trouvés sur la ligne de commande.

Type

array

$parametres

$parametres : array

Contient le tableau des paramètres disponible après vérification : le tableau est de la forme suivante : - clé = nom du paramêtre '-foo' - valeur = la valeur récupérée sur la ligne de commande

Type

array

$msg_niveaux_txt

$msg_niveaux_txt

Inititulé des différents types de message.

$script_nom

$script_nom : string

Le nom du script tel que passé dans la ligne de commande.

Type

string

$parametres_autorises_defaut

$parametres_autorises_defaut : array

Paramêtres par défaut disponibles pour la ligne de commande le tableau se construit de la forme suivante : - clé = nom du paramêtre '-foo' - value = contient un nouveau tableau composé de cette façon : - booléen: true si le paramêtre est obligatoire - booléen ou var : true si le paramêtre nécessite un valeur à sa suite ou la valeur par défaut - string: description du contenu du paramêtre Les paramêtres optionels devraient être déclaré à la fin du tableau.

Le dernier parametre du tableau peut avoir la valeur '...', il contiendra alors l'ensemble des paramêtres suivant trouvés sur la ligne de commande.

Type

array

$parametres_cli

$parametres_cli : array

Contient les valeurs des paramêtres récupérés de la ligne de commande : le tableau se construit de la forme suivnate : - clé = nom du paramêtre '-foo' - valeur = la valeur récupérée sur la ligne de commande

Type

array

$avancement

$avancement : array

Tableau associatif permettant de stocker l'avancement dans une boucle.

La clé est un md5 du message à afficher au démarrage de la boucle.

Type

array

$parametres_obligatoires

$parametres_obligatoires

Tableau des noms des paramètres à définir dans le fichier de config car obligatoirement nécessaire à cette classe.

Methods

__construct()

__construct( $script_nom,  $parametres_cli)

Parameters

$script_nom
$parametres_cli

executer()

executer()

getScriptNom()

getScriptNom()

getScriptChemin()

getScriptChemin( $doit_exister)

Parameters

$doit_exister

getParametre()

getParametre( $parametre)

Parameters

$parametre

traiterErreur()

traiterErreur( $message,  $tab_arguments) : \void.

Affiche un message d'erreur formaté.

Si le paramétre de verbosité (-v) vaut 1 ou plus, le message est écrit dans le fichier de log et afficher dans la console.

Parameters

$message
$tab_arguments

Returns

\void.

traiterAvertissement()

traiterAvertissement( $message,  $tab_arguments) : \void.

Affiche un message d'avertissement formaté.

Si le paramétre de verbosité (-v) vaut 1, le message est écrit dans le fichier de log. Si le paramétre de verbosité (-v) vaut 2 ou plus, le message est écrit dans le fichier de log et afficher dans la console.

Parameters

$message
$tab_arguments

Returns

\void.

traiterInfo()

traiterInfo( $message,  $tab_arguments) : \void.

Retourne un message d'information formaté.

Si le paramétre de verbosité (-v) vaut 1 ou 2 , le message est écrit dans le fichier de log. Si le paramétre de verbosité (-v) vaut 3 ou plus, le message est écrit dans le fichier de log et afficher dans la console.

Parameters

$message
$tab_arguments

Returns

\void.

formaterMsg()

formaterMsg( $message,  $tab_arguments,  $niveau) : string

Retourne un message d'information formaté.

Parameters

$message
$tab_arguments
$niveau

Returns

string —

le message d'erreur formaté.

afficherAvancement()

afficherAvancement( $message,  $depart) : void

Utiliser cette méthode dans une boucle pour afficher un message suivi du nombre de tour de boucle effectué.

Vous devrez vous même gérer le retour à la ligne à la sortie de la boucle.

Parameters

$message
$depart

getMsgNiveauTxt()

getMsgNiveauTxt( $niveau)

Parameters

$niveau

chargerParametresAutorises()

chargerParametresAutorises()

chargerParametres()

chargerParametres()

traiterMessage()

traiterMessage( $message,  $tab_arguments,  $niveau) : \void.

Retourne un message formaté en le stockant dans un fichier de log si nécessaire.

Parameters

$message
$tab_arguments
$niveau

Returns

\void.