documented new functions for trader

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@326911 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Anatol Belski 2012-07-31 21:34:23 +00:00
parent 95da005d84
commit 15c42ac9e2
7 changed files with 518 additions and 1 deletions

View file

@ -116,6 +116,276 @@
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.trader-func-unst-adx">
<term>
<constant>TRADER_FUNC_UNST_ADX</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.trader-func-unst-adxr">
<term>
<constant>TRADER_FUNC_UNST_ADXR</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.trader-func-unst-atr">
<term>
<constant>TRADER_FUNC_UNST_ATR</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.trader-func-unst-cmo">
<term>
<constant>TRADER_FUNC_UNST_CMO</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.trader-func-unst-dx">
<term>
<constant>TRADER_FUNC_UNST_DX</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.trader-func-unst-ema">
<term>
<constant>TRADER_FUNC_UNST_EMA</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.trader-func-unst-ht-dcperiod">
<term>
<constant>TRADER_FUNC_UNST_HT_DCPERIOD</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.trader-func-unst-ht-dcphase">
<term>
<constant>TRADER_FUNC_UNST_HT_DCPHASE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.trader-func-unst-ht-phasor">
<term>
<constant>TRADER_FUNC_UNST_HT_PHASOR</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.trader-func-unst-ht-sine">
<term>
<constant>TRADER_FUNC_UNST_HT_SINE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.trader-func-unst-ht-trendline">
<term>
<constant>TRADER_FUNC_UNST_HT_TRENDLINE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.trader-func-unst-ht-trendmode">
<term>
<constant>TRADER_FUNC_UNST_HT_TRENDMODE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.trader-func-unst-kama">
<term>
<constant>TRADER_FUNC_UNST_KAMA</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.trader-func-unst-mama">
<term>
<constant>TRADER_FUNC_UNST_MAMA</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.trader-func-unst-mfi">
<term>
<constant>TRADER_FUNC_UNST_MFI</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.trader-func-unst-minus-di">
<term>
<constant>TRADER_FUNC_UNST_MINUS_DI</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.trader-func-unst-minus-dm">
<term>
<constant>TRADER_FUNC_UNST_MINUS_DM</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.trader-func-unst-natr">
<term>
<constant>TRADER_FUNC_UNST_NATR</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.trader-func-unst-plus-di">
<term>
<constant>TRADER_FUNC_UNST_PLUS_DI</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.trader-func-unst-plus-dm">
<term>
<constant>TRADER_FUNC_UNST_PLUS_DM</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.trader-func-unst-rsi">
<term>
<constant>TRADER_FUNC_UNST_RSI</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.trader-func-unst-stochrsi">
<term>
<constant>TRADER_FUNC_UNST_STOCHRSI</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.trader-func-unst-t3">
<term>
<constant>TRADER_FUNC_UNST_T3</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.trader-func-unst-all">
<term>
<constant>TRADER_FUNC_UNST_ALL</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.trader-func-unst-none">
<term>
<constant>TRADER_FUNC_UNST_NONE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.trader-compatibility-default">
<term>
<constant>TRADER_COMPATIBILITY_DEFAULT</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.trader-compatibility-metastock">
<term>
<constant>TRADER_COMPATIBILITY_METASTOCK</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
</appendix>

View file

@ -0,0 +1,47 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 325956 $ -->
<refentry xml:id="function.trader-get-compat" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>trader_get_compat</refname>
<refpurpose>Get compatibility mode</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>integer</type><methodname>trader_get_compat</methodname>
<void/>
</methodsynopsis>
<para>
Get compatibility mode which affects the way calculations are done by all the extension functions.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>Returns the compatibility mode id.</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
-->

View file

@ -0,0 +1,62 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 325956 $ -->
<refentry xml:id="function.trader-get-unstable-period" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>trader_get_unstable_period</refname>
<refpurpose>Get unstable period</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>integer</type><methodname>trader_get_unstable_period</methodname>
<methodparam><type>integer</type><parameter>functionId</parameter></methodparam>
</methodsynopsis>
<para>
Get unstable period factor for a particular function.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>functionId</parameter></term>
<listitem>
<para>
Function ID the factor to be read for. TRADER_FUNC_UNST_* constant series should be used.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>Returns the unstable period factor for the corresponding function.</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
-->

View file

@ -0,0 +1,62 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 325956 $ -->
<refentry xml:id="function.trader-set-compat" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>trader_set_compat</refname>
<refpurpose>Set compatibility mode</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>trader_set_compat</methodname>
<methodparam><type>integer</type><parameter>compatId</parameter></methodparam>
</methodsynopsis>
<para>
Set compatibility mode which will affect the way calculations are done by all the extension functions.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>compatId</parameter></term>
<listitem>
<para>
Compatibility Id. TRADER_COMPATIBILITY_* constant series should be used.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>&return.void;</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
-->

View file

@ -0,0 +1,71 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 325956 $ -->
<refentry xml:id="function.trader-set-unstable-period" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>trader_set_unstable_period</refname>
<refpurpose>Set unstable period</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>trader_set_unstable_period</methodname>
<methodparam><type>integer</type><parameter>functionId</parameter></methodparam>
<methodparam><type>integer</type><parameter>timePeriod</parameter></methodparam>
</methodsynopsis>
<para>
Influences unstable period factor for functions, which are sensible to it. More information about unstable periods can be found on the <link xlink:href="http://ta-lib.org/d_api/ta_setunstableperiod.html">TA-Lib</link> API documentation page.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>functionId</parameter></term>
<listitem>
<para>
Function ID the factor should be set for. TRADER_FUNC_UNST_* constant series can be used to affect the corresponding function.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>timePeriod</parameter></term>
<listitem>
<para>
Unstable period value.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>&return.void;</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
-->

View file

@ -21,7 +21,8 @@
<link xlink:href="&url.pecl.package;trader">&url.pecl.package;trader</link>.
</para>
<para>
&pecl.windows.download;
<!-- &pecl.windows.download;-->
A DLL for this PECL extension is available under <link xlink:href="http://windows.php.net/downloads/pecl/releases/trader/">http://windows.php.net/downloads/pecl/releases/trader/</link>.
</para>
</section>

View file

@ -164,6 +164,10 @@
<function name='trader_wclprice' from='PECL trader &gt;= 0.2.0'/>
<function name='trader_willr' from='PECL trader &gt;= 0.2.0'/>
<function name='trader_wma' from='PECL trader &gt;= 0.2.0'/>
<function name='trader_set_unstable_period' from='PECL trader &gt;= 0.2.2'/>
<function name='trader_get_unstable_period' from='PECL trader &gt;= 0.2.2'/>
<function name='trader_set_compat' from='PECL trader &gt;= 0.2.2'/>
<function name='trader_get_compat' from='PECL trader &gt;= 0.2.2'/>
</versions>
<!-- Keep this comment at the end of the file