mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-21 03:18:55 +00:00
d23e009219
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@210411 c90b9560-bf6c-de11-be94-00142212c4b1
173 lines
4 KiB
XML
173 lines
4 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.4 $ -->
|
|
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
|
|
<refentry id="function.px-date2string">
|
|
<refnamediv>
|
|
<refname>px_date2string</refname>
|
|
<refpurpose>
|
|
Converts a date into a string.
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>px_date2string</methodname>
|
|
<methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>value</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>format</parameter></methodparam>
|
|
</methodsynopsis>
|
|
|
|
<para>
|
|
Turns a date as it stored in the paradox file into human readable
|
|
format. Paradox dates are the number of days since 1.1.0000.
|
|
This function is just for convenience. It can be easily replaced by some
|
|
math and the calendar functions as demonstrated in the example below.
|
|
</para>
|
|
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>pxdoc</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Resource identifier of the paradox database
|
|
as returned by <function>px_new</function>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>value</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Value as stored in paradox database field of type
|
|
PX_FIELD_DATE.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>format</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
String format similar to the format used by <function>date</function>.
|
|
The placeholders support by this function is a subset of those
|
|
supported by <function>date</function> (Y, y, m, n, d, j, L).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.success;
|
|
</para>
|
|
</refsect1>
|
|
|
|
<!-- Use when EXCEPTIONS exist
|
|
<refsect1 role="exceptions">
|
|
&reftitle.exceptions;
|
|
<para>
|
|
When does this function throw exceptions?
|
|
</para>
|
|
</refsect1>
|
|
-->
|
|
|
|
|
|
<!-- Use when a CHANGELOG exists
|
|
<refsect1 role="changelog">
|
|
&reftitle.changelog;
|
|
<para>
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>&Version;</entry>
|
|
<entry>&Description</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>Enter the PHP version of change here
|
|
<entry>Description of change
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</para>
|
|
</refsect1>
|
|
-->
|
|
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>Turn a paradox date into a human readable form</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$px = px_new();
|
|
|
|
/* make up a date as it could be stored in */
|
|
/* a date field of a paradox db. */
|
|
/* 700000 days since 1.1.0000. */
|
|
$days = 700000;
|
|
|
|
/* Use the calendar functions to print a */
|
|
/* human readable format of the date */
|
|
echo jdtogregorian($days+1721425)."\n";
|
|
/* px_date2string() outputs the same */
|
|
echo px_date2string($px, $days, "n/d/Y")."\n";
|
|
|
|
px_delete($px);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
7/15/1917
|
|
7/15/1917
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>px_timestamp2string</function></member>
|
|
<member><function>jdtogregorian</function></member>
|
|
</simplelist>
|
|
</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
|
|
-->
|