mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 14:28:56 +00:00
e6b43249c1
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@115951 c90b9560-bf6c-de11-be94-00142212c4b1
52 lines
1.7 KiB
XML
52 lines
1.7 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.3 $ -->
|
|
<!-- splitted from ./en/functions/mcal.xml, last change in rev 1.2 -->
|
|
<refentry id="function.mcal-list-events">
|
|
<refnamediv>
|
|
<refname>mcal_list_events</refname>
|
|
<refpurpose>
|
|
Return a list of IDs for a date or a range of dates
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>array</type><methodname>mcal_list_events</methodname>
|
|
<methodparam><type>int</type><parameter>mcal_stream</parameter></methodparam>
|
|
<methodparam><type>object</type><parameter>begin_date</parameter></methodparam>
|
|
<methodparam choice="opt"><type>object</type><parameter>end_date</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Returns an array of ID's that are between the start and end
|
|
dates, or if just a stream is given, uses the start and end dates
|
|
in the global event structure.
|
|
</para>
|
|
<para>
|
|
<function>mcal_list_events</function> takes in an
|
|
beginning date and an optional end date for a calendar stream. An
|
|
array of event id's that are between the given dates or the
|
|
internal event dates are returned.
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"../../../../manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|