|
| 1 | +<?php |
| 2 | +/** |
| 3 | + * Piwik - free/libre analytics platform |
| 4 | + * |
| 5 | + * @link http://piwik.org |
| 6 | + * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later |
| 7 | + */ |
| 8 | + |
| 9 | +namespace Piwik\Plugins\TrackingCodeCustomizer; |
| 10 | + |
| 11 | +use Piwik\Piwik; |
| 12 | +use Piwik\Settings\Setting; |
| 13 | +use Piwik\Settings\FieldConfig; |
| 14 | + |
| 15 | +/** |
| 16 | + * Defines Settings for TrackingCodeCustomizer. |
| 17 | + * |
| 18 | + * Usage like this: |
| 19 | + * $settings = new SystemSettings(); |
| 20 | + * $settings->metric->getValue(); |
| 21 | + * $settings->description->getValue(); |
| 22 | + */ |
| 23 | +class SystemSettings extends \Piwik\Settings\Plugin\SystemSettings |
| 24 | +{ |
| 25 | + |
| 26 | + public $idSite; |
| 27 | + public $protocol; |
| 28 | + public $piwikUrl; |
| 29 | + public $httpsPiwikUrl; |
| 30 | + public $options; |
| 31 | + public $optionsBeforeTrackerUrl; |
| 32 | + |
| 33 | + const TEXTBOX_SETTINGS = array("size"=> 65); |
| 34 | + |
| 35 | + protected function init() |
| 36 | + { |
| 37 | + $this->idSite = $this->createIdSiteSetting(); |
| 38 | + $this->protocol = $this->createProtocolSetting(); |
| 39 | + $this->piwikUrl = $this->createInstallUrlSetting(); |
| 40 | + $this->httpsPiwikUrl = $this->createSecureInstallUrlSetting(); |
| 41 | + $this->options = $this->createOptionsSetting(); |
| 42 | + $this->optionsBeforeTrackerUrl = $this->createOptionsBeforeTrackerUrl(); |
| 43 | + } |
| 44 | + |
| 45 | + private function createIdSiteSetting(){ |
| 46 | + return $this->makeSetting('idSite', $default = "", FieldConfig::TYPE_STRING, function (FieldConfig $field) { |
| 47 | + $field->title = $this->t('idSiteSettingTitle'); |
| 48 | + $field->uiControl = FieldConfig::UI_CONTROL_TEXT; |
| 49 | + $field->uiControlAttributes = array("size" => "6", "maxlength" => "8"); |
| 50 | + $field->description = $this->t('TitleSettingDescription'); |
| 51 | + $field->inlineHelp = sprintf('<br/>Probably not useful in most scenarios. The idSite option is included for completeness.<br/><br/>Default: %s',$this->t('TitleSettingDefault')); |
| 52 | + $field->validate = function ($value, $setting) { |
| 53 | + if ($value != "" && preg_match("/^[0-9]+$/",$value) !== 1) { |
| 54 | + throw new \Exception('Value is invalid. Must be positive integer'); |
| 55 | + } |
| 56 | + }; |
| 57 | + |
| 58 | + }); |
| 59 | + } |
| 60 | + |
| 61 | + private function createProtocolSetting(){ |
| 62 | + return $this->makeSetting('protocol', $default = "", FieldConfig::TYPE_STRING, function (FieldConfig $field) { |
| 63 | + $field->title = $this->t('protocolSettingTitle'); |
| 64 | + $field->uiControl = FieldConfig::UI_CONTROL_TEXT; |
| 65 | + $field->uiControlAttributes = array("size" => "10", "maxlength" => "8"); |
| 66 | + $field->description = $this->t('protocolSettingDescription'); |
| 67 | + $field->inlineHelp = sprintf('<br/>http:// or https://<br/><br/>Default: %s',$this->t('protocolSettingDefault')); |
| 68 | + $field->validate = function ($value, $setting) { |
| 69 | + if ($value != "" && !($value == "http://" || $value == "https://")) { |
| 70 | + throw new \Exception('Value is invalid'); |
| 71 | + } |
| 72 | + }; |
| 73 | + }); |
| 74 | + } |
| 75 | + |
| 76 | + private function createInstallUrlSetting(){ |
| 77 | + return $this->makeSetting('piwikUrl', $default = "", FieldConfig::TYPE_STRING, function (FieldConfig $field) { |
| 78 | + $field->title = $this->t('piwikUrlSettingTitle'); |
| 79 | + $field->uiControl = FieldConfig::UI_CONTROL_TEXT; |
| 80 | + //$field->uiControlAttributes = array("size"=> 65); |
| 81 | + $field->description = $this->t('piwikUrlSettingDescription'); |
| 82 | + $field->inlineHelp = sprintf('<br/>tracker.example.com/piwik use hostname+basepath only (omit protocol and trailing slash)<br/><br/>Default: %s',$this->t('piwikUrlSettingDefault')); |
| 83 | + }); |
| 84 | + } |
| 85 | + |
| 86 | + private function createSecureInstallUrlSetting(){ |
| 87 | + return $this->makeSetting('httpsPiwikUrl', $default = "", FieldConfig::TYPE_STRING, function (FieldConfig $field) { |
| 88 | + $field->title = $this->t('httpsPiwikUrlSettingTitle'); |
| 89 | + $field->uiControl = FieldConfig::UI_CONTROL_TEXT; |
| 90 | + //$field->uiControlAttributes = array("size"=> 65); |
| 91 | + $field->description = $this->t('httpsPiwikUrlSettingDescription'); |
| 92 | + $field->inlineHelp = sprintf('<br/>secure-tracker.example.com/piwik use hostname+basepath only (omit protocol and trailing slash)<br/><br/>Default: %s',$this->t('httpsPiwikUrlSettingDefault')); |
| 93 | + |
| 94 | + }); |
| 95 | + } |
| 96 | + |
| 97 | + private function createOptionsSetting(){ |
| 98 | + return $this->makeSetting('options', $default = "", FieldConfig::TYPE_STRING, function (FieldConfig $field) { |
| 99 | + $field->title = $this->t('optionsSettingTitle'); |
| 100 | + $field->uiControl = FieldConfig::UI_CONTROL_TEXTAREA; |
| 101 | + //$field->uiControlAttributes = array("size"=> 65); |
| 102 | + $field->description = $this->t('optionsSettingDescription'); |
| 103 | + $field->inlineHelp = sprintf('<br/>{$original_paramname} and {$paramname} tokens are available for referencing values.<br/><br/>Default: %s',$this->t('optionsSettingDefault')); |
| 104 | + }); |
| 105 | + } |
| 106 | + |
| 107 | + private function createOptionsBeforeTrackerUrl(){ |
| 108 | + return $this->makeSetting('optionsBeforeTrackerUrl', $default = "", FieldConfig::TYPE_STRING, function (FieldConfig $field) { |
| 109 | + $field->title = $this->t('optionsBeforeTrackerUrlSettingTitle'); |
| 110 | + $field->uiControl = FieldConfig::UI_CONTROL_TEXTAREA; |
| 111 | + //$field->uiControlAttributes = array("size"=> 65); |
| 112 | + $field->description = $this->t('optionsBeforeTrackerUrlSettingDescription'); |
| 113 | + $field->inlineHelp = sprintf('<br/>{$original_paramname} and {$paramname} tokens are available for referencing values.<br/><br/>Default: %s',$this->t('optionsBeforeTrackerUrlSettingDefault')); |
| 114 | + }); |
| 115 | + } |
| 116 | + |
| 117 | + private function t($translate_token){ |
| 118 | + return Piwik::translate("TrackingCodeCustomizer_".$translate_token); |
| 119 | + } |
| 120 | +} |
0 commit comments