Piwik\Common::getCampaignParameters PHP Méthode

getCampaignParameters() public static méthode

Returns the list of Campaign parameter names that will be read to classify a visit as coming from a Campaign
public static getCampaignParameters ( ) : array
Résultat array array( 0 => array( ... ) // campaign names parameters 1 => array( ... ) // campaign keyword parameters );
    public static function getCampaignParameters()
    {
        $return = array(Config::getInstance()->Tracker['campaign_var_name'], Config::getInstance()->Tracker['campaign_keyword_var_name']);
        foreach ($return as &$list) {
            if (strpos($list, ',') !== false) {
                $list = explode(',', $list);
            } else {
                $list = array($list);
            }
            $list = array_map('trim', $list);
        }
        return $return;
    }

Usage Example

Exemple #1
0
 /**
  * Returns the array of parameters names that must be excluded from the Query String in all tracked URLs
  * @static
  * @param $idSite
  * @return array
  */
 public static function getQueryParametersToExclude($idSite)
 {
     $campaignTrackingParameters = Common::getCampaignParameters();
     $campaignTrackingParameters = array_merge($campaignTrackingParameters[0], $campaignTrackingParameters[1]);
     $website = Cache::getCacheWebsiteAttributes($idSite);
     $excludedParameters = self::getExcludedParametersFromWebsite($website);
     if (!empty($excludedParameters)) {
         Common::printDebug('Excluding parameters "' . implode(',', $excludedParameters) . '" from URL');
     }
     $parametersToExclude = array_merge($excludedParameters, self::$queryParametersToExclude, $campaignTrackingParameters);
     $parametersToExclude = array_map('strtolower', $parametersToExclude);
     return $parametersToExclude;
 }
All Usage Examples Of Piwik\Common::getCampaignParameters