mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 08:58:56 +00:00
Add documentation for a whole buncha functions.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@24995 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Sterling Hughes
parent
d7806fd371
commit
90c3d2be5d
3 changed files with 307 additions and 0 deletions
|
|
@ -315,6 +315,38 @@ $black = ImageColorAllocate ($im, 0, 0, 0);
|
|||
</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 @@ $black = ImageColorAllocate ($im, 0, 0, 0);
|
|||
</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 @@ function LoadPNG ($imgname) {
|
|||
</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>
|
||||
|
|
@ -1244,6 +1361,61 @@ permits to find a solution.
|
|||
</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">
|
||||
<refnamediv>
|
||||
<refname>ImagePSText</refname>
|
||||
|
|
|
|||
|
|
@ -540,6 +540,28 @@ echo "The previous session name was $previous_name<p>";
|
|||
</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>
|
||||
|
|
@ -566,6 +588,82 @@ echo "The previous session name was $previous_name<p>";
|
|||
</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">
|
||||
<refnamediv>
|
||||
|
|
|
|||
|
|
@ -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>
|
||||
|
|
|
|||
Loading…
Reference in a new issue