1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.ibase-timefmt">
<refnamediv>
<refname>ibase_timefmt</refname>
<refpurpose>Sets the format of timestamp, date and time type columns returned from queries</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ibase_timefmt</methodname>
<methodparam><type>string</type><parameter>format</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>columntype</parameter></methodparam>
</methodsynopsis>
<para>
Sets the format of timestamp, date or time type columns returned from
queries.
</para>
<para>
You can set defaults for these formats with the PHP configuration
directives <literal>ibase.timestampformat</literal>,
<literal>ibase.dateformat</literal> and
<literal>ibase.timeformat</literal>.
</para>
<note>
<para>
This function has been removed from PHP 5, use
<function>ini_set</function> instead.
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>format</parameter></term>
<listitem>
<para>
Internally, the columns are formatted by c-function strftime(), so
refer to its documentation regarding to the format of the string.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>columntype</parameter></term>
<listitem>
<para>
<parameter>columntype</parameter> is one of the constants
<constant>IBASE_TIMESTAMP</constant>, <constant>IBASE_DATE</constant>
and <constant>IBASE_TIME</constant>. If omitted, defaults to
<constant>IBASE_TIMESTAMP</constant> for backwards compatibility.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>ibase_timefmt</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
/* InterBase 6 TIME-type columns will be returned in
* the form '05 hours 37 minutes'. */
ibase_timefmt("%H hours %M minutes", IBASE_TIME);
?>
]]>
</programlisting>
</example>
</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
-->
|