php-uname.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.php-uname" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>php_uname</refname>
  <refpurpose>Returns information about the operating system PHP is running on</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>php_uname</methodname>
   <methodparam choice="opt"><type>string</type><parameter>mode</parameter><initializer>"a"</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>php_uname</function> returns a description of the operating
   system PHP is running on.  This is the same string you see at the very
   top of the <function>phpinfo</function> output.  For the name of just
   the operating system, consider using the <constant>PHP_OS</constant>
   constant, but keep in mind this constant will contain the operating
   system PHP was <emphasis>built</emphasis> on.
  </para>
  <para>
   On some older UNIX platforms, it may not be able to determine the
   current OS information in which case it will revert to displaying
   the OS PHP was built on.  This will only happen if your uname() 
   library call either doesn't exist or doesn't work.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>mode</parameter></term>
     <listitem>
      <para>
       <parameter>mode</parameter> is a single character that defines what
       information is returned:
       <itemizedlist>
        <listitem>
         <para>
          <literal>'a'</literal>: This is the default. Returns the same
          information as the individual modes
          <simplelist type="inline">
           <member><literal>'s'</literal></member>
           <member><literal>'n'</literal></member>
           <member><literal>'r'</literal></member>
           <member><literal>'v'</literal></member>
           <member><literal>'m'</literal></member>
          </simplelist>
          separated by spaces.
         </para>
        </listitem>
        <listitem>
         <simpara>
          <literal>'s'</literal>: Operating system name. eg.
           <literal>FreeBSD</literal>.
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <literal>'n'</literal>: Host name. eg. 
          <literal>localhost.example.com</literal>.
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <literal>'r'</literal>: Release name. eg. 
          <literal>5.1.2-RELEASE</literal>.
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <literal>'v'</literal>: Version information. Varies a lot between
          operating systems.
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <literal>'m'</literal>: Machine type. eg. <literal>i386</literal>.
         </simpara>
        </listitem>
       </itemizedlist>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the description, as a string.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.4.0</entry>
      <entry>
       Throws a <classname>ValueError</classname> when an invalid
       <parameter>mode</parameter> is specified.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Some <function>php_uname</function> examples</title>
    <programlisting role="php">
<![CDATA[
<?php
echo php_uname();
echo PHP_OS;

/* Some possible outputs:
Linux localhost 2.4.21-0.13mdk #1 Fri Mar 14 15:08:06 EST 2003 i686
Linux

FreeBSD localhost 3.2-RELEASE #15: Mon Dec 17 08:46:02 GMT 2001
FreeBSD

Windows NT XN1 5.1 build 2600
WINNT
*/

if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
    echo 'This is a server using Windows!';
} else {
    echo 'This is a server not using Windows!';
}

?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   There are also some related <link linkend="language.constants.predefined">
   Predefined PHP constants</link> that may come in handy, for example:
   <example>
    <title>A few OS related constant examples</title>
    <programlisting role="php">
<![CDATA[
<?php
// *nix
echo DIRECTORY_SEPARATOR; // /
echo PHP_SHLIB_SUFFIX;    // so
echo PATH_SEPARATOR;      // :

// Win*
echo DIRECTORY_SEPARATOR; // \
echo PHP_SHLIB_SUFFIX;    // dll
echo PATH_SEPARATOR;      // ;
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>phpversion</function></member>
    <member><function>php_sapi_name</function></member>
    <member><function>phpinfo</function></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
-->