sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

WS

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@58019 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Jeroen van Wolffelaar 2001-09-22 01:22:45 +00:00
parent 51b307f73b
commit 8a13500b1b
24 changed files with 830 additions and 830 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
functions/array.xml
View file

@ -1,5 +1,5 @@
<?xml encoding="iso-8859-1"?>
<!-- $Revision: 1.100 $ -->
<!-- $Revision: 1.101 $ -->
<reference id="ref.array">
<title>Array Functions</title>
<titleabbrev>Arrays</titleabbrev>
@ -440,8 +440,8 @@ array_keys ($array); // returns array ("color", "size")
those still using PHP 3.
<example>
<title>
Implementation of <function>array_keys</function> for PHP 3
users
Implementation of <function>array_keys</function> for PHP 3
users
</title>
<programlisting role="php">
function array_keys ($arr, $term="") {
@ -1566,8 +1566,8 @@ array_values ($array); // returns array ("XL", "gold")
those still using PHP 3.
<example>
<title>
Implementation of <function>array_values</function> for PHP 3
users
Implementation of <function>array_values</function> for PHP 3
users
</title>
<programlisting role="php">
function array_values ($arr) {

106
functions/calendar.xml
View file

@ -1,5 +1,5 @@
<?xml encoding="iso-8859-1"?>
<!-- $Revision: 1.14 $ -->
<!-- $Revision: 1.15 $ -->
<reference id="ref.calendar">
<title>Calendar functions</title>
<titleabbrev>Calendar</titleabbrev>
@ -267,36 +267,36 @@ echo "$gregorian\n";
<title>Calendar modes</title>
<tgroup cols="2">
<thead>
<row>
<entry>Mode</entry>
<entry>Meaning</entry>
</row>
<row>
<entry>Mode</entry>
<entry>Meaning</entry>
</row>
</thead>
<tbody>
<row>
<entry>0</entry>
<entry>Gregorian - abbreviated</entry>
</row>
<row>
<entry>1</entry>
<entry>Gregorian</entry>
</row>
<row>
<entry>2</entry>
<entry>Julian - abbreviated</entry>
</row>
<row>
<entry>3</entry>
<entry>Julian</entry>
</row>
<row>
<entry>4</entry>
<entry>Jewish</entry>
</row>
<row>
<entry>5</entry>
<entry>French Republican</entry>
</row>
<row>
<entry>0</entry>
<entry>Gregorian - abbreviated</entry>
</row>
<row>
<entry>1</entry>
<entry>Gregorian</entry>
</row>
<row>
<entry>2</entry>
<entry>Julian - abbreviated</entry>
</row>
<row>
<entry>3</entry>
<entry>Julian</entry>
</row>
<row>
<entry>4</entry>
<entry>Jewish</entry>
</row>
<row>
<entry>5</entry>
<entry>French Republican</entry>
</row>
</tbody>
</tgroup>
</table>
@ -325,32 +325,32 @@ echo "$gregorian\n";
<title>Calendar week modes</title>
<tgroup cols="2">
<thead>
<row>
<entry>Mode</entry>
<entry>Meaning</entry>
</row>
<row>
<entry>Mode</entry>
<entry>Meaning</entry>
</row>
</thead>
<tbody>
<row>
<entry>0</entry>
<entry>
Returns the day number as an int (0=sunday, 1=monday, etc)
</entry>
</row>
<row>
<entry>1</entry>
<entry>
Returns string containing the day of week
(english-gregorian)
</entry>
</row>
<row>
<entry>2</entry>
<entry>
Returns a string containing the abbreviated day of week
(english-gregorian)
</entry>
</row>
<row>
<entry>0</entry>
<entry>
Returns the day number as an int (0=sunday, 1=monday, etc)
</entry>
</row>
<row>
<entry>1</entry>
<entry>
Returns string containing the day of week
(english-gregorian)
</entry>
</row>
<row>
<entry>2</entry>
<entry>
Returns a string containing the abbreviated day of week
(english-gregorian)
</entry>
</row>
</tbody>
</tgroup>
</table>

28
functions/cpdf.xml
View file

@ -1,5 +1,5 @@
<?xml encoding="iso-8859-1"?>
<!-- $Revision: 1.30 $ -->
<!-- $Revision: 1.31 $ -->
<reference id="ref.cpdf">
<title>ClibPDF functions</title>
<titleabbrev>ClibPDF</titleabbrev>
@ -71,7 +71,7 @@ cpdf_begin_text($cpdf);
cpdf_set_font($cpdf, "Times-Roman", 30, "WinAnsiEncoding");
cpdf_set_text_rendering($cpdf, 1);
cpdf_text($cpdf, "Times Roman outlined", 50, 750);
cpdf_end_text($cpdf);
cpdf_end_text($cpdf);
cpdf_moveto($cpdf, 50, 740);
cpdf_lineto($cpdf, 330, 740);
cpdf_stroke($cpdf);
@ -510,7 +510,7 @@ cpdf_end_text($pdf)
</para>
</refsect1>
</refentry>
<refentry id="function.cpdf-curveto">
<refnamediv>
<refname>cpdf_curveto</refname>
@ -587,7 +587,7 @@ cpdf_end_text($pdf)
</para>
</refsect1>
</refentry>
<refentry id="function.cpdf-fill">
<refnamediv>
<refname>cpdf_fill</refname>
@ -726,7 +726,7 @@ cpdf_end_text($pdf)
</para>
</refsect1>
</refentry>
<refentry id="function.cpdf-import-jpeg">
<refnamediv>
<refname>cpdf_import_jpeg</refname>
@ -909,7 +909,7 @@ cpdf_end_text($pdf)
</para>
</refsect1>
</refentry>
<refentry id="function.cpdf-output-buffer">
<refnamediv>
<refname>cpdf_output_buffer</refname>
@ -972,7 +972,7 @@ cpdf_end_text($pdf)
</para>
</refsect1>
</refentry>
<refentry id="function.cpdf-place-inline-image">
<refnamediv>
<refname>cpdf_place_inline_image</refname>
@ -1272,7 +1272,7 @@ cpdf_restore($pdf)
</para>
</refsect1>
</refentry>
<refentry id="function.cpdf-set-creator">
<refnamediv>
<refname>cpdf_set_creator</refname>
@ -1297,7 +1297,7 @@ cpdf_restore($pdf)
</para>
</refsect1>
</refentry>
<refentry id="function.cpdf-set-current-page">
<refnamediv>
<refname>cpdf_set_current_page</refname>
@ -1356,7 +1356,7 @@ cpdf_restore($pdf)
</para>
</refsect1>
</refentry>
<refentry id="function.cpdf-set-horiz-scaling">
<refnamediv>
<refname>cpdf_set_horiz_scaling</refname>
@ -1558,7 +1558,7 @@ cpdf_restore($pdf)
</para>
</refsect1>
</refentry>
<refentry id="function.cpdf-set-text-rendering">
<refnamediv>
<refname>cpdf_set_text_rendering</refname>
@ -1727,7 +1727,7 @@ cpdf_restore($pdf)
</para>
</refsect1>
</refentry>
<refentry id="function.cpdf-setgray-fill">
<refnamediv>
<refname>cpdf_setgray_fill</refname>
@ -1775,7 +1775,7 @@ cpdf_restore($pdf)
</para>
</refsect1>
</refentry>
<refentry id="function.cpdf-setlinecap">
<refnamediv>
<refname>cpdf_setlinecap</refname>
@ -1888,7 +1888,7 @@ cpdf_restore($pdf)
</para>
</refsect1>
</refentry>
<refentry id="function.cpdf-setrgbcolor-fill">
<refnamediv>
<refname>cpdf_setrgbcolor_fill</refname>

8
functions/curl.xml
View file

@ -1,5 +1,5 @@
<?xml encoding="iso-8859-1"?>
<!-- $Revision: 1.15 $ -->
<!-- $Revision: 1.16 $ -->
<reference id="ref.curl">
<title>CURL, Client URL Library Functions</title>
<titleabbrev>CURL</titleabbrev>
@ -174,9 +174,9 @@ curl_close ($ch);
</listitem>
<listitem>
<para>
<parameter>CURLOPT_NOPROGRESS</parameter>: Set this option to
a non-zero value if you don't want PHP to display a progress
meter for CURL transfers
<parameter>CURLOPT_NOPROGRESS</parameter>: Set this option to
a non-zero value if you don't want PHP to display a progress
meter for CURL transfers
<note>
<simpara>
PHP automatically sets this option to a non-zero parameter,

146
functions/datetime.xml
View file

@ -1,5 +1,5 @@
<?xml encoding="iso-8859-1"?>
<!-- $Revision: 1.47 $ -->
<!-- $Revision: 1.48 $ -->
<reference id="ref.datetime">
<title>Date and Time functions</title>
<titleabbrev>Date/time</titleabbrev>
@ -221,9 +221,9 @@
</listitem>
<listitem>
<simpara>
Z - timezone offset in seconds (i.e. "-43200" to "43200"). The
offset for timezones west of UTC is always negative, and for
those east of UTC is always positive.
Z - timezone offset in seconds (i.e. "-43200" to "43200"). The
offset for timezones west of UTC is always negative, and for
those east of UTC is always positive.
</simpara>
</listitem>
</itemizedlist>
@ -314,52 +314,52 @@ $today = date("H:i:s"); // 17:16:17
<itemizedlist>
<listitem>
<simpara>
"seconds" - seconds
"seconds" - seconds
</simpara>
</listitem>
<listitem>
<simpara>
"minutes" - minutes
"minutes" - minutes
</simpara>
</listitem>
<listitem>
<simpara>
"hours" - hours
"hours" - hours
</simpara>
</listitem>
<listitem>
<simpara>
"mday" - day of the month
"mday" - day of the month
</simpara>
</listitem>
<listitem>
<simpara>
"wday" - day of the week, numeric : from 0 as Sunday up to 6 as Saturday
"wday" - day of the week, numeric : from 0 as Sunday up to 6 as Saturday
</simpara>
</listitem>
<listitem>
<simpara>
"mon" - month, numeric
"mon" - month, numeric
</simpara>
</listitem>
<listitem>
<simpara>
"year" - year, numeric
"year" - year, numeric
</simpara>
</listitem>
<listitem>
<simpara>
"yday" - day of the year, numeric; i.e. "299"
"yday" - day of the year, numeric; i.e. "299"
</simpara>
</listitem>
<listitem>
<simpara>
"weekday" - day of the week, textual, full; i.e. "Friday"
"weekday" - day of the week, textual, full; i.e. "Friday"
</simpara>
</listitem>
<listitem>
<simpara>
"month" - month, textual, full; i.e. "January"
"month" - month, textual, full; i.e. "January"
</simpara>
</listitem>
</itemizedlist>
@ -399,22 +399,22 @@ echo "$month $mday, $year";
<itemizedlist>
<listitem>
<simpara>
"sec" - seconds
"sec" - seconds
</simpara>
</listitem>
<listitem>
<simpara>
"usec" - microseconds
"usec" - microseconds
</simpara>
</listitem>
<listitem>
<simpara>
"minuteswest" - minutes west of Greenwich
"minuteswest" - minutes west of Greenwich
</simpara>
</listitem>
<listitem>
<simpara>
"dsttime" - type of dst correction
"dsttime" - type of dst correction
</simpara>
</listitem>
</itemizedlist>
@ -563,47 +563,47 @@ echo gmstrftime ("%b %d %Y %H:%M:%S", mktime (20,0,0,12,31,98))."\n";
<itemizedlist>
<listitem>
<simpara>
"tm_sec" - seconds
"tm_sec" - seconds
</simpara>
</listitem>
<listitem>
<simpara>
"tm_min" - minutes
"tm_min" - minutes
</simpara>
</listitem>
<listitem>
<simpara>
"tm_hour" - hour
"tm_hour" - hour
</simpara>
</listitem>
<listitem>
<simpara>
"tm_mday" - day of the month
"tm_mday" - day of the month
</simpara>
</listitem>
<listitem>
<simpara>
"tm_mon" - month of the year
"tm_mon" - month of the year
</simpara>
</listitem>
<listitem>
<simpara>
"tm_year" - Years since 1900
"tm_year" - Years since 1900
</simpara>
</listitem>
<listitem>
<simpara>
"tm_wday" - Day of the week
"tm_wday" - Day of the week
</simpara>
</listitem>
<listitem>
<simpara>
"tm_yday" - Day of the year
"tm_yday" - Day of the year
</simpara>
</listitem>
<listitem>
<simpara>
"tm_isdst" - Is daylight savings time in effect
"tm_isdst" - Is daylight savings time in effect
</simpara>
</listitem>
</itemizedlist>
@ -790,131 +790,131 @@ echo strftime ("Last day in Feb 2000 is: %d", $lastday);
<itemizedlist>
<listitem>
<simpara>
%a - abbreviated weekday name according to the current locale
%a - abbreviated weekday name according to the current locale
</simpara>
</listitem>
<listitem>
<simpara>
%A - full weekday name according to the current locale
%A - full weekday name according to the current locale
</simpara>
</listitem>
<listitem>
<simpara>
%b - abbreviated month name according to the current locale
%b - abbreviated month name according to the current locale
</simpara>
</listitem>
<listitem>
<simpara>
%B - full month name according to the current locale
%B - full month name according to the current locale
</simpara>
</listitem>
<listitem>
<simpara>
%c - preferred date and time representation for the current
locale
%c - preferred date and time representation for the current
locale
</simpara>
</listitem>
<listitem>
<simpara>
%C - century number (the year divided by 100 and truncated to
an integer, range 00 to 99)
%C - century number (the year divided by 100 and truncated to
an integer, range 00 to 99)
</simpara>
</listitem>
<listitem>
<simpara>
%d - day of the month as a decimal number (range 01 to 31)
%d - day of the month as a decimal number (range 01 to 31)
</simpara>
</listitem>
<listitem>
<simpara>
%D - same as %m/%d/%y
%D - same as %m/%d/%y
</simpara>
</listitem>
<listitem>
<simpara>
%e - day of the month as a decimal number, a single digit is
preceded by a space (range ' 1' to '31')
%e - day of the month as a decimal number, a single digit is
preceded by a space (range ' 1' to '31')
</simpara>
</listitem>
<listitem>
<simpara>
%h - same as %b
%h - same as %b
</simpara>
</listitem>
<listitem>
<simpara>
%H - hour as a decimal number using a 24-hour clock (range 00
to 23)
%H - hour as a decimal number using a 24-hour clock (range 00
to 23)
</simpara>
</listitem>
<listitem>
<simpara>
%I - hour as a decimal number using a 12-hour clock (range 01
to 12)
%I - hour as a decimal number using a 12-hour clock (range 01
to 12)
</simpara>
</listitem>
<listitem>
<simpara>
%j - day of the year as a decimal number (range 001 to 366)
%j - day of the year as a decimal number (range 001 to 366)
</simpara>
</listitem>
<listitem>
<simpara>
%m - month as a decimal number (range 01 to 12)
%m - month as a decimal number (range 01 to 12)
</simpara>
</listitem>
<listitem>
<simpara>
%M - minute as a decimal number
%M - minute as a decimal number
</simpara>
</listitem>
<listitem>
<simpara>
%n - newline character
%n - newline character
</simpara>
</listitem>
<listitem>
<simpara>
%p - either `am' or `pm' according to the given time value, or
the corresponding strings for the current locale
%p - either `am' or `pm' according to the given time value, or
the corresponding strings for the current locale
</simpara>
</listitem>
<listitem>
<simpara>
%r - time in a.m. and p.m. notation
%r - time in a.m. and p.m. notation
</simpara>
</listitem>
<listitem>
<simpara>
%R - time in 24 hour notation
%R - time in 24 hour notation
</simpara>
</listitem>
<listitem>
<simpara>
%S - second as a decimal number
%S - second as a decimal number
</simpara>
</listitem>
<listitem>
<simpara>
%t - tab character
%t - tab character
</simpara>
</listitem>
<listitem>
<simpara>
%T - current time, equal to %H:%M:%S
%T - current time, equal to %H:%M:%S
</simpara>
</listitem>
<listitem>
<simpara>
%u - weekday as a decimal number [1,7], with 1 representing
Monday
%u - weekday as a decimal number [1,7], with 1 representing
Monday
</simpara>
</listitem>
<listitem>
<simpara>
%U - week number of the current year as a decimal number,
starting with the first Sunday as the first day of the first
week
%U - week number of the current year as a decimal number,
starting with the first Sunday as the first day of the first
week
</simpara>
</listitem>
<listitem>
@ -927,47 +927,47 @@ echo strftime ("Last day in Feb 2000 is: %d", $lastday);
</listitem>
<listitem>
<simpara>
%W - week number of the current year as a decimal number,
starting with the first Monday as the first day of the first
week
%W - week number of the current year as a decimal number,
starting with the first Monday as the first day of the first
week
</simpara>
</listitem>
<listitem>
<simpara>
%w - day of the week as a decimal, Sunday being 0
%w - day of the week as a decimal, Sunday being 0
</simpara>
</listitem>
<listitem>
<simpara>
%x - preferred date representation for the current locale
without the time
%x - preferred date representation for the current locale
without the time
</simpara>
</listitem>
<listitem>
<simpara>
%X - preferred time representation for the current locale
without the date
%X - preferred time representation for the current locale
without the date
</simpara>
</listitem>
<listitem>
<simpara>
%y - year as a decimal number without a century (range 00 to
99)
%y - year as a decimal number without a century (range 00 to
99)
</simpara>
</listitem>
<listitem>
<simpara>
%Y - year as a decimal number including the century
%Y - year as a decimal number including the century
</simpara>
</listitem>
<listitem>
<simpara>
%Z - time zone or name or abbreviation
%Z - time zone or name or abbreviation
</simpara>
</listitem>
<listitem>
<simpara>
%% - a literal `%' character
%% - a literal `%' character
</simpara>
</listitem>
</itemizedlist>

18
functions/dba.xml
View file

@ -1,5 +1,5 @@
<?xml encoding="iso-8859-1"?>
<!-- $Revision: 1.14 $ -->
<!-- $Revision: 1.15 $ -->
<reference id="ref.dba">
<title>Database (dbm-style) abstraction layer functions</title>
<titleabbrev>dba</titleabbrev>
@ -37,13 +37,13 @@
<tgroup cols="2">
<thead>
<row>
<entry>Handler</entry>
<entry>Notes</entry>
<entry>Handler</entry>
<entry>Notes</entry>
</row>
</thead>
<tbody>
<row>
<entry><literal>dbm</literal></entry>
<entry><literal>dbm</literal></entry>
<entry>
Dbm is the oldest (original) type of Berkeley DB style
databases. You should avoid it, if possible. We do not support
@ -54,7 +54,7 @@
</row>
<row>
<entry><literal>ndbm</literal></entry>
<entry><literal>ndbm</literal></entry>
<entry>
Ndbm is a newer type and more flexible than dbm. It still has
most of the arbitrary limits of dbm (therefore it is
@ -63,7 +63,7 @@
</row>
<row>
<entry><literal>gdbm</literal></entry>
<entry><literal>gdbm</literal></entry>
<entry>
Gdbm is the <ulink url="&url.gdbm;">GNU database
manager</ulink>. (<literal>--with-gdbm</literal>)
@ -71,7 +71,7 @@
</row>
<row>
<entry><literal>db2</literal></entry>
<entry><literal>db2</literal></entry>
<entry>
DB2 is <ulink url="&url.sleepycat;">Sleepycat Software's
DB2</ulink>. It is described as "a programmatic toolkit that
@ -81,7 +81,7 @@
</row>
<row>
<entry><literal>db3</literal></entry>
<entry><literal>db3</literal></entry>
<entry>
DB3 is <ulink url="&url.sleepycat;">Sleepycat Software's
DB3</ulink>. (<literal>--with-db3</literal>)
@ -89,7 +89,7 @@
</row>
<row>
<entry><literal>cdb</literal></entry>
<entry><literal>cdb</literal></entry>
<entry>
Cdb is "a fast, reliable, lightweight package for creating and
reading constant databases." It is from the author of qmail and

40
functions/dbase.xml
View file

@ -1,5 +1,5 @@
<?xml encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<!-- $Revision: 1.11 $ -->
<reference id="ref.dbase">
<title>dBase functions</title>
<titleabbrev>dBase</titleabbrev>
@ -56,44 +56,44 @@
<varlistentry>
<term>L</term>
<listitem>
<simpara>
Boolean. These do not have a length or precision.
</simpara>
<simpara>
Boolean. These do not have a length or precision.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>M</term>
<listitem>
<simpara>
Memo. (Note that these aren't supported by PHP.) These do
not have a length or precision.
</simpara>
<simpara>
Memo. (Note that these aren't supported by PHP.) These do
not have a length or precision.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>D</term>
<listitem>
<simpara>
Date (stored as YYYYMMDD). These do not have a length or
precision.
</simpara>
<simpara>
Date (stored as YYYYMMDD). These do not have a length or
precision.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>N</term>
<listitem>
<simpara>
Number. These have both a length and a precision (the number
of digits after the decimal point).
</simpara>
<simpara>
Number. These have both a length and a precision (the number
of digits after the decimal point).
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>C</term>
<listitem>
<simpara>
String.
</simpara>
<simpara>
String.
</simpara>
</listitem>
</varlistentry>
</variablelist>
@ -149,7 +149,7 @@ if (!dbase_create($dbname, $def))
Returns a dbase_identifier for the opened database, or &false; if
the database couldn't be opened.
</para>
&note.sm.uidcheck;
&note.sm.uidcheck;
</refsect1>
</refentry>

12
functions/dbx.xml
View file

@ -1,5 +1,5 @@
<?xml encoding="iso-8859-1"?>
<!-- $Revision: 1.18 $ -->
<!-- $Revision: 1.19 $ -->
<reference id="ref.dbx">
<title>dbx functions</title>
<titleabbrev>dbx</titleabbrev>
@ -109,27 +109,27 @@ dbx_close($link);
<itemizedlist>
<listitem>
<simpara>
module DBX_MYSQL : "mysql"
module DBX_MYSQL : "mysql"
</simpara>
</listitem>
<listitem>
<simpara>
module DBX_ODBC : "odbc"
module DBX_ODBC : "odbc"
</simpara>
</listitem>
<listitem>
<simpara>
module DBX_PGSQL : "pgsql"
module DBX_PGSQL : "pgsql"
</simpara>
</listitem>
<listitem>
<simpara>
module DBX_MSSQL : "mssql"
module DBX_MSSQL : "mssql"
</simpara>
</listitem>
<listitem>
<simpara>
module DBX_FBSQL : "fbsql" (CVS only)
module DBX_FBSQL : "fbsql" (CVS only)
</simpara>
</listitem>
</itemizedlist>

30
functions/domxml.xml
View file

@ -1,5 +1,5 @@
<?xml encoding="iso-8859-1"?>
<!-- $Revision: 1.22 $ -->
<!-- $Revision: 1.23 $ -->
<reference id="ref.domxml">
<title>DOM XML functions</title>
<titleabbrev>DOM XML</titleabbrev>
@ -429,7 +429,7 @@
<paramdef>string <parameter>str</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
&warn.experimental.func;
<para>
The function parses the XML document in
<parameter>str</parameter> and returns an object of class "Dom
@ -454,7 +454,7 @@
<paramdef>string <parameter>filename</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
&warn.experimental.func;
<para>
The function parses the XML document in the file named
<parameter>filename</parameter> and returns an object of class
@ -482,7 +482,7 @@
<paramdef>string <parameter>str</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
&warn.experimental.func;
<para>
The function parses the XML document in
<parameter>str</parameter> and returns a tree PHP objects as the
@ -511,7 +511,7 @@
<paramdef>object <parameter>doc</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
&warn.experimental.func;
<para>
<function>domxml_root</function> takes one argument, an object of class
"Dom document", and returns the root element node. There are actually
@ -577,7 +577,7 @@ print_r($root);
<paramdef>string <parameter>name</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
&warn.experimental.func;
<para>
Adds a root element node to a dom document and returns the new node.
The element name is given in the second parameter.
@ -614,7 +614,7 @@ echo $doc-&gt;dumpmem();
<paramdef>resource <parameter>doc</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
&warn.experimental.func;
<para>
Creates an XML document from the dom representation. This function
usually is called after a building a new dom document from scratch
@ -641,7 +641,7 @@ echo $doc-&gt;dumpmem();
<paramdef>resource <parameter>node</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
&warn.experimental.func;
<para>
Returns all attributes of a node as array of objects of type
"dom attribute".
@ -665,7 +665,7 @@ echo $doc-&gt;dumpmem();
<paramdef>string <parameter>name</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
&warn.experimental.func;
<para>
Returns the attribute with name <parameter>name</parameter> of the given
node.
@ -692,7 +692,7 @@ echo $doc-&gt;dumpmem();
<paramdef>string <parameter>value</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
&warn.experimental.func;
<para>
Sets an attribute with name <parameter>name</parameter> of the given
node on a value.
@ -733,7 +733,7 @@ echo $doc-&gt;dumpmem();
<paramdef>object <parameter>doc|node</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
&warn.experimental.func;
<para>
Returns all children of a node as an array of nodes.
</para>
@ -774,7 +774,7 @@ $children = $head-&gt;children();
<paramdef>string <parameter>content</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
&warn.experimental.func;
<para>
Adds a new child of type element to a node and returns it.
</para>
@ -796,7 +796,7 @@ $children = $head-&gt;children();
<paramdef>string <parameter>version</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
&warn.experimental.func;
<para>
Creates a new dom document from scratch and returns it.
</para>
@ -821,7 +821,7 @@ $children = $head-&gt;children();
<paramdef>object <parameter>dom document</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
&warn.experimental.func;
<para>
</para>
<para>
@ -845,7 +845,7 @@ $children = $head-&gt;children();
<paramdef>object <parameter>xpath context</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
&warn.experimental.func;
<para>
</para>
<para>

142
functions/errorfunc.xml
View file

@ -1,5 +1,5 @@
<?xml encoding="iso-8859-1"?>
<!-- $Revision: 1.17 $ -->
<!-- $Revision: 1.18 $ -->
<reference id="ref.errorfunc">
<title>Error Handling and Logging Functions</title>
<titleabbrev>Errors and Logging</titleabbrev>
@ -171,78 +171,78 @@ error_reporting (E_ALL ^ E_NOTICE); // The same in both PHP 3 and 4
<title><function>error_reporting</function> bit values</title>
<tgroup cols="2">
<thead>
<row>
<entry>constant</entry>
<entry>value</entry>
</row>
<row>
<entry>constant</entry>
<entry>value</entry>
</row>
</thead>
<tbody>
<row>
<entry>1</entry>
<entry>
<link linkend="internal.e-error">E_ERROR</link>
</entry>
</row>
<row>
<entry>2</entry>
<entry>
<link linkend="internal.e-warning">E_WARNING</link>
</entry>
</row>
<row>
<entry>4</entry>
<entry>
<link linkend="internal.e-parse">E_PARSE</link>
</entry>
</row>
<row>
<entry>8</entry>
<entry>
<link linkend="internal.e-notice">E_NOTICE</link>
</entry>
</row>
<row>
<entry>16</entry>
<entry>
<link linkend="internal.e-core-error">E_CORE_ERROR</link>
</entry>
</row>
<row>
<entry>32</entry>
<entry>
<link linkend="internal.e-core-warning">E_CORE_WARNING</link>
</entry>
</row>
<row>
<entry>64</entry>
<entry>
<link linkend="internal.e-compile-error">E_COMPILE_ERROR</link>
</entry>
</row>
<row>
<entry>128</entry>
<entry>
<link linkend="internal.e-compile-warning">E_COMPILE_WARNING</link>
</entry>
</row>
<row>
<entry>256</entry>
<entry>
<link linkend="internal.e-user-error">E_USER_ERROR</link>
</entry>
</row>
<row>
<entry>512</entry>
<entry>
<link linkend="internal.e-user-warning">E_USER_WARNING</link>
</entry>
</row>
<row>
<entry>1024</entry>
<entry>
<link linkend="internal.e-user-error">E_USER_NOTICE</link>
</entry>
</row>
<row>
<entry>1</entry>
<entry>
<link linkend="internal.e-error">E_ERROR</link>
</entry>
</row>
<row>
<entry>2</entry>
<entry>
<link linkend="internal.e-warning">E_WARNING</link>
</entry>
</row>
<row>
<entry>4</entry>
<entry>
<link linkend="internal.e-parse">E_PARSE</link>
</entry>
</row>
<row>
<entry>8</entry>
<entry>
<link linkend="internal.e-notice">E_NOTICE</link>
</entry>
</row>
<row>
<entry>16</entry>
<entry>
<link linkend="internal.e-core-error">E_CORE_ERROR</link>
</entry>
</row>
<row>
<entry>32</entry>
<entry>
<link linkend="internal.e-core-warning">E_CORE_WARNING</link>
</entry>
</row>
<row>
<entry>64</entry>
<entry>
<link linkend="internal.e-compile-error">E_COMPILE_ERROR</link>
</entry>
</row>
<row>
<entry>128</entry>
<entry>
<link linkend="internal.e-compile-warning">E_COMPILE_WARNING</link>
</entry>
</row>
<row>
<entry>256</entry>
<entry>
<link linkend="internal.e-user-error">E_USER_ERROR</link>
</entry>
</row>
<row>
<entry>512</entry>
<entry>
<link linkend="internal.e-user-warning">E_USER_WARNING</link>
</entry>
</row>
<row>
<entry>1024</entry>
<entry>
<link linkend="internal.e-user-error">E_USER_NOTICE</link>
</entry>
</row>
</tbody>
</tgroup>
</table>

18
functions/exec.xml
View file

@ -1,5 +1,5 @@
<?xml encoding="iso-8859-1"?>
<!-- $Revision: 1.19 $ -->
<!-- $Revision: 1.20 $ -->
<reference id="ref.exec">
<title>Program Execution functions</title>
<titleabbrev>Program Execution</titleabbrev>
@ -28,13 +28,13 @@
</funcsynopsis>
<para>
<function>escapeshellarg</function> adds single quotes around a string
and quotes/escapes any existing single quotes allowing you to pass a
string directly to a shell function and having it be treated as a single
safe argument. This function should be used to escape individual
arguments to shell functions coming from user input. The shell functions
include <function>exec</function>, <function>system</function> and the
<link linkend="language.operators.execution">backtick operator</link>.
A standard use would be:</para>
and quotes/escapes any existing single quotes allowing you to pass a
string directly to a shell function and having it be treated as a single
safe argument. This function should be used to escape individual
arguments to shell functions coming from user input. The shell functions
include <function>exec</function>, <function>system</function> and the
<link linkend="language.operators.execution">backtick operator</link>.
A standard use would be:</para>
<para>
<informalexample>
<programlisting role="php">
@ -85,7 +85,7 @@ system("touch \"/tmp/$f\"; ls -l \"/tmp/$f\""); // and here we do, so we use quo
</para>
<para>
See also <function>escapeshellarg</function>, <function>exec</function>,
<function>popen</function>, <function>system</function>, and the <link
<function>popen</function>, <function>system</function>, and the <link
linkend="language.operators.execution">backtick operator</link>.
</para>

40
functions/fbsql.xml
View file

@ -1,5 +1,5 @@
<?xml encoding="iso-8859-1"?>
<!-- $Revision: 1.23 $ -->
<!-- $Revision: 1.24 $ -->
<reference id="ref.fbsql">
<title>FrontBase functions</title>
<titleabbrev>FrontBase</titleabbrev>
@ -524,46 +524,46 @@
<itemizedlist>
<listitem>
<simpara>
&false - The exec handler for the host was invalid. This
error will ocour when the link_identifier connects directly to
a database by using a port number. FBExec can be available on the
server but no connection has been made for it.
&false - The exec handler for the host was invalid. This
error will ocour when the link_identifier connects directly to
a database by using a port number. FBExec can be available on the
server but no connection has been made for it.
</simpara>
</listitem>
<listitem>
<simpara>
FBSQL_UNKNOWN - The Status is unknown.
FBSQL_UNKNOWN - The Status is unknown.
</simpara>
</listitem>
<listitem>
<simpara>
FBSQL_STOPPED - The database is not running. Use
<function>fbsql_start_db</function> to start the database.
FBSQL_STOPPED - The database is not running. Use
<function>fbsql_start_db</function> to start the database.
</simpara>
</listitem>
<listitem>
<simpara>
FBSQL_STARTING - The database is starting.
FBSQL_STARTING - The database is starting.
</simpara>
</listitem>
<listitem>
<simpara>
FBSQL_RUNNING - The database is running and can be used to
perform SQL operations.
FBSQL_RUNNING - The database is running and can be used to
perform SQL operations.
</simpara>
</listitem>
<listitem>
<simpara>
FBSQL_STOPPING - The database is stopping.
FBSQL_STOPPING - The database is stopping.
</simpara>
</listitem>
<listitem>
<simpara>
FBSQL_NOEXEC - FBExec is not running on the server and it is not
possible to get the status of the database.
FBSQL_NOEXEC - FBExec is not running on the server and it is not
possible to get the status of the database.
</simpara>
</listitem>
</itemizedlist>
</itemizedlist>
</para>
<para> See also:
<function>fbsql_start_db</function> and
@ -870,27 +870,27 @@ fbsql_free_result ($result);
<itemizedlist>
<listitem>
<simpara>
name - column name
name - column name
</simpara>
</listitem>
<listitem>
<simpara>
table - name of the table the column belongs to
table - name of the table the column belongs to
</simpara>
</listitem>
<listitem>
<simpara>
max_length - maximum length of the column
max_length - maximum length of the column
</simpara>
</listitem>
<listitem>
<simpara>
not_null - 1 if the column cannot be &null;
not_null - 1 if the column cannot be &null;
</simpara>
</listitem>
<listitem>
<simpara>
type - the type of the column
type - the type of the column
</simpara>
</listitem>
</itemizedlist>

4
functions/fdf.xml
View file

@ -1,5 +1,5 @@
<?xml encoding="iso-8859-1"?>
<!-- $Revision: 1.18 $ -->
<!-- $Revision: 1.19 $ -->
<reference id="ref.fdf">
<title>Forms Data Format functions</title>
<titleabbrev>FDF</titleabbrev>
@ -9,7 +9,7 @@
<simpara>
Forms Data Format (FDF) is a format for handling
forms within PDF documents. You should read the documentation at
<ulink url="&spec.pdf.fdf;">&spec.pdf.fdf;</ulink>
<ulink url="&spec.pdf.fdf;">&spec.pdf.fdf;</ulink>
for more information on what FDF is and how it is used in general.
</simpara>

13
functions/filepro.xml
View file

@ -1,5 +1,5 @@
<?xml encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<!-- $Revision: 1.11 $ -->
<reference id="ref.filepro">
<title>filePro functions</title>
<titleabbrev>filePro</titleabbrev>
@ -31,7 +31,7 @@
<para>
No locking is done, so you should avoid modifying your filePro
database while it may be opened in PHP.</para>
&note.sm.uidcheck;
&note.sm.uidcheck;
</refsect1>
</refentry>
@ -105,7 +105,7 @@
</funcsynopsis>
<para>
Returns the data from the specified location in the database.</para>
&note.sm.uidcheck;
&note.sm.uidcheck;
</refsect1>
</refentry>
@ -123,8 +123,9 @@
</funcprototype>
</funcsynopsis>
<para>
Returns the number of fields (columns) in the opened filePro
database.</para>
Returns the number of fields (columns) in the opened filePro
database.
</para>
<para>
See also <function>filepro</function>.</para>
</refsect1>
@ -145,7 +146,7 @@
</funcsynopsis>
<para>
Returns the number of rows in the opened filePro database.</para>
&note.sm.uidcheck;
&note.sm.uidcheck;
<para>
See also <function>filepro</function>.</para>
</refsect1>

8
functions/http.xml
View file

@ -1,5 +1,5 @@
<?xml encoding="iso-8859-1"?>
<!-- $Revision: 1.25 $ -->
<!-- $Revision: 1.26 $ -->
<reference id="ref.http">
<title>HTTP functions</title>
<titleabbrev>HTTP</titleabbrev>
@ -233,9 +233,9 @@ setcookie ("TestCookie", "", time() - 3600);
setcookie ("TestCookie", "", time() - 3600, "/~rasmus/", ".utoronto.ca", 1);
</programlisting>
</example>
When deleting a cookie you should assure that the expiration date
is in the past, to trigger the removal mechanism in your browser.
</para>
When deleting a cookie you should assure that the expiration date
is in the past, to trigger the removal mechanism in your browser.
</para>
<para>
Note that the value portion of the cookie will automatically be
urlencoded when you send the cookie, and when it is received, it

167
functions/hw.xml
View file

@ -1,5 +1,5 @@
<?xml encoding="iso-8859-1"?>
<!-- $Revision: 1.16 $ -->
<!-- $Revision: 1.17 $ -->
<reference id="ref.hyperwave">
<title>Hyperwave functions</title>
<titleabbrev>Hyperwave</titleabbrev>
@ -122,23 +122,22 @@
replaced by another character, e.g. '_'. to be continued.
</para>
<para>
The network protocol to communicate
with the Hyperwave server is called <ulink url="&spec.hyperwave;">HG-CSP</ulink>
(Hyper-G Client/Server Protocol). It is based on messages to initiate
certain actions, e.g. get object record. In early versions of
the Hyperwave Server two native clients (Harmony, Amadeus) were
provided for communication with the server. Those two disappeared
when Hyperwave was commercialised. As a replacement a so called
wavemaster was provided. The wavemaster is like a protocol converter
from <abbrev>HTTP</abbrev> to <abbrev>HG-CSP</abbrev>. The idea is
to do all the administration of the database and visualisation of
documents by a web interface. The wavemaster implements a set of
placeholders for certain actions to customise the interface. This
set of placeholders is called the <abbrev>PLACE</abbrev> Language.
The network protocol to communicate with the Hyperwave server is called
<ulink url="&spec.hyperwave;">HG-CSP</ulink> (Hyper-G Client/Server
Protocol). It is based on messages to initiate certain actions, e.g. get
object record. In early versions of the Hyperwave Server two native
clients (Harmony, Amadeus) were provided for communication with the
server. Those two disappeared when Hyperwave was commercialised. As a
replacement a so called wavemaster was provided. The wavemaster is like a
protocol converter from <abbrev>HTTP</abbrev> to <abbrev>HG-CSP</abbrev>.
The idea is to do all the administration of the database and
visualisation of documents by a web interface. The wavemaster implements
a set of placeholders for certain actions to customise the interface.
This set of placeholders is called the <abbrev>PLACE</abbrev> Language.
<abbrev>PLACE</abbrev> lacks a lot of features of a real programming
language and any extension to it only enlarges the list of
placeholders. This has led to the use of JavaScript which IMO does
not make life easier.
language and any extension to it only enlarges the list of placeholders.
This has led to the use of JavaScript which IMO does not make life
easier.
</para>
<para>
Adding Hyperwave support to PHP should fill in the gap of a
@ -155,39 +154,39 @@
<itemizedlist>
<listitem>
<simpara>
object ID: An unique integer value for each object in the
Hyperwave server. It is also one of the attributes of the
object record (ObjectID). Object ids are often used as an
input parameter to specify an object.
object ID: An unique integer value for each object in the
Hyperwave server. It is also one of the attributes of the
object record (ObjectID). Object ids are often used as an
input parameter to specify an object.
</simpara>
</listitem>
<listitem>
<simpara>
object record: A string with attribute-value pairs of the form
attribute=value. The pairs are separated by a carriage return
from each other. An object record can easily be converted into
an object array with <function>hw_object2array</function>.
Several functions return object records. The names of those
functions end with obj.
object record: A string with attribute-value pairs of the form
attribute=value. The pairs are separated by a carriage return
from each other. An object record can easily be converted into
an object array with <function>hw_object2array</function>.
Several functions return object records. The names of those
functions end with obj.
</simpara>
</listitem>
<listitem>
<simpara>
object array: An associated array with all attributes of an
object. The key is the attribute name. If an attribute occurs
more than once in an object record it will result in another
indexed or associated array. Attributes which are language
depended (like the title, keyword, description) will form an
associated array with the key set to the language
abbreviation. All other multiple attributes will form an
indexed array. PHP functions never return object arrays.
object array: An associated array with all attributes of an
object. The key is the attribute name. If an attribute occurs
more than once in an object record it will result in another
indexed or associated array. Attributes which are language
depended (like the title, keyword, description) will form an
associated array with the key set to the language
abbreviation. All other multiple attributes will form an
indexed array. PHP functions never return object arrays.
</simpara>
</listitem>
<listitem>
<simpara>
hw_document: This is a complete new data type which holds the
actual document, e.g. HTML, PDF etc. It is somewhat optimised
for HTML documents but may be used for any format.
hw_document: This is a complete new data type which holds the
actual document, e.g. HTML, PDF etc. It is somewhat optimised
for HTML documents but may be used for any format.
</simpara>
</listitem>
</itemizedlist>
@ -202,54 +201,54 @@
<term>Hidden</term>
<listitem>
<simpara>
Number of object records with attribute PresentationHints
set to Hidden.
</simpara>
</listitem>
Number of object records with attribute PresentationHints
set to Hidden.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>CollectionHead</term>
<listitem>
<simpara>
Number of object records with attribute
PresentationHints set to CollectionHead.
</simpara>
</listitem>
Number of object records with attribute
PresentationHints set to CollectionHead.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>FullCollectionHead</term>
<listitem>
<simpara>
Number of object records with attribute
PresentationHints set to FullCollectionHead.
</simpara>
</listitem>
Number of object records with attribute
PresentationHints set to FullCollectionHead.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>CollectionHeadNr</term>
<listitem>
<simpara>
Index in array of object records with
attribute PresentationHints set to CollectionHead.
</simpara>
</listitem>
Index in array of object records with
attribute PresentationHints set to CollectionHead.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>FullCollectionHeadNr</term>
<listitem>
<simpara>
Index in array of object records with
attribute PresentationHints set to FullCollectionHead.
</simpara>
</listitem>
Index in array of object records with
attribute PresentationHints set to FullCollectionHead.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>Total</term>
<listitem>
<simpara>
Total: Number of object records.
</simpara>
</listitem>
Total: Number of object records.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
@ -316,31 +315,31 @@ RewriteEngine on
<itemizedlist>
<listitem>
<simpara>
to return the object itself
</simpara>
</listitem>
to return the object itself
</simpara>
</listitem>
<listitem>
<simpara>
to allow searching
</simpara>
</listitem>
to allow searching
</simpara>
</listitem>
<listitem>
<simpara>
to identify yourself
</simpara>
</listitem>
to identify yourself
</simpara>
</listitem>
<listitem>
<simpara>
to set your profile
</simpara>
</listitem>
to set your profile
</simpara>
</listitem>
<listitem>
<simpara>
one for each additional function like to show
the object attributes, to show information about users,
to show the status of the server, etc.
</simpara>
</listitem>
one for each additional function like to show
the object attributes, to show information about users,
to show the status of the server, etc.
</simpara>
</listitem>
</itemizedlist>
</para>
</sect1>
@ -351,15 +350,15 @@ RewriteEngine on
There are still some things todo:
<itemizedlist>
<listitem><simpara>The hw_InsertDocument has to be split into
<function>hw_insertobject</function> and
<function>hw_putdocument</function>.</simpara></listitem>
<function>hw_insertobject</function> and
<function>hw_putdocument</function>.</simpara></listitem>
<listitem><simpara>The names of several functions are not fixed, yet.
</simpara></listitem>
<listitem><simpara>Most functions require the current connection
as its first parameter. This leads to a lot of typing, which
is quite often not necessary if there is just one open
connection. A default connection will
improve this.</simpara></listitem>
as its first parameter. This leads to a lot of typing, which
is quite often not necessary if there is just one open
connection. A default connection will
improve this.</simpara></listitem>
<listitem><simpara>Conversion form object record into object array
needs to handle any multiple attribute.
</simpara></listitem>

20
functions/ibase.xml
View file

@ -1,5 +1,5 @@
<?xml encoding="iso-8859-1"?>
<!-- $Revision: 1.30 $ -->
<!-- $Revision: 1.31 $ -->
<reference id="ref.ibase">
<title>InterBase functions</title>
<titleabbrev>InterBase</titleabbrev>
@ -15,16 +15,16 @@
<para>
Full support for InterBase 6 was added in PHP 4.0.
</para>
<para>
This database uses a single quote (') character for escaping, a
behavior similar to the Sybase database, add to your
<filename>php.ini</filename> the following directive:
<informalexample>
<programlisting>
<para>
This database uses a single quote (') character for escaping, a
behavior similar to the Sybase database, add to your
<filename>php.ini</filename> the following directive:
<informalexample>
<programlisting>
magic_quotes_sybase = On
</programlisting>
</informalexample>
</para>
</programlisting>
</informalexample>
</para>
</note>
</partintro>

82
functions/icap.xml
View file

@ -1,5 +1,5 @@
<?xml encoding="iso-8859-1"?>
<!-- $Revision: 1.11 $ -->
<!-- $Revision: 1.12 $ -->
<reference id="ref.icap">
<title>ICAP Functions</title>
<titleabbrev>ICAP</titleabbrev>
@ -88,43 +88,43 @@
<itemizedlist>
<listitem>
<simpara>
int id - ID of that event.
int id - ID of that event.
</simpara>
</listitem>
<listitem>
<simpara>
int public - &true; if the event if public, &false; if it is private.
int public - &true; if the event if public, &false; if it is private.
</simpara>
</listitem>
<listitem>
<simpara>
string category - Category string of the event.
string category - Category string of the event.
</simpara>
</listitem>
<listitem>
<simpara>
string title - Title string of the event.
string title - Title string of the event.
</simpara>
</listitem>
<listitem>
<simpara>
string description - Description string of the event.
string description - Description string of the event.
</simpara>
</listitem>
<listitem>
<simpara>
int alarm - number of minutes before the event to send an
alarm/reminder.
int alarm - number of minutes before the event to send an
alarm/reminder.
</simpara>
</listitem>
<listitem>
<simpara>
object start - Object containing a datetime entry.
object start - Object containing a datetime entry.
</simpara>
</listitem>
<listitem>
<simpara>
object end - Object containing a datetime entry.
object end - Object containing a datetime entry.
</simpara>
</listitem>
</itemizedlist>
@ -132,32 +132,32 @@
<itemizedlist>
<listitem>
<simpara>
int year - year
int year - year
</simpara>
</listitem>
<listitem>
<simpara>
int month - month
int month - month
</simpara>
</listitem>
<listitem>
<simpara>
int mday - day of month
int mday - day of month
</simpara>
</listitem>
<listitem>
<simpara>
int hour - hour
int hour - hour
</simpara>
</listitem>
<listitem>
<simpara>
int min - minutes
int min - minutes
</simpara>
</listitem>
<listitem>
<simpara>
int sec - seconds
int sec - seconds
</simpara></listitem>
</itemizedlist>
</para>
@ -198,32 +198,32 @@
<itemizedlist>
<listitem>
<simpara>
int year - year
int year - year
</simpara>
</listitem>
<listitem>
<simpara>
int month - month
int month - month
</simpara>
</listitem>
<listitem>
<simpara>
int mday - day of month
int mday - day of month
</simpara>
</listitem>
<listitem>
<simpara>
int hour - hour
int hour - hour
</simpara>
</listitem>
<listitem>
<simpara>
int min - minutes
int min - minutes
</simpara>
</listitem>
<listitem>
<simpara>
int sec - seconds
int sec - seconds
</simpara>
</listitem>
</itemizedlist>
@ -251,37 +251,37 @@
<itemizedlist>
<listitem>
<simpara>
int public - 1 if public, 0 if private;
int public - 1 if public, 0 if private;
</simpara>
</listitem>
<listitem>
<simpara>
string caegory - Category string of the event.
string caegory - Category string of the event.
</simpara>
</listitem>
<listitem>
<simpara>
string title - Title string of the event.
string title - Title string of the event.
</simpara>
</listitem>
<listitem>
<simpara>
string description - Description string of the event.
string description - Description string of the event.
</simpara>
</listitem>
<listitem>
<simpara>
int alarm - Number of minutes before the event to sned out an alarm.
int alarm - Number of minutes before the event to sned out an alarm.
</simpara>
</listitem>
<listitem>
<simpara>
datetime start - datetime object of the start of the event.
datetime start - datetime object of the start of the event.
</simpara>
</listitem>
<listitem>
<simpara>
datetime end - datetime object of the end of the event.
datetime end - datetime object of the end of the event.
</simpara>
</listitem>
</itemizedlist>
@ -291,32 +291,32 @@
<itemizedlist>
<listitem>
<simpara>
int year - year
int year - year
</simpara>
</listitem>
<listitem>
<simpara>
int month - month
int month - month
</simpara>
</listitem>
<listitem>
<simpara>
int mday - day of month
int mday - day of month
</simpara>
</listitem>
<listitem>
<simpara>
int hour - hour
int hour - hour
</simpara>
</listitem>
<listitem>
<simpara>
int min - minutes
int min - minutes
</simpara>
</listitem>
<listitem>
<simpara>
int sec - seconds
int sec - seconds
</simpara>
</listitem>
</itemizedlist>
@ -407,32 +407,32 @@
<itemizedlist>
<listitem>
<simpara>
int year - year
int year - year
</simpara>
</listitem>
<listitem>
<simpara>
int month - month
int month - month
</simpara>
</listitem>
<listitem>
<simpara>
int mday - day of month
int mday - day of month
</simpara>
</listitem>
<listitem>
<simpara>
int hour - hour
int hour - hour
</simpara>
</listitem>
<listitem>
<simpara>
int min - minutes
int min - minutes
</simpara>
</listitem>
<listitem>
<simpara>
int sec - seconds
int sec - seconds
</simpara>
</listitem>
</itemizedlist>

8
functions/image.xml
View file

@ -1,5 +1,5 @@
<?xml encoding="iso-8859-1"?>
<!-- $Revision: 1.55 $ -->
<!-- $Revision: 1.56 $ -->
<reference id="ref.image">
<title>Image functions</title>
<titleabbrev>Image</titleabbrev>
@ -88,9 +88,9 @@
pictures. <literal>bits</literal> is the number of bits for each color.
</para>
<para>
If accessing the <parameter>filename</parameter> image is impossible,
or if it isn't a valid picture, <function>getimagesize</function>
will return &null; and generate a warning.
If accessing the <parameter>filename</parameter> image is impossible,
or if it isn't a valid picture, <function>getimagesize</function>
will return &null; and generate a warning.
</para>
<para>
The optional <parameter>imageinfo</parameter> parameter allows

404
functions/imap.xml
View file

@ -1,5 +1,5 @@
<?xml encoding="iso-8859-1"?>
<!-- $Revision: 1.50 $ -->
<!-- $Revision: 1.51 $ -->
<reference id='ref.imap'>
<title>IMAP, POP3 and NNTP functions</title>
<titleabbrev>IMAP</titleabbrev>
@ -26,62 +26,62 @@
</simpara>
<para>
This document can't go into detail on all the topics touched by
the provided functions. Further information is provided by the
documentation of the c-client library source
(<filename>docs/internal.txt</filename>). and the following RFC
documents:
the provided functions. Further information is provided by the
documentation of the c-client library source
(<filename>docs/internal.txt</filename>). and the following RFC
documents:
<itemizedlist>
<listitem>
<simpara>
<ulink url="&url.rfc;rfc2821.html">RFC2821</ulink>: Simple Mail
Transfer Protocol (SMTP).
Transfer Protocol (SMTP).
</simpara>
</listitem>
<listitem>
<simpara>
<ulink url="&url.rfc;rfc2822.html">RFC2822</ulink>: Standard for
ARPA internet text messages.
ARPA internet text messages.
</simpara>
</listitem>
<listitem>
<simpara>
<ulink url="&url.rfc;rfc2060.html">RFC2060</ulink>: Internet
Message Access Protocol (IMAP) Version 4rev1.
Message Access Protocol (IMAP) Version 4rev1.
</simpara>
</listitem>
<listitem>
<simpara>
<ulink url="&url.rfc;rfc1939.html">RFC1939</ulink>: Post
Office Protocol Version 3 (POP3).
Office Protocol Version 3 (POP3).
</simpara>
</listitem>
<listitem>
<simpara>
<ulink url="&url.rfc;rfc977.html">RFC977</ulink>: Network News
Transfer Protocol (NNTP).
Transfer Protocol (NNTP).
</simpara>
</listitem>
<listitem>
<simpara>
<ulink url="&url.rfc;rfc2076.html">RFC2076</ulink>: Common
Internet Message Headers.
Internet Message Headers.
</simpara>
</listitem>
<listitem>
<simpara>
<ulink url="&url.rfc;rfc2045.html">RFC2045</ulink> , <ulink
url="&url.rfc;rfc2046.html">RFC2046</ulink> , <ulink
url="&url.rfc;rfc2047.html">RFC2047</ulink> , <ulink
url="&url.rfc;rfc2048.html">RFC2048</ulink> &amp; <ulink
url="&url.rfc;rfc2049.html">RFC2049</ulink>: Multipurpose
Internet Mail Extensions (MIME).
url="&url.rfc;rfc2046.html">RFC2046</ulink> , <ulink
url="&url.rfc;rfc2047.html">RFC2047</ulink> , <ulink
url="&url.rfc;rfc2048.html">RFC2048</ulink> &amp; <ulink
url="&url.rfc;rfc2049.html">RFC2049</ulink>: Multipurpose
Internet Mail Extensions (MIME).
</simpara>
</listitem>
</itemizedlist>
A detailed overview is also available in the books
<ulink url="&url.email.book;">Programming Internet Email</ulink>
by David Wood and <ulink url="&url.imap.book;">Managing
IMAP</ulink> by Dianna Mullet &amp; Kevin Mullet.
A detailed overview is also available in the books
<ulink url="&url.email.book;">Programming Internet Email</ulink>
by David Wood and <ulink url="&url.imap.book;">Managing
IMAP</ulink> by Dianna Mullet &amp; Kevin Mullet.
</para>
</partintro>
@ -278,28 +278,28 @@ imap_close($stream);
<itemizedlist>
<listitem>
<simpara>
FT_UID - The <parameter>msgno</parameter> is a UID
FT_UID - The <parameter>msgno</parameter> is a UID
</simpara>
</listitem>
<listitem>
<simpara>
FT_PEEK - Do not set the \Seen flag if not already set
FT_PEEK - Do not set the \Seen flag if not already set
</simpara>
</listitem>
<listitem>
<simpara>
FT_INTERNAL - The return string is in internal format, will
not canonicalize to CRLF.
FT_INTERNAL - The return string is in internal format, will
not canonicalize to CRLF.
</simpara>
</listitem>
</itemizedlist>
</para>
<para>
<para>
<function>imap_body</function> will only return a verbatim copy of the
message body. To extract single parts of a multipart MIME-encoded
message you have to use <function>imap_fetchstructure</function> to
analyze its structure and <function>imap_fetchbody</function> to
extract a copy of a single body component.
extract a copy of a single body component.
</para>
</refsect1>
</refentry>
@ -335,22 +335,22 @@ imap_close($stream);
</listitem>
<listitem>
<simpara>
Driver - protocol used to access this mailbox: POP3, IMAP, NNTP
Driver - protocol used to access this mailbox: POP3, IMAP, NNTP
</simpara>
</listitem>
<listitem>
<simpara>
Mailbox - the mailbox name
Mailbox - the mailbox name
</simpara>
</listitem>
<listitem>
<simpara>
Nmsgs - number of messages in the mailbox
Nmsgs - number of messages in the mailbox
</simpara>
</listitem>
<listitem>
<simpara>
Recent - number of recent messages in the mailbox
Recent - number of recent messages in the mailbox
</simpara>
</listitem>
</itemizedlist>
@ -800,18 +800,18 @@ imap_close($mbox);
<itemizedlist>
<listitem>
<simpara>
FT_UID - The <parameter>msg_number</parameter> is a UID
FT_UID - The <parameter>msg_number</parameter> is a UID
</simpara>
</listitem>
<listitem>
<simpara>
FT_PEEK - Do not set the \Seen flag if not already set
FT_PEEK - Do not set the \Seen flag if not already set
</simpara>
</listitem>
<listitem>
<simpara>
FT_INTERNAL - The return string is in "internal" format,
without any attempt to canonicalize CRLF.
FT_INTERNAL - The return string is in "internal" format,
without any attempt to canonicalize CRLF.
</simpara>
</listitem>
</itemizedlist>
@ -901,74 +901,74 @@ FT_PREFETCHTEXT The RFC822.TEXT should be pre-fetched at the
</title>
<tgroup cols="2">
<tbody>
<row>
<entry>type</entry>
<entry>Primary body type</entry>
</row>
<row>
<entry>encoding</entry>
<entry>Body transfer encoding</entry>
</row>
<row>
<entry>ifsubtype</entry>
<entry>&true; if there is a subtype string</entry>
</row>
<row>
<entry>subtype</entry>
<entry><acronym>MIME</acronym> subtype</entry>
</row>
<row>
<entry>ifdescription</entry>
<entry>&true; if there is a description string</entry>
</row>
<row>
<entry>description</entry>
<entry>Content description string</entry>
</row>
<row>
<entry>ifid</entry>
<entry>&true; if there is an identification string</entry>
</row>
<row>
<entry>id</entry>
<entry>Identification string</entry>
</row>
<row>
<entry>lines</entry>
<entry>Number of lines</entry>
</row>
<row>
<entry>bytes</entry>
<entry>Number of bytes</entry>
</row>
<row>
<entry>ifdisposition</entry>
<entry>&true; if there is a disposition string</entry>
</row>
<row>
<entry>disposition</entry>
<entry>Disposition string</entry>
</row>
<row>
<entry>ifdparameters</entry>
<entry>&true; if the dparameters array exists</entry>
</row>
<row>
<entry>dparameters</entry>
<entry>Disposition parameter array</entry>
</row>
<row>
<entry>ifparameters</entry>
<entry>&true; if the parameters array exists</entry>
</row>
<row>
<entry>parameters</entry>
<entry><acronym>MIME</acronym> parameters array</entry>
</row>
<row>
<entry>parts</entry>
<entry>Array of objects describing each message part</entry>
</row>
<row>
<entry>type</entry>
<entry>Primary body type</entry>
</row>
<row>
<entry>encoding</entry>
<entry>Body transfer encoding</entry>
</row>
<row>
<entry>ifsubtype</entry>
<entry>&true; if there is a subtype string</entry>
</row>
<row>
<entry>subtype</entry>
<entry><acronym>MIME</acronym> subtype</entry>
</row>
<row>
<entry>ifdescription</entry>
<entry>&true; if there is a description string</entry>
</row>
<row>
<entry>description</entry>
<entry>Content description string</entry>
</row>
<row>
<entry>ifid</entry>
<entry>&true; if there is an identification string</entry>
</row>
<row>
<entry>id</entry>
<entry>Identification string</entry>
</row>
<row>
<entry>lines</entry>
<entry>Number of lines</entry>
</row>
<row>
<entry>bytes</entry>
<entry>Number of bytes</entry>
</row>
<row>
<entry>ifdisposition</entry>
<entry>&true; if there is a disposition string</entry>
</row>
<row>
<entry>disposition</entry>
<entry>Disposition string</entry>
</row>
<row>
<entry>ifdparameters</entry>
<entry>&true; if the dparameters array exists</entry>
</row>
<row>
<entry>dparameters</entry>
<entry>Disposition parameter array</entry>
</row>
<row>
<entry>ifparameters</entry>
<entry>&true; if the parameters array exists</entry>
</row>
<row>
<entry>parameters</entry>
<entry><acronym>MIME</acronym> parameters array</entry>
</row>
<row>
<entry>parts</entry>
<entry>Array of objects describing each message part</entry>
</row>
</tbody>
</tgroup>
</table>
@ -977,21 +977,21 @@ FT_PREFETCHTEXT The RFC822.TEXT should be pre-fetched at the
<orderedlist>
<listitem>
<para>
dparameters is an array of objects where each object has an
"attribute" and a "value" property.
dparameters is an array of objects where each object has an
"attribute" and a "value" property.
</para>
</listitem>
<listitem>
<para>
Parameter is an array of objects where each object has an
"attributte" and a "value" property.
Parameter is an array of objects where each object has an
"attributte" and a "value" property.
</para>
</listitem>
<listitem>
<para>
Parts is an array of objects identical in structure to the
top-level object, with the limitation that it cannot contain
further 'parts' objects.
Parts is an array of objects identical in structure to the
top-level object, with the limitation that it cannot contain
further 'parts' objects.
</para>
</listitem>
</orderedlist>
@ -1120,25 +1120,25 @@ imap_close($mbox);
<itemizedlist>
<listitem>
<simpara>
LATT_NOINFERIORS - This mailbox has no "children" (there are
no mailboxes below this one).
LATT_NOINFERIORS - This mailbox has no "children" (there are
no mailboxes below this one).
</simpara>
</listitem>
<listitem>
<simpara>
LATT_NOSELECT - This is only a container, not a mailbox - you
cannot open it.
LATT_NOSELECT - This is only a container, not a mailbox - you
cannot open it.
</simpara>
</listitem>
<listitem>
<simpara>
LATT_MARKED - This mailbox is marked. Only used by UW-IMAPD.
LATT_MARKED - This mailbox is marked. Only used by UW-IMAPD.
</simpara>
</listitem>
<listitem>
<simpara>
LATT_UNMARKED - This mailbox is not marked. Only used by
UW-IMAPD.
LATT_UNMARKED - This mailbox is not marked. Only used by
UW-IMAPD.
</simpara>
</listitem>
</itemizedlist>
@ -1190,9 +1190,9 @@ imap_close($mbox);
</programlisting>
</example>
</para>
<para>
See also <function>imap_getsubscribed</function>.
</para>
<para>
See also <function>imap_getsubscribed</function>.
</para>
</refsect1>
</refentry>
@ -1614,13 +1614,13 @@ echo nl2br(imap_mail_compose($envelope,$body));
<itemizedlist>
<listitem>
<simpara>
CP_UID - the sequence numbers contain UIDS
CP_UID - the sequence numbers contain UIDS
</simpara>
</listitem>
<listitem>
<simpara>
CP_MOVE - Delete the messages from the current mailbox after
copying
CP_MOVE - Delete the messages from the current mailbox after
copying
</simpara>
</listitem>
</itemizedlist>
@ -1657,7 +1657,7 @@ echo nl2br(imap_mail_compose($envelope,$body));
<itemizedlist>
<listitem>
<simpara>
CP_UID - the sequence numbers contain UIDS
CP_UID - the sequence numbers contain UIDS
</simpara>
</listitem>
</itemizedlist>
@ -1699,37 +1699,37 @@ echo nl2br(imap_mail_compose($envelope,$body));
<tgroup cols="2">
<tbody>
<row>
<entry>Date</entry>
<entry>date of last change</entry>
</row>
<entry>Date</entry>
<entry>date of last change</entry>
</row>
<row>
<entry>Driver</entry>
<entry>driver</entry>
</row>
<entry>Driver</entry>
<entry>driver</entry>
</row>
<row>
<entry>Mailbox</entry>
<entry>name of the mailbox</entry>
</row>
<entry>Mailbox</entry>
<entry>name of the mailbox</entry>
</row>
<row>
<entry>Nmsgs</entry>
<entry>number of messages</entry>
</row>
<entry>Nmsgs</entry>
<entry>number of messages</entry>
</row>
<row>
<entry>Recent</entry>
<entry>number of recent messages</entry>
</row>
<entry>Recent</entry>
<entry>number of recent messages</entry>
</row>
<row>
<entry>Unread</entry>
<entry>number of unread messages</entry>
</row>
<entry>Unread</entry>
<entry>number of unread messages</entry>
</row>
<row>
<entry>Deleted</entry>
<entry>number of deleted messages</entry>
</row>
<entry>Deleted</entry>
<entry>number of deleted messages</entry>
</row>
<row>
<entry>Size</entry>
<entry>mailbox size</entry>
</row>
<entry>Size</entry>
<entry>mailbox size</entry>
</row>
</tbody>
</tgroup>
</table>
@ -1798,8 +1798,8 @@ $text="=?ISO-8859-1?Q?Keld_J=F8rn_Simonsen?= &lt;keld@dkuug.dk>";
$elements=imap_mime_header_decode($text);
for($i=0;$i&lt;count($elements);$i++) {
echo "Charset: {$elements[$i]->charset}\n";
echo "Text: {$elements[$i]->text}\n\n";
echo "Charset: {$elements[$i]->charset}\n";
echo "Text: {$elements[$i]->text}\n\n";
}
</programlisting>
@ -1927,24 +1927,24 @@ for($i=0;$i&lt;count($elements);$i++) {
<itemizedlist>
<listitem>
<simpara>
OP_READONLY - Open mailbox read-only
OP_READONLY - Open mailbox read-only
</simpara>
</listitem>
<listitem>
<simpara>
OP_ANONYMOUS - Dont use or update a
<filename>.newsrc</filename> for news (NNTP only)
OP_ANONYMOUS - Dont use or update a
<filename>.newsrc</filename> for news (NNTP only)
</simpara>
</listitem>
<listitem>
<simpara>
OP_HALFOPEN - For IMAP and NNTP names, open a connection but
dont open a mailbox
OP_HALFOPEN - For IMAP and NNTP names, open a connection but
dont open a mailbox
</simpara>
</listitem>
<listitem>
<simpara>
CL_EXPUNGE - Expunge mailbox automatically upon mailbox close
CL_EXPUNGE - Expunge mailbox automatically upon mailbox close
</simpara>
</listitem>
</itemizedlist>
@ -2135,26 +2135,26 @@ imap_close($mbox);
<itemizedlist>
<listitem>
<simpara>
OP_READONLY - Open mailbox read-only
OP_READONLY - Open mailbox read-only
</simpara>
</listitem>
<listitem>
<simpara>
OP_ANONYMOUS - Dont use or update a
<filename>.newsrc</filename> for news (NNTP only)
OP_ANONYMOUS - Dont use or update a
<filename>.newsrc</filename> for news (NNTP only)
</simpara>
</listitem>
<listitem>
<simpara>
OP_HALFOPEN - For IMAP and NNTP names, open a connection but
dont open a mailbox.
OP_HALFOPEN - For IMAP and NNTP names, open a connection but
dont open a mailbox.
</simpara>
</listitem>
<listitem>
<simpara>
CL_EXPUNGE - Expunge mailbox automatically upon mailbox close
(see also <function>imap_delete</function> and
<function>imap_expunge</function>)
CL_EXPUNGE - Expunge mailbox automatically upon mailbox close
(see also <function>imap_delete</function> and
<function>imap_expunge</function>)
</simpara>
</listitem>
</itemizedlist>
@ -2350,124 +2350,124 @@ print imap_rfc822_write_address("hartmut","cvs.php.net","Hartmut Holzgraefe")."\
<itemizedlist>
<listitem>
<simpara>
ALL - return all messages matching the rest of the criteria
ALL - return all messages matching the rest of the criteria
</simpara>
</listitem>
<listitem>
<simpara>
ANSWERED - match messages with the \\ANSWERED flag set
ANSWERED - match messages with the \\ANSWERED flag set
</simpara>
</listitem>
<listitem>
<simpara>
BCC "string" - match messages with "string" in the Bcc: field
BCC "string" - match messages with "string" in the Bcc: field
</simpara>
</listitem>
<listitem>
<simpara>
BEFORE "date" - match messages with Date: before "date"
BEFORE "date" - match messages with Date: before "date"
</simpara>
</listitem>
<listitem>
<simpara>
BODY "string" - match messages with "string" in the body of the message
BODY "string" - match messages with "string" in the body of the message
</simpara>
</listitem>
<listitem>
<simpara>
CC "string" - match messages with "string" in the Cc: field
CC "string" - match messages with "string" in the Cc: field
</simpara>
</listitem>
<listitem>
<simpara>
DELETED - match deleted messages
DELETED - match deleted messages
</simpara>
</listitem>
<listitem>
<simpara>
FLAGGED - match messages with the \\FLAGGED (sometimes
referred to as Important or Urgent) flag set
FLAGGED - match messages with the \\FLAGGED (sometimes
referred to as Important or Urgent) flag set
</simpara>
</listitem>
<listitem>
<simpara>
FROM "string" - match messages with "string" in the From: field
FROM "string" - match messages with "string" in the From: field
</simpara>
</listitem>
<listitem>
<simpara>
KEYWORD "string" - match messages with "string" as a keyword
KEYWORD "string" - match messages with "string" as a keyword
</simpara>
</listitem>
<listitem>
<simpara>
NEW - match new messages
NEW - match new messages
</simpara>
</listitem>
<listitem>
<simpara>
OLD - match old messages
OLD - match old messages
</simpara>
</listitem>
<listitem>
<simpara>
ON "date" - match messages with Date: matching "date"
ON "date" - match messages with Date: matching "date"
</simpara>
</listitem>
<listitem>
<simpara>
RECENT - match messages with the \\RECENT flag set
RECENT - match messages with the \\RECENT flag set
</simpara>
</listitem>
<listitem>
<simpara>
SEEN - match messages that have been read (the \\SEEN flag is set)
SEEN - match messages that have been read (the \\SEEN flag is set)
</simpara>
</listitem>
<listitem>
<simpara>
SINCE "date" - match messages with Date: after "date"
SINCE "date" - match messages with Date: after "date"
</simpara>
</listitem>
<listitem>
<simpara>
SUBJECT "string" - match messages with "string" in the Subject:
SUBJECT "string" - match messages with "string" in the Subject:
</simpara>
</listitem>
<listitem>
<simpara>
TEXT "string" - match messages with text "string"
TEXT "string" - match messages with text "string"
</simpara>
</listitem>
<listitem>
<simpara>
TO "string" - match messages with "string" in the To:
TO "string" - match messages with "string" in the To:
</simpara>
</listitem>
<listitem>
<simpara>
UNANSWERED - match messages that have not been answered
UNANSWERED - match messages that have not been answered
</simpara>
</listitem>
<listitem>
<simpara>
UNDELETED - match messages that are not deleted
UNDELETED - match messages that are not deleted
</simpara>
</listitem>
<listitem>
<simpara>
UNFLAGGED - match messages that are not flagged
UNFLAGGED - match messages that are not flagged
</simpara>
</listitem>
<listitem>
<simpara>
UNKEYWORD "string" - match messages that do not have the
keyword "string"
UNKEYWORD "string" - match messages that do not have the
keyword "string"
</simpara>
</listitem>
<listitem>
<simpara>
UNSEEN - match messages which have not been read yet
UNSEEN - match messages which have not been read yet
</simpara>
</listitem>
</itemizedlist>
@ -2530,8 +2530,8 @@ print imap_rfc822_write_address("hartmut","cvs.php.net","Hartmut Holzgraefe")."\
$mbox = imap_open ("{your.imap.host:143}", "mailadmin", "password");
if(!imap_set_quota($mbox, "user.kalowsky", 3000)) {
print "Error in setting quota\n";
return;
print "Error in setting quota\n";
return;
}
imap_close($mbox);
@ -2671,37 +2671,37 @@ SE_NOPREFETCH Don't prefetch searched messages.
<itemizedlist>
<listitem>
<simpara>
SA_MESSAGES - set status->messages to the number of messages
in the mailbox
SA_MESSAGES - set status->messages to the number of messages
in the mailbox
</simpara>
</listitem>
<listitem>
<simpara>
SA_RECENT - set status->recent to the number of recent
messages in the mailbox
SA_RECENT - set status->recent to the number of recent
messages in the mailbox
</simpara>
</listitem>
<listitem>
<simpara>
SA_UNSEEN - set status->unseen to the number of unseen (new)
messages in the mailbox
SA_UNSEEN - set status->unseen to the number of unseen (new)
messages in the mailbox
</simpara>
</listitem>
<listitem>
<simpara>
SA_UIDNEXT - set status->uidnext to the next uid to be used in
the mailbox
SA_UIDNEXT - set status->uidnext to the next uid to be used in
the mailbox
</simpara>
</listitem>
<listitem>
<simpara>
SA_UIDVALIDITY - set status->uidvalidity to a constant that
changes when uids for the mailbox may no longer be valid
SA_UIDVALIDITY - set status->uidvalidity to a constant that
changes when uids for the mailbox may no longer be valid
</simpara>
</listitem>
<listitem>
<simpara>
SA_ALL - set all of the above
SA_ALL - set all of the above
</simpara>
</listitem>
</itemizedlist>

50
functions/info.xml
View file

@ -1,5 +1,5 @@
<?xml encoding="iso-8859-1"?>
<!-- $Revision: 1.65 $ -->
<!-- $Revision: 1.66 $ -->
<reference id="ref.info">
<title>PHP options &amp; information</title>
<titleabbrev>PHP options/info</titleabbrev>
@ -49,26 +49,26 @@
described in that functions manual page.
</para>
<para>
The <function>assert_options</function> function and/or
ASSERT_CALLBACK configuration directive allow a callback
function to be set to handle failed assertions.
</para>
<para>
<function>assert</function> callbacks are particularly
useful for building automated test suites because they
allow you to easily capture the code passed to the
assertion, along with information on where the assertion
was made. While this information can be captured via other
methods, using assertions makes it much faster and easier!
</para>
<para>
The callback function should accept three arguments. The first
argument will contain the file the assertion failed in. The second
argument will contain the line the assertion failed on and the
third argument will contain the expression that failed (if any - literal
values such as 1 or "two" will not be passed via this argument)
</para>
<para>
The <function>assert_options</function> function and/or
ASSERT_CALLBACK configuration directive allow a callback
function to be set to handle failed assertions.
</para>
<para>
<function>assert</function> callbacks are particularly
useful for building automated test suites because they
allow you to easily capture the code passed to the
assertion, along with information on where the assertion
was made. While this information can be captured via other
methods, using assertions makes it much faster and easier!
</para>
<para>
The callback function should accept three arguments. The first
argument will contain the file the assertion failed in. The second
argument will contain the line the assertion failed on and the
third argument will contain the expression that failed (if any - literal
values such as 1 or "two" will not be passed via this argument)
</para>
<para>
<example>
<title>Handle a failed assertion with a custom handler</title>
<programlisting role="php">
@ -80,10 +80,10 @@ assert_options (ASSERT_QUIET_EVAL, 1);
// Create a handler function
function my_assert_handler ($file, $line, $code) {
echo "&lt;hr&gt;Assertion Failed:
File '$file'&lt;br&gt;
Line '$line'&lt;br&gt;
Code '$code'&lt;br&gt;&lt;hr&gt;";
echo "&lt;hr&gt;Assertion Failed:
File '$file'&lt;br&gt;
Line '$line'&lt;br&gt;
Code '$code'&lt;br&gt;&lt;hr&gt;";
}
// Set up the callback

10
functions/ingres_ii.xml
View file

@ -1,5 +1,5 @@
<?xml encoding="iso-8859-1"?>
<!-- $Revision: 1.11 $ -->
<!-- $Revision: 1.12 $ -->
<reference id="ref.ingres">
<title>Ingres II functions</title>
<titleabbrev>Ingres II</titleabbrev>
@ -252,22 +252,22 @@
<itemizedlist>
<listitem>
<simpara>
close (see <function>ingres_close</function>)
close (see <function>ingres_close</function>)
</simpara>
</listitem>
<listitem>
<simpara>
commit (see <function>ingres_commit</function>)
commit (see <function>ingres_commit</function>)
</simpara>
</listitem>
<listitem>
<simpara>
connect (see <function>ingres_connect</function>)
connect (see <function>ingres_connect</function>)
</simpara>
</listitem>
<listitem>
<simpara>
disconnect (see <function>ingres_close</function>)
disconnect (see <function>ingres_close</function>)
</simpara>
</listitem>
<listitem>

14
functions/mail.xml
View file

@ -1,5 +1,5 @@
<?xml encoding="iso-8859-1"?>
<!-- $Revision: 1.27 $ -->
<!-- $Revision: 1.28 $ -->
<reference id="ref.mail">
<title>Mail functions</title>
<titleabbrev>Mail</titleabbrev>
@ -37,12 +37,12 @@
specified in <parameter>to</parameter>. Multiple recipients can
be specified by putting a comma between each address in
<parameter>to</parameter>. Email with attachments and special
types of content can be sent using this function. This is
accomplished via MIME-encoding - for more information, see
<ulink url="http://www.zend.com/zend/spotlight/sendmimeemailpart1.php"
>http://www.zend.com/zend/spotlight/sendmimeemailpart1.php</ulink> or
RFC 1896 (Visit <ulink url="http://www.rfc-editor.org/"
>http://www.rfc-editor.org/</ulink>).
types of content can be sent using this function. This is
accomplished via MIME-encoding - for more information, see
<ulink url="http://www.zend.com/zend/spotlight/sendmimeemailpart1.php"
>http://www.zend.com/zend/spotlight/sendmimeemailpart1.php</ulink> or
RFC 1896 (Visit <ulink url="http://www.rfc-editor.org/"
>http://www.rfc-editor.org/</ulink>).
</simpara>
<para>
<function>mail</function> returns &true; if the mail

282
functions/mbstring.xml
View file

@ -1,5 +1,5 @@
<?xml encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<!-- $Revision: 1.11 $ -->
<reference id="ref.mbstring">
<title>Multi-Byte String Functions</title>
<titleabbrev>
@ -46,18 +46,18 @@
<itemizedlist>
<listitem>
<simpara>
Per byte encoding
Per byte encoding
</simpara>
</listitem>
<listitem>
<simpara>
Single byte characters in range of <literal>00h-7fh</literal>
which is compatible with <literal>ASCII</literal>
Single byte characters in range of <literal>00h-7fh</literal>
which is compatible with <literal>ASCII</literal>
</simpara>
</listitem>
<listitem>
<simpara>
Multi-byte characters without <literal>00h-7fh</literal>
Multi-byte characters without <literal>00h-7fh</literal>
</simpara>
</listitem>
</itemizedlist>
@ -117,21 +117,21 @@ JIS, SJIS
<para>
<itemizedlist>
<listitem>
<para>
<option role="configure">--enable-mbstring</option> : Enable
<literal>mbstring</literal> functions. This option is
required to use <literal>mbstring</literal> functions.
</para>
<para>
<option role="configure">--enable-mbstring</option> : Enable
<literal>mbstring</literal> functions. This option is
required to use <literal>mbstring</literal> functions.
</para>
</listitem>
<listitem>
<para>
<option role="configure">--enable-mbstr-enc-trans</option> :
Enable HTTP input character encoding conversion using
<literal>mbstring</literal> conversion engine. If this
feature is enabled, HTTP input character encoding may be
converted to <literal>mbstring.internal_encoding</literal>
automatically.
</para>
<para>
<option role="configure">--enable-mbstr-enc-trans</option> :
Enable HTTP input character encoding conversion using
<literal>mbstring</literal> conversion engine. If this
feature is enabled, HTTP input character encoding may be
converted to <literal>mbstring.internal_encoding</literal>
automatically.
</para>
</listitem>
</itemizedlist>
</para>
@ -155,50 +155,50 @@ JIS, SJIS
<para>
<itemizedlist>
<listitem>
<simpara>
HTTP Input
</simpara>
<para> There is no way to control HTTP input character
conversion from PHP script. To disable HTTP input character
conversion, it has to be done in <literal>php.ini</literal>.
<example>
<title>
Disable HTTP input conversion in php.ini
</title>
<programlisting role="php">
<simpara>
HTTP Input
</simpara>
<para> There is no way to control HTTP input character
conversion from PHP script. To disable HTTP input character
conversion, it has to be done in <literal>php.ini</literal>.
<example>
<title>
Disable HTTP input conversion in php.ini
</title>
<programlisting role="php">
;; Disable HTTP Input conversion
mbstring.http_input = pass
</programlisting>
</example>
</para>
<para>
When using PHP as an Apache module, it is possible to
override PHP ini setting per Virtual Host in
<literal>httpd.conf</literal> or per directory with
<literal>.htaccess</literal>. Refer to the <link
linkend="configuration">Configuration</link> section and
Apache Manual for details.
</para>
</programlisting>
</example>
</para>
<para>
When using PHP as an Apache module, it is possible to
override PHP ini setting per Virtual Host in
<literal>httpd.conf</literal> or per directory with
<literal>.htaccess</literal>. Refer to the <link
linkend="configuration">Configuration</link> section and
Apache Manual for details.
</para>
</listitem>
<listitem>
<simpara>
HTTP Output
</simpara>
<para>
There are several ways to enable output character encoding
conversion. One is using <literal>php.ini</literal>, another
is using <function>ob_start</function> with
<function>mb_output_handler</function> as
<literal>ob_start</literal> callback function.
</para>
<note>
<para>
For PHP3-i18n users, <literal>mbstring</literal>'s output
conversion differs from PHP3-i18n. Character encoding is
converted using output buffer.
</para>
</note>
<simpara>
HTTP Output
</simpara>
<para>
There are several ways to enable output character encoding
conversion. One is using <literal>php.ini</literal>, another
is using <function>ob_start</function> with
<function>mb_output_handler</function> as
<literal>ob_start</literal> callback function.
</para>
<note>
<para>
For PHP3-i18n users, <literal>mbstring</literal>'s output
conversion differs from PHP3-i18n. Character encoding is
converted using output buffer.
</para>
</note>
</listitem>
</itemizedlist>
</para>
@ -305,35 +305,35 @@ ob_start('mb_output_handler');
<para>
<itemizedlist>
<listitem>
<simpara>
<literal>mbstring.internal_encoding</literal> defines default
internal character encoding.
</simpara>
<simpara>
<literal>mbstring.internal_encoding</literal> defines default
internal character encoding.
</simpara>
</listitem>
<listitem>
<simpara>
<literal>mbstring.http_input</literal> defines default HTTP
input character encoding.
</simpara>
<simpara>
<literal>mbstring.http_input</literal> defines default HTTP
input character encoding.
</simpara>
</listitem>
<listitem>
<simpara>
<literal>mbstring.http_output</literal> defines default HTTP
output character encoding.
</simpara>
<simpara>
<literal>mbstring.http_output</literal> defines default HTTP
output character encoding.
</simpara>
</listitem>
<listitem>
<simpara>
<literal>mbstring.detect_order</literal> defines default
character code detection order. See also
<function>mb_detect_order</function>.
</simpara>
<simpara>
<literal>mbstring.detect_order</literal> defines default
character code detection order. See also
<function>mb_detect_order</function>.
</simpara>
</listitem>
<listitem>
<simpara>
<literal>mbstring.substitute_character</literal> defines
character to substitute for invalid character encoding.
</simpara>
<simpara>
<literal>mbstring.substitute_character</literal> defines
character to substitute for invalid character encoding.
</simpara>
</listitem>
</itemizedlist>
</para>
@ -369,7 +369,7 @@ mbstring.internal_encoding = UTF-8 ; Set internal encoding to UTF-8
;; Note: Script cannot change http_input setting.
mbstring.http_input = pass ; No conversion.
mbstring.http_input = auto ; Set HTTP input to auto
; "auto" is expanded to "ASCII,JIS,UTF-8,EUC-JP,SJIS"
; "auto" is expanded to "ASCII,JIS,UTF-8,EUC-JP,SJIS"
mbstring.http_input = SJIS ; Set HTTP2 input to SJIS
mbstring.http_input = UTF-8,SJIS,EUC-JP ; Specify order
@ -457,33 +457,33 @@ mbstring.substitute_character = none
<para>
<itemizedlist>
<listitem>
<simpara>Storage for a character can be up to four
bytes</simpara>
<simpara>Storage for a character can be up to four
bytes</simpara>
</listitem>
<listitem>
<simpara>
A multi-byte character is usually twice of the width compared
to single-byte characters. Wider characters are called
"zen-kaku" - meaning full width, narrower characters are
called "han-kaku" - meaning half width. "zen-kaku" characters
are usually fixed width.
</simpara>
<simpara>
A multi-byte character is usually twice of the width compared
to single-byte characters. Wider characters are called
"zen-kaku" - meaning full width, narrower characters are
called "han-kaku" - meaning half width. "zen-kaku" characters
are usually fixed width.
</simpara>
</listitem>
<listitem>
<simpara>
Some character encoding defines shift(escape) sequence for
entering/exiting multi-byte character strings.
</simpara>
<simpara>
Some character encoding defines shift(escape) sequence for
entering/exiting multi-byte character strings.
</simpara>
</listitem>
<listitem>
<simpara>
ISO-2022-JP must be used for SMTP/NNTP.
</simpara>
<simpara>
ISO-2022-JP must be used for SMTP/NNTP.
</simpara>
</listitem>
<listitem>
<para>
&quot;i-mode&quot; web site is supposed to use SJIS.
</para>
<para>
&quot;i-mode&quot; web site is supposed to use SJIS.
</para>
</listitem>
</itemizedlist>
</para>
@ -498,23 +498,23 @@ mbstring.substitute_character = none
further readings.
<itemizedlist>
<listitem>
<para>
Unicode/UTF/UCS/etc
</para>
<para>
<literal>http://www.unicode.org/</literal>
</para>
<para>
Unicode/UTF/UCS/etc
</para>
<para>
<literal>http://www.unicode.org/</literal>
</para>
</listitem>
<listitem>
<para>
Japanese/Korean/Chinese character
information
</para>
<para>
<literal>
ftp://ftp.ora.com/pub/examples/nutshell/ujip/doc/cjk.inf
</literal>
</para>
<para>
Japanese/Korean/Chinese character
information
</para>
<para>
<literal>
ftp://ftp.ora.com/pub/examples/nutshell/ujip/doc/cjk.inf
</literal>
</para>
</listitem>
</itemizedlist>
</para>
@ -540,7 +540,7 @@ mbstring.substitute_character = none
<parameter><optional>language</optional></parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
&warn.experimental.func;
<para>
<function>mb_language</function> sets language. If
<parameter>language</parameter> is omitted, it returns current
@ -593,7 +593,7 @@ mbstring.substitute_character = none
</paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
&warn.experimental.func;
<para>
<function>mb_parse_str</function> parses GET/POST/COOKIE data and
sets global variables. Since PHP does not provide raw POST/COOKIE
@ -636,7 +636,7 @@ mbstring.substitute_character = none
<parameter><optional>encoding</optional></parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
&warn.experimental.func;
<para>
<function>mb_internal_encoding</function> sets internal character
encoding to <parameter>encoding</parameter> If parameter is
@ -693,7 +693,7 @@ echo mb_internal_encoding();
</paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
&warn.experimental.func;
<simpara>
<function>mb_http_input</function> returns result of HTTP input
character encoding detection.
@ -732,7 +732,7 @@ echo mb_internal_encoding();
</paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
&warn.experimental.func;
<para>
If <parameter>encoding</parameter> is set,
<function>mb_http_output</function> sets HTTP output character
@ -772,7 +772,7 @@ echo mb_internal_encoding();
</paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
&warn.experimental.func;
<para>
<function>mb_detect_order</function> sets automatic character
encoding detection order to <parameter>encoding-list</parameter>.
@ -870,7 +870,7 @@ echo implode(", ", mb_detect_order());
</paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
&warn.experimental.func;
<para>
<function>mb_substitute_character</function> specifies
substitution character when input character encoding is invalid
@ -888,13 +888,13 @@ echo implode(", ", mb_detect_order());
<itemizedlist>
<listitem>
<simpara>
&quot;none&quot; : no output
&quot;none&quot; : no output
</simpara>
</listitem>
<listitem>
<simpara>
&quot;long&quot; : Output character code value (Example:
U+3000,JIS+7E7E)
&quot;long&quot; : Output character code value (Example:
U+3000,JIS+7E7E)
</simpara>
</listitem>
</itemizedlist>
@ -940,7 +940,7 @@ echo mb_substitute_character();
<paramdef>int <parameter>status</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
&warn.experimental.func;
<para>
<function>mb_output_handler</function> is
<function>ob_start</function> callback
@ -1012,7 +1012,7 @@ ob_start("mb_output_handler");
<paramdef>string <parameter>encoding</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
&warn.experimental.func;
<para>
<function>mb_preferred_mime_name</function> returns MIME
<literal>charset</literal> string for character encoding
@ -1049,7 +1049,7 @@ header("Content-Type: text/html; charset=" . mb_preferred_mime_name($outputenc))
</paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
&warn.experimental.func;
<para>
<function>mb_strlen</function> returns number of characters in
string <parameter>str</parameter> having character encoding
@ -1090,7 +1090,7 @@ header("Content-Type: text/html; charset=" . mb_preferred_mime_name($outputenc))
</paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
&warn.experimental.func;
<para>
<function>mb_strpos</function> returns the numeric position of
the first occurrence of <parameter>needle</parameter> in the
@ -1147,7 +1147,7 @@ header("Content-Type: text/html; charset=" . mb_preferred_mime_name($outputenc))
</paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
&warn.experimental.func;
<para>
<function>mb_strrpos</function> returns the numeric position of
the last occurrence of <parameter>needle</parameter> in the
@ -1200,7 +1200,7 @@ header("Content-Type: text/html; charset=" . mb_preferred_mime_name($outputenc))
</paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
&warn.experimental.func;
<para>
<function>mb_substr</function> returns the portion of
<parameter>str</parameter> specified by the
@ -1250,7 +1250,7 @@ header("Content-Type: text/html; charset=" . mb_preferred_mime_name($outputenc))
</paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
&warn.experimental.func;
<para>
<function>mb_strcut</function> returns the portion of
<parameter>str</parameter> specified by the
@ -1297,7 +1297,7 @@ header("Content-Type: text/html; charset=" . mb_preferred_mime_name($outputenc))
</paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
&warn.experimental.func;
<para>
<function>mb_strwidth</function> returns width of string
<parameter>str</parameter>.
@ -1349,7 +1349,7 @@ header("Content-Type: text/html; charset=" . mb_preferred_mime_name($outputenc))
</paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
&warn.experimental.func;
<para>
<function>mb_strimwidth</function> truncates string
<parameter>str</parameter> to specified
@ -1403,7 +1403,7 @@ $str = mb_strimwidth($str, 0, 40, "..>");
</paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
&warn.experimental.func;
<para>
<function>mb_convert_encoding</function> converts
character encoding of string <parameter>str</parameter> from
@ -1459,7 +1459,7 @@ $str = mb_convert_encoding($str, "EUC-JP", "auto");
</paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
&warn.experimental.func;
<para>
<function>mb_detect_encoding</function> detects character
encoding in string <parameter>str</parameter>. It returns
@ -1520,7 +1520,7 @@ echo mb_detect_encoding($str, $ary);
</paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
&warn.experimental.func;
<para>
<function>mb_convert_kana</function> performs "han-kaku" -
"zen-kaku" conversion for string <parameter>str</parameter>. It
@ -1599,7 +1599,7 @@ $str = mb_convert_kana($str, "KVa");
</paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
&warn.experimental.func;
<para>
<function>mb_encode_mimeheader</function> converts string
<parameter>str</parameter> to encoded-word for header field.
@ -1650,7 +1650,7 @@ echo $addr;
<paramdef>string <parameter>str</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
&warn.experimental.func;
<para>
<function>mb_decode_mimeheader</function> decodes encoded-word
string <parameter>str</parameter> in MIME header.
@ -1679,7 +1679,7 @@ echo $addr;
<paramdef>mixed <parameter>vars</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
&warn.experimental.func;
<para>
<function>mb_convert_variables</function> convert
character encoding of variables <parameter>vars</parameter> in
@ -1738,7 +1738,7 @@ $inputenc = mb_convert_variables($interenc, "ASCII,UTF-8,SJIS-win", $post1, $pos
</paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
&warn.experimental.func;
<para>
<function>mb_encode_numericentity</function> converts
specified character codes in string <parameter>str</parameter>
@ -1819,7 +1819,7 @@ $str = mb_encode_numericentity($str, $convmap, "sjis-win");
</paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
&warn.experimental.func;
<para>
Convert numeric string reference of string
<parameter>str</parameter> in specified block to character. It
@ -1877,7 +1877,7 @@ $convmap = array (
</paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
&warn.experimental.func;
<para>
<function>mb_send_mail</function> sends email. Headers and
message are converted and encoded according to