Utilisation de POptimizer
Table des matières
POptimizer est écrit en Java, il nécessite d'avoir une machine virtuelle Java installée sur sa machine pour pouvoir l'exécuter. Si ce n'est pas votre cas, vous pouvez télécharger Java ici ou si vous êtes sur Linux l'installer avec votre gestionnaire de paquets comme décrit ici pour Ubuntu.
POptimizer s'exécute en ligne de commande. Il se lance en tapant la commande suivant en invite de commande. La commande est évidemment à adapter en fonction de là où vous vous trouvez dans votre arborescence de fichiers ainsi que du nom de l'exécutable (nommé poptimizer.jar lorsque vous le téléchargez).
L'option
Exemple : le code suivant optimisera tous les fichiers PHP du dossier dossiersource et recréera la même arborescence dans le dossier dossiercible.
L'option
Exemple : le code suivant optimisera tous les fichiers PHP du dossier dossiersource et recréera la même arborescence dans le dossier dossiercible.
Par défaut, POptimizer va optimiser l'ensemble des fichiers contenus dans le répertoire source. Cependant, il se peut qu'il y ait des fichiers ou des répertoires que vous ne vouliez pas optimiser. Pour cela, l'option
Exemple : le code suivant optimisera tous les fichiers PHP du dossier dossiersource sauf le fichier dossiersource/fichier.php et l'ensemble du contenu du dossier dossiersource/sousdossier. POptimizer recréera la même arborescence dans le dossier dossiercible.
Pour l'instant POptimizer se décompose en deux modules, un module qui retire les commentaires et un autre qui enlève tous les espaces inutiles (indentation et autour des opérateurs du langage). Par défaut, les deux modules sont appliqués sur les fichiers à optimiser, mais il est possible de choisir manuellement les modules à appliquer grâce à l'option
Exemples :
Le code suivant retirera uniquement les espaces des fichiers à optimiser.
Le code suivant retirera uniquement les commentaires des fichiers à optimiser.
Le code suivant fera une optimisation totale sur les fichiers à optimiser (équivalent à la commande sans l'option
Les fichiers source peuvent être encodés en différents jeux de caractères. Le code est généralement écrit en anglais donc les problèmes d'encodage sont limités mais il n'est pas rare que des caractères spéciaux soient présents dans les fichiers.
POptimizer est capable de lire et d'écrire les fichiers dans différents jeux de caractères grâce aux options
Les jeux de caractères disponibles sont les suivants :
Exemple : on souhaite optimiser un répertoire dont les fichiers sont encodés en UTF-8 et on souhaite l'exporter en ISO-8859-1.
Il est à noter qu'il est possible de préciser seulement un des deux encodages. Dans le cas où on ne précise pas, UTF-8 est utilisé par défaut.
L'option
L'option
Lancer POptimizer
POptimizer est écrit en Java, il nécessite d'avoir une machine virtuelle Java installée sur sa machine pour pouvoir l'exécuter. Si ce n'est pas votre cas, vous pouvez télécharger Java ici ou si vous êtes sur Linux l'installer avec votre gestionnaire de paquets comme décrit ici pour Ubuntu.
POptimizer s'exécute en ligne de commande. Il se lance en tapant la commande suivant en invite de commande. La commande est évidemment à adapter en fonction de là où vous vous trouvez dans votre arborescence de fichiers ainsi que du nom de l'exécutable (nommé poptimizer.jar lorsque vous le téléchargez).
Code BASH :
java -jar poptimizer.jarLes options
Fichiers à optimiser
L'option
-i permet de déterminer quel est le dossier à optimiser, elle est obligatoire. Il sera parcouru récursivement et tous ses enfants seront également optimisés à l'exception de ceux qui ont été exclus (voir l'option -e) et des fichiers qui ne sont pas des sources PHP qui eux seront copiés. L'arborescence de sortie sera la même que l'arborescence d'entrée.Exemple : le code suivant optimisera tous les fichiers PHP du dossier dossiersource et recréera la même arborescence dans le dossier dossiercible.
Code BASH :
java -jar poptimizer.jar -i dossiersource -o dossiercible
Répertoire cible
L'option
-o permet de déterminer quelle est le répertoire cible de l'optimisation, c'est-à-dire dans quel répertoire sera reconstituée l'arborescence passée en entrée. Si le répertoire cible indiqué n'existe pas, il sera créé.Exemple : le code suivant optimisera tous les fichiers PHP du dossier dossiersource et recréera la même arborescence dans le dossier dossiercible.
Code BASH :
java -jar poptimizer.jar -i dossiersource -o dossiercible
Fichiers/dossiers à exclure
Par défaut, POptimizer va optimiser l'ensemble des fichiers contenus dans le répertoire source. Cependant, il se peut qu'il y ait des fichiers ou des répertoires que vous ne vouliez pas optimiser. Pour cela, l'option
-e permet d'exclure certains chemins de l'optimisation. Ces fichiers qui seront ignorés seront tout de même copiés pour conserver l'arborescence originale.Exemple : le code suivant optimisera tous les fichiers PHP du dossier dossiersource sauf le fichier dossiersource/fichier.php et l'ensemble du contenu du dossier dossiersource/sousdossier. POptimizer recréera la même arborescence dans le dossier dossiercible.
Code BASH :
java -jar poptimizer.jar -i dossiersource -o dossiercible -e dossiersource/fichier.php dossiersource/sousdossier
Choix des modules d'optimisation
Pour l'instant POptimizer se décompose en deux modules, un module qui retire les commentaires et un autre qui enlève tous les espaces inutiles (indentation et autour des opérateurs du langage). Par défaut, les deux modules sont appliqués sur les fichiers à optimiser, mais il est possible de choisir manuellement les modules à appliquer grâce à l'option
-m suivie de la liste des modules à appliquer. Les modules disponibles sont les suivants :comments
: ce module retire tous les commentairesspaces
: ce module retire tous les espaces inutilesall
: sélectionne tous les modules (par défaut)
Exemples :
Le code suivant retirera uniquement les espaces des fichiers à optimiser.
Code BASH :
java -jar poptimizer.jar -i dossiersource -o dossiercible -m spaces
Le code suivant retirera uniquement les commentaires des fichiers à optimiser.
Code BASH :
java -jar poptimizer.jar -i dossiersource -o dossiercible -m comments
Le code suivant fera une optimisation totale sur les fichiers à optimiser (équivalent à la commande sans l'option
-m).Code BASH :
java -jar poptimizer.jar -i dossiersource -o dossiercible -m all
Encodage des fichiers
Les fichiers source peuvent être encodés en différents jeux de caractères. Le code est généralement écrit en anglais donc les problèmes d'encodage sont limités mais il n'est pas rare que des caractères spéciaux soient présents dans les fichiers.
POptimizer est capable de lire et d'écrire les fichiers dans différents jeux de caractères grâce aux options
-ics et -ocs pour les encodages respectivement en entrée et en sortie (input charset et output charset).Les jeux de caractères disponibles sont les suivants :
- UTF-8 (utilisé par défaut par POptimizer si on ne le précise pas, ce jeu de caractère est généralement par défaut sur Linux)
- UTF-16 (assez rarement utilisé)
- ISO-8859-1 (encodage européen, par défaut sur Windows et très utilisé sur les applications Web écrites en PHP car le support d'UTF-8 n'est pas natif dans PHP 5)
- US-ASCII (rarement utilisé)
Exemple : on souhaite optimiser un répertoire dont les fichiers sont encodés en UTF-8 et on souhaite l'exporter en ISO-8859-1.
Code BASH :
java -jar poptimizer.jar -i dossiersource -o dossiercible -ics UTF-8 -ocs ISO-8859-1
Il est à noter qu'il est possible de préciser seulement un des deux encodages. Dans le cas où on ne précise pas, UTF-8 est utilisé par défaut.
Autres
L'option
-h permet d'obtenir de l'aide sur la commande. S'affiche alors un résumé de cette page de documentation.L'option
-v permet d'obtenir la version de POptimizer que vous utilisez.