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:
authorvipsoft <vipsoft@59fd770c-687e-43c8-a1e3-f5a4ff64c105>2009-08-23 18:27:44 +0400
committervipsoft <vipsoft@59fd770c-687e-43c8-a1e3-f5a4ff64c105>2009-08-23 18:27:44 +0400
commita01e0d66b0111541d6851b54dbb7668553b60fab (patch)
treef53ff50dff8dc00c4a82cc17914696be80014357 /plugins/UserCountry
parentdcc49fa07ff5f6aa96b907eb5200b21ec7f67f2d (diff)
Tweak phpdoc config. Add some missing phpdocs.
Diffstat (limited to 'plugins/UserCountry')
-rw-r--r--plugins/UserCountry/API.php4
-rw-r--r--plugins/UserCountry/functions.php18
2 files changed, 22 insertions, 0 deletions
diff --git a/plugins/UserCountry/API.php b/plugins/UserCountry/API.php
index 3fda341b8c..3b83786e9a 100644
--- a/plugins/UserCountry/API.php
+++ b/plugins/UserCountry/API.php
@@ -13,6 +13,10 @@
// no direct access
defined('PIWIK_INCLUDE_PATH') or die;
+/**
+ * @see core/DataFiles/Countries.php
+ * @see plugins/UserCountry/functions.php
+ */
require_once PIWIK_INCLUDE_PATH . '/core/DataFiles/Countries.php';
require_once PIWIK_INCLUDE_PATH . '/plugins/UserCountry/functions.php';
diff --git a/plugins/UserCountry/functions.php b/plugins/UserCountry/functions.php
index 5ef4abd2e8..8e050fa9a2 100644
--- a/plugins/UserCountry/functions.php
+++ b/plugins/UserCountry/functions.php
@@ -10,6 +10,12 @@
* @package Piwik_UserCountry
*/
+/**
+ * Return the flag image path for a given country
+ *
+ * @param string $code ISO country code
+ * @return string Flag image path
+ */
function Piwik_getFlagFromCode($code)
{
$pathInPiwik = 'plugins/UserCountry/flags/%s.png';
@@ -22,6 +28,12 @@ function Piwik_getFlagFromCode($code)
return sprintf($pathInPiwik, 'xx');
}
+/**
+ * Returns the translated continent name for a given continent code
+ *
+ * @param string $label Continent code
+ * @return string Continent name
+ */
function Piwik_ContinentTranslate($label)
{
if($label == 'unk')
@@ -31,6 +43,12 @@ function Piwik_ContinentTranslate($label)
return Piwik_Translate('UserCountry_continent_'. $label);
}
+/**
+ * Returns the translated country name for a given country code
+ *
+ * @param string $label country code
+ * @return string Country name
+ */
function Piwik_CountryTranslate($label)
{
if($label == 'xx')