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

Parameters are not optional anymore (confirmed by pdflib.de)

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@166268 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Jakub Vrana 2004-08-13 12:05:17 +00:00
parent dab5943ceb
commit be61323df4
8 changed files with 37 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
reference/pdf/functions/pdf-add-bookmark.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-add-bookmark">
<refnamediv>
@ -12,8 +12,8 @@
<type>int</type><methodname>pdf_add_bookmark</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>string</type><parameter>text</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>parent</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>open</parameter></methodparam>
<methodparam><type>int</type><parameter>parent</parameter></methodparam>
<methodparam><type>int</type><parameter>open</parameter></methodparam>
</methodsynopsis>
<para>
Add a nested bookmark under <parameter>parent</parameter>, or a new top-level
@ -21,6 +21,8 @@
which may be used as parent for subsequent nested bookmarks.
If <parameter>open</parameter> = 1, child bookmarks will be folded out, and
invisible if <parameter>open</parameter> = 0.
Parameters <parameter>parent</parameter> and <parameter>open</parameter>
were optional before PHP 5.
</para>
<para>
<example>

5
reference/pdf/functions/pdf-findfont.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-findfont">
<refnamediv>
@ -13,7 +13,7 @@
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>string</type><parameter>fontname</parameter></methodparam>
<methodparam><type>string</type><parameter>encoding</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>embed</parameter></methodparam>
<methodparam><type>int</type><parameter>embed</parameter></methodparam>
</methodsynopsis>
<para>
Prepare a font for later use with <function>pdf_setfont</function>.
@ -23,6 +23,7 @@
<literal>macroman</literal>, <literal>winansi</literal>,
<literal>host</literal>, a user-defined encoding name or the name of
a CMap.
Parameter <parameter>embed</parameter> was optional before PHP 5.
</para>
<para>
<function>pdf_findfont</function> returns a font handle or &false;

5
reference/pdf/functions/pdf-get-value.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-get-value">
<refnamediv>
@ -12,10 +12,11 @@
<type>float</type><methodname>pdf_get_value</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
<methodparam choice="opt"><type>float</type><parameter>modifier</parameter></methodparam>
<methodparam><type>float</type><parameter>modifier</parameter></methodparam>
</methodsynopsis>
<para>
Get the contents of some PDFlib parameter with float type.
Parameter <parameter>modifier</parameter> was optional before PHP 5.
</para>
</refsect1>
</refentry>

8
reference/pdf/functions/pdf-open-file.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-open-file">
<refnamediv>
@ -11,14 +11,16 @@
<methodsynopsis>
<type>bool</type><methodname>pdf_open_file</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>filename</parameter></methodparam>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
<para>
Create a new PDF file using the supplied file name.
If <parameter>filename</parameter> is empty the PDF document
will be generated in memory instead of on file. The result
must be fetched by the client with the
<function>pdf_get_buffer</function> function. &return.success;
<function>pdf_get_buffer</function> function.
Parameter <parameter>filename</parameter> was optional before PHP 5.
&return.success;
</para>
<para>
The following example shows how to create a pdf document in memory

12
reference/pdf/functions/pdf-open-image-file.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-open-image-file">
<refnamediv>
@ -13,17 +13,19 @@
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>string</type><parameter>imagetype</parameter></methodparam>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>stringparam</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>intparam</parameter></methodparam>
<methodparam><type>string</type><parameter>stringparam</parameter></methodparam>
<methodparam><type>int</type><parameter>intparam</parameter></methodparam>
</methodsynopsis>
<para>
Open an image file. Supported types are <literal>jpeg</literal>,
<literal>tiff</literal>, <literal>gif</literal>, and <literal>png</literal>.
<parameter>stringparam</parameter> is either <literal></literal>,
<parameter>stringparam</parameter> is either empty,
<literal>mask</literal>, <literal>masked</literal>, or
<literal>page</literal>.
<parameter>intparam</parameter>is either 0, the image id
<parameter>intparam</parameter> is either 0, the image id
of the applied mask, or the page.
Parameters <parameter>stringparam</parameter> and
<parameter>intparam</parameter> were optional before PHP 5.
</para>
</refsect1>
</refentry>

10
reference/pdf/functions/pdf-setcolor.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-setcolor">
<refnamediv>
@ -14,9 +14,9 @@
<methodparam><type>string</type><parameter>type</parameter></methodparam>
<methodparam><type>string</type><parameter>colorspace</parameter></methodparam>
<methodparam><type>float</type><parameter>c1</parameter></methodparam>
<methodparam choice="opt"><type>float</type><parameter>c2</parameter></methodparam>
<methodparam choice="opt"><type>float</type><parameter>c3</parameter></methodparam>
<methodparam choice="opt"><type>float</type><parameter>c4</parameter></methodparam>
<methodparam><type>float</type><parameter>c2</parameter></methodparam>
<methodparam><type>float</type><parameter>c3</parameter></methodparam>
<methodparam><type>float</type><parameter>c4</parameter></methodparam>
</methodsynopsis>
<para>
Set the current color space and color. &return.success;
@ -32,6 +32,8 @@
space specified by <parameter>colorspace</parameter>. Except as
otherwise noted, the color components are floating-point values that
range from 0 to 1.
Parameters <parameter>c2</parameter>, <parameter>c3</parameter> and
<parameter>c4</parameter> were optional before PHP 5.
</para>
<para>
For <literal>gray</literal> only <parameter>c1</parameter> is used.

5
reference/pdf/functions/pdf-show-boxed.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-show-boxed">
<refnamediv>
@ -17,7 +17,7 @@
<methodparam><type>float</type><parameter>width</parameter></methodparam>
<methodparam><type>float</type><parameter>height</parameter></methodparam>
<methodparam><type>string</type><parameter>mode</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>feature</parameter></methodparam>
<methodparam><type>string</type><parameter>feature</parameter></methodparam>
</methodsynopsis>
<para>
Format <parameter>text</parameter> in the current font and size into the
@ -28,6 +28,7 @@
If <parameter>width</parameter> and <parameter>height</parameter> are 0,
only a single line is placed at the point (<parameter>left</parameter>,
<parameter>top</parameter>) in the requested <parameter>mode</parameter>.
Parameter <parameter>feature</parameter> was optional before PHP 5.
</para>
<para>
Returns the number of characters that did not fit in the specified

8
reference/pdf/functions/pdf-stringwidth.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-stringwidth">
<refnamediv>
@ -12,8 +12,8 @@
<type>float</type><methodname>pdf_stringwidth</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>string</type><parameter>text</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>font</parameter></methodparam>
<methodparam choice="opt"><type>float</type><parameter>size</parameter></methodparam>
<methodparam><type>int</type><parameter>font</parameter></methodparam>
<methodparam><type>float</type><parameter>size</parameter></methodparam>
</methodsynopsis>
<para>
Returns the width of <parameter>text</parameter> using the last
@ -23,6 +23,8 @@
calculated using that font and size instead. Please note that
<parameter>font</parameter> is a font handle returned by
<function>pdf_findfont</function>.
Parameters <parameter>font</parameter> and <parameter>size</parameter>
were optional before PHP 5.
</para>
<note>
<para>