mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 00:48:54 +00:00
Switch to new doc style
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@249452 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Mehdi Achour
parent
c10971d592
commit
bd4176288b
17 changed files with 921 additions and 191 deletions
|
|
@ -1,13 +1,12 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.5 $ -->
|
||||
<!-- splitted from ./en/functions/mcal.xml, last change in rev 1.2 -->
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<refentry xml:id="function.mcal-day-of-week" xmlns="http://docbook.org/ns/docbook">
|
||||
<refnamediv>
|
||||
<refname>mcal_day_of_week</refname>
|
||||
<refpurpose>Returns the day of the week of the given date</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>int</type><methodname>mcal_day_of_week</methodname>
|
||||
<methodparam><type>int</type><parameter>year</parameter></methodparam>
|
||||
|
|
@ -15,8 +14,43 @@
|
|||
<methodparam><type>int</type><parameter>day</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<function>mcal_day_of_week</function> returns the day of the week
|
||||
of the given date.
|
||||
Returns the day of the week of the given date.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>year</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The year.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>month</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The month.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>day</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The day.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Possible return values range from 0 for Sunday through 6 for Saturday.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
|
|
|||
|
|
@ -1,13 +1,12 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.5 $ -->
|
||||
<!-- splitted from ./en/functions/mcal.xml, last change in rev 1.2 -->
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<refentry xml:id="function.mcal-day-of-year" xmlns="http://docbook.org/ns/docbook">
|
||||
<refnamediv>
|
||||
<refname>mcal_day_of_year</refname>
|
||||
<refpurpose>Returns the day of the year of the given date</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>int</type><methodname>mcal_day_of_year</methodname>
|
||||
<methodparam><type>int</type><parameter>year</parameter></methodparam>
|
||||
|
|
@ -15,8 +14,44 @@
|
|||
<methodparam><type>int</type><parameter>day</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<function>mcal_day_of_year</function> returns the day of the year
|
||||
of the given date.
|
||||
Returns the day of the year of the given date.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>year</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The year.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>month</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The month.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>day</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The day.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the day as an integer.
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
|
|
|||
|
|
@ -1,13 +1,12 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.5 $ -->
|
||||
<!-- splitted from ./en/functions/mcal.xml, last change in rev 1.2 -->
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<refentry xml:id="function.mcal-days-in-month" xmlns="http://docbook.org/ns/docbook">
|
||||
<refnamediv>
|
||||
<refname>mcal_days_in_month</refname>
|
||||
<refpurpose>Returns the number of days in a month</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>int</type><methodname>mcal_days_in_month</methodname>
|
||||
<methodparam><type>int</type><parameter>month</parameter></methodparam>
|
||||
|
|
@ -19,6 +18,33 @@
|
|||
considered year is a leap year or not.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>month</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>leap_year</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the number of days in the <parameter>month</parameter>.
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
|||
|
|
@ -1,13 +1,12 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.5 $ -->
|
||||
<!-- splitted from ./en/functions/mcal.xml, last change in rev 1.11 -->
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<refentry xml:id="function.mcal-event-add-attribute" xmlns="http://docbook.org/ns/docbook">
|
||||
<refnamediv>
|
||||
<refname>mcal_event_add_attribute</refname>
|
||||
<refpurpose>Adds an attribute and a value to the streams global event structure</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>mcal_event_add_attribute</methodname>
|
||||
<methodparam><type>int</type><parameter>stream</parameter></methodparam>
|
||||
|
|
@ -15,9 +14,45 @@
|
|||
<methodparam><type>string</type><parameter>value</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<function>mcal_event_add_attribute</function> adds an attribute
|
||||
to the stream's global event structure with the value given by
|
||||
"value".
|
||||
Adds an attribute to the stream's global event structure with the given
|
||||
<parameter>value</parameter>.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>stream</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The MCAL stream.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>attribute</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The attribute name.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>value</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The attribute value.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
&return.success;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
|
|
|||
|
|
@ -1,13 +1,12 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<!-- splitted from ./en/functions/mcal.xml, last change in rev 1.2 -->
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<refentry xml:id="function.mcal-event-set-end" xmlns="http://docbook.org/ns/docbook">
|
||||
<refnamediv>
|
||||
<refname>mcal_event_set_end</refname>
|
||||
<refpurpose>Sets the end date and time of the streams global event structure</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>void</type><methodname>mcal_event_set_end</methodname>
|
||||
<methodparam><type>int</type><parameter>stream</parameter></methodparam>
|
||||
|
|
@ -15,12 +14,81 @@
|
|||
<methodparam><type>int</type><parameter>month</parameter></methodparam>
|
||||
<methodparam><type>int</type><parameter>day</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>int</type><parameter>hour</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>int</type><parameter>min</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>int</type><parameter>sec</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>int</type><parameter>minutes</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>int</type><parameter>seconds</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<function>mcal_event_set_end</function> sets the streams global
|
||||
event structure's end date and time to the given values.
|
||||
Sets the streams global event structure's end date and time to the given
|
||||
values.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>stream</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The MCAL stream.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>year</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The year.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>month</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The month.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>day</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The day.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>hour</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The hour.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>minutes</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The minutes.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>seconds</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The seconds.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
&return.void;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
|
|
|||
|
|
@ -1,13 +1,12 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<!-- splitted from ./en/functions/mcal.xml, last change in rev 1.2 -->
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<refentry xml:id="function.mcal-event-set-recur-daily" xmlns="http://docbook.org/ns/docbook">
|
||||
<refnamediv>
|
||||
<refname>mcal_event_set_recur_daily</refname>
|
||||
<refpurpose>Sets the recurrence of the streams global event structure</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>void</type><methodname>mcal_event_set_recur_daily</methodname>
|
||||
<methodparam><type>int</type><parameter>stream</parameter></methodparam>
|
||||
|
|
@ -17,9 +16,61 @@
|
|||
<methodparam><type>int</type><parameter>interval</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<function>mcal_event_set_recur_daily</function> sets the streams
|
||||
global event structure's recurrence to the given value to be
|
||||
reoccurring on a daily basis, ending at the given date.
|
||||
Sets the streams global event structure's recurrence to the given value to
|
||||
be reoccurring on a daily basis, ending at the given date.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>stream</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The MCAL stream.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>year</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The year.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>month</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The month.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>day</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The day.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>interval</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The interval.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
&return.void;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
|
|
|||
|
|
@ -1,13 +1,12 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<!-- splitted from ./en/functions/mcal.xml, last change in rev 1.2 -->
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<refentry xml:id="function.mcal-event-set-recur-monthly-mday" xmlns="http://docbook.org/ns/docbook">
|
||||
<refnamediv>
|
||||
<refname>mcal_event_set_recur_monthly_mday</refname>
|
||||
<refpurpose>Sets the recurrence of the streams global event structure</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>void</type><methodname>mcal_event_set_recur_monthly_mday</methodname>
|
||||
<methodparam><type>int</type><parameter>stream</parameter></methodparam>
|
||||
|
|
@ -17,10 +16,61 @@
|
|||
<methodparam><type>int</type><parameter>interval</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<function>mcal_event_set_recur_monthly_mday</function> sets the
|
||||
streams global event structure's recurrence to the given value to
|
||||
be reoccurring on a monthly by month day basis, ending at the
|
||||
given date.
|
||||
Sets the streams global event structure's recurrence to the given value to
|
||||
be reoccurring on a monthly by month day basis, ending at the given date.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>stream</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The MCAL stream.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>year</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The year.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>month</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The month.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>day</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The day.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>interval</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The interval.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
&return.void;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
|
|
|||
|
|
@ -1,13 +1,12 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<!-- splitted from ./en/functions/mcal.xml, last change in rev 1.2 -->
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<refentry xml:id="function.mcal-event-set-recur-monthly-wday" xmlns="http://docbook.org/ns/docbook">
|
||||
<refnamediv>
|
||||
<refname>mcal_event_set_recur_monthly_wday</refname>
|
||||
<refpurpose>Sets the recurrence of the streams global event structure</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>void</type><methodname>mcal_event_set_recur_monthly_wday</methodname>
|
||||
<methodparam><type>int</type><parameter>stream</parameter></methodparam>
|
||||
|
|
@ -23,6 +22,59 @@
|
|||
date.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>stream</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The MCAL stream.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>year</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The year.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>month</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The month.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>day</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The day.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>interval</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The interval.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
&return.void;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
|||
|
|
@ -1,13 +1,12 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<!-- splitted from ./en/functions/mcal.xml, last change in rev 1.2 -->
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<refentry xml:id="function.mcal-event-set-recur-weekly" xmlns="http://docbook.org/ns/docbook">
|
||||
<refnamediv>
|
||||
<refname>mcal_event_set_recur_weekly</refname>
|
||||
<refpurpose>Sets the recurrence of the streams global event structure</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>void</type><methodname>mcal_event_set_recur_weekly</methodname>
|
||||
<methodparam><type>int</type><parameter>stream</parameter></methodparam>
|
||||
|
|
@ -18,9 +17,68 @@
|
|||
<methodparam><type>int</type><parameter>weekdays</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<function>mcal_event_set_recur_weekly</function> sets the streams
|
||||
global event structure's recurrence to the given value to be
|
||||
reoccurring on a weekly basis, ending at the given date.
|
||||
Sets the streams global event structure's recurrence to the given value to
|
||||
be reoccurring on a weekly basis, ending at the given date.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>stream</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The MCAL stream.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>year</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The year.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>month</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The month.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>day</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The day.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>interval</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The interval.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>weekdays</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
&return.void;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
|
|
|||
|
|
@ -1,13 +1,12 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<!-- splitted from ./en/functions/mcal.xml, last change in rev 1.2 -->
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<refentry xml:id="function.mcal-event-set-recur-yearly" xmlns="http://docbook.org/ns/docbook">
|
||||
<refnamediv>
|
||||
<refname>mcal_event_set_recur_yearly</refname>
|
||||
<refpurpose>Sets the recurrence of the streams global event structure</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>void</type><methodname>mcal_event_set_recur_yearly</methodname>
|
||||
<methodparam><type>int</type><parameter>stream</parameter></methodparam>
|
||||
|
|
@ -17,9 +16,61 @@
|
|||
<methodparam><type>int</type><parameter>interval</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<function>mcal_event_set_recur_yearly</function> sets the streams
|
||||
global event structure's recurrence to the given value to be
|
||||
reoccurring on a yearly basis,ending at the given date.
|
||||
Sets the streams global event structure's recurrence to the given value to
|
||||
be reoccurring on a yearly basis,ending at the given date.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>stream</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The MCAL stream.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>year</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The year.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>month</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The month.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>day</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The day.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>interval</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The interval.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
&return.void;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
|
|
|||
|
|
@ -1,13 +1,12 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<!-- splitted from ./en/functions/mcal.xml, last change in rev 1.2 -->
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<refentry xml:id="function.mcal-event-set-start" xmlns="http://docbook.org/ns/docbook">
|
||||
<refnamediv>
|
||||
<refname>mcal_event_set_start</refname>
|
||||
<refpurpose>Sets the start date and time of the streams global event structure</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>void</type><methodname>mcal_event_set_start</methodname>
|
||||
<methodparam><type>int</type><parameter>stream</parameter></methodparam>
|
||||
|
|
@ -15,12 +14,81 @@
|
|||
<methodparam><type>int</type><parameter>month</parameter></methodparam>
|
||||
<methodparam><type>int</type><parameter>day</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>int</type><parameter>hour</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>int</type><parameter>min</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>int</type><parameter>sec</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>int</type><parameter>minutes</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>int</type><parameter>seconds</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<function>mcal_event_set_start</function> sets the streams global
|
||||
event structure's start date and time to the given values.
|
||||
Sets the streams global event structure's start date and time to the given
|
||||
values.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>stream</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The MCAL stream.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>year</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The year.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>month</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The month.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>day</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The day.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>hour</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The hour.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>minutes</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The minutes.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>seconds</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The seconds.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
&return.void;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
|
|
|||
|
|
@ -1,68 +1,140 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.5 $ -->
|
||||
<!-- splitted from ./en/functions/mcal.xml, last change in rev 1.2 -->
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<refentry xml:id="function.mcal-fetch-current-stream-event" xmlns="http://docbook.org/ns/docbook">
|
||||
<refnamediv>
|
||||
<refname>mcal_fetch_current_stream_event</refname>
|
||||
<refpurpose>Returns an object containing the current streams event structure</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>object</type><methodname>mcal_fetch_current_stream_event</methodname>
|
||||
<methodparam><type>int</type><parameter>stream</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Returns an object containing the current streams event structure.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>stream</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The MCAL stream.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
<function>mcal_fetch_current_stream_event</function>
|
||||
returns the current stream's event structure as an object
|
||||
containing:
|
||||
|
||||
<itemizedlist>
|
||||
<listitem><simpara>
|
||||
int id - ID of that event.</simpara></listitem>
|
||||
<listitem><simpara>
|
||||
int public - &true; if the event if public, &false; if it is
|
||||
private.</simpara></listitem>
|
||||
<listitem><simpara>
|
||||
string category - Category string of the event.</simpara></listitem>
|
||||
<listitem><simpara>
|
||||
string title - Title string of the event.</simpara></listitem>
|
||||
<listitem><simpara>
|
||||
string description - Description string of the event.</simpara></listitem>
|
||||
<listitem><simpara>
|
||||
int alarm - number of minutes before the event to send an
|
||||
alarm/reminder.</simpara></listitem>
|
||||
<listitem><simpara>
|
||||
object start - Object containing a datetime entry.</simpara></listitem>
|
||||
<listitem><simpara>
|
||||
object end - Object containing a datetime entry.</simpara></listitem>
|
||||
<listitem><simpara>
|
||||
int recur_type - recurrence type</simpara></listitem>
|
||||
<listitem><simpara>
|
||||
int recur_interval - recurrence interval</simpara></listitem>
|
||||
<listitem><simpara>
|
||||
datetime recur_enddate - recurrence end date</simpara></listitem>
|
||||
<listitem><simpara>
|
||||
int recur_data - recurrence data</simpara></listitem>
|
||||
<listitem>
|
||||
<simpara>
|
||||
int id - ID of that event.
|
||||
</simpara>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<simpara>
|
||||
int public - &true; if the event if public, &false; if it is private.
|
||||
</simpara>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<simpara>
|
||||
string category - Category string of the event.
|
||||
</simpara>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<simpara>
|
||||
string title - Title string of the event.
|
||||
</simpara>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<simpara>
|
||||
string description - Description string of the event.
|
||||
</simpara>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<simpara>
|
||||
int alarm - number of minutes before the event to send an alarm/reminder.
|
||||
</simpara>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<simpara>
|
||||
object start - Object containing a datetime entry.
|
||||
</simpara>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<simpara>
|
||||
object end - Object containing a datetime entry.
|
||||
</simpara>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<simpara>
|
||||
int recur_type - recurrence type
|
||||
</simpara>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<simpara>
|
||||
int recur_interval - recurrence interval
|
||||
</simpara>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<simpara>
|
||||
datetime recur_enddate - recurrence end date
|
||||
</simpara>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<simpara>
|
||||
int recur_data - recurrence data
|
||||
</simpara>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
|
||||
All datetime entries consist of an object that contains:
|
||||
|
||||
<itemizedlist>
|
||||
<listitem><simpara>
|
||||
int year - year</simpara></listitem>
|
||||
<listitem><simpara>
|
||||
int month - month</simpara></listitem>
|
||||
<listitem><simpara>
|
||||
int mday - day of month</simpara></listitem>
|
||||
<listitem><simpara>
|
||||
int hour - hour</simpara></listitem>
|
||||
<listitem><simpara>
|
||||
int min - minutes</simpara></listitem>
|
||||
<listitem><simpara>
|
||||
int sec - seconds</simpara></listitem>
|
||||
<listitem><simpara>
|
||||
int alarm - minutes before event to send an alarm</simpara></listitem>
|
||||
<listitem>
|
||||
<simpara>
|
||||
int year - year
|
||||
</simpara>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<simpara>
|
||||
int month - month
|
||||
</simpara>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<simpara>
|
||||
int mday - day of month
|
||||
</simpara>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<simpara>
|
||||
int hour - hour
|
||||
</simpara>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<simpara>
|
||||
int min - minutes
|
||||
</simpara>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<simpara>
|
||||
int sec - seconds
|
||||
</simpara>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<simpara>
|
||||
int alarm - minutes before event to send an alarm
|
||||
</simpara>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
|
|
|||
|
|
@ -1,13 +1,12 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.5 $ -->
|
||||
<!-- splitted from ./en/functions/mcal.xml, last change in rev 1.3 -->
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<refentry xml:id="function.mcal-next-recurrence" xmlns="http://docbook.org/ns/docbook">
|
||||
<refnamediv>
|
||||
<refname>mcal_next_recurrence</refname>
|
||||
<refpurpose>Returns the next recurrence of the event</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>object</type><methodname>mcal_next_recurrence</methodname>
|
||||
<methodparam><type>int</type><parameter>stream</parameter></methodparam>
|
||||
|
|
@ -15,11 +14,46 @@
|
|||
<methodparam><type>array</type><parameter>next</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<function>mcal_next_recurrence</function> returns an object
|
||||
filled with the next date the event occurs, on or after the
|
||||
supplied date. Returns empty date field if event does not occur
|
||||
or something is invalid. Uses weekstart to determine what day is
|
||||
considered the beginning of the week.
|
||||
Gets the next recurrence of the event.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>stream</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The MCAL stream.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>weekstart</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Uses weekstart to determine what day is considered the beginning of
|
||||
the week.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>next</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns an object filled with the next date the event occurs, on or after
|
||||
the supplied date. Returns empty date field if event does not occur or
|
||||
something is invalid.
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
|
|
|||
|
|
@ -1,13 +1,12 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.5 $ -->
|
||||
<!-- splitted from ./en/functions/mcrypt.xml, last change in rev 1.7 -->
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<refentry xml:id="function.mcrypt-decrypt" xmlns="http://docbook.org/ns/docbook">
|
||||
<refnamediv>
|
||||
<refname>mcrypt_decrypt</refname>
|
||||
<refpurpose>Decrypts crypttext with given parameters</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>string</type><methodname>mcrypt_decrypt</methodname>
|
||||
<methodparam><type>string</type><parameter>cipher</parameter></methodparam>
|
||||
|
|
@ -17,34 +16,70 @@
|
|||
<methodparam choice="opt"><type>string</type><parameter>iv</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<function>mcrypt_decrypt</function> decrypts the data
|
||||
and returns the unencrypted data.
|
||||
Decrypts the <parameter>data</parameter> and returns the unencrypted data.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<parameter>Cipher</parameter> is one of the MCRYPT_ciphername
|
||||
constants of the name of the algorithm as string.
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>cipher</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<parameter>cipher</parameter> is one of the MCRYPT_ciphername constants
|
||||
of the name of the algorithm as string.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>key</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<parameter>key</parameter> is the key with which the data is encrypted.
|
||||
If it's smaller that the required keysize, it is padded with
|
||||
'<literal>\0</literal>'.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>data</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<parameter>data</parameter> is the data that will be decrypted with
|
||||
the given cipher and mode. If the size of the data is not n * blocksize,
|
||||
the data will be padded with '<literal>\0</literal>'.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>mode</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<parameter>mode</parameter> is one of the MCRYPT_MODE_modename
|
||||
constants of one of "ecb", "cbc", "cfb", "ofb", "nofb" or "stream".
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>iv</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The <parameter>iv</parameter> parameter is used for the initialisation
|
||||
in CBC, CFB, OFB modes, and in some algorithms in STREAM mode. If you
|
||||
do not supply an IV, while it is needed for an algorithm, the function
|
||||
issues a warning and uses an IV with all bytes set to
|
||||
'<literal>\0</literal>'.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
<parameter>Key</parameter> is the key with which the data
|
||||
is encrypted. If it's smaller that the required keysize, it
|
||||
is padded with '<literal>\0</literal>'.
|
||||
</para>
|
||||
<para>
|
||||
<parameter>Data</parameter> is the data that will be decrypted
|
||||
with the given cipher and mode. If the size of the data is not
|
||||
n * blocksize, the data will be padded with '<literal>\0</literal>'.
|
||||
</para>
|
||||
<para>
|
||||
<parameter>Mode</parameter> is one of the MCRYPT_MODE_modename
|
||||
constants of one of "ecb", "cbc", "cfb", "ofb", "nofb" or
|
||||
"stream".
|
||||
</para>
|
||||
<para>
|
||||
The <parameter>IV</parameter> parameter is used for the
|
||||
initialisation in CBC, CFB, OFB modes, and in some algorithms
|
||||
in STREAM mode. If you do not supply an IV, while it is needed
|
||||
for an algorithm, the function issues a warning and uses an
|
||||
IV with all bytes set to '<literal>\0</literal>'.
|
||||
Returns the decrypted data as a string.
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
|
|
|||
|
|
@ -1,13 +1,12 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<!-- splitted from ./en/functions/mcrypt.xml, last change in rev 1.7 -->
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<refentry xml:id="function.mcrypt-enc-get-modes-name" xmlns="http://docbook.org/ns/docbook">
|
||||
<refnamediv>
|
||||
<refname>mcrypt_enc_get_modes_name</refname>
|
||||
<refpurpose>Returns the name of the opened mode</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>string</type><methodname>mcrypt_enc_get_modes_name</methodname>
|
||||
<methodparam><type>resource</type><parameter>td</parameter></methodparam>
|
||||
|
|
@ -15,23 +14,45 @@
|
|||
<para>
|
||||
This function returns the name of the mode.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>td</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The encryption descriptior.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the name as a string.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<para>
|
||||
<example>
|
||||
<title><function>mcrypt_enc_get_modes_name</function> example</title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
$td = mcrypt_module_open (MCRYPT_CAST_256, '', MCRYPT_MODE_CFB, '');
|
||||
echo mcrypt_enc_get_modes_name($td). "\n";
|
||||
$td = mcrypt_module_open (MCRYPT_CAST_256, '', MCRYPT_MODE_CFB, '');
|
||||
echo mcrypt_enc_get_modes_name($td). "\n";
|
||||
|
||||
$td = mcrypt_module_open ('cast-256', '', 'ecb', '');
|
||||
echo mcrypt_enc_get_modes_name($td). "\n";
|
||||
$td = mcrypt_module_open ('cast-256', '', 'ecb', '');
|
||||
echo mcrypt_enc_get_modes_name($td). "\n";
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
<para>
|
||||
Prints:
|
||||
</para>
|
||||
&example.outputs;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
CFB
|
||||
|
|
|
|||
|
|
@ -1,13 +1,12 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.8 $ -->
|
||||
<!-- splitted from ./en/functions/mcrypt.xml, last change in rev 1.7 -->
|
||||
<!-- $Revision: 1.9 $ -->
|
||||
<refentry xml:id="function.mcrypt-generic-init" xmlns="http://docbook.org/ns/docbook">
|
||||
<refnamediv>
|
||||
<refname>mcrypt_generic_init</refname>
|
||||
<refpurpose>This function initializes all buffers needed for encryption</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>int</type><methodname>mcrypt_generic_init</methodname>
|
||||
<methodparam><type>resource</type><parameter>td</parameter></methodparam>
|
||||
|
|
@ -15,17 +14,52 @@
|
|||
<methodparam><type>string</type><parameter>iv</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
The maximum length of the key should be the one obtained by
|
||||
calling <function>mcrypt_enc_get_key_size</function> and every
|
||||
value smaller than this is legal. The IV should normally have
|
||||
the size of the algorithms block size, but you must obtain the
|
||||
size by calling <function>mcrypt_enc_get_iv_size</function>.
|
||||
IV is ignored in ECB. IV MUST exist in CFB, CBC, STREAM, nOFB
|
||||
and OFB modes. It needs to be random and unique (but not secret).
|
||||
The same IV must be used for encryption/decryption. If you do not
|
||||
want to use it you should set it to zeros, but this is not
|
||||
recommended.
|
||||
You need to call this function before every call to
|
||||
<function>mcrypt_generic</function> or
|
||||
<function>mdecrypt_generic</function>.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>td</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The encryption descriptior.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>key</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The maximum length of the key should be the one obtained by calling
|
||||
<function>mcrypt_enc_get_key_size</function> and every value smaller
|
||||
than this is legal.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>iv</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The IV should normally have the size of the algorithms block size, but
|
||||
you must obtain the size by calling
|
||||
<function>mcrypt_enc_get_iv_size</function>. IV is ignored in ECB. IV
|
||||
MUST exist in CFB, CBC, STREAM, nOFB and OFB modes. It needs to be
|
||||
random and unique (but not secret). The same IV must be used for
|
||||
encryption/decryption. If you do not want to use it you should set it
|
||||
to zeros, but this is not recommended.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
The function returns a negative value on error, -3 when the key length
|
||||
was incorrect, -4 when there was a memory allocation problem and any
|
||||
|
|
@ -33,13 +67,13 @@
|
|||
be displayed accordingly. &false; is returned if incorrect parameters
|
||||
were passed.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
You need to call this function before every call to
|
||||
<function>mcrypt_generic</function> or
|
||||
<function>mdecrypt_generic</function>.
|
||||
</para>
|
||||
<para>
|
||||
See for an example <function>mcrypt_module_open</function>.
|
||||
<simplelist>
|
||||
<member><function>mcrypt_module_open</function></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
|
|
|||
|
|
@ -1,12 +1,12 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1'?>
|
||||
<!-- $Revision: 1.5 $ -->
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<refentry xml:id="function.tidy-get-release" xmlns="http://docbook.org/ns/docbook">
|
||||
<refnamediv>
|
||||
<refname>tidy_get_release</refname>
|
||||
<refpurpose>Get release date (version) for Tidy library</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<para>Procedural style:</para>
|
||||
<methodsynopsis>
|
||||
<type>string</type><methodname>tidy_get_release</methodname>
|
||||
|
|
@ -18,7 +18,13 @@
|
|||
<void />
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
This function returns a string with the release date of the Tidy library.
|
||||
Gets the release date of the Tidy library.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns a string with the release date of the Tidy library.
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
|
|
|||
Loading…
Reference in a new issue