 |
 |
 |
 |
|
|
Date: 05/24/00
- Next message: Sterling Hughes: "[PHPDOC] cvs: phpdoc /en/functions/ swf.xml"
- Previous message: Hartmut Holzgraefe: "[PHPDOC] cvs: phpdoc / README"
- Next in thread: Hartmut Holzgraefe: "[PHPDOC] cvs: phpdoc /en/functions/ image.xml session.xml var.xml"
- Maybe reply: Hartmut Holzgraefe: "[PHPDOC] cvs: phpdoc /en/functions/ image.xml session.xml var.xml"
- Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]
sterling Thu May 25 03:02:39 2000 EDT
Modified files:
/phpdoc/en/functions image.xml session.xml var.xml
Log:
Add documentation for a whole buncha functions.
Index: phpdoc/en/functions/image.xml
diff -u phpdoc/en/functions/image.xml:1.6 phpdoc/en/functions/image.xml:1.7
--- phpdoc/en/functions/image.xml:1.6 Tue May 2 10:30:17 2000
+++ phpdoc/en/functions/image.xml Thu May 25 03:02:39 2000
@@ -315,6 +315,38 @@
</refsect1>
</refentry>
+ <refentry id="function.imagegammacorrect">
+ <refnamediv>
+ <refname>ImageGammaCorrect</refname>
+ <refpurpose>
+ Apply a gamma correction to a GD image
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcdef>int
+ <function>imagegammacorrect</function>
+ </funcdef>
+ <paramdef>int
+ <parameter>im</parameter>
+ </paramdef>
+ <paramdef>double
+ <parameter>inputgamma</parameter>
+ </paramdef>
+ <paramdef>double
+ <parameter>outputgamma</parameter>
+ </paramdef>
+ </funcsynopsis>
+ <para>
+ The <function>ImageGammaCorrect</function> function applies gamma correction
+ to a gd image stream (<parameter>im</parameter>) given an input gamma, the
+ parameter <parameter>inputgamma</parameter> and an output gamma, the parameter
+ <parameter>outputgamma</parameter>.
+ </para>
+ </refsect1>
+ </refentry>
+
<refentry id="function.imagecolorset">
<refnamediv>
<refname>ImageColorSet</refname>
@@ -421,6 +453,54 @@
</refsect1>
</refentry>
+ <refentry id="function.imagecopy">
+ <refnamediv>
+ <refname>ImageCopy</refname>
+ <refpurpose>
+ Copy part of an image
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcdef>int
+ <function>ImageCopy</function>
+ </funcdef>
+ <paramdef>int
+ <parameter>dst_im</parameter>
+ </paramdef>
+ <paramdef>int
+ <parameter>src_im</parameter>
+ </paramdef>
+ <paramdef>int
+ <parameter>dst_x</parameter>
+ </paramdef>
+ <paramdef>int
+ <parameter>dst_y</parameter>
+ </paramdef>
+ <paramdef>int
+ <parameter>src_x</parameter>
+ </paramdef>
+ <paramdef>int
+ <parameter>src_y</parameter>
+ </paramdef>
+ <paramdef>int
+ <parameter>src_w</parameter>
+ </paramdef>
+ <parameter>int
+ <parameter>src_h</parameter>
+ </parameter>
+ </funcsynopsis>
+ <para>
+ Copy a part of <parameter>src_im</parameter> onto <parameter>dst_im</parameter>
+ starting at the x,y coordinates <parameter>src_x</parameter>, <parameter>src_y
+ </parameter> with a width of <parameter>src_w</parameter> and a height of
+ <parameter>src_h</parameter>. The portion defined will be copied onto
+ the x,y coordinates, <parameter>dst_x</parameter> and <parameter>dst_y</parameter>.
+ </para>
+ </refsect1>
+ </refentry>
+
<refentry id="function.imagecopyresized">
<refnamediv>
<refname>ImageCopyResized</refname>
@@ -849,6 +929,43 @@
</refsect1>
</refentry>
+ <refentry id="function.imagepng">
+ <refnamediv>
+ <refname>ImagePng</refname>
+ <refpurpose>
+ Output a PNG image to either the browser or a file
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcdef>int
+ <function>imagepng</function>
+ </funcdef>
+ <paramdef>int
+ <parameter>im</parameter>
+ </paramdef>
+ <paramdef>
+ <optional>
+ string
+ <parameter>filename</parameter>
+ </optional>
+ </paramdef>
+ </funcsynopsis>
+ <para>
+ The <function>ImagePng</function> outputs a GD image stream (<parameter>im</parameter>)
+ in PNG format to standard output (usually the browser) or, if a filename is given by the
+ <parameter>filename</parameter> it outputs the image to the file.
+ <informalexample>
+ <programlisting role="php">
+$im = ImageCreateFromPng("test.png");
+ImagePng($im);
+ </programlisting>
+ </informalexample>
+ </para>
+ </refsect1>
+ </refentry>
+
<refentry id="function.imagejpeg">
<refnamediv>
<refname>ImageJPEG</refname>
@@ -1242,6 +1359,61 @@
See also <function>ImagePSFreeFont</function>.
</para>
</refsect1>
+ </refentry>
+
+ <refentry id="function.imagepsextendfont">
+ <refnamediv>
+ <refname>ImagePsExtendFont</refname>
+ <refpurpose>
+ Extend or condense a font
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcdef>bool
+ <function>imagepsextendfont</function>
+ </funcdef>
+ <paramdef>int
+ <parameter>font_index</parameter>
+ </paramdef>
+ <paramdef>double
+ <parameter>extend</parameter>
+ </paramdef>
+ </funcsynopsis>
+ <para>
+ Extend or condense a font (<parameter>font_index</parameter>), if the value of
+ the <parameter>extend</parameter> parameter is less than one you will be condensing
+ the font.
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.imagepsslantfont">
+ <refnamediv>
+ <refname>ImagePsSlantFont</refname>
+ <refpurpose>
+ Slant a font
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcdef>bool
+ <function>imagepsslantfont</function>
+ </funcdef>
+ <paramdef>int
+ <parameter>font_index</parameter>
+ </paramdef>
+ <paramdef>double
+ <parameter>slant</parameter>
+ </paramdef>
+ </funcsynopsis>
+ <para>
+ Slant a font given by the <parameter>font_index</parameter> parameter with a slant of
+ the value of the <parameter>slant</parameter> parameter.
+ </para>
+ </refsect1>
</refentry>
<refentry id="function.imagepstext">
Index: phpdoc/en/functions/session.xml
diff -u phpdoc/en/functions/session.xml:1.7 phpdoc/en/functions/session.xml:1.8
--- phpdoc/en/functions/session.xml:1.7 Fri Feb 25 01:02:34 2000
+++ phpdoc/en/functions/session.xml Thu May 25 03:02:39 2000
@@ -540,6 +540,28 @@
</para>
</refsect1>
</refentry>
+
+ <refentry id="function.session-unset">
+ <refnamediv>
+ <refname>session_unset</refname>
+ <refpurpose>
+ Free all session variables
+ </refpurpose>
+ </refname>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcdef>void
+ <function>session_unset</function>
+ </funcdef>
+ <void/>
+ </funcsynopsis>
+ <para>
+ The <function>session_unset</function> function free's all session variables
+ currently registered.
+ </para>
+ </refsect1>
+ </refentry>
<refentry id="function.session-is-registered">
<refnamediv>
@@ -565,6 +587,82 @@
</note>
</para>
</refsect1>
+ </refentry>
+
+ <refentry id="function.session-get-cookie-params">
+ <refnamediv>
+ <refname>session_get_cookie_params</refname>
+ <refpurpose>
+ Get the session cookie parameters
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcdef>array
+ <function>session_get_cookie_params</function>
+ </funcdef>
+ <void/>
+ </funcsynopsis>
+ <para>
+ The <function>session_get_cookie_params</function> function returns an array
+ with the current session cookie information, the array contains the following
+ items:
+ <itemizedlist>
+ <listitem>
+ <simpara>
+ "lifetime" - The lifetime of the cookie.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ "path" - The path where information is stored.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ "domain" - The domain of the cookie.
+ </simpara>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.session-set-cookie-params">
+ <refnamediv>
+ <refname>session_set_cookie_params</refname>
+ <refpurpose>
+ Set the session cookie parameters
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcdef>void
+ <function>session_set_cookie_params</function>
+ </funcdef>
+ <paramdef>int
+ <parameter>lifetime</parameter>
+ </paramdef>
+ <paramdef>
+ <optional>
+ string
+ <parameter>path</parameter>
+ </optional>
+ </paramdef>
+ <paramdef>
+ <optional>
+ string
+ <parameter>domain</parameter>
+ </optional>
+ </paramdef>
+ </funcsynopsis>
+ <para>
+ Set cookie parameters defined in the php.ini file. The effect of this function only lasts
+ for the duration of the script.
+ </para>
+ </refsect1>
</refentry>
<refentry id="function.session-decode">
Index: phpdoc/en/functions/var.xml
diff -u phpdoc/en/functions/var.xml:1.14 phpdoc/en/functions/var.xml:1.15
--- phpdoc/en/functions/var.xml:1.14 Wed Apr 12 23:35:48 2000
+++ phpdoc/en/functions/var.xml Thu May 25 03:02:39 2000
@@ -2,6 +2,43 @@
<title>Variable Functions</title>
<titleabbrev>Variables</titleabbrev>
+ <refentry id="function.call-user-func">
+ <refnamediv>
+ <refname>call_user_func</refname>
+ <refpurpose>Call a user function given by the first parameter</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcdef>mixed
+ <function>call_user_func</function>
+ </funcdef>
+ <paramdef>string
+ <parameter>function_name</parameter>
+ </paramdef>
+ <paramdef>
+ <optional>
+ mixed
+ <function>parameters</function>
+ </optional>
+ </paramdef>
+ </funcsynopsis>
+ <para>
+ Call a user defined function given by the <parameter>function_name</parameter>
+ parameter. Take the following:
+ <informalexample>
+ <programlisting role="php">
+function barber ($type) {
+ print "You wanted a $type haircut, no problem";
+}
+call_user_func('barber', "mushroom");
+call_user_func('barber', "shave");
+ </programlisting>
+ </informalexample>
+ </para>
+ </refsect1>
+ </refentry>
+
<refentry id="function.doubleval">
<refnamediv>
<refname>doubleval</refname>
- Next message: Sterling Hughes: "[PHPDOC] cvs: phpdoc /en/functions/ swf.xml"
- Previous message: Hartmut Holzgraefe: "[PHPDOC] cvs: phpdoc / README"
- Next in thread: Hartmut Holzgraefe: "[PHPDOC] cvs: phpdoc /en/functions/ image.xml session.xml var.xml"
- Maybe reply: Hartmut Holzgraefe: "[PHPDOC] cvs: phpdoc /en/functions/ image.xml session.xml var.xml"
- Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]