Class Script

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

Abstract
Package: Framework
Category: PHP 5.2
Copyright: Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)
License: Licence GNU-GPL-v3
License: Licence CECILL-v2
Author: Jean-Pascal MILCENT <jpm@tela-botanica.org>
Author: Delphine CAUQUIL <delphine@tela-botanica.org>
Version: $Id: Script.php 299 2011-01-18 14:03:46Z jpm $
Since: 0.3
Link: /doc/framework/
Located at Script.php

Methods summary
`public`	# `__construct( mixed $script_nom, mixed $parametres_cli )`
`protected`	# `getScriptNom( )`
`protected`	# `getScriptChemin( mixed $doit_exister = true )`
`protected`	# `getParametre( mixed $parametre )`
`abstract public`	# `executer( )`
`protected void.`	# `traiterErreur( string $message, array $tab_arguments = array() )` 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. 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` `string` le message d'erreur avec des %s. `$tab_arguments` `array` le tableau des paramêtres à insérer dans le message d'erreur. Returns `void.`
`protected void.`	# `traiterAvertissement( string $message, array $tab_arguments = array() )` 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. 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` `string` le message d'erreur avec des %s. `$tab_arguments` `array` le tableau des paramêtres à insérer dans le message d'erreur. Returns `void.`
`protected void.`	# `traiterInfo( string $message, array $tab_arguments = array() )` 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. 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` `string` le message d'information avec des %s. `$tab_arguments` `array` le tableau des paramêtres à insérer dans le message d'erreur. Returns `void.`
`protected string`	# `formaterMsg( string $message, array $tab_arguments = array(), mixed $niveau = null )` Retourne un message d'information formaté. Retourne un message d'information formaté. Parameters `$message` `string` le message d'information avec des %s. `$tab_arguments` `array` le tableau des paramêtres à insérer dans le message d'erreur. `$niveau` Returns `string` le message d'erreur formaté.
`protected`	# `afficherAvancement( string $message, integer $depart = 0 )` 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. 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` `string` le message d'information. `$depart` `integer` le nombre de départ à afficher. Returns le message est affiché dans la console.

Constants summary
`integer`	`MSG_LOG`	`0`	# Niveau de message de type LOG Niveau de message de type LOG
`integer`	`MSG_ERREUR`	`1`	# Niveau de message de type ERREUR Niveau de message de type ERREUR
`integer`	`MSG_AVERTISSEMENT`	`2`	# Niveau de message de type AVERTISSEMENT Niveau de message de type AVERTISSEMENT
`integer`	`MSG_INFO`	`3`	# Niveau de message de type INFORMATION Niveau de message de type INFORMATION

Properties summary
`protected array`	`$parametres_autorises`	`null`	# 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. 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.
`protected array`	`$parametres`	`null`	# 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 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

Packages

Classes

Class Script

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns