argv.xml

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

<refentry role="variable" xml:id="reserved.variables.argv" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>$argv</refname>
  <refpurpose>Array of arguments passed to script</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <para>
   Contains an <type>array</type> of all the arguments passed to the script when running
   from the <link linkend="features.commandline">command line</link>.
  </para>
  <note>
   <simpara>
    The first argument <varname>$argv[0]</varname> is always the name that was
    used to run the script.
   </simpara>
  </note>
  <note>
   <simpara>
    This variable is not available when <link linkend="ini.register-argc-argv">register_argc_argv</link>
    is disabled.
   </simpara>
  </note>
  <warning>
   <simpara>
    To test if a script is being run from the command
    line, <function>php_sapi_name</function> should be used
    instead of checking whether <varname>$argv</varname> or
    <varname>$_SERVER['argv']</varname> is set.
   </simpara>
  </warning>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example xml:id="variable.argv.basic">
    <title><varname>$argv</varname> example</title>
    <programlisting role="php">
<![CDATA[
<?php
var_dump($argv);
?>
]]>
    </programlisting>
    <simpara>
     When executing the example with: php script.php arg1 arg2 arg3
    </simpara>
    &example.outputs.similar;
    <screen>
<![CDATA[
array(4) {
  [0]=>
  string(10) "script.php"
  [1]=>
  string(4) "arg1"
  [2]=>
  string(4) "arg2"
  [3]=>
  string(4) "arg3"
}
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    This is also available as <varname>$_SERVER['argv']</varname>. 
   </para>
  </note>
 </refsect1>
  
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>getopt</function></member>
    <member><link linkend="reserved.variables.argc"><varname>$argc</varname></link></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>
 
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->