<?xml version="1.0" encoding="utf-8"?>

<chapter xml:id="features.commandline" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">

<title>Utiliser PHP en ligne de commande</title>

<titleabbrev>Utilisation des lignes de commande</titleabbrev>

<!--Introduction: {{{-->

<section xml:id="features.commandline.introduction" annotations="chunk:false">

<title>Introduction</title>

<para>

Le but premier de &cli.sapi; est le développement

d'applications shell avec PHP. Les différences entre le &cli.sapi;

et les autres <acronym>SAPI</acronym> sont

expliquées dans ce chapitre. Il est important de mentionner que &cli;

et <acronym>CGI</acronym> sont des <acronym>SAPI</acronym> différents malgré

le fait qu'ils puissent partager la majeure partie de leurs comportements.

</para>

<para>

Le &cli.sapi; est activé par défaut en utilisant l'option

<option role="configure">--enable-cli</option>, mais il est possible de le désactiver

en utilisant l'option <option role="configure">--disable-cli</option>

lors de l'exécution de la commande <command>./configure</command>.

</para>

<para>

Le nom, l'emplacement et l'existence des binaires &cli;/<acronym>CGI</acronym>

vont dépendre de la façon dont PHP est installé sur le système. Par

défaut, en exécutant <command>make</command>, les deux binaires <acronym>CGI</acronym>

et &cli; sont compilés et nommés respectivement <filename>sapi/cgi/php-cgi</filename> et

<filename>sapi/cli/php</filename> dans le répertoire source PHP. On

remarquera que les deux se nomment <filename>php</filename>. Ce qui se passe

ensuite pendant le <command>make install</command> dépend de la ligne

de configuration. Si un module <acronym>SAPI</acronym>, apxs par exemple, a été choisi pendant la

configuration, ou que l'option <option role="configure">--disable-cgi</option> a été

activée, le &cli; est copié dans <filename>{PREFIX}/bin/php</filename> pendant

le <command>make install</command> sinon, le <acronym>CGI</acronym> sera placé ici.

Si, par exemple, <option role="configure">--with-apxs</option> figure dans la

ligne de configuration, le &cli; est copié dans <filename>{PREFIX}/bin/php</filename>

pendant le <command>make install</command>. Pour forcer l'installation du

binaire <acronym>CGI</acronym>, lancez <command>make install-cli</command>

après le <command>make install</command>. Sinon, il est aussi possible de spécifier

<option role="configure">--disable-cgi</option> dans la ligne de configuration.

</para>

<note>

<para>

Du fait que les deux options <option role="configure">--enable-cli</option> et

<option role="configure">--enable-cgi</option> sont activées par défaut, avoir simplement

<option role="configure">--enable-cli</option> dans la ligne de configuration

n'implique pas nécessairement que le CLI soit renommé en <filename>

{PREFIX}/bin/php</filename> pendant le <command>make install</command>.

</para>

</note>

<para>

Le binaire &cli; est distribué dans le dossier principal

sous le nom de <filename>php.exe</filename> sous Windows. La version

<acronym>CGI</acronym> est distribuée sous le nom de <filename>php-cgi.exe</filename>.

De plus, un fichier <filename>php-win.exe</filename> est distribué si PHP

est configuré en utilisant l'option de configuration

<option role="configure">--enable-cli-win32</option>. Ce fichier fait la

même chose que la version &cli;, sauf qu'il n'affiche rien et qu'il ne fournit

pas de console.

</para>

<note>

<title>Quel SAPI est installé ?</title>

<para>

À partir d'un terminal, lancer <command>php -v</command> indiquera si

<filename>php</filename> est en version <acronym>CGI</acronym> ou

&cli;. Il est aussi possible de consulter la fonction

<function>php_sapi_name</function> et la constante

<constant>PHP_SAPI</constant>.

</para>

</note>

<note>

<para>

Une page <literal>man</literal> de manuel Unix est disponible

en tapant <command>man php</command> dans l'interpréteur de commande.

</para>

</note>

</section>

<!--}}}-->

<!--Differences: {{{-->

<section xml:id="features.commandline.differences">

<title>Différences avec les autres <acronym>SAPI</acronym>s</title>

<para>

Les différences les plus notables entre le &cli; <acronym>SAPI</acronym> et les

<acronym>SAPI</acronym> sont :

<itemizedlist>

<listitem>

<para>

Contrairement au <acronym>CGI</acronym> <acronym>SAPI</acronym>, aucun

en-tête HTTP n'est écrit dans le résultat.

</para>

<para>

Bien que le <acronym>CGI</acronym> <acronym>SAPI</acronym> fournisse un

moyen de supprimer les en-têtes HTTP, il n'est pas possible d'activer les

en-têtes HTTP dans le &cli.sapi;.

</para>

<para>

&cli; est lancé en mode silencieux par défaut, bien que les options

<option>-q</option> et <option>--no-header</option> soient gardées

pour rester compatible avec les anciennes versions <acronym>CGI</acronym>.

</para>

<para>

Il ne change pas le répertoire courant en celui du script.

(les options <option>-C</option> et <option>--no-chdir</option> sont

gardées par souci de compatibilité)

</para>

<para>

Messages d'erreurs en texte brut (pas de formatage <acronym>HTML</acronym>).

</para>

</listitem>

<listitem>

<para>

Il y a plusieurs directives du &php.ini; qui sont redéfinies par le

&cli.sapi;, car elles n'ont pas de sens en environnement shell :

</para>

<para>

<table>

<title>Directives &php.ini; redéfinies</title>

<tgroup cols="3">

<thead>

<row>

<entry>Directive</entry>

<entry>Valeur par défaut pour &cli; <acronym>SAPI</acronym></entry>

<entry>Commentaire</entry>

</row>

</thead>

<tbody>

<row>

<entry><link linkend="ini.html-errors">html_errors</link></entry>

<entry>&false;</entry>

<entry>

Par défaut à &false;, vu qu'il peut être bien difficile de lire des messages

d'erreur sur un terminal lorsqu'ils sont noyés dans des balises <acronym>HTML</acronym>

non-interprétées.

</entry>

</row>

<row>

<entry><link linkend="ini.implicit-flush">implicit_flush</link></entry>

<entry>&true;</entry>

<entry>

Dans un terminal, il est généralement souhaitable que tout affichage en provenance de

<function>print</function>,

<function>echo</function>

et autres, soit immédiatement affiché, et non pas placé dans un

buffer quelconque. Néanmoins, il est toujours possible d'utiliser

<link linkend="ref.outcontrol">la bufferisation de sortie</link>

pour retarder un affichage, ou bien en manipuler le contenu

une dernière fois.

</entry>

</row>

<row>

<entry><link linkend="ini.max-execution-time">max_execution_time</link></entry>

<entry>0 (sans limite)</entry>

<entry>

PHP dans un terminal est susceptible d'être utilisé pour des tâches

bien plus diverses que dans des scripts web, et vu que cela

prend généralement beaucoup de temps, ce paramètre sera défini par défaut

à 0 permettant ainsi d'être illimité.

</entry>

</row>

<row>

<entry><link linkend="ini.register-argc-argv">register_argc_argv</link></entry>

<entry>&true;</entry>

<entry>

<para>

La définition à &true; de cette directive signifie que les scripts

exécutés via le <acronym>SAPI</acronym> &cli; auront toujours

accès à <emphasis>argc</emphasis> (représentant le nombre

d'arguments passés à l'application) et

<emphasis>argv</emphasis> (le tableau contenant les arguments passés).

</para>

<para>

Les variables PHP <varname>$argc</varname>

et <varname>$argv</varname> sont automatiquement définies et remplies

avec les valeurs appropriées, lors de l'utilisation du

<acronym>SAPI</acronym> &cli;. Ces valeurs peuvent également

être trouvées dans la variable <varname>$_SERVER</varname>, par exemple :

<varname>$_SERVER['argv']</varname>.

</para>

<warning>

<para>

La présence de <varname>$argv</varname> ou <varname>$_SERVER['argv']</varname>

n'est pas une indication fiable qu'un script est exécuté depuis la

ligne de commande, car ces variables peuvent être définies dans d'autres contextes

lorsque <link linkend="ini.register-argc-argv">register_argc_argv</link> est activé.

La valeur retournée par <function>php_sapi_name</function> devrait être vérifiée

à la place.

<informalexample>

<programlisting role="php">

</programlisting>

</informalexample>

</para>

</warning>

</entry>

</row>

<row>

<entry><link linkend="ini.output-buffering">output_buffering</link></entry>

<entry>&false;</entry>

<entry>

<para>

Même si cette configuration INI est codée en dur à &false;,

les fonctions relatives à

<link linkend="book.outcontrol">l'affichage du buffer</link>

sont disponibles.

</para>

</entry>

</row>

<row>

<entry><link linkend="ini.max-input-time">max_input_time</link></entry>

<entry>&false;</entry>

<entry>

<para>

Le PHP &cli; ne supporte pas GET, POST et le téléchargement de fichiers.

</para>

</entry>

</row>

</tbody>

</tgroup>

</table>

</para>

<note>

<para>

Ces directives ne peuvent pas être initialisées avec d'autres valeurs

dans le fichier &php.ini; ou par une autre méthode. C'est une limitation,

car ces valeurs par défaut s'appliquent une fois que tous les autres

fichiers de configuration ont été analysés. Cependant, ces

valeurs peuvent être modifiées durant l'exécution (ce qui n'est pas

logique pour certaines directives, comme

<link linkend="ini.register-argc-argv">register_argc_argv</link>).

</para>

</note>

<note>

<para>

Il est recommandé de définir

<link linkend="ini.ignore-user-abort">ignore_user_abort</link> pour

les scripts en ligne de commande. Voir la fonction

<function>ignore_user_abort</function> pour plus d'informations.

</para>

</note>

</listitem>

<listitem>

<para>

Pour faciliter le travail en environnement shell, plusieurs constantes

sont définies pour les <link linkend="features.commandline.io-streams">flux

I/O</link>.

</para>

</listitem>

<listitem>

<para>

Le &cli.sapi; <emphasis role="strong">ne transforme pas</emphasis>

le dossier courant en dossier d'exécution du script.

</para>

<example>

<title>

Exemple montrant la différence avec le <acronym>SAPI</acronym>

<acronym>CGI</acronym> :

</title>

<programlisting role="php">

</programlisting>

<para>

Lors de l'utilisation de la version <acronym>CGI</acronym>, l'affichage sera :

</para>

<screen>

</screen>

<para>

Cela montre clairement que PHP modifie le dossier

courant, et utilise le dossier du script exécuté.

</para>

<para>

En utilisant le &cli.sapi;, on obtient :

</para>

<screen>

</screen>

<para>

Cela donne beaucoup plus de souplesse lors de la rédaction de

scripts shell avec PHP.

</para>

</example>

<note>

<para>

Le <acronym>CGI</acronym> <acronym>SAPI</acronym> se comporte de la même façon que le

&cli.sapi;, en lui passant l'option

<option>-C</option>, lorsqu'il est invoqué en ligne de commande.

</para>

</note>

</listitem>

</itemizedlist>

</para>

</section>

<!--}}}-->

<!--Options: {{{-->

<section xml:id="features.commandline.options">

<title>Options de ligne de commande</title>

<titleabbrev>Options</titleabbrev>

<para>

La liste des options de ligne de commande fournies par PHP

est disponible à n'importe quel moment en exécutant PHP avec l'option

<option>-h</option> :

<screen>

</screen>

</para>

<para>

<table>

<title>Options de ligne de commande</title>

<tgroup cols="2">

<thead>

<row>

<entry>Option</entry>

<entry>Option longue</entry>

<entry>Description</entry>

</row>

</thead>

<tbody>

<row>

<entry>-a</entry>

<entry>--interactive</entry>

<entry>

<para>

Lance PHP de façon interactive. Pour plus d'informations, se reporter

à la documentation concernant le <link

linkend="features.commandline.interactive">shell interactif</link>.

</para>

</entry>

</row>

<row>

<entry>-b</entry>

<entry>--bindpath</entry>

<entry>

<para>

Lie le chemin pour les externes, en mode serveur FASTCGI

(<acronym>CGI</acronym> uniquement).

</para>

</entry>

</row>

<row>

<entry>-C</entry>

<entry>--no-chdir</entry>

<entry>

<para>

Ne pas aller dans le dossier du script (<acronym>CGI</acronym> uniquement).

</para>

</entry>

</row>

<row>

<entry>-q</entry>

<entry>--no-header</entry>

<entry>

<para>

Mode silencieux. Supprime la sortie des en-têtes <acronym>HTTP</acronym>

(<acronym>CGI</acronym> uniquement).

</para>

</entry>

</row>

<row>

<entry>-T</entry>

<entry>--timing</entry>

<entry>

<para>

Mesure le temps d'exécution du script, répété <varname>count</varname>

fois (<acronym>CGI</acronym> uniquement).

</para>

</entry>

</row>

<row>

<entry>-c</entry>

<entry>--php-ini</entry>

<entry>

<para>

Spécifie le nom du dossier dans lequel se trouve le fichier &php.ini;,

ou encore spécifie un fichier de configuration (<literal>INI</literal>)

directement (qui ne s'appelle pas obligatoirement &php.ini;) :

</para>

<para>

<informalexample>

<screen>

</screen>

</informalexample>

</para>

<para>

Si cette option n'est pas spécifiée, &php.ini; est recherché dans

les <link linkend="configuration.file">endroits par défaut</link>.

</para>

</entry>

</row>

<row>

<entry>-n</entry>

<entry>--no-php-ini</entry>

<entry>

<para>

Ignore totalement &php.ini;.

</para>

</entry>

</row>

<row>

<entry>-d</entry>

<entry>--define</entry>

<entry>

<para>

Définit une valeur personnalisée pour n'importe quelle directive

de configuration du fichier &php.ini;. La syntaxe est :

<screen>

</screen>

</para>

<para>

<example>

<title>Exemple d'utilisation de <literal>-d</literal> pour définir une directive INI</title>

<screen>

</screen>

</example>

</para>

</entry>

</row>

<row>

<entry>-e</entry>

<entry>--profile-info</entry>

<entry>

<para>

Génère des informations étendues pour le profilage et le débogage.

</para>

</entry>

</row>

<row>

<entry>-f</entry>

<entry>--file</entry>

<entry>

<para>

Analyse et exécute le fichier spécifié. L'option <option>-f</option>

est facultative, et peut être omise. Le seul nom du fichier

est suffisant.

</para>

</entry>

</row>

<row>

<entry>-h et -?</entry>

<entry>--help et --usage</entry>

<entry>

Affiche des informations sur la liste courante des options de la

ligne de commande, ainsi que leur description.

</entry>

</row>

<row>

<entry>-i</entry>

<entry>--info</entry>

<entry>

Appelle la fonction <function>phpinfo</function>, et

affiche le résultat. Si PHP ne fonctionne pas

correctement, il est recommandé d'utiliser la commande <command>php -i</command>

et de voir s'il n'y a pas d'erreurs affichées avant ou après la

table d'information. N'oubliez pas que le résultat de cette

option, lors de l'utilisation du mode <acronym>CGI</acronym>, est au format

<acronym>HTML</acronym>, et donc de taille conséquente.

</entry>

</row>

<row>

<entry>-l</entry>

<entry>--syntax-check</entry>

<entry>

<para>

Vérifie la syntaxe mais n'exécute pas le code PHP donné.

L'entrée provenant de l'entrée standard sera traitée si aucun nom de fichier n'est spécifié,

sinon chaque fichier spécifié sera vérifié.

En cas de réussite, le message

<literal>No syntax errors detected in &lt;filename&gt;</literal>

(Littéralement, aucune erreur de syntaxe n'a été détectée dans le fichier)

est affiché sur la sortie standard.

En cas d'erreur, le message <literal>Errors parsing &lt;filename&gt;</literal>

(Littéralement, erreur d'analyse dans le fichier filename)

est affiché, en plus des messages d'erreurs détectés par l'analyseur

lui-même.

Si des erreurs sont trouvées dans les fichiers spécifiés (ou l'entrée standard),

le code de retour du shell est défini à <literal>-1</literal>, sinon le

code de retour du shell est défini à <literal>0</literal>.

</para>

<para>

Cette option ne détecte pas les erreurs fatales (par exemple les

fonctions non définies) qui nécessitent l'exécution du code.

</para>

<note>

<para>

Antérieur à PHP 8.3.0, il n'était possible de spécifier qu'un seul nom de fichier

à vérifier.

</para>

</note>

<note>

<para>

Cette option ne fonctionne pas avec l'option <option>-r</option>.

</para>

</note>

</entry>

</row>

<row>

<entry>-m</entry>

<entry>--modules</entry>

<entry>

<para>

<example>

<title>Affichage des modules internes (et chargés) de PHP et Zend</title>

<screen>

</screen>

</example>

</para>

</entry>

</row>

<row>

<entry>-r</entry>

<entry>--run</entry>

<entry>

<para>

Permet l'exécution de PHP directement dans la ligne de commande.

Les balises de PHP (<literal>&lt;?php</literal> et <literal>?&gt;</literal>)

<emphasis role="strong">ne sont pas</emphasis> nécessaires, et causeront

une erreur d'analyse si elles sont présentes.

</para>

<note>

<para>

Une attention toute particulière doit être portée lors de l'utilisation de cette option

de PHP, pour qu'il n'y ait pas de collision avec

les substitutions de variables en ligne de commande, réalisées par le

shell.

</para>

<example>

<title>Erreur de syntaxe lors de l'utilisation de doubles guillemets</title>

<screen>

</screen>

</example>

<para>

Le problème ici est que le shell (sh/bash) effectue une substitution

de variables, même avec les guillemets doubles <literal>"</literal>.

Puisque la variable <varname>$foo</varname> n'est probablement pas

définie dans le shell, elle est remplacée par rien, ce qui fait

que le code passé à PHP pour l'exécution est :

</para>

<informalexample>

<screen>

</screen>

</informalexample>

<para>

La solution de ce problème est d'utiliser les guillemets simples

<literal>'</literal>. Les variables de ces chaînes ne seront pas

substituées par leurs valeurs par le shell.

</para>

<example>

<title>Utilisation de guillemets simples pour éviter une substitution

par le shell</title>

<screen>

</screen>

</example>

<para>

Si un shell différent de sh/bash est utilisé, d'autres problèmes pourront

être rencontrés - si approprié, un rapport de bogues pourra être ouvert

à <link xlink:href="&url.php.bugs;">&url.php.bugs;</link>.

Il est toujours très facile d'avoir des problèmes en essayant

d'inclure des variables shell dans le code, ou d'utiliser les antislashs

pour la protection. Considérez-le comme un avertissement !

</para>

</note>

<note>

<para>

<option>-r</option> est disponible avec le &cli.sapi;

mais pas avec le <acronym>SAPI</acronym> <emphasis>CGI</emphasis>.

</para>

</note>

<note>

<para>

Cette option est seulement utilisée pour des choses simples. Ainsi,

quelques directives de configuration (par exemple <link

linkend="ini.auto-prepend-file">auto_prepend_file</link> et <link

linkend="ini.auto-append-file">auto_append_file</link>) sont ignorées

dans ce mode.

</para>

</note>

</entry>

</row>

<row>

<entry>-B</entry>

<entry>--process-begin</entry>

<entry>

<para>

Code PHP à exécuter avant le traitement de stdin.

</para>

</entry>

</row>

<row>

<entry>-R</entry>

<entry>--process-code</entry>

<entry>

<para>

Code PHP à exécuter pour chaque ligne en entrée.

</para>

<para>

Il y a deux variables spéciales de disponibles dans ce mode :

<varname>$argn</varname> et <varname>$argi</varname>.

<varname>$argn</varname> doit contenir la ligne PHP

traitée à ce moment donné, tandis que

<varname>$argi</varname> doit contenir le numéro de la ligne.

</para>

</entry>

</row>

<row>

<entry>-F</entry>

<entry>--process-file</entry>

<entry>

<para>

Fichier PHP à exécuter pour chaque ligne en entrée.

</para>

</entry>

</row>

<row>

<entry>-E</entry>

<entry>--process-end</entry>

<entry>

<para>

Code PHP à exécuter après avoir effectué l'entrée.

</para>

<para>

<example>

<title>Exemple d'utilisation des options <option>-B</option>, <option>-R</option>

et <option>-E</option> pour compter le nombre de lignes d'un projet.

</title>

<screen>

</screen>

</example>

</para>

</entry>

</row>

<row>

<entry>-S</entry>

<entry>--server</entry>

<entry>

<para>

Démarre le <link linkend="features.commandline.webserver">serveur

web interne</link>.

</para>

</entry>

</row>

<row>

<entry>-t</entry>

<entry>--docroot</entry>

<entry>

Spécifie la racine des documents pour le <link

linkend="features.commandline.webserver">serveur web interne</link>.

</entry>

</row>

<row>

<entry>-s</entry>

<entry>--syntax-highlight et --syntax-highlighting</entry>

<entry>

<para>

Affiche le code avec la colorisation syntaxique.

</para>

<para>

Cette option utilise le mécanisme interne pour analyser le fichier,

et écrire au format HTML une version colorisée du code source.

Il est à noter que cette option ne fait que générer un bloc HTML, avec les balises HTML

<literal>&lt;code&gt; [...] &lt;/code&gt;</literal>, sans en-têtes HTML.

</para>

<note>

<para>

Cette option ne fonctionne pas avec l'option <option>-r</option>.

</para>

</note>

</entry>

</row>

<row>

<entry>-v</entry>

<entry>--version</entry>

<entry>

<para><example>

<title>Utilisation de l'option <option>-v</option> pour récupérer le nom du <acronym>SAPI</acronym>

ainsi que la version de PHP et de Zend</title>

<screen>

</screen>

</example>

</para>

</entry>

</row>

<row>

<entry>-w</entry>

<entry>--strip</entry>

<entry>

<para>

Affiche la source sans les commentaires ni les espaces.

</para>

<note>

<para>

Cette option ne fonctionne pas avec l'option <option>-r</option>.

</para>

</note>

</entry>

</row>

<row>

<entry>-z</entry>

<entry>--zend-extension</entry>

<entry>

<para>

Charge une extension Zend. Si et seulement si un fichier est fourni, PHP

essaie de charger cette extension dans le dossier courant par défaut

des bibliothèques sur le système (généralement spécifié avec

<filename>/etc/ld.so.conf</filename> sous Linux par exemple). Passer un nom de

fichier avec le chemin complet fera que PHP utilisera ce fichier,

sans recherche dans les dossiers classiques. Un chemin de dossier

relatif, incluant les informations sur le dossier, indiquera à PHP qu'il doit

chercher les extensions uniquement dans ce dossier.

</para>

</entry>

</row>

<row>

<entry></entry>

<entry>--ini</entry>

<entry>

<para>

Affiche les noms des fichiers de configuration et des dossiers analysés.

<example>

<title>Exemple avec <literal>--ini</literal></title>

<programlisting role="shell">

</programlisting>

</example>

</para>

</entry>

</row>

<row>

<entry>--rf</entry>

<entry>--rfunction</entry>

<entry>

<para>

Affiche des informations sur la fonction donnée ou la méthode

d'une classe (c.-à-d. nombre et nom des paramètres).

</para>

<para>

Cette option n'est disponible que si PHP a été compilé avec le support

<link linkend="book.reflection">Reflection</link>.

</para>

<para>

<example>

<title>Exemple avec <literal>--rf</literal></title>

<programlisting role="shell">

</programlisting>

</example>

</para>

</entry>

</row>

<row>

<entry>--rc</entry>

<entry>--rclass</entry>

<entry>

<para>

Affiche des informations sur la classe donnée (liste des constantes,

propriétés et méthodes).

</para>

<para>

Cette option n'est disponible que si PHP a été compilé avec le support

<link linkend="book.reflection">Reflection</link>.

</para>

<para>

<example>

<title>Exemple avec <literal>--rc</literal></title>

<programlisting role="shell">

</programlisting>

</example>

</para>

</entry>

</row>

<row>

<entry>--re</entry>

<entry>--rextension</entry>

<entry>

<para>

Affiche les informations sur l'extension donnée (liste les options du

&php.ini;, les fonctions définies, les constantes et les classes).

</para>

<para>

Cette option n'est disponible que si PHP a été compilé avec le support

<link linkend="book.reflection">Reflection</link>.

</para>

<para>

<example>

<title>Exemple avec <literal>--re</literal></title>

<programlisting role="shell">

</programlisting>

</example>

</para>

</entry>