Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/matomo-org/matomo.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authordiosmosis <benakamoorthi@fastmail.fm>2013-12-08 22:12:48 +0400
committerdiosmosis <benakamoorthi@fastmail.fm>2013-12-08 22:13:07 +0400
commit13297a804c38999aa790af93f1d599e3c809dc7d (patch)
treecdf7cb0b4df018853852a1af675041cd23944293 /core/ViewDataTable
parent54bb5200d2567e51ff5a77dcd4dfa89195c169d9 (diff)
Fixes #4200, revised rest of @api classes/methods, closing ticket.
Diffstat (limited to 'core/ViewDataTable')
-rw-r--r--core/ViewDataTable/Factory.php2
-rw-r--r--core/ViewDataTable/RequestConfig.php18
2 files changed, 16 insertions, 4 deletions
diff --git a/core/ViewDataTable/Factory.php b/core/ViewDataTable/Factory.php
index 4dd4a15273..e657d0a797 100644
--- a/core/ViewDataTable/Factory.php
+++ b/core/ViewDataTable/Factory.php
@@ -73,7 +73,7 @@ class Factory
* Creates a {@link Piwik\Plugin\ViewDataTable} instance by ID. If the **viewDataTable** query parameter is set,
* this parameter's value is used as the ID.
*
- * See [ViewDataTable docs](#) to read about the ViewDataTable implementations that are packaged with Piwik.
+ * See {@link Piwik\Plugin\ViewDataTable} to read about the visualizations that are packaged with Piwik.
*
* @param string|null $defaultType A ViewDataTable ID representing the default ViewDataTable type to use. If
* the **viewDataTable** query parameter is not found, this value is used as
diff --git a/core/ViewDataTable/RequestConfig.php b/core/ViewDataTable/RequestConfig.php
index bc0311f678..733511dc06 100644
--- a/core/ViewDataTable/RequestConfig.php
+++ b/core/ViewDataTable/RequestConfig.php
@@ -196,7 +196,7 @@ class RequestConfig
/**
* Whether to run ViewDataTable's list of queued filters or not.
*
- * NOTE: Priority queued filters are always run.
+ * _NOTE: Priority queued filters are always run._
*
* Default value: false
*/
@@ -216,6 +216,12 @@ class RequestConfig
return get_object_vars($this);
}
+ /**
+ * Marks request properties as client side properties. [Read this](#client-side-properties-desc)
+ * to learn more.
+ *
+ * @param array $propertyNames List of property names, eg, `array('disable_queued_filters', 'filter_column')`.
+ */
public function addPropertiesThatShouldBeAvailableClientSide(array $propertyNames)
{
foreach ($propertyNames as $propertyName) {
@@ -223,6 +229,12 @@ class RequestConfig
}
}
+ /**
+ * Marks display properties as overridable. [Read this](#overridable-properties-desc) to
+ * learn more.
+ *
+ * @param array $propertyNames List of property names, eg, `array('disable_queued_filters', 'filter_column')`.
+ */
public function addPropertiesThatCanBeOverwrittenByQueryParams(array $propertyNames)
{
foreach ($propertyNames as $propertyName) {
@@ -243,7 +255,7 @@ class RequestConfig
}
/**
- * Returns true if queued filters have been disabled, false if otherwise.
+ * Returns `true` if queued filters have been disabled, `false` if otherwise.
*
* @return bool
*/
@@ -253,7 +265,7 @@ class RequestConfig
}
/**
- * Returns true if generic filters have been disabled, false if otherwise.
+ * Returns `true` if generic filters have been disabled, `false` if otherwise.
*
* @return bool
*/