cvs: peardoc /en/pecl kadm5.xml oggvorbis.xml paradox.xml ps.xml radius.xml

From:	Martin Jansen	Date:	Sat, 10 Sep 2005 13:43:34 +0000
Subject:	cvs: peardoc /en/pecl kadm5.xml oggvorbis.xml paradox.xml ps.xml radius.xml
Groups:	php.doc
Request:	Send a blank email to phpdoc+get-969370062@lists.php.net to get a copy of this message

mj Sat Sep 10 09:43:34 2005 EDT Modified files: /peardoc/en/pecl kadm5.xml oggvorbis.xml paradox.xml ps.xml radius.xml Log: * A few more docs for packages have been moved to the PHP manual a long time ago.

http://cvs.php.net/diff.php/peardoc/en/pecl/kadm5.xml?r1=1.3&r2=1.4&ty=u Index: peardoc/en/pecl/kadm5.xml diff -u peardoc/en/pecl/kadm5.xml:1.3 peardoc/en/pecl/kadm5.xml:1.4 --- peardoc/en/pecl/kadm5.xml:1.3 Fri Jun 20 01:19:08 2003 +++ peardoc/en/pecl/kadm5.xml Sat Sep 10 09:43:34 2005 @@ -1,680 +1,22 @@ <?xml version="1.0" encoding="iso-8859-1"?> - + <reference id="pecl.kadm5"> <title>KADM5</title> - <titleabbrev>kadm5</titleabbrev> - <partintro> - <sect1 id="pecl.kadm5.intro"> - <title>Introduction</title> - <simpara> - These package allows you to access Kerberos V administration servers. - You can create, modify, and delete Kerberos V principals and policies. - </simpara> - <simpara> - More information about Kerberos can be found at <ulink - url="&url.kerberos.info;">&url.kerberos.info;</ulink>. - </simpara> - <simpara> - Documentation for Kerberos and KADM5 can be found at <ulink - url="&url.kerberos.docs;">&url.kerberos.docs;</ulink>. - </simpara> - - <para> - This simple example shows how to connect, query, print - resulting principals and disconnect from a KADM5 database. - <example> - <title>KADM5 extension overview example</title> - <programlisting role="php"> -<![CDATA[ -<?php - - $handle = kadm5_init_with_password("afs-1", "GONICUS.LOCAL", "admin/admin", "password"); - - print "<h1>get_principals</h1>\n"; - $principals = kadm5_get_principals($handle); - for( $i=0; $i<count($principals); $i++) - print "$principals[$i]<br>\n"; - - print "<h1>get_policies</h1>\n"; - $policies = kadm5_get_policies($handle); - for( $i=0; $i<count($policies); $i++) - print "$policies[$i]<br>\n"; - - print "<h1>get_principal burbach@GONICUS.LOCAL</h1>\n"; - - $options = kadm5_get_principal($handle, "burbach@GONICUS.LOCAL" ); - $keys = array_keys($options); - for( $i=0; $i<count($keys); $i++) { - $value = $options[$keys[$i]]; - print "$keys[$i]: $value<br>\n"; - } - - $options = array(KADM5_PRINC_EXPIRE_TIME => 0); - kadm5_modify_principal($handle, "burbach@GONICUS.LOCAL", $options); - - kadm5_destroy($handle); -?> -]]> - </programlisting> - </example> - </para> - </sect1> - - <sect1 id="pecl.kadm5.contact"> - <title>Contact Information</title> - <para> - If you have comments, bugfixes, enhancements or want to help - developping this you can send me a mail at - <ulink url="mailto:&email.hburbach;">&email.hburbach;</ulink>. - The project homepage can be found at - <ulink url="&url.kadm5;">&url.kadm5;</ulink>. - </para> - </sect1> - - <sect1 id="pecl.kadm5.constantsAF"> - <title>Constants for Attribute Flags</title> - <para> - The functions <function>kadm5_create_principal</function>, - <function>kadm5_modify_principal</function>, and - <function>kadm5_modify_principal</function> allow to specify - special attributes using a bitfield. The symbols are defined below: - <table> - <title>Attributes for use by the KDC</title> - <tgroup cols="1"> - <thead> - <row> - <entry>constant</entry> - </row> - </thead> - <tbody> - <row> - <entry>KRB5_KDB_DISALLOW_POSTDATED</entry> - </row> - <row> - <entry>KRB5_KDB_DISALLOW_FORWARDABLE</entry> - </row> - <row> - <entry>KRB5_KDB_DISALLOW_TGT_BASED</entry> - </row> - <row> - <entry>KRB5_KDB_DISALLOW_RENEWABLE</entry> - </row> - <row> - <entry>KRB5_KDB_DISALLOW_PROXIABLE</entry> - </row> - <row> - <entry>KRB5_KDB_DISALLOW_DUP_SKEY</entry> - </row> - <row> - <entry>KRB5_KDB_DISALLOW_ALL_TIX</entry> - </row> - <row> - <entry>KRB5_KDB_REQUIRES_PRE_AUTH</entry> - </row> - <row> - <entry>KRB5_KDB_REQUIRES_HW_AUTH</entry> - </row> - <row> - <entry>KRB5_KDB_REQUIRES_PWCHANGE</entry> - </row> - <row> - <entry>KRB5_KDB_DISALLOW_SVR</entry> - </row> - <row> - <entry>KRB5_KDB_PWCHANGE_SERVER</entry> - </row> - <row> - <entry>KRB5_KDB_SUPPORT_DESMD5</entry> - </row> - <row> - <entry>KRB5_KDB_NEW_PRINC</entry> - </row> - </tbody> - </tgroup> - </table> - </para> - </sect1> - - <sect1 id="pecl.kadm5.constantsOP"> - <title>Constants for Options</title> - <para> - The functions <function>kadm5_create_principal</function>, - <function>kadm5_modify_principal</function>, and - <function>kadm5_get_principal</function> allow to specify - or return principal's options as an associative array. - The keys for the associative array are defined as string - constants below: - - <table> - <title>Options for creating/modifying/retrieving principals</title> - <tgroup cols="2"> - <thead> - <row> - <entry>constant</entry> - <entry>funcdef</entry> - <entry>description</entry> - </row> - </thead> - <tbody> - <row> - <entry>KADM5_PRINCIPAL</entry> - <entry>long</entry> - <entry>The expire time of the princial as a Kerberos timestamp.</entry> - </row> - <row> - <entry>KADM5_PRINC_EXPIRE_TIME</entry> - <entry>long</entry> - <entry>The expire time of the princial as a Kerberos timestamp.</entry> - </row> - <row> - <entry>KADM5_LAST_PW_CHANGE</entry> - <entry>long</entry> - <entry>The time this principal's password was last changed.</entry> - </row> - <row> - <entry>KADM5_PW_EXPIRATION</entry> - <entry>long</entry> - <entry>The expire time of the principal's current password, as a Kerberos timestamp.</entry> - </row> - <row> - <entry>KADM5_MAX_LIFE</entry> - <entry>long</entry> - <entry>The maximum lifetime of any Kerberos ticket issued to this principal.</entry> - </row> - <row> - <entry>KADM5_MAX_RLIFE</entry> - <entry>long</entry> - <entry>The maximum renewable lifetime of any Kerberos ticket issued to or for this principal.</entry> - </row> - <row> - <entry>KADM5_MOD_NAME</entry> - <entry>string</entry> - <entry>The name of the Kerberos principal that most recently modified this principal.</entry> - </row> - <row> - <entry>KADM5_MOD_TIME</entry> - <entry>long</entry> - <entry>The time this principal was last modified, as a Kerberos timestamp.</entry> - </row> - <row> - <entry>KADM5_KVNO</entry> - <entry>long</entry> - <entry>The version of the principal's current key.</entry> - </row> - <row> - <entry>KADM5_POLICY</entry> - <entry>string</entry> - <entry>The name of the policy controlling this principal.</entry> - </row> - <row> - <entry>KADM5_CLEARPOLICY</entry> - <entry>long</entry> - <entry>Standard procedure is to assign the 'default' policy to new principals. - KADM5_CLEARPOLICY suppresses this behaviour.</entry> - </row> - <row> - <entry>KADM5_LAST_SUCCESS</entry> - <entry>long</entry> - <entry>The KDC time of the last successfull AS_REQ.</entry> - </row> - <row> - <entry>KADM5_LAST_FAILED</entry> - <entry>long</entry> - <entry>The KDC time of the last failed AS_REQ.</entry> - </row> - <row> - <entry>KADM5_FAIL_AUTH_COUNT</entry> - <entry>long</entry> - <entry>The number of consecutive failed AS_REQs.</entry> - </row> - <row> - <entry>KADM5_RANDKEY</entry> - <entry>long</entry> - <entry>Generates a random password for the principal. The parameter - <parameter>password</parameter> will be ignored. - </entry> - </row> - <row> - <entry>KADM5_ATTRIBUTES</entry> - <entry>long</entry> - <entry>A bitfield of attributes for use by the KDC. - </entry> - </row> - </tbody> - </tgroup> - </table> - </para> - </sect1> - </partintro> - - - <refentry id="pecl.kadm5.kadm5-init-with-password"> - <refnamediv> - <refname>kadm5_init_with_password</refname> - <refpurpose>Opens a conncetion to the KADM5 library and initializes any neccessary - state information.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>kadm5_init_with_password</function></funcdef> - <paramdef>string <parameter>admin_server</parameter></paramdef> - <paramdef>string <parameter>realm</parameter></paramdef> - <paramdef>string <parameter>principal</parameter></paramdef> - <paramdef>string <parameter>password</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Returns a KADM5 handle on success, or &false; on failure. - </para> - <para> - <function>kadm5_init_with_password</function> - Opens a connection with the KADM5 library using the - <parameter>principal</parameter> and the given - <parameter>password</parameter> to obtain initial credentials - from the <parameter>admin_server</parameter>. The parameter - <parameter>realm</parameter> defines the authentication domain - for the connection. - </para> - <example> - <title>KADM5 initialization example</title> - <programlisting role="php"> -<![CDATA[ -<?php - - $handle = kadm5_init_with_password("afs-1", "GONICUS.LOCAL", "admin/admin", "password"); - - $attributes = KRB5_KDB_REQUIRES_PRE_AUTH | KRB5_KDB_DISALLOW_PROXIABLE; - $options = array(KADM5_PRINC_EXPIRE_TIME => 0, - KADM5_POLICY => "default", - KADM5_ATTRIBUTES => $attributes); - - kadm5_create_principal($handle, "burbach@GONICUS.LOCAL", "password", $options); - - kadm5_destroy($handle); -?> -]]> - </programlisting> - </example> - - <note> - <para> - Connection should be closed after use with - <function>kadm5_destroy</function>. - </para> - </note> - <para> - See also: <function>kadm5_destroy</function>. - </para> - </refsect1> - </refentry> - - <refentry id="pecl.kadm5.kadm5-flush"> - <refnamediv> - <refname>kadm5_flush</refname> - <refpurpose>Flush all changes to the Kerberos database, leaving the connection - to the Kerberos admin server open.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>kadm5_flush</function></funcdef> - <paramdef>resource <parameter>handle</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Returns &true; on success, or &false; on failure. - </para> - </refsect1> - </refentry> - - <refentry id="pecl.kadm5.kadm5-destroy"> - <refnamediv> - <refname>kadm5_destroy</refname> - <refpurpose>Closes the connection to the admin server and releases all related resources.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>kadm5_destroy</function></funcdef> - <paramdef>resource <parameter>handle</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Returns &true; on success, or &false; on failure. - </para> - </refsect1> - </refentry> - - <refentry id="pecl.kadm5.kadm5-create-principal"> - <refnamediv> - <refname>kadm5_create_principal</refname> - <refpurpose>Creates a kerberos principal with the given parameters.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>kadm5_create_principal</function></funcdef> - <paramdef>resource <parameter>handle</parameter></paramdef> - <paramdef>string <parameter>principal</parameter></paramdef> - <paramdef>string <parameter><optional>password</optional></parameter></paramdef> - <paramdef>array <parameter><optional>options</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Returns &true; on success, or &false; on failure. - </para> - <para> - <function>kadm5_create_principal</function> - creates a <parameter>principal</parameter> with the given - <parameter>password</parameter>. If <parameter>password</parameter> - is omitted or is &null;, a random key will be generated. - </para> - <para> - It is possible to specify several optional parameters within the - array <parameter>options</parameter>. Allowed are the following - options: KADM5_PRINC_EXPIRE_TIME, KADM5_PW_EXPIRATION, KADM5_ATTRIBUTES, - KADM5_MAX_LIFE, KADM5_KVNO, KADM5_POLICY, KADM5_CLEARPOLICY, - KADM5_MAX_RLIFE. - </para> - - <example> - <title>Example of principal's creation</title> - <programlisting role="php"> -<![CDATA[ -<?php - - $handle = kadm5_init_with_password("afs-1", "GONICUS.LOCAL", "admin/admin", "password"); - - $attributes = KRB5_KDB_REQUIRES_PRE_AUTH | KRB5_KDB_DISALLOW_PROXIABLE; - $options = array(KADM5_PRINC_EXPIRE_TIME => 0, - KADM5_POLICY => "default", - KADM5_ATTRIBUTES => $attributes); - - kadm5_create_principal($handle, "burbach@GONICUS.LOCAL", "password", $options); - - kadm5_destroy($handle); -?> -]]> - </programlisting> - </example> - </refsect1> - </refentry> - - <refentry id="pecl.kadm5.kadm5-delete-principal"> - <refnamediv> - <refname>kadm5_delete_principal</refname> - <refpurpose>Deletes a kerberos principal.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>kadm5_delete_principal</function></funcdef> - <paramdef>resource <parameter>handle</parameter></paramdef> - <paramdef>string <parameter>principal</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Returns &true; on success, or &false; on failure. - </para> - <para> - <function>kadm5_delete_principal</function> - remove the <parameter>principal</parameter> from the - Kerberos database. - </para> - <example> - <title>KADM5 extension overview example</title> - <programlisting role="php"> -<![CDATA[ -<?php - - $handle = kadm5_init_with_password("afs-1", "GONICUS.LOCAL", "admin/admin", "password"); - - kadm5_delete_principal($handle, "burbach@GONICUS.LOCAL"); - - kadm5_destroy($handle); -?> -]]> - </programlisting> - </example> - - </refsect1> - </refentry> - - <refentry id="pecl.kadm5.kadm5-modify-principal"> - <refnamediv> - <refname>kadm5_modify_principal</refname> - <refpurpose>Modifies a kerberos principal with the given parameters.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>kadm5_modify_principal</function></funcdef> - <paramdef>resource <parameter>handle</parameter></paramdef> - <paramdef>string <parameter>principal</parameter></paramdef> - <paramdef>array <parameter><optional>options</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Returns &true; on success, or &false; on failure. - </para> - <para> - <function>kadm5_create_principal</function> - modifies a <parameter>principal</parameter> according to the given - <parameter>options</parameter>. Allowed are the following - options: KADM5_PRINC_EXPIRE_TIME, KADM5_PW_EXPIRATION, KADM5_ATTRIBUTES, - KADM5_MAX_LIFE, KADM5_KVNO, KADM5_POLICY, KADM5_CLEARPOLICY, - KADM5_MAX_RLIFE, KADM5_FAIL_AUTH_COUNT. - </para> - <example> - <title>Example of modifying principal</title> - <programlisting role="php"> -<![CDATA[ -<?php - - $handle = kadm5_init_with_password("afs-1", "GONICUS.LOCAL", "admin/admin", "password"); - - $attributes = KRB5_KDB_REQUIRES_PRE_AUTH; - $options = array(KADM5_PRINC_EXPIRE_TIME => 3451234, - KADM5_POLICY => "gonicus", - KADM5_ATTRIBUTES => $attributes); - - kadm5_modify_principal($handle, "burbach@GONICUS.LOCAL", "password", $options); - - kadm5_destroy($handle); -?> -]]> - </programlisting> - </example> - - </refsect1> - </refentry> - - <refentry id="pecl.kadm5.kadm5-chpass-principal"> - <refnamediv> - <refname>kadm5_chpass_principal</refname> - <refpurpose>Changes the principal's password.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>kadm5_chpass_principal</function></funcdef> - <paramdef>resource <parameter>handle</parameter></paramdef> - <paramdef>string <parameter>principal</parameter></paramdef> - <paramdef>string <parameter>password</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Returns &true; on success, or &false; on failure. - </para> - <para> - <function>kadm5_chpass_principal</function> - sets the new password <parameter>password</parameter> for - the <parameter>principal</parameter>. - </para> - <example> - <title>Example of changing principal's password</title> - <programlisting role="php"> -<![CDATA[ -<?php - - $handle = kadm5_init_with_password("afs-1", "GONICUS.LOCAL", "admin/admin", "password"); - - kadm5_chpass_principal($handle, "burbach@GONICUS.LOCAL", "newpassword"); - - kadm5_destroy($handle); -?> -]]> - </programlisting> - </example> - - </refsect1> + <refentry id="pecl.kadm5.docs"> + <refnamediv> + <refname>Documentation</refname> + <refpurpose /> + </refnamediv> + <refsect1> + <title>Documentation moved</title> + <simpara> + The documentation is now part of the <ulink url="&url.php.manual;/en/ref.kadm5.php">PHP + manual</ulink>. + </simpara> + </refsect1> </refentry> - - <refentry id="pecl.kadm5.kadm5-get-principal"> - <refnamediv> - <refname>kadm5_get_principal</refname> - <refpurpose>Gets the principal's entries from the Kerberos database.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>kadm5_get_principal</function></funcdef> - <paramdef>resource <parameter>handle</parameter></paramdef> - <paramdef>string <parameter>principal</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Returns array of options on success, or &false; on failure. - </para> - <para> - <function>kadm5_get_principal</function> - returns an associative array containing the following - keys: KADM5_PRINCIPAL, KADM5_PRINC_EXPIRE_TIME, KADM5_PW_EXPIRATION, KADM5_ATTRIBUTES, - KADM5_MAX_LIFE, KADM5_MOD_NAME, KADM5_MOD_TIME, KADM5_KVNO, KADM5_POLICY, - KADM5_MAX_RLIFE, KADM5_LAST_SUCCESS, KADM5_LAST_FAILED, KADM5_FAIL_AUTH_COUNT. - </para> - <example> - <title>KADM5 extension overview example</title> - <programlisting role="php"> -<![CDATA[ -<?php - - $handle = kadm5_init_with_password("afs-1", "GONICUS.LOCAL", "admin/admin", "password"); - - print "<h1>get_principal burbach@GONICUS.LOCAL</h1>\n"; - - $options = kadm5_get_principal($handle, "burbach@GONICUS.LOCAL" ); - - $keys = array_keys($options); - for( $i=0; $i<count($keys); $i++) { - $value = $options[$keys[$i]]; - print "$keys[$i]: $value<br>\n"; - } - - kadm5_destroy($handle); -?> -]]> - </programlisting> - </example> - - </refsect1> - </refentry> - - <refentry id="pecl.kadm5.kadm5-get-principals"> - <refnamediv> - <refname>kadm5_get_principals</refname> - <refpurpose>Gets all principals from the Kerberos database.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>kadm5_get_principals</function></funcdef> - <paramdef>resource <parameter>handle</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Returns array of principals on success, or &false; on failure. - </para> - <para> - <function>kadm5_get_principals</function> - returns an array containing the principals's names. - </para> - <example> - <title>KADM5 extension overview example</title> - <programlisting role="php"> -<![CDATA[ -<?php - - $handle = kadm5_init_with_password("afs-1", "GONICUS.LOCAL", "admin/admin", "password"); - - print "<h1>get_principals</h1>\n"; - $principals = kadm5_get_principals($handle); - for( $i=0; $i<count($principals); $i++) - print "$principals[$i]<br>\n"; - - kadm5_destroy($handle); -?> -]]> - </programlisting> - </example> - </refsect1> - </refentry> - - <refentry id="pecl.kadm5.kadm5-get-policies"> - <refnamediv> - <refname>kadm5_get_policies</refname> - <refpurpose>Gets all policies from the Kerberos database.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>kadm5_get_policies</function></funcdef> - <paramdef>resource <parameter>handle</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Returns array of policies on success, or &false; on failure. - </para> - <para> - <function>kadm5_get_principals</function> - returns an array containing the policies's names. - </para> - <example> - <title>KADM5 extension overview example</title> - <programlisting role="php"> -<![CDATA[ -<?php - - $handle = kadm5_init_with_password("afs-1", "GONICUS.LOCAL", "admin/admin", "password"); - - print "<h1>get_policies</h1>\n"; - $policies = kadm5_get_policies($handle); - for( $i=0; $i<count($policies); $i++) - print "$policies[$i]<br>\n"; - - kadm5_destroy($handle); -?> -]]> - </programlisting> - </example> - - </refsect1> - </refentry> - - - </reference> +</reference>  - <reference id="pecl.oggvorbis"> + +<reference id="pecl.oggvorbis"> <title>oggvorbis</title> - <titleabbrev>OGG/Vorbis</titleabbrev> - <partintro> - <section id="pecl.oggvorbis.intro"> - <title>About OGG/Vorbis</title> - <simpara> - The OGG/Vorbis file format, as defined by <ulink url="&url.ogg;">&url.ogg;</ulink> - and <ulink url="&url.ogg.vorbis;">&url.ogg.vorbis;</ulink>, is a scheme for compressing - audio streams by multiple factors with a minimum of quality loss. This extension adds - oggvorbis support to PHP's <ulink url="&url.php.lookup;wrappers">URL Wrappers</ulink>. - When used in read mode, compressed OGG/Vorbis data is expanded to raw PCM audio in one of - six PCM encoding formats listed below. - </simpara> - </section> - - <section id="pecl.oggvorbis.install"> - <title>Installation</title> - <simpara> - oggvorbis is installed through the usual PECL package installation process. - </simpara> - <itemizedlist> - <listitem> - <simpara> - Prerequisite: - <literal>PHP >= 4.3.0</literal>, - <ulink url="&url.ogg.vorbis.downloads;">libogg</ulink> >= 1.0, and - <ulink url="&url.ogg.vorbis.downloads;">libvorbis</ulink> >= 1.0. - </simpara> - </listitem> - <listitem> + <refentry id="pecl.oggvorbis.docs"> + <refnamediv> + <refname>Documentation</refname> + <refpurpose /> + </refnamediv> + <refsect1> + <title>Documentation moved</title> <simpara> - <literal>pear install oggvorbis</literal> + The documentation is now part of the <ulink url="&url.php.manual;/en/ref.oggvorbis.php">PHP + manual</ulink>. </simpara> - </listitem> - <listitem> - <simpara> - Copy the resulting <literal>oggvorbis.so</literal> to an appropriate location - and add <literal>extension=oggvorbis.so</literal> to your <literal>php.ini</literal> - file or load it dynamically in your PHP script using - <literal>dl("oggvorbis.so");</literal> - </simpara> - </listitem> - </itemizedlist> - </section> - - <section id="pecl.oggvorbis.contexts"> - <title>Context options</title> - <table> - <title>OGG/Vorbis tuning options</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Option</entry> - <entry>Definition</entry> - <entry>Relevance</entry> - <entry>Default</entry> - </row> - </thead> - <tbody> - <row> - <entry>pcm_mode</entry> - <entry>PCM byte encoding used. See constants below.</entry> - <entry>Read / Write</entry> - <entry><constant>OGGVORBIS_PCM_S16_LE</constant></entry> - </row> - <row> - <entry>rate</entry> - <entry>PCM Sampling rate. Measured in Hz.</entry> - <entry>Write only</entry> - <entry><constant>44100</constant></entry> - </row> - <row> - <entry>bitrate</entry> - <entry> - Vorbis Average Bitrate Encoding / Variable Bitrate Encoding. - Measured in bps (ABR) or Quality level (VBR: 0.0 to 1.0). - 128000 ABR is rough equal to 0.4 VBR. - </entry> - <entry>Write only</entry> - <entry><constant>128000</constant></entry> - </row> - <row> - <entry>channels</entry> - <entry>Number of PCM channels. 1 == Mono, 2 == Stereo.</entry> - <entry>Write only</entry> - <entry><constant>2</constant></entry> - </row> - <row> - <entry>serialno</entry> - <entry> - Serial Number of stream within file. Must be unique within file. - Because of the potential to select a duplicate serial number within - a chained file, make efforts to manually assign unique numbers when - encoding. - </entry> - <entry>Write only</entry> - <entry><emphasis>Random</emphasis></entry> - </row> - <row> - <entry>comments</entry> - <entry> - Associative array of file comments. - Will be translated to <literal>strtoupper($name) . "=$value"</literal>. - Note: This context option is not available in oggvorbis-0.1 - </entry> - <entry>Write only</entry> - <entry><constant>array('ENCODER' => 'PHP/OggVorbis, http://pear.php.net/oggvorbis')</constant></entry> - </row> - </tbody> - </tgroup> - </table> - </section> - - <section id="pecl.oggvorbis.constants"> - <title>Constants</title> - <table> - <title>OGG/Vorbis supports PCM encodings in the following formats</title> - <tgroup cols="2"> - <thead> - <row> - <entry>Constant</entry> - <entry>Definition</entry> - </row> - </thead> - <tbody> - <row> - <entry><constant>OGGVORBIS_PCM_U8</constant></entry> - <entry>Unsigned 8-bit PCM.</entry> - </row> - <row> - <entry><constant>OGGVORBIS_PCM_S8</constant></entry> - <entry>Signed 8-bit PCM.</entry> - </row> - <row> - <entry><constant>OGGVORBIS_PCM_U16_LE</constant></entry> - <entry>Unsigned 16-bit PCM. Little Endian byte order.</entry> - </row> - <row> - <entry><constant>OGGVORBIS_PCM_U16_BE</constant></entry> - <entry>Unsigned 16-bit PCM. Big Endian byte order.</entry> - </row> - <row> - <entry><constant>OGGVORBIS_PCM_S16_LE</constant></entry> - <entry>Signed 16-bit PCM. Little Endian byte order.</entry> - </row> - <row> - <entry><constant>OGGVORBIS_PCM_S16_BE</constant></entry> - <entry>Signed 16-bit PCM. Big Endian byte order.</entry> - </row> - </tbody> - </tgroup> - </table> - </section> - - </partintro> - - <refentry> - <refnamediv> - <refname>Usage</refname> - <refpurpose> - Examples on using the ogg:// wrapper. - </refpurpose> - </refnamediv> - - <refsect1 id="pecl.oggvorbis.usage"> - <title>Usage</title> - <example> - <title>Reading an OGG/Vorbis file</title> - <programlisting role="php"> -<![CDATA[ -<?php -dl("oggvorbis.so"); - -/* By default, ogg:// will decode to Signed 16-bit Little Endian */ -$fp = fopen('ogg://myaudio.ogg', 'r'); - -/* Collect some information about the file. */ -$metadata = stream_get_meta_data($fp); - -/* Inspect the first song (usually the only song, - but OGG/Vorbis files may be chained) */ -$songdata = $metadata['wrapper_data'][0]; - -echo "OGG/Vorbis file encoded by: {$songdata['vendor']}\n."; -echo " {$songdata['channels']} channels of {$songdata['rate']}Hz sampling encoded at {$songdata['bitrate_nominal']}bps.\n"; -foreach($songdata['comments'] as $comment) { - echo " $comment\n"; -} - -while ($audio_data = fread($fp, 8192)) { - /* Do something with the PCM audio we're extracting from the OGG. - Copying to /dev/dsp is a good target on linux systems, - just remember to setup the device for your sampling mode first. */ -} - -fclose($fp); - -?> -]]> - </programlisting> - </example> - - <example> - <title>Encode an audio file to OGG/Vorbis</title> - <programlisting role="php"> -<![CDATA[ -<?php -dl('oggvorbis.so'); - -$context = stream_context_create(array('ogg'=>array( - 'pcm_mode' => OGGVORBIS_PCM_S8, /* Signed 8bit audio */ - 'rate' => 44100, /* 44kHz CD quality */ - 'bitrate' => 0.5, /* Midquality VBR */ - 'channels' => 1, /* Mono */ - 'serialno' => 12345))); /* Unique within our stream */ - -/* Open file for appending. This will "chain" a second OGG stream at the end of the first. */ -$ogg = fopen('ogg://mysong.ogg', 'a', false, $context); - -$pcm = fopen('mysample.pcm', 'r'); - -/* Compress the raw PCM audio from mysample.pcm into mysong.ogg */ -stream_copy_to_stream($pcm, $ogg); - -fclose($pcm); -fclose($ogg); -?> -]]> - </programlisting> - </example> - - </refsect1> + </refsect1> </refentry> - - </reference> +</reference>  - - <reference id="pecl.paradox"> - <title>Paradox File Access</title> - <titleabbrev>Paradox</titleabbrev> - <partintro> - <sect1 id="pecl.paradox.partintro"> - <title>Introduction</title> - - <sect2 id="pecl.paradox.intro"> - <title>About Paradox file access</title> - <para> - This module allows to read Paradox database and primary index files. - It has initial support for creating Paradox databases. Consider it - to be experimental due to lack of documentation of the Paradox file - format. - </para> - <note> - <para> - You will need to get the paradox library (libpx) available at - <ulink url="http://pxlib.sourceforge.net">http://pxlib.sourceforge.net</ulink>. - </para> - </note> - <note> - <para> - This module has not been tested on other platforms than Debian/GNU - Linux for PPC. - </para> - </note> - <note> - <para> - This module is also in development and may change, though I don't - expect major changes to the API. - </para> - </note> - </sect2> - - <sect2 id="pecl.paradox.constants"> - <title>Constants</title> - <para> - The following two tables lists all constants defined by the paradox - extension. - - <table id="pecl.paradox.table-fieldtypes"> - <title>Contants for field types</title> - <tgroup cols="2"> - <thead> - <row> - <entry>Name</entry> - <entry>Meaning</entry> - </row> - </thead> - <tbody> - <row> - <entry>PX_FIELD_ALPHA</entry> - <entry>Character data with fixed length</entry> - </row> - <row> - <entry>PX_FIELD_DATE</entry> - <entry>Date</entry> - </row> - <row> - <entry>PX_FIELD_SHORT</entry> - <entry>Short integer (2 Bytes)</entry> - </row> - <row> - <entry>PX_FIELD_LONG</entry> - <entry>Long integer (4 Bytes)</entry> - </row> - <row> - <entry>PX_FIELD_CURRENCY</entry> - <entry>same as PX_FIELD_NUMBER</entry> - </row> - <row> - <entry>PX_FIELD_NUMBER</entry> - <entry>Double</entry> - </row> - <row> - <entry>PX_FIELD_LOGICAL</entry> - <entry>Boolean</entry> - </row> - <row> - <entry>PX_FIELD_MEMOBLOB</entry> - <entry>Binary large object (not supported)</entry> - </row> - <row> - <entry>PX_FIELD_BLOB</entry> - <entry>Binary large object (not supported)</entry> - </row> - <row> - <entry>PX_FIELD_FMTMEMOBLOB</entry> - <entry>Binary large object (not supported)</entry> - </row> - <row> - <entry>PX_FIELD_OLE</entry> - <entry>OLE object (basically a blob, not supported)</entry> - </row> - <row> - <entry>PX_FIELD_GRAPHIC</entry> - <entry>Graphic (basically a blob, not supported)</entry> - </row> - <row> - <entry>PX_FIELD_TIME</entry> - <entry>time</entry> - </row> - <row> - <entry>PX_FIELD_TIMESTAMP</entry> - <entry>timestamp (like the unix timestamp)</entry> - </row> - <row> - <entry>PX_FIELD_AUTOINC</entry> - <entry>Auto incrementing interger (like PX_FIELD_LONG)</entry> - </row> - <row> - <entry>PX_FIELD_BCD</entry> - <entry>Decimal number stored in bcd format (not supported)</entry> - </row> - <row> - <entry>PX_FIELD_BYTES</entry> - <entry>Array of Bytes with not more than 255 bytes (not supported)</entry> - </row> - </tbody> - </tgroup> - </table> - - <table id="pecl.paradox.table-filetypes"> - <title>Contants for file types</title> - <tgroup cols="2"> - <thead> - <row> - <entry>Name</entry> - <entry>Meaning</entry> - </row> - </thead> - <tbody> - <row> - <entry>PX_FILE_INDEX_DB</entry> - <entry>Indexed database</entry> - </row> - <row> - <entry>PX_FILE_PRIM_INDEX</entry> - <entry>Primary index</entry> - </row> - <row> - <entry>PX_FILE_NON_INDEX_DB</entry> - <entry>None indexed database</entry> - </row> - <row> - <entry>PX_FILE_NON_INC_SEC_INDEX</entry> - <entry>None incremental secondary index (not supported)</entry> - </row> - <row> - <entry>PX_FILE_SEC_INDEX</entry> - <entry>Secondary index (not supported)</entry> - </row> - <row> - <entry>PX_FILE_INC_SEC_INDEX</entry> - <entry>Incremental secondary index (not supported)</entry> - </row> - <row> - <entry>PX_FILE_NON_INC_SEC_INDEX_G</entry> - <entry>(not supported)</entry> - </row> - <row> - <entry>PX_FILE_SEC_INDEX_G</entry> - <entry>(not supported)</entry> - </row> - <row> - <entry>PX_FILE_INC_SEC_INDEX_G</entry> - <entry>(not supported)</entry> - </row> - </tbody> - </tgroup> - </table> - </para> - </sect2> - - <sect2 id="pecl.paradox.install"> - <title>Installation</title> - <para> - A short installation note: - <itemizedlist> - <listitem> - <simpara> - You need at least PHP 5.0.0 and libpx >= 0.1.9 - </simpara> - </listitem> - <listitem> - <simpara> - Just type 'pear install paradox' in your console. - </simpara> - </listitem> - </itemizedlist> - </para> - </sect2> - - <sect2 id="pecl.paradox.configuration"> - <title>Configuration</title> - <para>There is currently no need to configure the extension. - </para> - </sect2> - - <sect2 id="pecl.paradox.oo-api"> - <title>Object oriented API</title> - <para> - The paradox extension provides also an - object oriented API. It consists of only one class called - paradox_doc. Its methods only differ from the functions - in its name and of course the missing first parameter. - The following table will list all methods and its - equivalent functions. - - <table id="pecl.paradox.table-class-methods"> - <title>Methods of class paradox_doc</title> - <tgroup cols="2"> - <thead> - <row> - <entry>Name of method</entry> - <entry>Equivalent function</entry> - </row> - </thead> - <tbody> - <row> - <entry>Constructor</entry> - <entry><function>px_new</function></entry> - </row> - <row> - <entry>Destructor</entry> - <entry><function>px_delete</function></entry> - </row> - <row> - <entry><function>open_fp</function></entry> - <entry><function>px_open_fp</function></entry> - </row> - <row> - <entry><function>create_fp</function></entry> - <entry><function>px_create_fp</function></entry> - </row> - <row> - <entry><function>close</function></entry> - <entry><function>px_close</function></entry> - </row> - <row> - <entry><function>numrecords</function></entry> - <entry><function>px_numrecords</function></entry> - </row> - <row> - <entry><function>numfields</function></entry> - <entry><function>px_numfields</function></entry> - </row> - <row> - <entry><function>get_record</function></entry> - <entry><function>px_get_record</function></entry> - </row> - <row> - <entry><function>put_record</function></entry> - <entry><function>px_put_record</function></entry> - </row> - <row> - <entry><function>get_field</function></entry> - <entry><function>px_get_field</function></entry> - </row> - <row> - <entry><function>get_schema</function></entry> - <entry><function>px_get_schema</function></entry> - </row> - <row> - <entry><function>get_info</function></entry> - <entry><function>px_get_info</function></entry> - </row> - <row> - <entry><function>set_parameter</function></entry> - <entry><function>px_set_parameter</function></entry> - </row> - <row> - <entry><function>get_parameter</function></entry> - <entry><function>px_get_parameter</function></entry> - </row> - <row> - <entry><function>set_value</function></entry> - <entry><function>px_set_value</function></entry> - </row> - <row> - <entry><function>get_value</function></entry> - <entry><function>px_get_value</function></entry> - </row> - <row> - <entry><function>get_info</function></entry> - <entry><function>px_get_info</function></entry> - </row> - <row> - <entry><function>set_targetencoding</function></entry> - <entry><function>px_set_targetencoding</function></entry> - </row> - <row> - <entry><function>set_tablename</function></entry> - <entry><function>px_set_tablename</function></entry> - </row> - <row> - <entry><function>set_blob_file</function></entry> - <entry><function>px_set_blob_file</function></entry> - </row> - </tbody> - </tgroup> - </table> - - </para> - </sect2> - - </sect1> - - </partintro> - - <refentry id="pecl.paradox.px-new"> - <refnamediv> - <refname>px_new</refname> - <refpurpose>Create a new paradox object</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>px_new</function></funcdef> - <paramdef>void <parameter></parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Create a new paradox object. You will have to call this function - before any further functions. <function>px_new</function> does not - create any file on the disk, it justs creates an instance of a paradox - object. Returns FALSE on failure. - </para> - <para> - <example> - <title>Opening a Paradox database</title> - <programlisting role="php"> -<![CDATA[ -<?php -if(!$pxdoc = px_new()) { - /* Error handling */ -} -$fp = fopen("test.db", "r"); -if(!px_open_fp($pxdoc, $fp)) { - /* Error handling */ -} -// ... -px_close($pxdoc); -px_delete($pxdoc); -fclose($fp); -?> -]]> - </programlisting> - </example> - </para> - <para> - If you prefer the object oriented API, then the above example will look - like the following. - <example> - <title>Opening a Paradox database</title> - <programlisting role="php"> -<![CDATA[ -<?php -$fp = fopen("test.db", "r"); -$pxdoc = new paradox_db(); -if(!$pxdoc->open_fp($fp)) { - /* Error handling */ -} -// ... -$pxdoc->close(); -fclose($fp); -?> -]]> - </programlisting> - </example> - </para> - <para> - See also <function>px_open_fp</function>, <function>px_delete</function>. - </para> - </refsect1> - </refentry> - - <refentry id="pecl.paradox.px-open-fp"> - <refnamediv> - <refname>px_open_fp</refname> - <refpurpose>Open paradox database</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>px_open_fp</function></funcdef> - <paramdef>resource <parameter>pxdoc</parameter></paramdef> - <paramdef>resource <parameter>file</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Open an existing paradox database file. The actual file has to - be opened before with <function>fopen</function>. The first parameter - is the return value of <function>px_new</function>. This function can - also be used to open primary index files and tread them like a paradox - database. This is supported for those who would like to investigate - a primary index. It cannot be used to accelerate access to a database - file. Returns FALSE on failure. - </para> - <para> - See also example at <function>px_new</function>, <function>fopen</function>. - </para> - </refsect1> - </refentry> - - <refentry id="pecl.paradox.px-create-fp"> - <refnamediv> - <refname>px_create_fp</refname> - <refpurpose>Create a new paradox database</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>px_create_fp</function></funcdef> - <paramdef>resource <parameter>pxdoc</parameter></paramdef> - <paramdef>array <parameter>fielddesc</parameter></paramdef> - <paramdef>resource <parameter>file</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Create a new paradox database file. The actual file has to - be opened before with <function>fopen</function>. Make sure - the file is writable. The first - parameter is the return value of <function>px_new</function>. - <option>fielddesc</option> is an array containing - one element for each field containing its specification. Each field - specification is an array itself with either two or three elements. - The first element is always a string value used as the name of the field. - It may not be larger than ten characters. The second element contains - the field type which is one of the constants listed in the table <link - linkend="pecl.paradox.table-fieldtypes">Constants for field types</link>. - In the case of a - character field, you will have to provide a third element specifying - the length of the field. - </para> - <note> - <para>This function is highly experimental, due to insufficient - documentation of the paradox file format. Database files created - with this function can be opened by <function>px_open_fp</function> - and has been successfully opened by the Paradox software, but your - milage may vary.</para> - </note> - <para> - <example> - <title>Creating a Paradox database with two fields</title> - <programlisting role="php"> -<![CDATA[ -<?php -if(!$pxdoc = px_new()) { - /* Error handling */ -} -$fp = fopen("test.db", "w+"); -$fields = array(array("col1", "S"), array("col2", "I")); -if(!@px_create_fp($pxdoc, $fields, $fp)) { - /* Error handling */ -} -px_set_tablename($pxdoc, "testtable"); -for($i=-50; $i<50; $i++) { - $rec = array($i, -$i); - px_put_record($pxdoc, $rec); -} -px_close($pxdoc); -px_delete($pxdoc); -fclose($fp); -?> -]]> - </programlisting> - </example> - </para> - <para> - See also <function>px_new</function>, <function>fopen</function>, - <function>px_put_record</function>. - </para> - </refsect1> - </refentry> - - <refentry id="pecl.paradox.px-close"> - <refnamediv> - <refname>px_close</refname> - <refpurpose>Closes a paradox database</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>px_close</function></funcdef> - <paramdef>resource <parameter>pxdoc</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Closes the paradox database. This function will not close the file. You will - have to call <function>fclose</function> afterwards. - </para> - <para> - See also <function>px_open_fp</function>, the example at - <function>px_new</function>. - </para> - </refsect1> - </refentry> - - <refentry id="pecl.paradox.px-delete"> - <refnamediv> - <refname>px_delete</refname> - <refpurpose>Deletes resource of paradox database</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>px_delete</function></funcdef> - <paramdef>resource <parameter>pxdoc</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Deletes the resource of the paradox file and frees all memory. - </para> - </refsect1> - </refentry> - - <refentry id="pecl.paradox.px-get-record"> - <refnamediv> - <refname>px_get_record</refname> - <refpurpose>Returns record of paradox database</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>px_get_record</function></funcdef> - <paramdef>resource <parameter>pxdoc</parameter></paramdef> - <paramdef>int <parameter>num</parameter></paramdef> - <paramdef>int <parameter><optional>mode</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Returns the <option>num</option>'th record from the paradox database. The record is - returned as an associated array with its keys being the field names. - <parameter>mode</parameter> can be PX_KEYTOLOWER or PX_KEYTOUPPER - in order to convert the keys into lower or upper case. If - <parameter>mode</parameter> is not passed or is 0, then the key will be - exactly - like the field name. The element values will contain the field values. - NULL values will be retained and are different from 0.0, 0 or the empty - string. Fields of typ PX_FIELD_TIME will be returned as an integer - counting the number of milli seconds starting at midnight. - A timestamp is a floating point value also counting milli seconds - starting at the beginning of julian calendar. - </para> - <para> - The record number is an artificial number counting records in the - order as they are stored in the database. The first record has number 0. - </para> - </refsect1> - </refentry> - - <refentry id="pecl.paradox.px-put-record"> - <refnamediv> - <refname>px_put_record</refname> - <refpurpose>Stores record into paradox database</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>px_put_record</function></funcdef> - <paramdef>resource <parameter>pxdoc</parameter></paramdef> - <paramdef>array <parameter>record</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Stores a record into a paradox database. The record is added at the - end of the database. - </para> - </refsect1> - </refentry> - - <refentry id="pecl.paradox.px-numrecords"> - <refnamediv> - <refname>px_numrecords</refname> - <refpurpose>Returns number of records in a database</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>px_numrecords</function></funcdef> - <paramdef>resource <parameter>pxdoc</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Returns the number of records in a database file. The return value - of this function is identical to the element 'numrecords' in the - associated array returned by <function>px_get_info</function>. - </para> - </refsect1> + +<reference id="pecl.paradox"> + <title>Net_Gopher</title> + + <refentry id="pecl.paradox.docs"> + <refnamediv> + <refname>Documentation</refname> + <refpurpose /> + </refnamediv> + <refsect1> + <title>Documentation moved</title> + <simpara> + The documentation is now part of the <ulink url="&url.php.manual;/en/ref.paradox.php">PHP + manual</ulink>. + </simpara> + </refsect1> </refentry> - - <refentry id="pecl.paradox.px-numfields"> - <refnamediv> - <refname>px_numfields</refname> - <refpurpose>Returns number of fields in a database</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>px_numfields</function></funcdef> - <paramdef>resource <parameter>pxdoc</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Returns the number of fields in a database file. The return value - of this function is identical to the element 'numfields' in the - associated array returned by <function>px_get_info</function>. - </para> - </refsect1> - </refentry> - - <refentry id="pecl.paradox.px-get-schema"> - <refnamediv> - <refname>px_get_schema</refname> - <refpurpose>Returns the database schema</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>px_get_schema</function></funcdef> - <paramdef>resource <parameter>pxdoc</parameter></paramdef> - <paramdef>int <parameter><optional>mode</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Returns the schema of a database file as an associated array. The key - name is equal to the field name. If <parameter>mode</parameter> is - PX_KEYTOLOWER or PX_KEYTOUPPER the key will be converted to lower or - upper case. If <parameter>mode</parameter> is 0 or not passed at all, - then the key name will be identical to the field name. Each array - element is itself an associated array containing the two fields - 'type' and 'size'. 'type' is one of the constants in table <link - linkend="pecl.paradox.table-fieldtypes">Constants for field types</link>. - </para> - </refsect1> - </refentry> - - <refentry id="pecl.paradox.px-get-field"> - <refnamediv> - <refname>px_get_field</refname> - <refpurpose>Returns the specification of a single field</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>px_get_field</function></funcdef> - <paramdef>resource <parameter>pxdoc</parameter></paramdef> - <paramdef>int <parameter><optional>fieldno</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Returns the specification of the <option>fieldno</option>'th database - field as an associated - array. The array contains three fields named 'name', 'type' and 'size'. - </para> - </refsect1> - </refentry> - - <refentry id="pecl.paradox.px-set-targetencoding"> - <refnamediv> - <refname>px_set_targetencoding</refname> - <refpurpose>Sets the encoding for character fields (deprecated)</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>px_set_targetencoding</function></funcdef> - <paramdef>resource <parameter>pxdoc</parameter></paramdef> - <paramdef>string <parameter>encoding</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Set the encoding for data retrieved from a character field. All character - fields will be recoded - to the encoding set by this function. If the encoding is not set, the - character data will be returned in the DOS code page encoding as - specified in the database. Returns FALSE if the encoding could not be set, - e.g. the encoding is unknown, or pxlib does not support recoding at all. - In the second case a warning will be issued. - </para> - <para> - See also <function>px_get_info</function> to determine the DOS code page. - </para> - </refsect1> - </refentry> - - <refentry id="pecl.paradox.px-set-parameter"> - <refnamediv> - <refname>px_set_parameter</refname> - <refpurpose>Sets a parameter</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>px_set_parameter</function></funcdef> - <paramdef>resource <parameter>pxdoc</parameter></paramdef> - <paramdef>string <parameter>name</parameter></paramdef> - <paramdef>string <parameter>value</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Sets various parameters. <parameter>name</parameter> can be one of - the following.</para> - <variablelist> - <varlistentry> - <term>tablename</term> - <listitem> - <para>The name of the table as it will be stored in the datbase - header. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>targetencoding</term> - <listitem> - <para>The encoding for the output. Data which is being read from - character fields is being recode into the targetencoding. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>inputencoding</term> - <listitem> - <para>The econding of the input data which is to be stored into the - database. - </para> - </listitem> - </varlistentry> - </variablelist> - <para> - See also <function>px_get_info</function> to determine the DOS code page. - </para> - </refsect1> - </refentry> - - <refentry id="pecl.paradox.px-get-parameter"> - <refnamediv> - <refname>px_get_parameter</refname> - <refpurpose>Gets a parameter</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>px_get_parameter</function></funcdef> - <paramdef>resource <parameter>pxdoc</parameter></paramdef> - <paramdef>string <parameter>name</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Gets various parameters. <parameter>name</parameter> can be one of - the following.</para> - <variablelist> - <varlistentry> - <term>tablename</term> - <listitem> - <para>The name of the table as it will be stored in the datbase - header. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>targetencoding</term> - <listitem> - <para>The encoding for the output. Data which is being read from - character fields is being recode into the targetencoding. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>inputencoding</term> - <listitem> - <para>The econding of the input data which is to be stored into the - database. - </para> - </listitem> - </varlistentry> - </variablelist> - </refsect1> - </refentry> - - <refentry id="pecl.paradox.px-set-value"> - <refnamediv> - <refname>px_set_value</refname> - <refpurpose>Sets a value</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>px_set_value</function></funcdef> - <paramdef>resource <parameter>pxdoc</parameter></paramdef> - <paramdef>string <parameter>name</parameter></paramdef> - <paramdef>double <parameter>value</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Sets various values. <parameter>name</parameter> can be one of - the following.</para> - <variablelist> - <varlistentry> - <term>numprimkeys</term> - <listitem> - <para>The number of primary keys. Paradox databases always use the - first <option>numprimkeys</option> fields for the primary index.</para> - </listitem> - </varlistentry> - </variablelist> - </refsect1> - </refentry> - - <refentry id="pecl.paradox.px-get-value"> - <refnamediv> - <refname>px_get_value</refname> - <refpurpose>Gets a value</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>double <function>px_set_value</function></funcdef> - <paramdef>resource <parameter>pxdoc</parameter></paramdef> - <paramdef>string <parameter>name</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Gets various values. <parameter>name</parameter> can be one of - the following.</para> - <variablelist> - <varlistentry> - <term>numprimkeys</term> - <listitem> - <para>The number of primary keys. Paradox databases always use the - first 'numprimkeys' fields for the primary index.</para> - </listitem> - </varlistentry> - </variablelist> - </refsect1> - </refentry> - - <refentry id="pecl.paradox.px-set-tablename"> - <refnamediv> - <refname>px_set_tablename</refname> - <refpurpose>Sets the name of a table (deprecated)</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>px_set_tablename</function></funcdef> - <paramdef>resource <parameter>pxdoc</parameter></paramdef> - <paramdef>string <parameter>name</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Sets the table name of a paradox database, which was created with - <function>px_create_fp</function>. Applying this function on an - existing database has no effect. - </para> - </refsect1> - </refentry> - - <refentry id="pecl.paradox.px-set-blob-file"> - <refnamediv> - <refname>px_set_blob_file</refname> - <refpurpose>Sets the file where blobs are read from</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>px_set_blob_file</function></funcdef> - <paramdef>resource <parameter>pxdoc</parameter></paramdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Sets the name of the file where blobs are going to be read from. - Without calling this function, <function>px_get_record</function> - will only return data in blob fields if the data is part of the - record and not stored in the blob file. Blob data is stored in - the record if it is small enough to fit in the size of the - blob field.</para> - <para>Calling this function - twice will close the first blob file and open the new one. - </para> - </refsect1> - </refentry> - - <refentry id="pecl.paradox.px-get-info"> - <refnamediv> - <refname>px_get_info</refname> - <refpurpose>Return lots of information about a paradox file</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>px_get_info</function></funcdef> - <paramdef>resource <parameter>pxdoc</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Returns an associated array with lots of information about a paradox - file. This array is likely to extend in the future. - </para> - <variablelist> - <varlistentry> - <term>fileversion</term> - <listitem> - <para>Version of file multiplied by 10. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>tablename</term> - <listitem> - <para>Name of table as stored in the file. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>numrecords</term> - <listitem> - <para>Number of records in this table. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>numfields</term> - <listitem> - <para>Number of fields in this table. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>headersize</term> - <listitem> - <para>Number of bytes used for the header. This is usally 0x800. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>maxtablesize</term> - <listitem> - <para>This value multiplied by 0x400 is the size of a data block - in bytes.</para> - </listitem> - </varlistentry> - <varlistentry> - <term>numdatablocks</term> - <listitem> - <para>The number of data blocks in the file. Each data block contains - a certain number of records which depends on the record size and - the data block size (maxtablesize). Data blocks may not necessarily - be completely filled. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>numindexfields</term> - <listitem> - <para>Number of fields used for the primary index. The fields do - always start as field number 1. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>codepage</term> - <listitem> - <para>The DOS codepage which was used for encoding fields with - character data. If the target encoding is not set with - <function>px_set_targetencoding</function> this will be the encoding - for character fields when records are being accessed with - <function>px_get_record</function>. - </para> - </listitem> - </varlistentry> - </variablelist> - <para> - See also <function>px_numfields</function>, - <function>px_numrecords</function>. - </para> - </refsect1> - </refentry> - - </reference> +</reference>  + http://cvs.php.net/diff.php/peardoc/en/pecl/ps.xml?r1=1.12&r2=1.13&ty=u Index: peardoc/en/pecl/ps.xml diff -u peardoc/en/pecl/ps.xml:1.12 peardoc/en/pecl/ps.xml:1.13 --- peardoc/en/pecl/ps.xml:1.12 Tue Jul 27 13:22:51 2004 +++ peardoc/en/pecl/ps.xml Sat Sep 10 09:43:34 2005 @@ -1,2826 +1,21 @@ <?xml version="1.0" encoding="iso-8859-1"?> - - - <reference id="pecl.ps"> + +<reference id="pecl.ps"> <title>PostScript document creation</title> - <titleabbrev>PS</titleabbrev> - <partintro> - <sect1 id="pecl.ps.partintro"> - <title>Introduction</title> - - <sect2 id="pecl.ps.intro"> - <title>About PostScript document creation</title> - <para> - This module allows to create PostScript documents. It has many - similarities with the pdf extension. Actually the API is almost - identical and one can in many cases just replace the prefix of - each function from pdf_ to ps_. This also works for functions which - has no meaning in the PostScript document (like adding hyperlinks) - but will have an effect if the document is converted to PDF. - </para> - <para>Documents created by this extension are sometimes even superior - to documents created with the pdf extension, because pslib's text - rendering functions can handle kerning, hyphenation and ligatures - which results in much better output of boxed text. - </para> - <note> - <para> - You will need to get the ps library (pslib) available at - <ulink url="http://pslib.sourceforge.net">http://pslib.sourceforge.net</ulink>. - </para> - </note> - </sect2> - - <sect2 id="pecl.ps.constants"> - <title>Constants</title> - <para> - The following two tables lists all constants defined by the ps - extension. - - <table id="pecl.ps.table-linecap"> - <title>Contants for line caps</title> - <tgroup cols="2"> - <thead> - <row> - <entry>Name</entry> - <entry>Meaning</entry> - </row> - </thead> - <tbody> - <row> - <entry>ps_LINECAP_BUTT</entry> - <entry></entry> - </row> - <row> - <entry>ps_LINECAP_ROUND</entry> - <entry></entry> - </row> - <row> - <entry>ps_LINECAP_SQUARED</entry> - <entry></entry> - </row> - </tbody> - </tgroup> - </table> - - <table id="pecl.paradox.table-linejoin"> - <title>Contants for line joins</title> - <tgroup cols="2"> - <thead> - <row> - <entry>Name</entry> - <entry>Meaning</entry> - </row> - </thead> - <tbody> - <row> - <entry>ps_LINEJOIN_MITER</entry> - <entry></entry> - </row> - <row> - <entry>ps_LINEJOIN_ROUND</entry> - <entry></entry> - </row> - <row> - <entry>ps_LINEJOIN_BEVEL</entry> - <entry></entry> - </row> - </tbody> - </tgroup> - </table> - </para> - </sect2> - - <sect2 id="pecl.ps.install"> - <title>Installation</title> - <para> - A short installation note: - <itemizedlist> - <listitem> - <simpara> - You need at least PHP 4.3.0 and pslib >= 0.1.12 - </simpara> - </listitem> - <listitem> - <simpara> - Just type 'pear install ps' in your console. - </simpara> - </listitem> - </itemizedlist> - </para> - </sect2> - - <sect2 id="pecl.ps.configuration"> - <title>Configuration</title> - <para> - </para> - </sect2> - <sect2 id="pecl.ps.contact"> - <title>Contact Information</title> - <para> - ...... - </para> - <para> - If you have comments, bugfixes, enhancements for either this extension - or pslib then please drop me a mail <ulink - url="mailto:steinm@php.net">steinm@php.net</ulink>. Any help is very - welcome. - </para> - </sect2> - - </sect1> - - </partintro> -<refentry id="pecl.ps.ps-add-bookmark"> - <refnamediv> - <refname>ps_add_bookmark</refname> - - <refpurpose>Add bookmark to current page</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ps_add_bookmark</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>string <parameter>text</parameter></paramdef> - <paramdef>int <parameter>parent</parameter></paramdef> - <paramdef>int <parameter>open</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Adds a bookmark for the current page. Bookmarks usually appear - in PDF-Viewers left of the page in a hierachical tree. - Clicking on a bookmark will jump to the given page.</para> - <para>The parameter <parameter>parent</parameter> is another bookmark - which is used as the parent of the new bookmark. If - <parameter>open</parameter> is unequal to zero the bookmark will - be shown open by the pdf viewer.</para> - <para>The bookmark has no meaning if the document is printed or - viewed but it will be used if the document is converted to pdf by either - Acrobat Distiller™ or Ghostview.</para> - <para>The returned value is a reference for the bookmark. It is only - used if the bookmark shall be used as a parent.</para> - - </refsect1> - <refsect1> - <title>Return value</title> - <para>Returns the identifier of the bookmark or zero in case of an error. - The identifier is a positiv number.</para> - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_add_launchlink</function>, <function>ps_add_pdflink</function>, <function>ps_add_weblink</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-add-launchlink"> - <refnamediv> - <refname>ps_add_launchlink</refname> - - <refpurpose>Adds link which launches file</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_add_launchlink</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>float <parameter>llx</parameter></paramdef> - <paramdef>float <parameter>lly</parameter></paramdef> - <paramdef>float <parameter>urx</parameter></paramdef> - <paramdef>float <parameter>ury</parameter></paramdef> - <paramdef>string <parameter>filename</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Places a hyperlink at the given position pointing to a file program - which is being started when clicked on. The hyperlink start is - a rectangle with its lower left corner at (llx, lly) and its upper right - corner at (urx, ury). The rectangle has by default a thin blue border. - </para> - <para>The hyperlink will not be visible if the document is printed or - viewed but it will show up if the document is converted to pdf by either - Acrobat Distiller™ or Ghostview.</para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_add_launchlink</function>, <function>ps_add_pdflink</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-add-locallink"> - <refnamediv> - <refname>ps_add_locallink</refname> - - <refpurpose>Adds link to a page in the same document</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_add_locallink</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>float <parameter>llx</parameter></paramdef> - <paramdef>float <parameter>lly</parameter></paramdef> - <paramdef>float <parameter>urx</parameter></paramdef> - <paramdef>float <parameter>ury</parameter></paramdef> - <paramdef>int <parameter>page</parameter></paramdef> - <paramdef>string <parameter>dest</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Places a hyperlink at the given position pointing to a page - in the same document. Clicking on the link will jump to the - given page. The first page in a document has number 1. - The parameter <parameter>dest</parameter> determines how - the document is being viewed. It can be 'fitpage', 'fitwidth', - 'fitheight', or 'fitbbox'.</para> - <para>The hyperlink start is - a rectangle with its lower left corner at (<parameter>llx</parameter>, - <parameter>lly</parameter>) and its upper right - corner at (<parameter>urx</parameter>, <parameter>ury</parameter>). - The rectangle has by default a thin blue border. - </para> - <para>The hyperlink will not be visible if the document is printed or - viewed but it will show up if the document is converted to pdf by either - Acrobat Distiller™ or Ghostview.</para> - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_add_launchlink</function>, <function>ps_add_pdflink</function>, <function>ps_add_weblink</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-add-note"> - <refnamediv> - <refname>ps_add_note</refname> - - <refpurpose>Adds note to current page</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_add_note</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>string <parameter>text</parameter></paramdef> - <paramdef>int <parameter>parent</parameter></paramdef> - <paramdef>int <parameter>open</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para></para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_add_pdflink</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-add-pdflink"> - <refnamediv> - <refname>ps_add_pdflink</refname> - - <refpurpose>Adds link to a page in a second pdf document</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_add_pdflink</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>float <parameter>llx</parameter></paramdef> - <paramdef>float <parameter>lly</parameter></paramdef> - <paramdef>float <parameter>urx</parameter></paramdef> - <paramdef>float <parameter>ury</parameter></paramdef> - <paramdef>string <parameter>filename</parameter></paramdef> - <paramdef>int <parameter>page</parameter></paramdef> - <paramdef>string <parameter>dest</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Places a hyperlink at the given position pointing to a second - pdf document. Clicking on the link will branch to the document at the - given page. The first page in a document has number 1. - The parameter <parameter>dest</parameter> determines how - the document is being viewed. It can be 'fitpage', 'fitwidth', - 'fitheight', or 'fitbbox'.</para> - <para>The hyperlink start is a rectangle with its lower left corner at - (<parameter>llx</parameter>, <parameter>lly</parameter>) and its upper right - corner at (<parameter>urx</parameter>, <parameter>ury</parameter>). The - rectangle has by default a thin blue border. - </para> - <para>The hyperlink will not be visible if the document is printed or - viewed but it will show up if the document is converted to pdf by either - Acrobat Distiller™ or Ghostview.</para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_add_launchlink</function>, <function>ps_add_locallink</function>, <function>ps_add_weblink</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-add-weblink"> - <refnamediv> - <refname>ps_add_weblink</refname> - - <refpurpose>Adds link to a web location</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_add_weblink</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>float <parameter>llx</parameter></paramdef> - <paramdef>float <parameter>lly</parameter></paramdef> - <paramdef>float <parameter>urx</parameter></paramdef> - <paramdef>float <parameter>ury</parameter></paramdef> - <paramdef>string <parameter>url</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Places a hyperlink at the given position pointing to a web page. - The hyperlink start is - a rectangle with its lower left corner at (llx, lly) and its upper right - corner at (urx, ury). The rectangle has by default a thin blue border. - </para> - <para>The hyperlink will not be visible if the document is printed or - viewed but it will show up if the document is converted to pdf by either - Acrobat Distiller™ or Ghostview.</para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_add_launchlink</function>, <function>ps_add_pdflink</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-arcn"> - <refnamediv> - <refname>ps_arcn</refname> - - <refpurpose>Draws an arc clockwise</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_arcn</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>float <parameter>x</parameter></paramdef> - <paramdef>float <parameter>y</parameter></paramdef> - <paramdef>float <parameter>radius</parameter></paramdef> - <paramdef>float <parameter>alpha</parameter></paramdef> - <paramdef>float <parameter>beta</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Draws a portion of a circle with at middle point at - (<parameter>x</parameter>, <parameter>y</parameter>). The arc starts at - an angle of <parameter>alpha</parameter> and ends at an angle of - <parameter>beta</parameter>. It is draws clockwise. - The subpath added to the current path starts on the arc at angle - <parameter>beta</parameter> and ends on the arc at angle - <parameter>alpha</parameter>.</para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_arc</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-arc"> - <refnamediv> - <refname>ps_arc</refname> - - <refpurpose>Draws an arc counterclockwise</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_arc</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>float <parameter>x</parameter></paramdef> - <paramdef>float <parameter>y</parameter></paramdef> - <paramdef>float <parameter>radius</parameter></paramdef> - <paramdef>float <parameter>alpha</parameter></paramdef> - <paramdef>float <parameter>beta</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Draws a portion of a circle with at middle point at - (<parameter>x</parameter>, <parameter>y</parameter>). The arc starts at - an angle of <parameter>alpha</parameter> and ends at an angle of - <parameter>beta</parameter>. It is draw counterclockwise. - The subpath added to the current path starts on the arc at angle - <parameter>alpha</parameter> and ends on the arc at angle - <parameter>beta</parameter>. - </para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_arcn</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-begin-page"> - <refnamediv> - <refname>ps_begin_page</refname> - - <refpurpose>Start a new page</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_begin_page</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>float <parameter>width</parameter></paramdef> - <paramdef>float <parameter>height</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Starts a new page. Though the parameters <parameter>width</parameter> - and <parameter>height</parameter> imply a different page size for each - page, this is not possible in PostScript. The first call of - <function>ps_begin_page</function> will set - the page size for the whole document. Consecutive calls will have no - effect, except for creating a new page. The situation is different - if you indent to convert the PostScript document into PDF. This function - places pdfmarks into the document which can set the size for each page - indiviually. The resulting PDF document will have different page sizes. - </para> - <para>Each page is encapsulated into save/restore. This means, that most - of the settings made on one page will not be retained on the next page. - </para> - <para>If there is up to the first call of - <function>ps_begin_page</function> no call of - <function>ps_findfont</function>, then the header of the PostScript - document will be output and the bounding box will be set to the size of the - first page. If <function>ps_findfont</function> was called before the - header has been output already, the document will not have a valid bounding - box. In order to prevent this, one should set the info field 'BoundingBox' - and possibly `Orientation' before any <function>ps_findfont</function> or - <function>ps_begin_page</function> calls.</para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_end_page</function>, <function>ps_findfont</function>, <function>ps_set_info</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-begin-pattern"> - <refnamediv> - <refname>ps_begin_pattern</refname> - - <refpurpose>Start a new pattern</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ps_begin_pattern</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>float <parameter>width</parameter></paramdef> - <paramdef>float <parameter>height</parameter></paramdef> - <paramdef>float <parameter>xstep</parameter></paramdef> - <paramdef>float <parameter>ystep</parameter></paramdef> - <paramdef>long <parameter>painttype</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Starts a new pattern. - </para> - - </refsect1> - <refsect1> - <title>Return value</title> - - <para>The identifier of the pattern or false in case of an error.</para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_end_pattern</function>, - <function>ps_setcolor</function>, - <function>ps_shading_pattern</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-begin-template"> - <refnamediv> - <refname>ps_begin_template</refname> - - <refpurpose>Start a new template</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_begin_template</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>float <parameter>width</parameter></paramdef> - <paramdef>float <parameter>height</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Starts a new template. - </para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_end_template</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-circle"> - <refnamediv> - <refname>ps_circle</refname> - - <refpurpose>Draws a circle</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_circle</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>float <parameter>x</parameter></paramdef> - <paramdef>float <parameter>y</parameter></paramdef> - <paramdef>float <parameter>radius</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Draws a circle with its middle point at - (<parameter>x</parameter>, <parameter>y</parameter>). The circle starts - and ends at position - (<parameter>x</parameter>+<parameter>radius</parameter>, - <parameter>y</parameter>). If this function is called outside a path it - will start a new path. If it is called within a path it will add the - circle as a subpath. If the last drawing operation does not end in point - (<parameter>x</parameter>+<parameter>radius</parameter>, - <parameter>y</parameter>) then there will be a gab in the path.</para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_arc</function>, <function>ps_arcn</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-clip"> - <refnamediv> - <refname>ps_clip</refname> - - <refpurpose>Clips drawing to current path</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_clip</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Takes the current path and uses it to define the border of a clipping - area.</para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_closepath</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-close-image"> - <refnamediv> - <refname>ps_close_image</refname> - - <refpurpose>Closes image and frees memory</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_close_image</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>int <parameter>imageid</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para></para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_open_image</function>, <function>ps_open_image_file</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-closepath"> - <refnamediv> - <refname>ps_closepath</refname> - - <refpurpose>Closes path</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_closepath</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Connects the last point with first point of a path.</para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_closepath_stoke</function>, <function>ps_clip</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-closepath-stroke"> - <refnamediv> - <refname>ps_closepath_stroke</refname> - - <refpurpose>Closes and strokes path</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_closepath_stroke</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Connects the last point with first point of a path and draws - the resulting closed line.</para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_closepath</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-close"> - <refnamediv> - <refname>ps_close</refname> - - <refpurpose>Closes a PostScript document</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_close</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Closes the PostScript document. - </para> - <para>This function outputs a last line into - the PostScript document, which is a PostScript comment containing - the number of pages. It also writes the bookmark tree.</para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_open_file</function>, <function>ps_delete</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-continue-text"> - <refnamediv> - <refname>ps_continue_text</refname> - - <refpurpose>Continue text in next line</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_continue_text</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>string <parameter>text</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Output a text one line below the last outputed line. - The line spacing is taken from the value "leading" which must be - set with <function>ps_set_value</function> in points. - The actual position of the text is determined - by the values "textx" and "texty" which can be requested with - <function>ps_get_value</function></para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_show</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-curveto"> - <refnamediv> - <refname>ps_curveto</refname> - - <refpurpose>Draws a curve</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_curveto</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>float <parameter>x1</parameter></paramdef> - <paramdef>float <parameter>y1</parameter></paramdef> - <paramdef>float <parameter>x2</parameter></paramdef> - <paramdef>float <parameter>y2</parameter></paramdef> - <paramdef>float <parameter>x3</parameter></paramdef> - <paramdef>float <parameter>y3</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Draws a curve described by the three given points.</para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_lineto</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-delete"> - <refnamediv> - <refname>ps_delete</refname> - - <refpurpose>Deletes all resources of a PostScript document</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_delete</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Mainly frees memory used by the document. Also closes a file, if - it was not closed before with <function>ps_close</function>. You should in any case close - the file with <function>ps_close</function> before, because <function>ps_close</function> not just closes the - file but also outputs a last line containing the PostScript comment with - the number of pages in the document. Without this comment, a PostScript - viewer may not show the number of pages propperly.</para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_close</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-end-page"> - <refnamediv> - <refname>ps_end_page</refname> - - <refpurpose>End a page</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_end_page</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Ends a page which was started with <function>ps_begin_page</function>.</para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_begin_page</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-end-pattern"> - <refnamediv> - <refname>ps_end_pattern</refname> - - <refpurpose>End a page</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_end_pattern</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Ends a pattern which was started with <function>ps_begin_pattern</function>.</para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_begin_pattern</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-end-template"> - <refnamediv> - <refname>ps_end_template</refname> - - <refpurpose>End a template</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_end_template</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Ends a template which was started with <function>ps_begin_template</function>.</para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_begin_template</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-fill"> - <refnamediv> - <refname>ps_fill</refname> - - <refpurpose>Fills the current path</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_fill</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Fills the path constructed with previously called drawing functions - like <function>ps_lineto</function>.</para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_stroke</function>, <function>ps_fill_stroke</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-fill-stroke"> - <refnamediv> - <refname>ps_fill_stroke</refname> - - <refpurpose>Fills and strokes the current path</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_fill_stroke</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Fills and draws the path constructed with previously called - drawing functions like <function>ps_lineto</function>.</para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_stroke</function>, <function>ps_fill</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-findfont"> - <refnamediv> - <refname>ps_findfont</refname> - - <refpurpose>Loads a font</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ps_findfont</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>string <parameter>fontname</parameter></paramdef> - <paramdef>string <parameter>encoding</parameter></paramdef> - <paramdef>bool <parameter>embed</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Loads a font for later use. Before text is output with a loaded - font it must be set with <function>ps_setfont</function>. This function needs the adobe - font metric file in order to calculate the space used up by the - characters. A font which is loaded within a page will only be available - on that page. Fonts which are to be used in the complete document - has to be loaded before the first call of <function>ps_begin_page</function>. Calling - <function>ps_findfont</function> between pages will make that font available for all - following pages.</para> - <para><function>ps_findfont</function> will try to load the file passed - in the parameter - <parameter>encoding</parameter>. Encoding files are of the same - syntax as those used by <command>dvips(1)</command>. The contain - a font encoding vector (which is currently not used but must be present) - and a list of extra ligatures to extend the - list of ligatures derived from the afm file.</para> - <para><parameter>encoding</parameter> can be NULL or the empty string - if the default encoding (TeXBase1) schall be used.</para> - <para>If the encoding is set to `builtin' then there will be no - reencoding and the font specific encoding will be used. This is - very useful with symbol fonts.</para> - - </refsect1> - <refsect1> - <title>Return value</title> - <para>Returns the identifier of the font or zero in case of an error. - The identifier is a positiv number.</para> - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_setfont</function>, <function>ps_begin_page</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-get-buffer"> - <refnamediv> - <refname>ps_get_buffer</refname> - - <refpurpose></refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ps_get_buffer</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Not yet implemented</para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_open_file</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-get-parameter"> - <refnamediv> - <refname>ps_get_parameter</refname> - - <refpurpose>Gets certain parameters</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ps_get_parameter</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>string<parameter>name</parameter></paramdef> - <paramdef>float <parameter><optional>modifier</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> - - <para>Gets several parameters which were set by <function>ps_set_parameter</function>. - Parameters are by definition string values. This function cannot be used - to retrieve resources which were also set by <function>ps_set_parameter</function>.</para> - - </refsect1> - <refsect1> - <title>Return value</title> - <para>Returns the value of the parameter or FALSE.</para> - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_set_parameter</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-get-value"> - <refnamediv> - <refname>ps_get_value</refname> - - <refpurpose>Gets certain values</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>float <function>ps_get_value</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>string <parameter>name</parameter></paramdef> - <paramdef>float <parameter><optional>modifier</optional></parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Gets several values which were set by - <function>ps_set_value</function>. - Parameters are by definition float values.</para> - <para>The parameter <parameter>modifier</parameter> specifies the - resource for which the value is to be retrieved. This can be the - id of a font or an image. It must be 0.0 if not used.</para> - - </refsect1> - <refsect1> - <title>Return value</title> - <para>Returns the value of the parameter or FALSE.</para> - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_set_value</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-hyphenate"> - <refnamediv> - <refname>ps_hyphenate</refname> - - <refpurpose>Hyphenates a word</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>ps_hyphenate</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>string <parameter>text</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Hyphenates the passed word. <parameter>text</parameter> should not - contain any non alpha characters. Possible positions for breaks are - returned in an array of interger numbers. Each number is the - position of the char in <parameter>text</parameter> after which - a hyphenation can take place.</para> - <para>This function requires the locale category LC_CTYPE to be set - propperly. This is done when the extension is initialized by using the - enviroment variables. On Unix systems read the man page of locale. - </para> - <para>ps_hyphenate() evaluates the value hyphenminchars and the parameter - hyphendict. hyphendict must be set before calling this function.</para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_boot</function>, <function>ps_show_boxed</function>, locale(1)</para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-lineto"> - <refnamediv> - <refname>ps_lineto</refname> - - <refpurpose>Draws a line</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_lineto</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>float <parameter>x</parameter></paramdef> - <paramdef>float <parameter>y</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Adds a straight line from the current point to the given coordinates - to the current path. - Use <function>ps_moveto</function> to set the starting point of the line.</para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_moveto</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-makespotcolor"> - <refnamediv> - <refname>ps_makespotcolor</refname> - - <refpurpose>Create spot color</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_lineto</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>string <parameter>name</parameter></paramdef> - <paramdef>float <parameter><optional>reserved</optional></parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Creates a spot color from the current fill color. The fill color - must be defined in rgb, cmyk or gray colorspace. The spot color name - can be an abitrary name. A spot color can be set as any color with - <function>ps_setcolor</function>.</para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_setcolor</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-moveto"> - <refnamediv> - <refname>ps_moveto</refname> - - <refpurpose>Sets current point</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_moveto</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>float <parameter>x</parameter></paramdef> - <paramdef>float <parameter>y</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Sets the current point to new coordinates. If this is the first - call of <function>ps_moveto</function> after a previous path has been ended then it will - start a new path. If this function is called in the middle of a path - it will just set the current point and start a subpath.</para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_lineto</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-new"> - <refnamediv> - <refname>ps_new</refname> - - <refpurpose>Creates a new PostScript document object</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>ps_new</function></funcdef> - <paramdef>void <parameter></parameter></paramdef> - </funcprototype> - </funcsynopsis> - - <para>Creates a new document instance. It does not create the file on disk - or in memory. It just sets up everything.</para> - - </refsect1> - <refsect1> - <title>Return value</title> - <para>Resource of PostScript document or FALSE on failure.</para> - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_delete</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-open-file"> - <refnamediv> - <refname>ps_open_file</refname> - - <refpurpose>Opens a file for output</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_open_file</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>string <parameter><optional>filename</optional></parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Creates a new file on disk and writes the PostScript document into - it. The file will be closed when <function>ps_close</function> is called. - If filename is - not passed the document will be created in memory and all output will - go straight to the browser.</para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_close</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-open-image-file"> - <refnamediv> - <refname>ps_open_image_file</refname> - - <refpurpose>Opens image from file</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ps_open_image_file</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>string <parameter>type</parameter></paramdef> - <paramdef>string <parameter>filename</parameter></paramdef> - <paramdef>string <parameter>stringparam</parameter></paramdef> - <paramdef>int <parameter>intparam</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para></para> - - </refsect1> - <refsect1> - <title>Return value</title> - <para>Returns identifier of image or zero in case of an error. - The identifier is a positiv number greater 0.</para> - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_open_image</function>, <function>ps_place_image</function>, <function>ps_close_image</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-open-image"> - <refnamediv> - <refname>ps_open_image</refname> - - <refpurpose>Reads an image for later placement</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ps_open_image</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>string <parameter>type</parameter></paramdef> - <paramdef>string <parameter>source</parameter></paramdef> - <paramdef>string <parameter>data</parameter></paramdef> - <paramdef>int <parameter>lenght</parameter></paramdef> - <paramdef>int <parameter>width</parameter></paramdef> - <paramdef>int <parameter>height</parameter></paramdef> - <paramdef>int <parameter>components</parameter></paramdef> - <paramdef>int <parameter>bpc</parameter></paramdef> - <paramdef>string <parameter>params</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Reads an image which is already available in memory. The parameter - <parameter>source</parameter> is currently not evaluated and assumed - to be `memory'.</para> - - </refsect1> - <refsect1> - <title>Return value</title> - <para>Returns identifier of image or zero in case of an error. - The identifier is a positiv number greater 0.</para> - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_open_image_file</function>, <function>ps_place_image</function>, <function>ps_close_image</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-place-image"> - <refnamediv> - <refname>ps_place_image</refname> - - <refpurpose>Places image on the page</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_place_image</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>int <parameter>imageid</parameter></paramdef> - <paramdef>float <parameter>x</parameter></paramdef> - <paramdef>float <parameter>y</parameter></paramdef> - <paramdef>float <parameter>scale</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Places a formerly loaded image on the page. The image can be scaled. - </para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_open_image</function>, <function>ps_open_image_file</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-rect"> - <refnamediv> - <refname>ps_rect</refname> - - <refpurpose>Draws a rectangle</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_rect</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>float <parameter>x</parameter></paramdef> - <paramdef>float <parameter>y</parameter></paramdef> - <paramdef>float <parameter>width</parameter></paramdef> - <paramdef>float <parameter>height</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Draws a rectangle with its lower left corner at - (<parameter>x</parameter>, <parameter>y</parameter>). The rectangle - starts and ends in its lower left corner. If this function is called - outside a path it will start a new path. If it is called within a path - it will add the rectangle as a subpath. If the last drawing operation - does not end in the lower left corner then there will be a gab in the - path.</para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_cirle</function>, <function>ps_arc</function>, <function>ps_lineto</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-restore"> - <refnamediv> - <refname>ps_restore</refname> - - <refpurpose>Restore previously save context</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_restore</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Restores a previously saved graphics context. Any call of <function>ps_save</function> - must be accompanied by a call to <function>ps_restore</function>.</para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_save</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-rotate"> - <refnamediv> - <refname>ps_rotate</refname> - - <refpurpose>Sets rotation factor</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_rotate</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>float <parameter>rot</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Sets the rotation of the coordinate system.</para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_scale</function>, <function>ps_translate</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-save"> - <refnamediv> - <refname>ps_save</refname> - - <refpurpose>Save current context</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_save</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Saves the current graphics context, containing colors, translation - and rotation settings and some more. A save context be restored with - <function>ps_restore</function>.</para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_restore</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-scale"> - <refnamediv> - <refname>ps_scale</refname> - - <refpurpose>Sets scaling factor</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_scale</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>float <parameter>x</parameter></paramdef> - <paramdef>float <parameter>y</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Sets horizontal and vertical scaling of the coordinate system.</para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_rotate</function>, <function>ps_translate</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-set-border-color"> - <refnamediv> - <refname>ps_set_border_color</refname> - - <refpurpose>Sets color of border for annotations</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_set_border_color</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>float <parameter>red</parameter></paramdef> - <paramdef>float <parameter>green</parameter></paramdef> - <paramdef>float <parameter>blue</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Annotations like the starting points of links are surounded by - a rectancle. This function sets the color of the border line.</para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_set_border_style</function>, <function>ps_set_border_dash</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-set-border-dash"> - <refnamediv> - <refname>ps_set_border_dash</refname> - - <refpurpose>Sets length of dashes for border of annotations</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_set_border_dash</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>float <parameter>black</parameter></paramdef> - <paramdef>float <parameter>white</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Annotations like the starting points of links are surounded by - a rectancle. This function sets the black and white portion of a - dashed border line.</para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_set_border_style</function>, <function>ps_set_border_color</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-set-border-style"> - <refnamediv> - <refname>ps_set_border_style</refname> - - <refpurpose>Sets border style of annotations</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_set_border_style</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>string <parameter>style</parameter></paramdef> - <paramdef>float <parameter>width</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Annotations like the starting points of links are surounded by - a rectancle. This function sets the appearance and width of the - border line. <parameter>style</parameter> can be 'solid' or - 'dashed'.</para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_set_border_color</function>, <function>ps_set_border_dash</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-set-color"> - <refnamediv> - <refname>ps_setcolor</refname> - - <refpurpose>Sets current color</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_setcolor</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>string <parameter>type</parameter></paramdef> - <paramdef>string <parameter>colorspace</parameter></paramdef> - <paramdef>float <parameter>c1</parameter></paramdef> - <paramdef>float <parameter>c2</parameter></paramdef> - <paramdef>float <parameter>c3</parameter></paramdef> - <paramdef>float <parameter>c4</parameter></paramdef> - </funcprototype> - </funcsynopsis> - - <para>Sets the color for drawing, filling, or both. The colorspace should - be one of 'gray', 'rgb, 'cmyk', 'spot', 'pattern'. Depending on the - colorspace either - only the first, the first three or all parameters will be used.</para> - <para>The parameter <parameter>type</parameter> can be 'both', 'fill', - or 'fillstroke'.</para> - - </refsect1> - <refsect1> - <title>Bugs</title> - - <para>The second parameter is currently not always evaluated. The color is - sometimes set for filling and drawing just as if 'fillstroke' where - passed.</para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-setdash"> - <refnamediv> - <refname>ps_setdash</refname> - - <refpurpose>Sets appearance of a dashed line</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_setdash</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>float <parameter>on</parameter></paramdef> - <paramdef>float <parameter>off</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Sets the length of the black and white portions of a dashed line.</para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_setpolydash</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-setflat"> - <refnamediv> - <refname>ps_setflat</refname> - - <refpurpose>Sets flatness</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_setflat</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>float <parameter>value</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para><parameter>value</parameter> must be between 0.2 and 1.</para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-setfont"> - <refnamediv> - <refname>ps_setfont</refname> - - <refpurpose>Sets font to use for following output</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_setfont</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>int <parameter>fontid</parameter></paramdef> - <paramdef>float <parameter>size</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Sets a font, which has to be loaded before with <function>ps_findfont</function>. - Outputting text without setting a font before results in an error.</para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_findfont</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-setgray"> - <refnamediv> - <refname>ps_setgray</refname> - - <refpurpose>Sets gray value</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_setgray</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>float <parameter>gray</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Sets the gray value for all following drawing operations. The value - must be between 0 (white) and 1 (black).</para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_setcolor</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-set-info"> - <refnamediv> - <refname>ps_set_info</refname> - - <refpurpose>Sets information fields of document</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_set_info</function></funcdef> - <paramdef>resource <parameter>p</parameter></paramdef> - <paramdef>string <parameter>key</parameter></paramdef> - <paramdef>string <parameter>val</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Sets certain information fields of the document. This fields - will be shown as a comment in the header of the PostScript file. - The values which can be set are Keywords, Subject, Title, Creator, - Author, BoundingBox, Orientation. Be aware that some of them has - a meaning to PostScript viewers.</para> - <para>The BoundingBox is usually set to the value given to the first - page. This only works if <function>ps_findfont</function> has not been called before. - In such cases the BoundingBox would be left unset unless you set - it explicitly with this function.</para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_findfont</function>, <function>ps_begin_page</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-setlinecap"> - <refnamediv> - <refname>ps_setlinecap</refname> - - <refpurpose>Sets appearance of line ends</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_setlinecap</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>int <parameter>type</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Sets how line ends look like.</para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_setlinewidth</function>, <function>ps_setlinejoin</function>, <function>ps_setmiterlimit</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-setlinejoin"> - <refnamediv> - <refname>ps_setlinejoin</refname> - - <refpurpose>Sets how contected lines are joined</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_setlinejoin</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>int <parameter>type</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Sets how lines are joined.</para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_setlinewidth</function>, <function>ps_setlinecap</function>, <function>ps_setmiterlimit</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-setlinewidth"> - <refnamediv> - <refname>ps_setlinewidth</refname> - - <refpurpose>Sets width of a line</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_setlinewidth</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>float <parameter>width</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Sets the line width for all following drawing operations.</para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_setlinecap</function>, <function>ps_setlinejoin</function>, <function>ps_setmiterlimit</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-setmiterlimit"> - <refnamediv> - <refname>ps_setmiterlimit</refname> - - <refpurpose>Sets the miter limit</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_setmiterlimit</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>float <parameter>value</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>If two lines join in a small angle and the line join is set - to miter, then the resulting spike will be very long. The miter limit - is the maximum ratio of the miter length (the length of the spike) - and the line width.</para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-set-parameter"> - <refnamediv> - <refname>ps_set_parameter</refname> - - <refpurpose>Sets certain parameters</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_set_parameter</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>string <parameter>name</parameter></paramdef> - <paramdef>string <parameter>value</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Sets several parameters which are used by many functions. Parameters - are by definition string values.</para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_get_parameters</function>, <function>ps_set_value</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-setpolydash"> - <refnamediv> - <refname>ps_setpolydash</refname> - - <refpurpose>Sets appearance of a dashed line</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_setpolydash</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>float <parameter>*arr</parameter></paramdef> - <paramdef>int <parameter>length</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Sets the length of the black and white portions of a dashed line. - <parameter>arr</parameter> is a list of <parameter>length</parameter> - elements alternately for the black and white portion.</para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_setdash</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-set-text-pos"> - <refnamediv> - <refname>ps_set_test_pos</refname> - - <refpurpose>Sets position for text output</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_set_text_pos</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>float <parameter>x</parameter></paramdef> - <paramdef>float <parameter>y</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Set the postion for the next text output. You may alternatively - set the x and y value separately by calling - <function>ps_set_value</function> and choosing 'textx' respectively - 'texty' as the value name.</para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_show</function>, <function>ps_set_value</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-set-value"> - <refnamediv> - <refname>ps_set_value</refname> - - <refpurpose>Sets certain values</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_set_value</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>string <parameter>name</parameter></paramdef> - <paramdef>float <parameter>value</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Sets several values which are used by many functions. Parameters - are by definition float values.</para> - - <variablelist> - <varlistentry> - <term>textrendering</term> - <listitem> - <para>The way how text is shown. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>textx</term> - <listitem> - <para>The x coordinate for text output.</para> - </listitem> - </varlistentry> - <varlistentry> - <term>texty</term> - <listitem> - <para>The y coordinate for text output.</para> - </listitem> - </varlistentry> - <varlistentry> - <term>wordspacing</term> - <listitem> - <para>The distance between words relativ to the width of a space. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>leading</term> - <listitem> - <para>The distance between lines in pixels. - </para> - </listitem> - </varlistentry> - </variablelist> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_get_value</function>, <function>ps_set_parameter</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-shading"> - <refnamediv> - <refname>ps_shading</refname> - - <refpurpose>Creates a shading for later use</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ps_shading</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>string <parameter>type</parameter></paramdef> - <paramdef>float <parameter>x0</parameter></paramdef> - <paramdef>float <parameter>y0</parameter></paramdef> - <paramdef>float <parameter>x1</parameter></paramdef> - <paramdef>float <parameter>y1</parameter></paramdef> - <paramdef>float <parameter>c1</parameter></paramdef> - <paramdef>float <parameter>c2</parameter></paramdef> - <paramdef>float <parameter>c3</parameter></paramdef> - <paramdef>float <parameter>c4</parameter></paramdef> - <paramdef>string <parameter>optlist</parameter></paramdef> - </funcprototype> - </funcsynopsis> - - <para>Creates a shading, which can be used by - <function>ps_shfill</function> or - <function>ps_shading_pattern</function>. The type of shading - can be either `radial' or `axial'. Each shading starts with - the current fill color and ends with the given color values - passed in the parameters <parameter>c1</parameter> to - <parameter>c4</parameter> (see <function>ps_setcolor</function> for - their meaning). The coordinates <parameter>x0</parameter>, - <parameter>y0</parameter>, <parameter>x1</parameter>, - <parameter>y1</parameter> are the start and end point of the shading. If - the shading is of type `radial' the option list must also contain the - parameters r0 and r1 with the radius of the start and end circle.</para> - <para>The color of the shading can be in any color space except for - `pattern'.</para> - </refsect1> - - <refsect1> - <title>Return value</title> - <para>Returns the identifier of the pattern or false in case of an - error.</para> - </refsect1> - - <refsect1> - <title>See also</title> - - <para><function>ps_shfill</function>, - <function>ps_shading_pattern</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-shading-pattern"> - <refnamediv> - <refname>ps_shading_pattern</refname> - - <refpurpose>Creates a pattern based on a shading</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_shading_pattern</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>int <parameter>shadingid</parameter></paramdef> - <paramdef>string <parameter>optlist</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Creates a pattern based on a shading, which has to be created - before with <function>ps_shading</function>. Shading patterns can be - used like regular patterns.</para> - - </refsect1> - <refsect1> - <title>Return value</title> - - <para>The identifier of the pattern or false in case of an error.</para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_shading</function>, - <function>ps_shfill</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-shfill"> - <refnamediv> - <refname>ps_shfill</refname> - - <refpurpose>Fills an area with a shading</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_shfill</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>int <parameter>shadingid</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Fills an area with a shading, which has to be created before with - <function>ps_shading</function>.</para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_shading</function>, - <function>ps_shading_pattern</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-show"> - <refnamediv> - <refname>ps_show</refname> - - <refpurpose>Output text</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_show</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>string <parameter>text</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Output a text at the current text position. - The function will issue - an error if no font was set before with <function>ps_setfont</function>.</para> - <para>ps_show() evaluates the following parameters and values as - set by <function>ps_set_parameter</function> and <function>ps_set_value</function>.</para> - <variablelist> - <varlistentry> - <term>charspacing (value)</term> - <listitem> - <para>Distance between two consecutive glyphs. If this value is - unequal to zero then all ligatures will be resolved. Values less - than zero are allowed. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>kerning (parameter)</term> - <listitem> - <para>Setting this parameter to `false' will turn off kerning. - Kerning is turned on by default. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>ligatures (parameter)</term> - <listitem> - <para>Setting this parameter to `false' will turn off the use - of ligatures. Ligatures are turned on by default. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>underline (parameter)</term> - <listitem> - <para>Setting this parameter to `true' will turn on underlining. - Underlining is turned off by default. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>overline (parameter)</term> - <listitem> - <para>Setting this parameter to `true' will turn on overlining. - Overlining is turned off by default. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>strikeout (parameter)</term> - <listitem> - <para>Setting this parameter to `true' will turn on striking out. - Striking out is turned off by default. - </para> - </listitem> - </varlistentry> - </variablelist> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_show</function>, <function>ps_continue_text2</function>, <function>ps_setfont</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-show-boxed"> - <refnamediv> - <refname>ps_show_boxed</refname> - - <refpurpose>Output text in a box</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ps_show_boxed</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>string <parameter>text</parameter></paramdef> - <paramdef>float <parameter>left</parameter></paramdef> - <paramdef>float <parameter>bottom</parameter></paramdef> - <paramdef>float <parameter>width</parameter></paramdef> - <paramdef>float <parameter>height</parameter></paramdef> - <paramdef>string <parameter>hmode</parameter></paramdef> - <paramdef>string <parameter>feature</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Outputs a text in a given box. The lower left corner of the - box is at (<parameter>left</parameter>, <parameter>bottom</parameter>). - Line breaks will be inserted where - needed. Multiple spaces are treated as one. Tabulators are treated as - spaces. The parameter <parameter>hmode</parameter> can be "justify", - "fulljustify", "right", "left", or "center". The difference of "justify" - and "fulljustify" just affects the last line of the box. In fulljustify - mode the last line will be left and right justified unless this is also - the last line of paragraph. In justify mode it will always be left - justified.</para> - - <para>The text will be hyphenated if the parameter - "hyphenation" is set to "true" and the parameter "hyphendict" contains - a valid filename for a hyphenation file. The line spacing is taken - from the value "leading". Paragraphs can be separated by an empty - line just like in TeX. If the value "parindent" is set to value > 0.0 - then the first n lines will be indented. The number n of lines is set - by the parameter "numindentlines". In order to prevent indenting - of the first m paragraphs set the value "parindentskip" to a positive - number.</para> - </refsect1> - - <refsect1> - <title>Used parameters</title> - - <para>The output of <function>ps_show_boxed</function> can be configured - with several parameters and values which must be set with either - <function>ps_set_parameter</function> or - <function>ps_set_value</function>. Beside the parameters and values - which affect text output the following parameters and values are - evaluated.</para> - <variablelist> - <varlistentry> - <term>leading (value)</term> - <listitem> - <para>Distance between baselines of two consecutive lines. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>linebreak (parameter)</term> - <listitem> - <para>Set to "true" if you want a carrige return to start a new - line instead of treating it as a space. Defaults to "false". - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>parbreak (parameter)</term> - <listitem> - <para>Set to "true" if you want a carrige return on a single line - to start a new paragraph instead of treating it as a space. - Defaults to "true". - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>hyphenation (parameter)</term> - <listitem> - <para>Set to "true" in order to turn hyphenation on. This requires - a dictionary to be set with the parameter "hyphendict". Defaults - to "false". - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>hyphendict (parameter)</term> - <listitem> - <para>Filename of the dictionary used for hyphenation pattern (see - below). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>hyphenminchar (value)</term> - <listitem> - <para>The number of chars which must at least be left over before - or after the hyphen. This implies that only words of at least - two times this value will be hyphenated. The default value is - three. Setting a value of zero will result in the default value. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>parindent (value)</term> - <listitem> - <para>Set the amount of space in pixel for indenting the first - m lines of a paragraph. m can be set with the value - "numindentlines". - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>parskip (value)</term> - <listitem> - <para>Set the amount of extra space in pixel between paragraphs. - Defaults to 0 which will result in a normal line distance. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>numindentlines (value)</term> - <listitem> - <para>Number of lines from the start of the paragraph which will - be indented. Defaults to 1. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>parindentskip (value)</term> - <listitem> - <para>Number of paragraphs in the box whose first lines will - not be indented. This defaults to 0. This is useful for paragraphs - right after a section heading or text being continued in a - second box. In both case one would set this to 1. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>linenumbermode (parameter)</term> - <listitem> - <para>Set how lines are to be numbered. Possible values are "box" - for numbering lines in the whole box or "paragraph" to number - lines within each paragraph. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>linenumberspace (value)</term> - <listitem> - <para>The space for the column left of the numbered line containing - the line number. The - line number will be right justified into this column. Defaults - to 20. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>linenumbersep (value)</term> - <listitem> - <para>The space between the column with line numbers and the - line itself. Defaults to 5. - </para> - </listitem> - </varlistentry> - </variablelist> - </refsect1> - <refsect1> - <title>Hyphenation</title> - <para>Text is hyphenated if the parameter "hyphenation" is set to true - and a valid hyphenation dictory is set. pslib does not ship its own - hyphenation dictionary but uses one from openoffice, scribus or koffice. - You can find their dictionaries for different languages in one of the - following directories if the software is - installed: /usr/share/apps/koffice/hyphdicts/, - /usr/lib/scribus/dicts/, or /usr/lib/openoffice/share/dict/ooo/. - Currently scribus appears to have the most complete hyphenation - dictionaries.</para> - </refsect1> - <refsect1> - <title>Return value</title> - <para>Number of charactes that could not be written.</para> - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_continue_text</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-show-xy"> - <refnamediv> - <refname>ps_show_xy</refname> - - <refpurpose>Output text at given position</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_show_xy</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>string <parameter>text</parameter></paramdef> - <paramdef>float <parameter>x</parameter></paramdef> - <paramdef>float <parameter>y</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Output a text at the given text position. - </para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_continue_text</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-stringwidth"> - <refnamediv> - <refname>ps_stringwidth</refname> - - <refpurpose>Gets width of a string</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>float <function>ps_stringwidth</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>string <parameter>text</parameter></paramdef> - <paramdef>int <parameter>fontid</parameter></paramdef> - <paramdef>float <parameter>size</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Calculates the width of a string in points if it was output - in the given font and font size. - This function needs an Adobe font - metrics file to calculate the precise width. If kerning is turned on, - it will be taken into account.</para> - - </refsect1> - <refsect1> - <title>Return value</title> - <para>Width of a string in points.</para> - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_string_geometry</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-string-geometry"> - <refnamediv> - <refname>ps_string_geometry</refname> - - <refpurpose>Gets geometry of a string</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>ps_string_geometry</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>string <parameter>text</parameter></paramdef> - <paramdef>int <parameter>fontid</parameter></paramdef> - <paramdef>float <parameter>size</parameter></paramdef> - </funcprototype> - </funcsynopsis> - - <para>This function is similar to <function>ps_stringwidth</function> - but returns an array of dimensions.</para> - <para>The element 'width' contains the width of the string as returned by - <function>ps_stringwidth</function>. - The element 'descender' contains the maximum descender and - 'ascender' the maximum ascender of the string.</para> - - </refsect1> - <refsect1> - <title>Return value</title> - <para>Width of a string in points.</para> - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_stringwidth</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-stroke"> - <refnamediv> - <refname>ps_stroke</refname> - - <refpurpose>Draws the current path</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_stroke</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Draws the path constructed with previously called drawing functions - like <function>ps_lineto</function>.</para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_closepath_stroke</function>, <function>ps_fill</function>, <function>ps_fill_stroke</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-symbol"> - <refnamediv> - <refname>ps_symbol</refname> - - <refpurpose>Output a glyph</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_symbol</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>int <parameter>ord</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Output the glyph at position <parameter>ord</parameter> in - the font encoding vector of the current font. The font encoding for - a font can be set when loading the font with - <function>ps_findfont</function>.</para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_symbol_width</function>, <function>ps_symbol_name</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-symbol-name"> - <refnamediv> - <refname>ps_symbol_name</refname> - - <refpurpose>Gets name of a glyph</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ps_symbol_name</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>int <parameter>ord</parameter></paramdef> - <paramdef>int <parameter>fontid</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Returns the name of a glyph in the given font. - This function needs an Adobe font - metrics file to know which glyphs are available. The parameter - <parameter>ord</parameter> is the position of the glyph in the font - encoding vector.</para> - - </refsect1> - <refsect1> - <title>Return value</title> - <para>Name of a glyph.</para> - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_symbol</function>, <function>ps_symbol_width</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-symbol-width"> - <refnamediv> - <refname>ps_symbol_width</refname> - - <refpurpose>Gets width of a glyph</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>float <function>ps_symbol_width</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>int <parameter>ord</parameter></paramdef> - <paramdef>int <parameter>fontid</parameter></paramdef> - <paramdef>float <parameter>size</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Calculates the width of a glyph in points if it was output - in the given font and font size. This function needs an Adobe font - metrics file to calculate the precise width. The parameter - <parameter>ord</parameter> is the position of the glyph in the font - encoding vector.</para> - - </refsect1> - <refsect1> - <title>Return value</title> - <para>Width of a glyph in points.</para> - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_symbol</function>, <function>ps_symbol_name</function></para> - - </refsect1> -</refentry> - -<refentry id="pecl.ps.ps-translate"> - <refnamediv> - <refname>ps_translate</refname> - - <refpurpose>Sets translation</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ps_translate</function></funcdef> - <paramdef>resource <parameter>psdoc</parameter></paramdef> - <paramdef>float <parameter>x</parameter></paramdef> - <paramdef>float <parameter>y</parameter></paramdef> - - </funcprototype> - </funcsynopsis> - - <para>Sets a new initial point of the coordinate system.</para> - - </refsect1> - <refsect1> - <title>See also</title> - - <para><function>ps_rotate</function>, <function>ps_scale</function></para> - - </refsect1> -</refentry> + <refentry id="pecl.ps.docs"> + <refnamediv> + <refname>Documentation</refname> + <refpurpose /> + </refnamediv> + <refsect1> + <title>Documentation moved</title> + <simpara> + The documentation is now part of the <ulink url="&url.php.manual;/en/ref.ps.php">PHP + manual</ulink>. + </simpara> + </refsect1> + </refentry> </reference>  + http://cvs.php.net/diff.php/peardoc/en/pecl/radius.xml?r1=1.9&r2=1.10&ty=u Index: peardoc/en/pecl/radius.xml diff -u peardoc/en/pecl/radius.xml:1.9 peardoc/en/pecl/radius.xml:1.10 --- peardoc/en/pecl/radius.xml:1.9 Sun Jun 22 10:27:13 2003 +++ peardoc/en/pecl/radius.xml Sat Sep 10 09:43:34 2005 @@ -1,1026 +1,22 @@ <?xml version="1.0" encoding="iso-8859-1"?> - - <reference id="pecl.radius"> + +<reference id="pecl.radius"> <title>Radius</title> - <titleabbrev>radius</titleabbrev> - <partintro> - - <sect1 id="pecl.radius.partintro"> - <title>Introduction</title> - <sect2 id="pecl.radius.intro"> - <title>About Radius</title> - <para> - This package is based on the libradius of FreeBSD. This PECL adds - full support for Radius Authentication - (<ulink url="&url.rfc;2865">RFC 2865</ulink>) and Radius Accounting - (<ulink url="&url.rfc;2866">RFC 2866</ulink>). This package is - available for Unix (tested on FreeBSD and Linux) and for Windows. - </para> - <note> - <para> - An exact description for libradius can be found <ulink url="http://www.freebsd.org/cgi/man.cgi?query=libradius">here</ulink>. - A detailed description of the configuration file can be found <ulink url="http://www.freebsd.org/cgi/man.cgi?query=radius.conf">here</ulink>. - </para> - </note> - </sect2> - <sect2 id="pecl.radius.contact"> - <title>Contact Information</title> - <para> - If you have comments, bugfixes, enhancements or want to help - developping this you can send me a mail at <ulink - url="mailto:mbretter@php.net">mbretter@php.net</ulink>. - Binaries for Windows can be downloaded from <ulink url="http://www.bretterklieber.com/php">here</ulink>. - </para> - </sect2> - <sect2 id="pecl.radius.install"> - <title>Install</title> - <para> - Howto install the package? - <itemizedlist> - <listitem><simpara>untar the package (usualy into php4/ext)</simpara></listitem> - <listitem><simpara>rename radius-x.x to radius</simpara></listitem> - <listitem><simpara>run ./buildconf in php4</simpara></listitem> - <listitem><simpara>run ./configure --enable-radius</simpara></listitem> - <listitem><simpara>make; make install</simpara></listitem> - </itemizedlist> - or if you would like to have it as .so: - <itemizedlist> - <listitem><simpara>untar the package </simpara></listitem> - <listitem><simpara>run phpize in the radius-x.x directory</simpara></listitem> - <listitem><simpara>run ./configure in the radius-x.x directory</simpara></listitem> - <listitem><simpara>make; make install</simpara></listitem> - </itemizedlist> - for windows I recommend to use the php_radius.dll from <ulink url="http://www.bretterklieber.com/php/radius-builds/win32-i386/">here</ulink> - </para> - </sect2> - <sect2 id="pecl.radius.howtostart"> - <title>Quickstart</title> - <para> - Howto start? - <itemizedlist> - <listitem><simpara>get a radius ressource</simpara></listitem> - <listitem><simpara>configure the library</simpara></listitem> - <listitem><simpara>create the request</simpara></listitem> - <listitem><simpara>put attributes</simpara></listitem> - <listitem><simpara>send the request</simpara></listitem> - <listitem><simpara>receive attributes</simpara></listitem> - <listitem><simpara>close the radius ressource (optional)</simpara></listitem> - </itemizedlist> - Take also a look at the examples in this package. - </para> - <para> - The package contains an example php script. This script demonstrates howto - authenticate with radius using PAP or CHAP (md5). If you authenticate with - MSoft Radius servers then its not possible to use CHAP (md5). If you would like to - authenticate with MSoft Servers you have to use MS-CHAPv1 or MS-CHAPv2, but its - more complicated, because you need md4, sha1 and des to generate the right data. - The enclosed examples demonstrate all authentication-methods, including MS-CHAPv1 and - MS-CHAPv2. To get the MS-CHAP to work you need the mcrypt and the mhash extension, starting - with version 1.2 of the package, the mcrypt extension is no longer needed. - </para> - </sect2> - </sect1> - </partintro> - - <refentry id="pecl.radius.radius_auth_open"> - <refnamediv> - <refname>radius_auth_open</refname> - <refpurpose>Creates a Radius handle for authentication</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>radius_auth_open</function></funcdef> - <paramdef><parameter>void</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Returns a handle on success, - &false; on error. - This function only fails if insufficient memory is available. - </para> - <example> - <title><function>radius_auth_open</function> example</title> - <programlisting role="php"> -<![CDATA[ -<?php -$radh = radius_auth_open () - or die ("Could not create handle"); -print("Handle successfully created"); -?> -]]> - </programlisting> - </example> - </refsect1> - </refentry> - - <refentry id="pecl.radius.radius_acct_open"> - <refnamediv> - <refname>radius_acct_open</refname> - <refpurpose>Creates a Radius handle for accounting</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>radius_acct_open</function></funcdef> - <paramdef><parameter>void</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Returns a handle on success, - &false; on error. - This function only fails if insufficient memory is available. - </para> - <example> - <title><function>radius_acct_open</function> example</title> - <programlisting role="php"> -<![CDATA[ -<?php -$res = radius_acct_open () - or die ("Could not create handle"); -print("Handle successfully created"); -?> -]]> - </programlisting> - </example> - </refsect1> + <refentry id="pecl.radius.docs"> + <refnamediv> + <refname>Documentation</refname> + <refpurpose /> + </refnamediv> + <refsect1> + <title>Documentation moved</title> + <simpara> + The documentation is now part of the <ulink url="&url.php.manual;/en/ref.radius.php">PHP + manual</ulink>. + </simpara> + </refsect1> </refentry> - - <refentry id="pecl.radius.radius_strerror"> - <refnamediv> - <refname>radius_strerror</refname> - <refpurpose>Returns an error message</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>radius_strerror</function></funcdef> - <paramdef>resource <parameter>radius_handle</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Returns: string - </para> - <para> - If Radius-functions fail then they record an error message. This error message can be retrieved with this function. - </para> - </refsect1> - </refentry> - - <refentry id="pecl.radius.radius_config"> - <refnamediv> - <refname>radius_config</refname> - <refpurpose>Causes the library to read the given configuration file</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>boolean <function>radius_config</function></funcdef> - <paramdef>resource <parameter>radius_handle</parameter></paramdef> - <paramdef>string <parameter>file</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Returns: &true; on success, &false; on error. - </para> - <para> - Before issuing any Radius requests, the library must be made aware of the - servers it can contact. The easiest way to configure the library is to - call <function>radius_config</function>. <function>radius_config</function> causes the library to read a configura - tion file whose format is described in <ulink url="http://www.freebsd.org/cgi/man.cgi?query=radius.conf">radius.conf</ulink>. - The pathname of the configuration file is passed as the file argument to <function>radius_config</function>. - The library can also be configured programmatically by calls to <function>radius_add_server</function>. - </para> - </refsect1> - </refentry> - - <refentry id="pecl.radius.radius_add_server"> - <refnamediv> - <refname>radius_add_server</refname> - <refpurpose>Adds a server</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>boolean <function>radius_add_server</function></funcdef> - <paramdef>resource <parameter>radius_handle</parameter></paramdef> - <paramdef>string <parameter>hostname</parameter></paramdef> - <paramdef>int <parameter>port</parameter></paramdef> - <paramdef>string <parameter>secret</parameter></paramdef> - <paramdef>int <parameter>timeout</parameter></paramdef> - <paramdef>int <parameter>max_tries</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Returns: &true; on success, &false; on error. - </para> - <para> - The host parameter specifies the server host, either - as a fully qualified domain name or as a dotted-quad IP address in text - form. The port parameter specifies the UDP port to contact on the - server. If port is given as 0, the library looks up the `radius/udp' or - `radacct/udp' service in the network services database, and uses the port - found there. If no entry is found, the library uses the standard Radius - ports, 1812 for authentication and 1813 for accounting. The shared - secret for the server host is passed to the secret parameter. The Radius protocol - ignores all but the leading 128 bytes of the shared secret. The timeout for receiving - replies from the server is passed to the timeout parameter, in units of - seconds. The maximum number of repeated requests to make before giving - up is passed into the max_tries parameter. - </para> - <para> - <function>radius_add_server</function> may be called multiple times, and it may be used - together with <function>radius_config</function>. At most 10 servers may be specified. When - multiple servers are given, they are tried in round-robin fashion until a - valid response is received, or until each server's max_tries limit has - been reached. - </para> - <example> - <title><function>radius_add_server</function> example</title> - <programlisting role="php"> -<![CDATA[ -<?php -if (!radius_add_server($res, 'radius.example.com', 1812, 'testing123', 3, 3)) { - echo 'RadiusError:' . radius_strerror($res). "\n<br>"; - exit; -} -?> -]]> - </programlisting> - </example> - </refsect1> - </refentry> - - <refentry id="pecl.radius.radius_create_request"> - <refnamediv> - <refname>radius_create_request</refname> - <refpurpose>Create accounting or authentication request</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>boolean <function>radius_create_request</function></funcdef> - <paramdef>resource <parameter>radius_handle</parameter></paramdef> - <paramdef>int <parameter>type</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Returns: &true; on success, &false; on error. - </para> - <para> - A Radius request consists of a code specifying the kind of request, and - zero or more attributes which provide additional information. To begin - constructing a new request, call <function>radius_create_request</function>. - Type is RADIUS_ACCESS_REQUEST or RADIUS_ACCOUNTING_REQUEST. - <note> - <para> - Attention: You must call this function, before you can put any attribute! - </para> - </note> - </para> - <example> - <title><function>radius_create_request</function> example</title> - <programlisting role="php"> -<![CDATA[ -<?php -if (!radius_create_request($res, RADIUS_ACCESS_REQUEST)) { - echo 'RadiusError:' . radius_strerror($res). "\n<br>"; - exit; -} -?> -]]> - </programlisting> - </example> - </refsect1> - </refentry> - - <refentry id="pecl.radius.radius_put_string"> - <refnamediv> - <refname>radius_put_string</refname> - <refpurpose>Attaches a string attribute</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>boolean <function>radius_put_string</function></funcdef> - <paramdef>resource <parameter>radius_handle</parameter></paramdef> - <paramdef>int <parameter>type</parameter></paramdef> - <paramdef>string <parameter>value</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Returns: &true; on success, &false; on error. - </para> - <example> - <title><function>radius_put_string</function> example</title> - <programlisting role="php"> -<![CDATA[ -<?php -if (!radius_put_string($res, RADIUS_USER_NAME, 'billy')) { - echo 'RadiusError:' . radius_strerror($res). "\n<br>"; - exit; -} -?> -]]> - </programlisting> - </example> - </refsect1> - </refentry> - - <refentry id="pecl.radius.radius_put_int"> - <refnamediv> - <refname>radius_put_int</refname> - <refpurpose>Attaches an integer attribute</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>boolean <function>radius_put_int</function></funcdef> - <paramdef>resource <parameter>radius_handle</parameter></paramdef> - <paramdef>int <parameter>type</parameter></paramdef> - <paramdef>int <parameter>value</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Returns: &true; on success, &false; on error. - </para> - <example> - <title><function>radius_put_int</function> example</title> - <programlisting role="php"> -<![CDATA[ -<?php -if (!radius_put_int($res, RAD_FRAMED_PROTOCOL, RAD_PPP)) { - echo 'RadiusError:' . radius_strerror($res). "\n<br>"; - exit; -} -?> -]]> - </programlisting> - </example> - </refsect1> - </refentry> - - <refentry id="pecl.radius.radius_put_attr"> - <refnamediv> - <refname>radius_put_attr</refname> - <refpurpose>Attaches a binary attribute</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>boolean <function>radius_put_attr</function></funcdef> - <paramdef>resource <parameter>radius_handle</parameter></paramdef> - <paramdef>int <parameter>type</parameter></paramdef> - <paramdef>string <parameter>value</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Returns: &true; on success, &false; on error. - </para> - <example> - <title><function>radius_put_attr</function> example</title> - <programlisting role="php"> -<![CDATA[ -<?php -mt_srand(time()); -$chall = mt_rand(); -$chapval = md5(pack('Ca*',1 , 'sepp' . $chall)); -$pass = pack('CH*', 1, $chapval); -if (!radius_put_attr($res, RADIUS_CHAP_PASSWORD, $pass)) { - echo 'RadiusError:' . radius_strerror($res). "\n<br>"; - exit; -} -?> -]]> - </programlisting> - </example> - </refsect1> - </refentry> - - <refentry id="pecl.radius.radius_put_addr"> - <refnamediv> - <refname>radius_put_addr</refname> - <refpurpose>Attaches an IP-Address attribute</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>boolean <function>radius_put_addr</function></funcdef> - <paramdef>resource <parameter>radius_handle</parameter></paramdef> - <paramdef>int <parameter>type</parameter></paramdef> - <paramdef>string <parameter>addr</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Returns: &true; on success, &false; on error. - </para> - </refsect1> - </refentry> - - <refentry id="pecl.radius.radius_put_vendor_string"> - <refnamediv> - <refname>radius_put_vendor_string</refname> - <refpurpose>Attaches a vendor specific string attribute</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>boolean <function>radius_put_vendor_string</function></funcdef> - <paramdef>resource <parameter>radius_handle</parameter></paramdef> - <paramdef>int <parameter>vendor</parameter></paramdef> - <paramdef>int <parameter>type</parameter></paramdef> - <paramdef>string <parameter>value</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Returns: &true; on success, &false; on error. - </para> - </refsect1> - </refentry> - - <refentry id="pecl.radius.radius_put_vendor_int"> - <refnamediv> - <refname>radius_put_vendor_int</refname> - <refpurpose>Attaches a vendor specific integer attribute</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>boolean <function>radius_put_vendor_int</function></funcdef> - <paramdef>resource <parameter>radius_handle</parameter></paramdef> - <paramdef>int <parameter>vendor</parameter></paramdef> - <paramdef>int <parameter>type</parameter></paramdef> - <paramdef>int <parameter>value</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Returns: &true; on success, &false; on error. - </para> - </refsect1> - </refentry> - - <refentry id="pecl.radius.radius_put_vendor_attr"> - <refnamediv> - <refname>radius_put_vendor_attr</refname> - <refpurpose>Attaches a vendor specific binary attribute</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>boolean <function>radius_put_vendor_attr</function></funcdef> - <paramdef>resource <parameter>radius_handle</parameter></paramdef> - <paramdef>int <parameter>vendor</parameter></paramdef> - <paramdef>int <parameter>type</parameter></paramdef> - <paramdef>string <parameter>value</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Returns: &true; on success, &false; on error. - </para> - <example> - <title><function>radius_put_vendor_attr</function> example</title> - <programlisting role="php"> -<![CDATA[ -<?php -if (!radius_put_vendor_attr($res, RADIUS_VENDOR_MICROSOFT, RAD_MICROSOFT_MS_CHAP_CHALLENGE, $challenge)) { - echo 'RadiusError:' . radius_strerror($res). "\n<br>"; - exit; -} -?> -]]> - </programlisting> - </example> - </refsect1> - </refentry> - - <refentry id="pecl.radius.radius_put_vendor_addr"> - <refnamediv> - <refname>radius_put_vendor_addr</refname> - <refpurpose>Attaches a vendor specific IP-Address attribute</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>boolean <function>radius_put_vendor_addr</function></funcdef> - <paramdef>resource <parameter>radius_handle</parameter></paramdef> - <paramdef>int <parameter>vendor</parameter></paramdef> - <paramdef>int <parameter>type</parameter></paramdef> - <paramdef>string <parameter>addr</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Returns: &true; on success, &false; on error. - </para> - </refsect1> - </refentry> - - <refentry id="pecl.radius.radius_send_request"> - <refnamediv> - <refname>radius_send_request</refname> - <refpurpose>Sends the request and waites for a reply</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>boolean <function>radius_send_request</function></funcdef> - <paramdef>resource <parameter>radius_handle</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Returns: Access code, &false; on error. - </para> - <para> - After the Radius request has been constructed, it is sent by <function>radius_send_request</function> - </para> - <para> - The <function>radius_send_request</function> function sends the request and waits for a valid - reply, retrying the defined servers in round-robin fashion as necessary. - If a valid response is received, <function>radius_send_request</function> returns the Radius - code which specifies the type of the response. This will typically be - RADIUS_ACCESS_ACCEPT, RADIUS_ACCESS_REJECT, or RADIUS_ACCESS_CHALLENGE. If no - valid response is received, <function>radius_send_request</function> returns &false;. - </para> - </refsect1> - </refentry> - - <refentry id="pecl.radius.radius_get_attr"> - <refnamediv> - <refname>radius_get_attr</refname> - <refpurpose>Extracts an attribute</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>radius_get_attr</function></funcdef> - <paramdef>resource <parameter>radius_handle</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Returns: An assoc-array containing the attribute-type and the data. - &false; on error. - </para> - <para> - Like Radius requests, each response may contain zero or more attributes. - After a response has been received successfully by <function>radius_send_request</function>, - its attributes can be extracted one by one - using <function>radius_get_attr</function>. - Each time <function>radius_get_attr</function> is called, it gets the - next attribute from the current response. - </para> - <example> - <title><function>radius_get_attr</function> example</title> - <programlisting role="php"> -<![CDATA[ -<?php -while ($resa = radius_get_attr($res)) { - - if (!is_array($resa)) { - printf ("Error getting attribute: %s\n", radius_strerror($res)); - exit; - } - - $attr = $resa['attr']; - $data = $resa['data']; - printf("Got Attr:%d %d Bytes %s\n", $attr, strlen($data), bin2hex($data)); -} -?> -]]> - </programlisting> - </example> - </refsect1> - </refentry> - - <refentry id="pecl.radius.radius_get_vendor_attr"> - <refnamediv> - <refname>radius_get_vendor_attr</refname> - <refpurpose>Extracts a vendor specific attribute</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>radius_get_vendor_attr</function></funcdef> - <paramdef>resource <parameter>radius_handle</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Returns: An assoc-array containing the attribute-type, vendor and the data. - &false; on error. - </para> - <para> - If <function>radius_get_attr</function> returns RADIUS_VENDOR_SPECIFIC, - <function>radius_get_vendor_attr</function> may - be called to determine the vendor. - </para> - <example> - <title><function>radius_get_vendor_attr</function> example</title> - <programlisting role="php"> -<![CDATA[ -<?php -while ($resa = radius_get_attr($res)) { - - if (!is_array($resa)) { - printf ("Error getting attribute: %s\n", radius_strerror($res)); - exit; - } - - $attr = $resa['attr']; - $data = $resa['data']; - printf("Got Attr:%d %d Bytes %s\n", $attr, strlen($data), bin2hex($data)); - if ($attr == RADIUS_VENDOR_SPECIFIC) { - - $resv = radius_get_vendor_attr($data); - if (is_array($resv)) { - $vendor = $resv['vendor']; - $attrv = $resv['attr']; - $datav = $resv['data']; - printf("Got Vendor Attr:%d %d Bytes %s\n", $attrv, strlen($datav), bin2hex($datav)); - } - - } -} -?> -]]> - </programlisting> - </example> - </refsect1> - </refentry> - - <refentry id="pecl.radius.radius_cvt_int"> - <refnamediv> - <refname>radius_cvt_int</refname> - <refpurpose>Converts raw data to integer</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>radius_cvt_int</function></funcdef> - <paramdef>string <parameter>data</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Returns: integer. - </para> - <example> - <title><function>radius_cvt_int</function> example</title> - <programlisting role="php"> -<![CDATA[ -<?php -while ($resa = radius_get_attr($res)) { - - if (!is_array($resa)) { - printf ("Error getting attribute: %s\n", radius_strerror($res)); - exit; - } - - $attr = $resa['attr']; - $data = $resa['data']; - - switch ($attr) { - - case RADIUS_FRAMED_MTU: - $mtu = radius_cvt_int($data); - echo "MTU: $mtu<br>\n"; - break; - } - -} -?> -]]> - </programlisting> - </example> - </refsect1> - </refentry> - - <refentry id="pecl.radius.radius_cvt_string"> - <refnamediv> - <refname>radius_cvt_string</refname> - <refpurpose>Converts raw data to string</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>radius_cvt_string</function></funcdef> - <paramdef>string <parameter>data</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Returns: string - </para> - <example> - <title><function>radius_cvt_string</function> example</title> - <programlisting role="php"> -<![CDATA[ -<?php -while ($resa = radius_get_attr($res)) { - - if (!is_array($resa)) { - printf ("Error getting attribute: %s\n", radius_strerror($res)); - exit; - } - - $attr = $resa['attr']; - $data = $resa['data']; - - switch ($attr) { - - case RADIUS_FILTER_ID: - $id = radius_cvt_string($data); - echo "Filter ID: $id<br>\n"; - break; - } - -} -?> -]]> - </programlisting> - </example> - </refsect1> - </refentry> - - <refentry id="pecl.radius.radius_cvt_addr"> - <refnamediv> - <refname>radius_cvt_addr</refname> - <refpurpose>Converts raw data to IP-Address</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>radius_cvt_addr</function></funcdef> - <paramdef>string <parameter>data</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Returns: string - </para> - <example> - <title><function>radius_cvt_addr</function> example</title> - <programlisting role="php"> -<![CDATA[ -<?php -while ($resa = radius_get_attr($res)) { - - if (!is_array($resa)) { - printf ("Error getting attribute: %s\n", radius_strerror($res)); - exit; - } - - $attr = $resa['attr']; - $data = $resa['data']; - - switch ($attr) { - - case RADIUS_FRAMED_IP_ADDRESS: - $ip = radius_cvt_addr($data); - echo "IP: $ip<br>\n"; - break; - - case RADIUS_FRAMED_IP_NETMASK: - $mask = radius_cvt_addr($data); - echo "MASK: $mask<br>\n"; - break; - } -} -?> -]]> - </programlisting> - </example> - </refsect1> - </refentry> - - <refentry id="pecl.radius.radius_request_authenticator"> - <refnamediv> - <refname>radius_request_authenticator</refname> - <refpurpose>Returns the request authenticator</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>radius_request_authenticator</function></funcdef> - <paramdef>resource <parameter>radius_handle</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Returns: string &false; on error. - </para> - <para> - The request authenticator is needed for demangling mangled data like passwords and encryption-keys. - </para> - </refsect1> - </refentry> - - <refentry id="pecl.radius.radius_server_secret"> - <refnamediv> - <refname>radius_server_secret</refname> - <refpurpose>Returns the shared secret</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>radius_server_secret</function></funcdef> - <paramdef>resource <parameter>radius_handle</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Returns: string. - </para> - <para> - The shared secret is needed as salt for demangling mangled data like passwords and encryption-keys. - </para> - </refsect1> - </refentry> - - <refentry id="pecl.radius.radius_demangle"> - <refnamediv> - <refname>radius_demangle</refname> - <refpurpose>Demangles data</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>radius_demangle</function></funcdef> - <paramdef>string <parameter>mangled</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Returns: string, &false; on error. - </para> - <para> - Some data (Passwords, MS-CHAPv1 MPPE-Keys) is mangled for security reasons, and must be demangled - before you can use them. - </para> - </refsect1> - </refentry> - - <refentry id="pecl.radius.radius_demangle_mppe_key"> - <refnamediv> - <refname>radius_demangle_mppe_key</refname> - <refpurpose>Derives mppe-keys from mangled data</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>radius_demangle_mppe_key</function></funcdef> - <paramdef>resource <parameter>radius_handle</parameter></paramdef> - <paramdef>string <parameter>mangled</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Returns: string, &false; on error. - </para> - <para> - When using MPPE with MS-CHAPv2, the send- and recv-keys are mangled - (see <ulink url="&url.rfc;2548">RFC 2548</ulink>), however this - function is useless, because I don't think that there is or will be a - PPTP-MPPE implementation in PHP. - </para> - </refsect1> - </refentry> - - <refentry id="pecl.radius.radius_close"> - <refnamediv> - <refname>radius_close</refname> - <refpurpose>Frees all ressources</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>radius_close</function></funcdef> - <paramdef>resource <parameter>radius_handle</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <para> - Returns: &true; - </para> - <para> - Its not needed to call this function because php frees all resources at the end of each request. - </para> - </refsect1> - </refentry> - - <refentry id="pecl.radius.constants"> - <refnamediv> - <refname>constants</refname> - <refpurpose>Predefined constants</refpurpose> - </refnamediv> - <refsect1> - <title>Table of predefined constants</title> - <para> - <table> - <title>Table of predefined constants</title> - <tgroup cols="3"> - <thead><row><entry>Consant</entry><entry>Type of value</entry><entry>Description</entry></row></thead> - <tbody> - <row><entry>RADIUS_ACCESS_REQUEST</entry><entry>-</entry><entry>Authentication Request</entry></row> - <row><entry>RADIUS_ACCESS_ACCEPT</entry><entry>-</entry><entry>Access accepted</entry></row> - <row><entry>RADIUS_ACCESS_REJECT</entry><entry>-</entry><entry>Access rejected</entry></row> - <row><entry>RADIUS_ACCOUNTING_REQUEST</entry><entry>-</entry><entry>Accounting request</entry></row> - <row><entry>RADIUS_ACCOUNTING_RESPONSE</entry><entry>-</entry><entry>Accounting response</entry></row> - <row><entry>RADIUS_ACCESS_CHALLENGE</entry><entry>-</entry><entry>Accsess challenge</entry></row> - <row><entry>RADIUS_USER_NAME</entry><entry>string</entry><entry>Username</entry></row> - <row><entry>RADIUS_USER_PASSWORD</entry><entry>string</entry><entry>Password</entry></row> - <row><entry>RADIUS_CHAP_PASSWORD</entry><entry>string</entry><entry>Chap Password. FYI: chappass = md5(ident + plaintextpass + challenge)</entry></row> - <row><entry>RADIUS_NAS_IP_ADDRESS</entry><entry>string</entry><entry>NAS IP-Adress</entry></row> - <row><entry>RADIUS_NAS_PORT</entry><entry>int</entry><entry>NAS Port</entry></row> - <row><entry>RADIUS_SERVICE_TYPE</entry><entry>int</entry><entry>Type of Service, one of: RADIUS_LOGIN, RADIUS_FRAMED, RADIUS_CALLBACK_LOGIN, - RADIUS_CALLBACK_FRAMED, RADIUS_OUTBOUND, RADIUS_ADMINISTRATIVE, RADIUS_NAS_PROMPT, RADIUS_AUTHENTICATE_ONLY, RADIUS_CALLBACK_NAS_PROMPT</entry></row> - <row><entry>RADIUS_FRAMED_PROTOCOL</entry><entry>int</entry><entry>Framed Protocol, one of: RADIUS_PPP, RADIUS_SLIP, RADIUS_ARAP, RADIUS_GANDALF, RADIUS_XYLOGICS</entry></row> - <row><entry>RADIUS_FRAMED_IP_ADDRESS</entry><entry>string</entry><entry>IP-Address</entry></row> - <row><entry>RADIUS_FRAMED_IP_NETMASK</entry><entry>string</entry><entry>Netmask</entry></row> - <row><entry>RADIUS_FRAMED_ROUTING</entry><entry>int</entry><entry>Routing</entry></row> - <row><entry>RADIUS_FILTER_ID</entry><entry>string</entry><entry>Filter ID</entry></row> - <row><entry>RADIUS_FRAMED_MTU</entry><entry>int</entry><entry>MTU</entry></row> - <row><entry>RADIUS_FRAMED_COMPRESSION</entry><entry>int</entry><entry>Compression, on of: RADIUS_COMP_NONE, RADIUS_COMP_VJ, RADIUS_COMP_IPXHDR</entry></row> - <row><entry>RADIUS_LOGIN_IP_HOST</entry><entry>string</entry><entry>Login IP Host</entry></row> - <row><entry>RADIUS_LOGIN_SERVICE</entry><entry>int</entry><entry>Login Service</entry></row> - <row><entry>RADIUS_LOGIN_TCP_PORT</entry><entry>int</entry><entry>Login TCP Port</entry></row> - <row><entry>RADIUS_REPLY_MESSAGE</entry><entry>string</entry><entry>Reply Message</entry></row> - <row><entry>RADIUS_CALLBACK_NUMBER</entry><entry>string</entry><entry>Callback Number</entry></row> - <row><entry>RADIUS_CALLBACK_ID</entry><entry>string</entry><entry>Callback ID</entry></row> - <row><entry>RADIUS_FRAMED_ROUTE</entry><entry>string</entry><entry>Framed Route</entry></row> - <row><entry>RADIUS_FRAMED_IPX_NETWORK</entry><entry>string</entry><entry>Framed IPX Networl</entry></row> - <row><entry>RADIUS_STATE</entry><entry>string</entry><entry>State</entry></row> - <row><entry>RADIUS_CLASS</entry><entry>int</entry><entry>Class</entry></row> - <row><entry>RADIUS_VENDOR_SPECIFIC</entry><entry>int</entry><entry>Vendor specific attribute</entry></row> - <row><entry>RADIUS_SESSION_TIMEOUT</entry><entry>int</entry><entry>Session timeout</entry></row> - <row><entry>RADIUS_IDLE_TIMEOUT</entry><entry>int</entry><entry>Idle timeout</entry></row> - <row><entry>RADIUS_TERMINATION_ACTION</entry><entry>int</entry><entry>Termination action</entry></row> - <row><entry>RADIUS_CALLED_STATION_ID</entry><entry>string</entry><entry>Called Station Id</entry></row> - <row><entry>RADIUS_CALLING_STATION_ID</entry><entry>string</entry><entry>Calling Station Id</entry></row> - <row><entry>RADIUS_NAS_IDENTIFIER</entry><entry>int</entry><entry>NAS ID</entry></row> - <row><entry>RADIUS_PROXY_STATE</entry><entry>int</entry><entry>Proxy State</entry></row> - <row><entry>RADIUS_LOGIN_LAT_SERVICE</entry><entry>int</entry><entry>Login LAT Service</entry></row> - <row><entry>RADIUS_LOGIN_LAT_NODE</entry><entry>int</entry><entry>Login LAT Node</entry></row> - <row><entry>RADIUS_LOGIN_LAT_GROUP</entry><entry>int</entry><entry>Login LAT Group</entry></row> - <row><entry>RADIUS_FRAMED_APPLETALK_LINK</entry><entry>int</entry><entry>Framed Appletalk Link</entry></row> - <row><entry>RADIUS_FRAMED_APPLETALK_NETWORK</entry><entry>int</entry><entry>Framed Appletalk Network</entry></row> - <row><entry>RADIUS_FRAMED_APPLETALK_ZONE</entry><entry>int</entry><entry>Framed Appletalk Zone</entry></row> - <row><entry>RADIUS_CHAP_CHALLENGE</entry><entry>string</entry><entry>Challenge</entry></row> - <row><entry>RADIUS_NAS_PORT_TYPE</entry><entry>int</entry><entry>NAS port type, on of: RADIUS_ASYNC, RADIUS_SYNC, RADIUS_ISDN_SYNC, - RADIUS_ISDN_ASYNC_V120, RADIUS_ISDN_ASYNC_V110, RADIUS_VIRTUAL, RADIUS_PIAFS, RADIUS_HDLC_CLEAR_CHANNEL, RADIUS_X_25, RADIUS_X_75, - RADIUS_G_3_FAX, RADIUS_SDSL, RADIUS_ADSL_CAP, RADIUS_ADSL_DMT, RADIUS_IDSL, RADIUS_ETHERNET, RADIUS_XDSL, RADIUS_CABLE, - RADIUS_WIRELESS_OTHER, RADIUS_WIRELESS_IEEE_802_11</entry></row> - <row><entry>RADIUS_PORT_LIMIT</entry><entry>int</entry><entry>Port Limit</entry></row> - <row><entry>RADIUS_LOGIN_LAT_PORT</entry><entry>int</entry><entry>Login LAT Port</entry></row> - <row><entry>RADIUS_CONNECT_INFO</entry><entry>string</entry><entry>Connect info</entry></row> - <row><entry>RADIUS_ACCT_STATUS_TYPE</entry><entry>int</entry><entry>Accounting status type, one of: RADIUS_START, RADIUS_STOP, RADIUS_ACCOUNTING_ON, RADIUS_ACCOUNTING_OFF</entry></row> - <row><entry>RADIUS_ACCT_DELAY_TIME</entry><entry>int</entry><entry>Accounting delay time</entry></row> - <row><entry>RADIUS_ACCT_INPUT_OCTETS</entry><entry>int</entry><entry>Accounting input bytes</entry></row> - <row><entry>RADIUS_ACCT_OUTPUT_OCTETS</entry><entry>int</entry><entry>Accounting output bytes</entry></row> - <row><entry>RADIUS_ACCT_SESSION_ID</entry><entry>string</entry><entry>Accounting session ID</entry></row> - <row><entry>RADIUS_ACCT_AUTHENTIC</entry><entry>int</entry><entry>Accounting authenic, one of: RADIUS_AUTH_RADIUS, RADIUS_AUTH_LOCAL, RADIUS_AUTH_REMOTE</entry></row> - <row><entry>RADIUS_ACCT_SESSION_TIME</entry><entry>int</entry><entry>Accounting session time</entry></row> - <row><entry>RADIUS_ACCT_INPUT_PACKETS</entry><entry>int</entry><entry>Accounting input packets</entry></row> - <row><entry>RADIUS_ACCT_OUTPUT_PACKETS</entry><entry>int</entry><entry>Accounting output packets</entry></row> - <row><entry>RADIUS_ACCT_TERMINATE_CAUSE</entry><entry>int</entry><entry>Accounting terminate cause, one of: RADIUS_TERM_USER_REQUEST, - RADIUS_TERM_LOST_CARRIER, RADIUS_TERM_LOST_SERVICE, RADIUS_TERM_IDLE_TIMEOUT, RADIUS_TERM_SESSION_TIMEOUT, RADIUS_TERM_ADMIN_RESET, - RADIUS_TERM_ADMIN_REBOOT, RADIUS_TERM_PORT_ERROR, RADIUS_TERM_NAS_ERROR, RADIUS_TERM_NAS_REQUEST, RADIUS_TERM_NAS_REBOOT, RADIUS_TERM_PORT_UNNEEDED, - RADIUS_TERM_PORT_PREEMPTED, RADIUS_TERM_PORT_SUSPENDED, RADIUS_TERM_SERVICE_UNAVAILABLE, RADIUS_TERM_CALLBACK, RADIUS_TERM_USER_ERROR, RADIUS_TERM_HOST_REQUEST</entry></row> - <row><entry>RADIUS_ACCT_MULTI_SESSION_ID</entry><entry>string</entry><entry>Accounting multi session ID</entry></row> - <row><entry>RADIUS_ACCT_LINK_COUNT</entry><entry>int</entry><entry>Accounting link count</entry></row> - <row><entry>RADIUS_VENDOR_MICROSOFT</entry><entry>int</entry><entry>Microsoft specific vendor attributes (RFC 2548), one of: - RADIUS_MICROSOFT_MS_CHAP_RESPONSE, RADIUS_MICROSOFT_MS_CHAP_ERROR, RADIUS_MICROSOFT_MS_CHAP_PW_1, RADIUS_MICROSOFT_MS_CHAP_PW_2, - RADIUS_MICROSOFT_MS_CHAP_LM_ENC_PW, RADIUS_MICROSOFT_MS_CHAP_NT_ENC_PW, RADIUS_MICROSOFT_MS_MPPE_ENCRYPTION_POLICY, - RADIUS_MICROSOFT_MS_MPPE_ENCRYPTION_TYPES, RADIUS_MICROSOFT_MS_RAS_VENDOR, RADIUS_MICROSOFT_MS_CHAP_DOMAIN, RADIUS_MICROSOFT_MS_CHAP_CHALLENGE, - RADIUS_MICROSOFT_MS_CHAP_MPPE_KEYS, RADIUS_MICROSOFT_MS_BAP_USAGE, RADIUS_MICROSOFT_MS_LINK_UTILIZATION_THRESHOLD, RADIUS_MICROSOFT_MS_LINK_DROP_TIME_LIMIT, - RADIUS_MICROSOFT_MS_MPPE_SEND_KEY, RADIUS_MICROSOFT_MS_MPPE_RECV_KEY, RADIUS_MICROSOFT_MS_RAS_VERSION, RADIUS_MICROSOFT_MS_OLD_ARAP_PASSWORD, - RADIUS_MICROSOFT_MS_NEW_ARAP_PASSWORD, RADIUS_MICROSOFT_MS_ARAP_PASSWORD_CHANGE_REASON, RADIUS_MICROSOFT_MS_FILTER, RADIUS_MICROSOFT_MS_ACCT_AUTH_TYPE, - RADIUS_MICROSOFT_MS_ACCT_EAP_TYPE, RADIUS_MICROSOFT_MS_CHAP2_RESPONSE, RADIUS_MICROSOFT_MS_CHAP2_SUCCESS, RADIUS_MICROSOFT_MS_CHAP2_PW, - RADIUS_MICROSOFT_MS_PRIMARY_DNS_SERVER, RADIUS_MICROSOFT_MS_SECONDARY_DNS_SERVER, RADIUS_MICROSOFT_MS_PRIMARY_NBNS_SERVER, - RADIUS_MICROSOFT_MS_SECONDARY_NBNS_SERVER, RADIUS_MICROSOFT_MS_ARAP_CHALLENGE</entry></row> - </tbody> - </tgroup> - </table> - </para> - </refsect1> - </refentry> - - </reference> +</reference>  +