From 15c42ac9e26b27c30de7902ad7281605f2623486 Mon Sep 17 00:00:00 2001 From: Anatol Belski Date: Tue, 31 Jul 2012 21:34:23 +0000 Subject: [PATCH] documented new functions for trader git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@326911 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/trader/constants.xml | 270 ++++++++++++++++++ .../trader/functions/trader-get-compat.xml | 47 +++ .../functions/trader-get-unstable-period.xml | 62 ++++ .../trader/functions/trader-set-compat.xml | 62 ++++ .../functions/trader-set-unstable-period.xml | 71 +++++ reference/trader/setup.xml | 3 +- reference/trader/versions.xml | 4 + 7 files changed, 518 insertions(+), 1 deletion(-) create mode 100644 reference/trader/functions/trader-get-compat.xml create mode 100644 reference/trader/functions/trader-get-unstable-period.xml create mode 100644 reference/trader/functions/trader-set-compat.xml create mode 100644 reference/trader/functions/trader-set-unstable-period.xml diff --git a/reference/trader/constants.xml b/reference/trader/constants.xml index f9adbca33d..ec46e01871 100644 --- a/reference/trader/constants.xml +++ b/reference/trader/constants.xml @@ -116,6 +116,276 @@ + + + TRADER_FUNC_UNST_ADX + (integer) + + + + + + + + + TRADER_FUNC_UNST_ADXR + (integer) + + + + + + + + + TRADER_FUNC_UNST_ATR + (integer) + + + + + + + + + TRADER_FUNC_UNST_CMO + (integer) + + + + + + + + + TRADER_FUNC_UNST_DX + (integer) + + + + + + + + + TRADER_FUNC_UNST_EMA + (integer) + + + + + + + + + TRADER_FUNC_UNST_HT_DCPERIOD + (integer) + + + + + + + + + TRADER_FUNC_UNST_HT_DCPHASE + (integer) + + + + + + + + + TRADER_FUNC_UNST_HT_PHASOR + (integer) + + + + + + + + + TRADER_FUNC_UNST_HT_SINE + (integer) + + + + + + + + + TRADER_FUNC_UNST_HT_TRENDLINE + (integer) + + + + + + + + + TRADER_FUNC_UNST_HT_TRENDMODE + (integer) + + + + + + + + + TRADER_FUNC_UNST_KAMA + (integer) + + + + + + + + + TRADER_FUNC_UNST_MAMA + (integer) + + + + + + + + + TRADER_FUNC_UNST_MFI + (integer) + + + + + + + + + TRADER_FUNC_UNST_MINUS_DI + (integer) + + + + + + + + + TRADER_FUNC_UNST_MINUS_DM + (integer) + + + + + + + + + TRADER_FUNC_UNST_NATR + (integer) + + + + + + + + + TRADER_FUNC_UNST_PLUS_DI + (integer) + + + + + + + + + TRADER_FUNC_UNST_PLUS_DM + (integer) + + + + + + + + + TRADER_FUNC_UNST_RSI + (integer) + + + + + + + + + TRADER_FUNC_UNST_STOCHRSI + (integer) + + + + + + + + + TRADER_FUNC_UNST_T3 + (integer) + + + + + + + + + TRADER_FUNC_UNST_ALL + (integer) + + + + + + + + + TRADER_FUNC_UNST_NONE + (integer) + + + + + + + + + TRADER_COMPATIBILITY_DEFAULT + (integer) + + + + + + + + + TRADER_COMPATIBILITY_METASTOCK + (integer) + + + + + + diff --git a/reference/trader/functions/trader-get-compat.xml b/reference/trader/functions/trader-get-compat.xml new file mode 100644 index 0000000000..1b7c7f5997 --- /dev/null +++ b/reference/trader/functions/trader-get-compat.xml @@ -0,0 +1,47 @@ + + + + + + trader_get_compat + Get compatibility mode + + + + &reftitle.description; + + integertrader_get_compat + + + + Get compatibility mode which affects the way calculations are done by all the extension functions. + + + + &reftitle.returnvalues; + Returns the compatibility mode id. + + + + + + diff --git a/reference/trader/functions/trader-get-unstable-period.xml b/reference/trader/functions/trader-get-unstable-period.xml new file mode 100644 index 0000000000..c6a776d697 --- /dev/null +++ b/reference/trader/functions/trader-get-unstable-period.xml @@ -0,0 +1,62 @@ + + + + + + trader_get_unstable_period + Get unstable period + + + + &reftitle.description; + + integertrader_get_unstable_period + integerfunctionId + + + Get unstable period factor for a particular function. + + + + + &reftitle.parameters; + + + functionId + + + Function ID the factor to be read for. TRADER_FUNC_UNST_* constant series should be used. + + + + + + + + &reftitle.returnvalues; + Returns the unstable period factor for the corresponding function. + + + + + + diff --git a/reference/trader/functions/trader-set-compat.xml b/reference/trader/functions/trader-set-compat.xml new file mode 100644 index 0000000000..6e4eb4eadf --- /dev/null +++ b/reference/trader/functions/trader-set-compat.xml @@ -0,0 +1,62 @@ + + + + + + trader_set_compat + Set compatibility mode + + + + &reftitle.description; + + voidtrader_set_compat + integercompatId + + + Set compatibility mode which will affect the way calculations are done by all the extension functions. + + + + + &reftitle.parameters; + + + compatId + + + Compatibility Id. TRADER_COMPATIBILITY_* constant series should be used. + + + + + + + + &reftitle.returnvalues; + &return.void; + + + + + + diff --git a/reference/trader/functions/trader-set-unstable-period.xml b/reference/trader/functions/trader-set-unstable-period.xml new file mode 100644 index 0000000000..7c520e57ec --- /dev/null +++ b/reference/trader/functions/trader-set-unstable-period.xml @@ -0,0 +1,71 @@ + + + + + + trader_set_unstable_period + Set unstable period + + + + &reftitle.description; + + voidtrader_set_unstable_period + integerfunctionId + integertimePeriod + + + Influences unstable period factor for functions, which are sensible to it. More information about unstable periods can be found on the TA-Lib API documentation page. + + + + + &reftitle.parameters; + + + functionId + + + Function ID the factor should be set for. TRADER_FUNC_UNST_* constant series can be used to affect the corresponding function. + + + + + timePeriod + + + Unstable period value. + + + + + + + + &reftitle.returnvalues; + &return.void; + + + + + + diff --git a/reference/trader/setup.xml b/reference/trader/setup.xml index fd58741173..aa5c9a2593 100644 --- a/reference/trader/setup.xml +++ b/reference/trader/setup.xml @@ -21,7 +21,8 @@ &url.pecl.package;trader. - &pecl.windows.download; + + A DLL for this PECL extension is available under http://windows.php.net/downloads/pecl/releases/trader/. diff --git a/reference/trader/versions.xml b/reference/trader/versions.xml index f9a45b86ef..f6a41496d4 100644 --- a/reference/trader/versions.xml +++ b/reference/trader/versions.xml @@ -164,6 +164,10 @@ + + + +