File: php-uname.xml

package info (click to toggle)
php-doc 20061001-1
  • links: PTS
  • area: non-free
  • in suites: etch, etch-m68k
  • size: 45,764 kB
  • ctags: 1,611
  • sloc: xml: 502,485; php: 7,645; cpp: 500; makefile: 297; perl: 161; sh: 141; awk: 28
file content (148 lines) | stat: -rw-r--r-- 4,070 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.11 $ -->
<!-- splitted from ./en/functions/info.xml, last change in rev 1.7 -->
  <refentry id="function.php-uname">
   <refnamediv>
    <refname>php_uname</refname>
    <refpurpose>
     Returns information about the operating system PHP is running on
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>string</type><methodname>php_uname</methodname>
      <methodparam choice="opt"><type>string</type><parameter>mode</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>php_uname</function> returns a description of the operating
     system PHP is running on. For the name of just the operating system,
     consider using the <constant>PHP_OS</constant> constant, but be
     reminded this constant will contain the operating system PHP was
     <emphasis>built</emphasis> on.
    </para>
    <para>
     On Unix, the output reverts to displaying the operating system
     information PHP was built on if it cannot determine the currently
     running OS.
    </para>
    <para>
     <parameter>mode</parameter> is a single character that defines what
     information is returned:
     <itemizedlist>
      <listitem>
       <simpara>
        <literal>'a'</literal>: This is the default. Contains all modes in the sequence <literal>"s n r v m"</literal>.
       </simpara>
      </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>
    <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:
    </para>
    <para>
     <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>
    <para>
     See also <function>phpversion</function>, 
     <function>php_sapi_name</function>, and 
     <function>phpinfo</function>.
    </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:"../../../../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
-->