php-doc-en/reference/calendar/functions/jddayofweek.xml
Peter Cowburn db43575bd6 lowercase calendar function names
Patch by cmb

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@336889 c90b9560-bf6c-de11-be94-00142212c4b1
2015-06-08 22:46:53 +00:00

103 lines
2.5 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.jddayofweek" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>jddayofweek</refname>
<refpurpose>Returns the day of the week</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>jddayofweek</methodname>
<methodparam><type>int</type><parameter>julianday</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer>CAL_DOW_DAYNO</initializer></methodparam>
</methodsynopsis>
<para>
Returns the day of the week. Can return a string or an integer
depending on the mode.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>julianday</parameter></term>
<listitem>
<para>
A julian day number as integer
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mode</parameter></term>
<listitem>
<table>
<title>Calendar week modes</title>
<tgroup cols="2">
<thead>
<row>
<entry>Mode</entry>
<entry>Meaning</entry>
</row>
</thead>
<tbody>
<row>
<entry>0 (Default)</entry>
<entry>
Return the day number as an int (0=Sunday, 1=Monday, etc)
</entry>
</row>
<row>
<entry>1</entry>
<entry>
Returns string containing the day of week
(English-Gregorian)
</entry>
</row>
<row>
<entry>2</entry>
<entry>
Return a string containing the abbreviated day of week
(English-Gregorian)
</entry>
</row>
</tbody>
</tgroup>
</table>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The gregorian weekday as either an integer or string.
</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:"~/.phpdoc/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
-->