<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.72 $ -->
 <reference id="ref.misc">
  <title>Miscellaneous functions</title>
  <titleabbrev>Misc.</titleabbrev>

  <partintro>
   <para>
    These functions were placed here because none of the other
    categories seemed to fit.
   </para>
  </partintro>

  <refentry id="function.connection-aborted">
   <refnamediv>
    <refname>connection_aborted</refname>
    <refpurpose>Returns &true; if client disconnected</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>int</type><methodname>connection_aborted</methodname>
      <void/>
     </methodsynopsis>
    <simpara>
     Returns &true; if client disconnected.  See the <link
     linkend="features.connection-handling">Connection Handling</link>
     description in the <link linkend="features">Features</link>
     chapter for a complete explanation.
    </simpara>
   </refsect1>
  </refentry>

  <refentry id="function.connection-status">
   <refnamediv>
    <refname>connection_status</refname>
    <refpurpose>Returns connection status bitfield</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>int</type><methodname>connection_status</methodname>
      <void/>
     </methodsynopsis>
    <simpara>
     Returns the connection status bitfield.  See the <link
     linkend="features.connection-handling">Connection Handling</link>
     description in the <link linkend="features">Features</link>
     chapter for a complete explanation.
    </simpara>
   </refsect1>
  </refentry>

  <refentry id="function.connection-timeout">
   <refnamediv>
    <refname>connection_timeout</refname>
    <refpurpose>Return &true; if script timed out</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>bool</type><methodname>connection_timeout</methodname>
      <void/>
     </methodsynopsis>
    <simpara>
     Returns &true; if script timed out.
    </simpara>
    <warning>
     <title>Deprecated</title>
     <simpara> 
      This function is deprecated, and doesn't even exist anymore
      as of 4.0.5.
     </simpara>
     <!-- so it's quite late to declare it 'deprecated' by now :)
     TODO: correct connection handling. Any volunteers?
     -->
    </warning>
      
    <simpara>
     See the <link
     linkend="features.connection-handling">Connection Handling</link>
     description in the <link linkend="features">Features</link>
     chapter for a complete explanation.
    </simpara>
   </refsect1>
  </refentry>

  <refentry id="function.constant">
   <refnamediv>
    <refname>constant</refname>
    <refpurpose>Returns the value of a constant</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>mixed</type><methodname>constant</methodname>
      <methodparam><type>string</type><parameter>name</parameter></methodparam>
     </methodsynopsis>
    <simpara>
     <function>constant</function> will return the value of the
     constant indicated by <parameter>name</parameter>.
    </simpara>
    <simpara>
     <function>constant</function> is useful if you need to retrieve
     the value of a constant, but do not know it's name.  i.e. It is
     stored in a variable or returned by a function.
    </simpara>
    <para>
     <example>
      <title><function>constant</function> example</title>
      <programlisting role="php">
<![CDATA[
<?php

define ("MAXSIZE", 100);

echo MAXSIZE;
echo constant("MAXSIZE"); // same thing as the previous line

?>
]]>
      </programlisting>
     </example>
    </para>
    <para>
     See also <function>define</function>,
     <function>defined</function> and the section on <link
     linkend="language.constants">Constants</link>.
    </para>
   </refsect1>
  </refentry>


  <refentry id="function.define">
   <refnamediv>
    <refname>define</refname>
    <refpurpose>Defines a named constant.</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>bool</type><methodname>define</methodname>
      <methodparam><type>string</type><parameter>name</parameter></methodparam>
      <methodparam><type>mixed</type><parameter>value</parameter></methodparam>
      <methodparam choice="opt"><type>bool</type><parameter>case_insensitive</parameter></methodparam>
     </methodsynopsis>
    <para>
     Defines a named constant. See the 
     <link linkend="language.constants">section on constants</link>
     for more details.
    </para>
    <para>
     The name of the constant is given by <parameter>name</parameter>;
     the value is given by <parameter>value</parameter>.
    </para>
    <para>
     The optional third parameter
     <parameter>case_insensitive</parameter> is also available. If the
     value &true; is given, then the constant will be
     defined case-insensitive. The default behaviour is
     case-sensitive; i.e. CONSTANT and Constant represent different
     values.
    </para>
    <para>
     <example>
      <title>Defining Constants</title>
      <programlisting role="php">
<![CDATA[
<?php
define ("CONSTANT", "Hello world.");
echo CONSTANT; // outputs "Hello world."
echo Constant; // outputs "Constant" and issues a notice.

define ("GREETING", "Hello you.",TRUE);
echo GREETING; // outputs "Hello you."
echo Greeting; // outputs "Hello you."

?>
]]>
      </programlisting>
     </example>
    </para>
    <para>
     <function>define</function> returns &true; 
     on success and &false; if
     an error occurs.
    </para>
    <para>
     See also <function>defined</function>,
     <function>constant</function> and the section on <link
     linkend="language.constants">Constants</link>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.defined">
   <refnamediv>
    <refname>defined</refname>
    <refpurpose>
     Checks whether a given named constant exists
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>bool</type><methodname>defined</methodname>
      <methodparam><type>string</type><parameter>name</parameter></methodparam>
     </methodsynopsis>
    <para>
     Returns &true; if the named constant given by
     <parameter>name</parameter> has been defined, 
     &false; otherwise.
      <example>
      <title>Checking Constants</title>
      <programlisting role="php">
<![CDATA[
<?php
if (defined("CONSTANT")){ // Note that it should be quoted
    echo CONSTANT; //
    }
?>
]]>
      </programlisting>
     </example>
    </para>
    <para>
     See also <function>define</function>,
     <function>constant</function>,
     <function>get_defined_constants</function> and the section on
     <link linkend="language.constants">Constants</link>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.die">
   <refnamediv>
    <refname>die</refname>
    <refpurpose>Alias of <function>exit</function></refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <para>
     This function is an alias of <function>exit</function>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.eval">
   <refnamediv>
    <refname>eval</refname>
    <refpurpose>Evaluate a string as PHP code</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>mixed</type><methodname>eval</methodname>
      <methodparam><type>string</type><parameter>code_str</parameter></methodparam>
     </methodsynopsis>
    <simpara>
     <function>eval</function> evaluates the string given in
     <parameter>code_str</parameter> as PHP code. Among other things,
     this can be useful for storing code in a database text field for
     later execution.
    </simpara>
    <simpara>
     There are some factors to keep in mind when using
     <function>eval</function>. Remember that the string passed must
     be valid PHP code, including things like terminating statements
     with a semicolon so the parser doesn't die on the line after the
     <function>eval</function>, and properly escaping things in
     <parameter>code_str</parameter>.
    </simpara> 
    <simpara>
     Also remember that variables given values under
     <function>eval</function> will retain these values in the main
     script afterwards.
    </simpara>
    <simpara>
     A <literal>return</literal> statement will terminate the evaluation of 
     the string immediately. In PHP 4, <function>eval</function> returns
     &false; unless <function>return</function> is called in the evaluated
     code, in which case the value passed to <function>return</function> is
     returned. In PHP 3, <function>eval</function> does not return a value.
    </simpara>
    <para>
     <example>
      <title>
       <function>eval</function> example - simple text merge
      </title>
      <programlisting role="php">
<![CDATA[
<?php
$string = 'cup';
$name = 'coffee';
$str = 'This is a $string with my $name in it.<br>';
echo $str;
eval ("\$str = \"$str\";");
echo $str;
?>
]]>
      </programlisting>
      <para>
       The above example will show:
       <screen>
<![CDATA[
This is a $string with my $name in it.
This is a cup with my coffee in it.
]]>
       </screen>
      </para>
     </example>
    </para>
    &tip.ob-capture;
   </refsect1>
  </refentry>

  <refentry id="function.exit">
   <refnamediv>
    <refname>exit</refname>
    <refpurpose>Output a message and terminate the current script</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>void</type><methodname>exit</methodname>
      <methodparam choice="opt"><type>string</type><parameter>status</parameter></methodparam>
     </methodsynopsis>
     <methodsynopsis>
      <type>void</type><methodname>exit</methodname>
      <methodparam><type>int</type><parameter>status</parameter></methodparam>
     </methodsynopsis>
    <note>
     <simpara>
      This is not a real function, but a language construct.
     </simpara>
    </note>
    <simpara>
     The <function>exit</function> function terminates execution of
     the script. It prints <parameter>status</parameter> just before exiting.
    </simpara>
    <simpara>
     If <parameter>status</parameter> is an <type>integer</type>, that value
     will also be used as the exit status. Exit statuses should be in the
     range 1 to 254, the exit status 255 is reserved by PHP and shall not be
     used.
    </simpara>
    <note>
     <simpara>
      The current CVS version does NOT print the <parameter>status</parameter>
      if it is an <type>integer</type>.
     </simpara>
    </note>
    <note>
     <simpara>
      The <function>die</function> function is an alias for
      <function>exit</function>.
     </simpara>
    </note>
    <para>
     <example>
      <title><function>exit</function> example</title>
      <programlisting role="php">
<![CDATA[
<?php

$filename = '/path/to/data-file';
$file = fopen ($filename, 'r')
    or exit("unable to open file ($filename)");

?>
]]>
      </programlisting>
      <!-- TODO: example with integer exit-statis -->
     </example>
    </para>
   </refsect1>
  </refentry> 

  <refentry id="function.get-browser">
   <refnamediv>
    <refname>get_browser</refname>
    <refpurpose>
     Tells what the user's browser is capable of
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>object</type><methodname>get_browser</methodname>
      <methodparam choice="opt"><type>string</type><parameter>user_agent</parameter></methodparam>
     </methodsynopsis>
    <simpara>
     <function>get_browser</function> attempts to determine the
     capabilities of the user's browser. This is done by looking up
     the browser's information in the
     <filename>browscap.ini</filename> file. By default, the value of
     $HTTP_USER_AGENT is used; however, you can alter this (i.e., look
     up another browser's info) by passing the optional
     <parameter>user_agent</parameter> parameter to
     <function>get_browser</function>.
    </simpara>
    <simpara>
     The information is returned in an object, which will contain
     various data elements representing, for instance, the browser's
     major and minor version numbers and ID string; &true;/false values
     for features such as frames, JavaScript, and cookies; and so
     forth.
    </simpara>
    <simpara>
     While <filename>browscap.ini</filename> contains information on
     many browsers, it relies on user updates to keep the database
     current. The format of the file is fairly self-explanatory.
    </simpara>
    <para>
     The following example shows how one might list all available
     information retrieved about the user's browser.
     <example>
      <title><function>get_browser</function> example</title>
      <programlisting role="php">
<![CDATA[
<?php
function list_array ($array) {
    while (list ($key, $value) = each ($array)) {
    $str .= "<b>$key:</b> $value<br>\n";
    }
    return $str;
}
echo "$HTTP_USER_AGENT<hr>\n";
$browser = get_browser();
echo list_array ((array) $browser);
?>
]]>
      </programlisting>
     </example>
    </para>
    <simpara>
     The output of the above script would look something like this:
    </simpara>
    <programlisting>
<![CDATA[
Mozilla/4.5 [en] (X11; U; Linux 2.2.9 i586)<hr>
<b>browser_name_pattern:</b> Mozilla/4\.5.*<br>
<b>parent:</b> Netscape 4.0<br>
<b>platform:</b> Unknown<br>
<b>majorver:</b> 4<br>
<b>minorver:</b> 5<br>
<b>browser:</b> Netscape<br>
<b>version:</b> 4<br>
<b>frames:</b> 1<br>
<b>tables:</b> 1<br>
<b>cookies:</b> 1<br>
<b>backgroundsounds:</b> <br>
<b>vbscript:</b> <br>
<b>javascript:</b> 1<br>
<b>javaapplets:</b> 1<br>
<b>activexcontrols:</b> <br>
<b>beta:</b> <br>
<b>crawler:</b> <br>
<b>authenticodeupdate:</b> <br>
<b>msn:</b> <br>
]]>
    </programlisting>
    <simpara>
     In order for this to work, your <link
     linkend="ini.sect.browscap">browscap</link> configuration file
     setting must point to the correct location of the
     <filename>browscap.ini</filename> file.
    </simpara>
    <simpara>
     For more information (including locations from which you may
     obtain a <filename>browscap.ini</filename> file), check the PHP
     FAQ at <ulink
     url="&url.php.faq;">&url.php.faq;</ulink>.
    </simpara>
   </refsect1>
  </refentry>

  <refentry id="function.highlight-file">
   <refnamediv>
    <refname>highlight_file</refname>
    <refpurpose>Syntax highlighting of a file</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>bool</type><methodname>highlight_file</methodname>
      <methodparam><type>string</type><parameter>filename</parameter></methodparam>
      <methodparam
      choice="opt"><type>bool</type><parameter>return</parameter></methodparam>
     </methodsynopsis>
    <simpara>
     The <function>highlight_file</function> function prints out a syntax
     higlighted version of the code contained in <parameter>filename</parameter> 
     using the colors defined in the built-in syntax highlighter for PHP.
    </simpara>
    <simpara>
     If the second parameter <parameter>return</parameter> is set to &true;
     then <function>highlight_file</function> will return the highlighted
     code as a string instead of printing it out. If the second parameter is
     not set to &true; then <function>highlight_file</function> will
     return &true; on success, &false; on failure.
    </simpara>
    <note>
     <simpara>
      The <parameter>return</parameter> parameter became available in PHP 
      4.2.0.  Before this time it behaved like the default, which is &false;
     </simpara>
    </note>
    <note>
     <simpara>
      Care should be taken when using the
      <function>show_source</function> and
      <function>highlight_file</function> functions to make sure that
      you do not inadvertently reveal sensitive information such as
      passwords or any other type of information that might create a
      potential security risk.
     </simpara>
    </note>
    <para>
     <example>
      <title>Creating a source highlighting URL</title>
      <simpara>
       To setup a URL that can code hightlight any script that you pass to
       it, we will make use of the "ForceType" directive in
       Apache to generate a nice URL pattern, and use the 
       function <function>highlight_file</function> to show a nice looking
       code list.
      </simpara>
      <simpara>
       In your httpd.conf you can add the following:
      </simpara>
      <para>
       <informalexample>
        <programlisting>
<![CDATA[
<Location /source>
    ForceType application/x-httpd-php
</Location>
]]>
        </programlisting>
       </informalexample>
      </para>
      <simpara>
       And then make a file named "source" and put it in your
       web root directory.
      </simpara>
      <para>
       <programlisting role="php">
<![CDATA[
<HTML>
<HEAD>
<TITLE>Source Display</TITLE>
</HEAD>
<BODY BGCOLOR="white">
<?php
    $script = getenv ("PATH_TRANSLATED");
    if(!$script) {
    echo "<BR><B>ERROR: Script Name needed</B><BR>";
    } else {
    if (ereg("(\.php|\.inc)$",$script)) {
    echo "<H1>Source of: $PATH_INFO</H1>\n<HR>\n";
    highlight_file($script);
    } else {
    echo "<H1>ERROR: Only PHP or include script names are allowed</H1>"; 
    }
    }
    echo "<HR>Processed: ".date("Y/M/d H:i:s",time());
?>
</BODY>
</HTML>
]]>
       </programlisting>
      </para>
      <simpara>
       Then you can use an URL like the one below to display a colorized
       version of a script located in "/path/to/script.php" 
       in your web site.
      </simpara>
      <para>
       <informalexample>
    <programlisting>
<![CDATA[
http://your.server.com/source/path/to/script.php
]]>
    </programlisting>
       </informalexample>
      </para>
     </example>
    </para>
    <simpara>
     See also <function>highlight_string</function>,
     <function>show_source</function>.
    </simpara>
   </refsect1>
  </refentry>

  <refentry id="function.highlight-string">
   <refnamediv>
    <refname>highlight_string</refname>
    <refpurpose>Syntax highlighting of a string</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>mixed</type><methodname>highlight_string</methodname>
      <methodparam><type>string</type><parameter>str</parameter></methodparam>
      <methodparam choice="opt"><type>bool</type><parameter>return</parameter></methodparam>
     </methodsynopsis>
    <simpara>
     The <function>highlight_string</function> function outputs a syntax
     highlighted version of <parameter>str</parameter> using the colors defined
     in the built-in syntax highlighter for PHP.
    </simpara>
    <simpara>
     If the second parameter <parameter>return</parameter> is set to &true;
     then <function>highlight_string</function> will return the highlighted
     code as a string instead of printing it out. If the second parameter is
     not set to &true; then <function>highlight_string</function> will
     return &true; on success, &false; on failure.
    </simpara>
    <note>
     <simpara>
      The <parameter>return</parameter> parameter became available in PHP 
      4.2.0.  Before this time it behaved like the default, which is &false;
     </simpara>
    </note>
    <simpara>
     See also <function>highlight_file</function>, and 
     <function>show_source</function>.
    </simpara>
   </refsect1>
  </refentry>

  <refentry id="function.ignore-user-abort">
   <refnamediv>
    <refname>ignore_user_abort</refname>
    <refpurpose>
     Set whether a client disconnect should abort script execution
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>int</type><methodname>ignore_user_abort</methodname>
      <methodparam choice="opt"><type>int</type><parameter>setting</parameter></methodparam>
     </methodsynopsis>
    <simpara>
     This function sets whether a client disconnect should cause a
     script to be aborted.    It will return the previous setting and
     can be called without an argument to not change the current
     setting and only return the current setting.  See the <link
     linkend="features.connection-handling">Connection Handling</link>
     section in the <link linkend="features">Features</link> chapter
     for a complete description of connection handling in PHP.
    </simpara>
   </refsect1>
  </refentry> 
    
  <refentry id="function.iptcparse">
   <refnamediv>
    <refname>iptcparse</refname>
    <refpurpose>
     Parse a binary IPTC <ulink url="&url.iptc;">&url.iptc;</ulink>
     block into single tags.
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>array</type><methodname>iptcparse</methodname>
      <methodparam><type>string</type><parameter>iptcblock</parameter></methodparam>
     </methodsynopsis>
    <simpara>
     This function parses a binary IPTC block into its single tags. It
     returns an array using the tagmarker as an index and the value as
     the value. It returns &false; on error or if no IPTC data was
     found.  See <function>GetImageSize</function> for a sample.
    </simpara>
   </refsect1>
  </refentry>

  <refentry id="function.leak">
   <refnamediv>
    <refname>leak</refname>
    <refpurpose>Leak memory</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>void</type><methodname>leak</methodname>
      <methodparam><type>int</type><parameter>bytes</parameter></methodparam>
     </methodsynopsis>
    <simpara>
     <function>leak</function> leaks the specified amount of memory.
    </simpara>
    <simpara>
     This is useful when debugging the memory manager, which
     automatically cleans up "leaked" memory when each request is
     completed.
    </simpara>
   </refsect1>
  </refentry>

  <refentry id="function.pack">
   <refnamediv>
    <refname>pack</refname>
    <refpurpose>Pack data into binary string.</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>string</type><methodname>pack</methodname>
      <methodparam><type>string</type><parameter>format</parameter></methodparam>
      <methodparam choice="opt"><type>mixed</type><parameter>args</parameter></methodparam>
     </methodsynopsis>
    <para>
     Pack given arguments into binary string according to
     <parameter>format</parameter>. Returns binary string containing
     data.
    </para>
    <para>
     The idea to this function was taken from Perl and all formatting
     codes work the same as there, however, there are some formatting
     codes that are missing such as Perl's "u" format code. The format
     string consists of format codes followed by an optional repeater
     argument. The repeater argument can be either an integer value or
     * for repeating to the end of the input data. For a, A, h, H the
     repeat count specifies how many characters of one data argument
     are taken, for @ it is the absolute position where to put the
     next data, for everything else the repeat count specifies how
     many data arguments are consumed and packed into the resulting
     binary string. Currently implemented are
     <itemizedlist>
      <listitem>
       <simpara>
    a NUL-padded string
       </simpara>
      </listitem>
      <listitem>
       <simpara>
    A SPACE-padded string
       </simpara>
      </listitem>
      <listitem>
       <simpara>
    h Hex string, low nibble first
       </simpara>
      </listitem>
      <listitem>
       <simpara>
    H Hex string, high nibble first
       </simpara>
      </listitem>
      <listitem>
       <simpara>
    c signed char
       </simpara>
      </listitem>
      <listitem>
       <simpara>
    C unsigned char
       </simpara>
      </listitem>
      <listitem>
       <simpara>
    s signed short (always 16 bit, machine byte order)
       </simpara>
      </listitem>
      <listitem>
       <simpara>
    S unsigned short (always 16 bit, machine byte order)
       </simpara>
      </listitem>
      <listitem>
       <simpara>
    n unsigned short (always 16 bit, big endian byte order)
       </simpara>
      </listitem>
      <listitem>
       <simpara>
    v unsigned short (always 16 bit, little endian byte order)
       </simpara>
      </listitem>
      <listitem>
       <simpara>
    i signed integer (machine dependent size and byte order)
       </simpara>
      </listitem>
      <listitem>
       <simpara>
    I unsigned integer (machine dependent size and byte order)
       </simpara>
      </listitem>
      <listitem>
       <simpara>
    l signed long (always 32 bit, machine byte order)
       </simpara>
      </listitem>
      <listitem>
       <simpara>
    L unsigned long (always 32 bit, machine byte order)
       </simpara>
      </listitem>
      <listitem>
       <simpara>
    N unsigned long (always 32 bit, big endian byte order)
       </simpara>
      </listitem>
      <listitem>
       <simpara>
    V unsigned long (always 32 bit, little endian byte order)
       </simpara>
      </listitem>
      <listitem>
       <simpara>
    f float (machine dependent size and representation)
       </simpara>
      </listitem>
      <listitem>
       <simpara>
    d double (machine dependent size and representation)
       </simpara>
      </listitem>
      <listitem>
       <simpara>
    x NUL byte
       </simpara>
      </listitem>
      <listitem>
       <simpara>
    X Back up one byte
       </simpara>
      </listitem>
      <listitem>
       <simpara>
    @ NUL-fill to absolute position
       </simpara>
      </listitem>
     </itemizedlist>
     <example>
      <title><function>pack</function> format string</title>
      <programlisting role="php">
<![CDATA[
$binarydata = pack ("nvc*", 0x1234, 0x5678, 65, 66);
]]>
      </programlisting>
      <para>
       The resulting binary string will be 6 bytes long and contain
       the byte sequence 0x12, 0x34, 0x78, 0x56, 0x41, 0x42.
      </para>
     </example>
    </para>
    <para>
     Note that the distinction between signed and unsigned values only 
     affects the function <function>unpack</function>, where as
     function <function>pack</function> gives the same result for
     signed and unsigned format codes.
    </para>
    <para>
     Also note that PHP internally stores <type>integer</type> values as
     signed values of a machine dependent size. If you give it an unsigned
     integer value too large to be stored that way it is converted to a
     <type>float</type> which often yields an undesired result.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.show-source">
   <refnamediv>
    <refname>show_source</refname>
    <refpurpose>Syntax highlighting of a file</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>bool</type><methodname>show_source</methodname>
      <methodparam><type>string</type><parameter>filename</parameter></methodparam>
      <methodparam
      choice="opt"><type>bool</type><parameter>return</parameter></methodparam>
     </methodsynopsis>
    <simpara>
     The <function>show_source</function> function prints out a syntax
     higlighted version of the code contained in <parameter>filename</parameter> 
     using the colors defined in the built-in syntax highlighter for PHP.
    </simpara>
    <simpara>
     If the second parameter <parameter>return</parameter> is set to &true;
     then <function>show_source</function> will return the highlighted
     code as a string instead of printing it out. If the second parameter is
     not set to &true; then <function>show_source</function> will
     return &true; on success, &false; on failure.
    </simpara>
    <note>
     <simpara>
      The <parameter>return</parameter> parameter became available in PHP 
      4.2.0.  Before this time it behaved like the default, which is &false;
     </simpara>
    </note>
   <simpara>
     This function is an alias for the function
     <function>highlight_file</function>
    </simpara>
    <note>
     <simpara>
      Care should be taken when using the
      <function>show_source</function> and
      <function>highlight_file</function> functions to make sure that
      you do not inadvertently reveal sensitive information such as
      passwords or any other type of information that might create a
      potential security risk.
     </simpara>
    </note>
    <simpara>
     See also <function>highlight_string</function>,
     <function>highlight_file</function>.
    </simpara>
   </refsect1>
  </refentry>

  <refentry id="function.sleep">
   <refnamediv>
    <refname>sleep</refname>
    <refpurpose>Delay execution</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>void</type><methodname>sleep</methodname>
      <methodparam><type>int</type><parameter>seconds</parameter></methodparam>
     </methodsynopsis>
    <simpara>
     The sleep function delays program execution for the given number
     of <parameter>seconds</parameter>.
    </simpara>
    <simpara>
     See also <function>usleep</function>.
    </simpara>
   </refsect1>
  </refentry>

  <refentry id="function.uniqid">
   <refnamediv>
    <refname>uniqid</refname>
    <refpurpose>Generate a unique id</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>string</type><methodname>uniqid</methodname>
      <methodparam><type>string</type><parameter>prefix</parameter></methodparam>
      <methodparam choice="opt"><type>bool</type><parameter>lcg</parameter></methodparam>
     </methodsynopsis>
    <simpara>
     <function>uniqid</function> returns a prefixed unique identifier
     based on the current time in microseconds. The prefix can be
     useful for instance if you generate identifiers simultaneously on
     several hosts that might happen to generate the identifier at the
     same microsecond. <parameter>Prefix</parameter> can be up to 114
     characters long.
    </simpara>
    <simpara>
     If the optional <parameter>lcg</parameter> parameter is &true;,
     <function>uniqid</function> will add additional "combined LCG"
     entropy at the end of the return value, which should make the
     results more unique.
    </simpara>
    <simpara>
     With an empty <parameter>prefix</parameter>, the returned string
     will be 13 characters long.  If <parameter>lcg</parameter> is
     &true;, it will be 23 characters.
    </simpara>
    <note>
     <simpara>
      The <parameter>lcg</parameter> parameter is only available in
      PHP 4 and PHP 3.0.13 and later.
     </simpara>
    </note>
    <para>
     If you need a unique identifier or token and you intend to give
     out that token to the user via the network (i.e. session cookies),
     it is recommended that you use something along the lines of
     <informalexample>
      <programlisting role="php">
<![CDATA[
$token = md5(uniqid("")); // no prefix
$better_token = md5(uniqid(rand(),1)); // better, difficult to guess
]]>
      </programlisting>
     </informalexample>
    </para>
    <simpara>
     This will create a 32 character identifier (a 128 bit hex number)
     that is extremely difficult to predict.
    </simpara>
   </refsect1>
  </refentry>

  <refentry id="function.unpack">
   <refnamediv>
    <refname>unpack</refname>
    <refpurpose>Unpack data from binary string</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>array</type><methodname>unpack</methodname>
      <methodparam><type>string</type><parameter>format</parameter></methodparam>
      <methodparam><type>string</type><parameter>data</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>unpack</function> from binary string into array
     according to <parameter>format</parameter>. Returns array
     containing unpacked elements of binary string.
    </para>
    <para>
     <function>unpack</function> works slightly different from Perl as
     the unpacked data is stored in an associative array. To
     accomplish this you have to name the different format codes and
     separate them by a slash /.
     <example>
      <title><function>unpack</function> format string</title>
      <programlisting role="php">
<![CDATA[
$array = unpack ("c2chars/nint", $binarydata);
]]>
      </programlisting>
      <para>
       The resulting array will contain the entries "chars1",
       "chars2" and "int".
      </para>
     </example>
    </para>
    <para>
     For an explanation of the format codes see also:
     <function>pack</function>
    </para>
    <para>
     Note that PHP internally stores integral values as signed. If you
     unpack a large unsigned long and it is of the same size as PHP
     internally stored values the result will be a negative number
     even though unsigned unpacking was specified.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.usleep">
   <refnamediv>
    <refname>usleep</refname>
    <refpurpose>Delay execution in microseconds</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>void</type><methodname>usleep</methodname>
      <methodparam><type>int</type><parameter>micro_seconds</parameter></methodparam>
     </methodsynopsis>
    <simpara>
     The <function>usleep</function> function delays program execution
     for the given number of <parameter>micro_seconds</parameter>.
    </simpara>
    <simpara>
     See also <function>sleep</function>.
    </simpara>
    <note>
     <simpara>
      This function does not work on Windows systems.
     </simpara>
    </note>
   </refsect1>
  </refentry>

 </reference>

<!-- 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
-->