updated for Matomo 5

.gitignore

@@ -0,0 +1 @@
+vendor

API.php

@@ -4,12 +4,11 @@
 
 class API extends \Piwik\Plugin\API
 {
-
     private static $plugin_name = 'AdminNotification';
-    
+
     public function isEnabled()
     {
-        $settings = new Settings(self::$plugin_name);
+        $settings = new SystemSettings();
         $enabled  = $settings->enabled->getValue();
         $message  = $this->getMessage();
 
@@ -19,19 +18,22 @@ public function isEnabled()
 
         return false;
     }
-
-    public function getContext(){
-        $settings = new Settings(self::$plugin_name);
+
+    public function getContext()
+    {
+        $settings = new SystemSettings();
         return $settings->context->getValue();
     }
-
-    public function getTitle(){
-        $settings = new Settings(self::$plugin_name);
+
+    public function getTitle()
+    {
+        $settings = new SystemSettings();
         return $settings->title->getValue();
     }
-
-    public function getMessage(){
-        $settings = new Settings(self::$plugin_name);
+
+    public function getMessage()
+    {
+        $settings = new SystemSettings();
         return $settings->message->getValue();
     }
-}
+}

AdminNotification.php

@@ -6,52 +6,53 @@
 use Piwik\Notification;
 
 /**
- */ 
+ */
 class AdminNotification extends \Piwik\Plugin
 {
     private static $hooks = array(
             'Login.authenticate.successful' => 'setNotificationV3', //Version 3.X Post login handler
             'SystemSettings.updated' => 'settingsChangedV3' //Version 3.X Setting updated handler
     );
-    
+
     public function registerEvents()
     {
         return self::$hooks;
     }
-
-    public function settingsChangedV3($settings){        
-        if($settings->getPluginName() === 'AdminNotification'){
+
+    public function settingsChangedV3($settings)
+    {
+        if ($settings->getPluginName() === 'AdminNotification') {
             $this->setNotificationV3();
         }
     }
-
-    public function setNotificationV3(){
-            //Known issue. The alert notification is not updated until login/logout on v3.x.        
-
-            //2.X Compatibility. This method appears to be getting called in v2.X which I didn't believe would trigger the newer hooks.
-            if(!class_exists('\Piwik\Settings\Plugin\SystemSettings')){ //If class doesn't exist just get out.
-             return;
-            }
-
+
+    public function setNotificationV3()
+    {
+            // Known issue. The alert notification is not updated until login/logout on v3.x.
+
+            // 2.X Compatibility. This method appears to be getting called in v2.X which I didn't
+            // believe would trigger the newer hooks.
+        if (!class_exists('\Piwik\Settings\Plugin\SystemSettings')) { //If class doesn't exist just get out.
+            return;
+        }
+
             $settings = new SystemSettings();
             //print_r($settings->enabled->getValue());
-
-            if($settings->enabled->getValue()){
-
-                $notification = new Notification($settings->message->getValue());
-                $notification->title = $settings->messageTitle->getValue();
-                $notification->context = $settings->context->getValue();
-                $notification->type = Notification::TYPE_PERSISTENT;
-                //$notification->priority = Notification::PRIORITY_MAX;
-
-                //echo "NOTIFY";
-                //print_r($notification);
-
-                Notification\Manager::notify('AdminNotification_notice', $notification);
-
-            }else{
-                //echo "NOTIFY CANCEL";
-                Notification\Manager::cancel('AdminNotification_notice');
-            }
+
+        if ($settings->enabled->getValue()) {
+            $notification = new Notification($settings->message->getValue());
+            $notification->title = $settings->messageTitle->getValue();
+            $notification->context = $settings->context->getValue();
+            $notification->type = Notification::TYPE_PERSISTENT;
+            //$notification->priority = Notification::PRIORITY_MAX;
+
+            //echo "NOTIFY";
+            //print_r($notification);
+
+            Notification\Manager::notify('AdminNotification_notice', $notification);
+        } else {
+            //echo "NOTIFY CANCEL";
+            Notification\Manager::cancel('AdminNotification_notice');
+        }
     }
 }

README.md

@@ -1,21 +1,29 @@
-# Piwik AdminNotification Plugin
+# Matomo AdminNotification Plugin
+
 ## Description
-Adds the ability for Piwik administrators to include an informative message on all users' dashboards. This may be useful for communicating with users in larger shared environments. In our setup we were tracking 1,900 websites with 250 users. This is a solution we wrote to allow us to easily inform our users of maintenance windows.
+
+Adds the ability for Matomo administrators to include an informative message on all users' dashboards. This may be useful for communicating with users in larger shared environments. In our setup we were tracking 1,900 websites with 250 users. This is a solution we wrote to allow us to easily inform our users of maintenance windows.
 
 ## Instructions
-The easiest way to install is to find the plugin in the [Piwik Marketplace](http://plugins.piwik.org/).
+
+The easiest way to install is to find the plugin in the [Matomo Marketplace](http://plugins.matomo.org/).
 
 ## Changelog
+
+* 5.0.0 Matomo v5 compatible, not backwards compatible.
 * 3.0.0 Piwik v3 compatible. Effort was made to maintain backwards compatibility. This should work all the way back to 2.12.x
 * 0.1.2 Tested with Piwik v2.15 and included new registerEvents() hook for compatibility with Piwik 3.0
 * 0.1.1 Cleanup. Removed plugin template verbiage from code files.
 * 0.1.0 Initial Release
 
 ## Known Issues
+
 * v3.0.0 Display/Update of notification requires logout/login to see change. (Notification API not working as expected during tests)
 
 ## License
+
 GPL v3 / fair use
 
 ## Support
-Please [report any issues](https://github.com/jbrule/piwikplugin-AdminNotification/issues). Pull requests welcome.
+
+Please [report any issues](https://github.com/jbrule/Matomoplugin-AdminNotification/issues). Pull requests welcome.

SystemSettings.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Piwik - free/libre analytics platform
  *
@@ -28,7 +29,7 @@ class SystemSettings extends \Piwik\Settings\Plugin\SystemSettings
 
     /** @var Setting */
     public $context;
-    
+
     /** @var Setting */
     public $messageTitle;
 
@@ -41,13 +42,12 @@ protected function init()
         $this->enabled = $this->createEnabledSetting();
 
         $this->context = $this->createContextSetting();
-        
+
         $this->messageTitle = $this->createTitleSetting();
 
         $this->message = $this->createMessageSetting();
-
     }
-    
+
     private function createEnabledSetting()
     {
         return $this->makeSetting('enabled', $default = false, FieldConfig::TYPE_BOOL, function (FieldConfig $field) {
@@ -57,32 +57,42 @@ private function createEnabledSetting()
             $field->readableByCurrentUser = true;
         });
     }
-    
+
     private function createContextSetting()
     {
-        return $this->makeSetting('context', $default = "info", FieldConfig::TYPE_STRING, function (FieldConfig $field) {
-            $field->title = $this->t('ContextSettingTitle');
-            $field->condition = 'enabled';
-            $field->uiControl = FieldConfig::UI_CONTROL_SINGLE_SELECT;
-            $field->description = $this->t('ContextSettingDescription');
-            $field->availableValues = array(Notification::CONTEXT_INFO => Notification::CONTEXT_INFO,
+        return $this->makeSetting(
+            'context',
+            $default = "info",
+            FieldConfig::TYPE_STRING,
+            function (FieldConfig $field) {
+                $field->title = $this->t('ContextSettingTitle');
+                $field->condition = 'enabled';
+                $field->uiControl = FieldConfig::UI_CONTROL_SINGLE_SELECT;
+                $field->description = $this->t('ContextSettingDescription');
+                $field->availableValues = array(Notification::CONTEXT_INFO => Notification::CONTEXT_INFO,
                                                  Notification::CONTEXT_ERROR => Notification::CONTEXT_ERROR,
                                                  Notification::CONTEXT_SUCCESS => Notification::CONTEXT_SUCCESS,
                                                  Notification::CONTEXT_WARNING => Notification::CONTEXT_WARNING);
-        });
+            }
+        );
     }
-    
+
     private function createTitleSetting()
     {
-        return $this->makeSetting('title', $default = "Message from Piwik Administrator", FieldConfig::TYPE_STRING, function (FieldConfig $field) {
-            $field->title = $this->t('TitleSettingTitle');
-            $field->condition = 'enabled';
-            $field->uiControl = FieldConfig::UI_CONTROL_TEXT;
+        return $this->makeSetting(
+            'title',
+            $default = "Message from Piwik Administrator",
+            FieldConfig::TYPE_STRING,
+            function (FieldConfig $field) {
+                $field->title = $this->t('TitleSettingTitle');
+                $field->condition = 'enabled';
+                $field->uiControl = FieldConfig::UI_CONTROL_TEXT;
             //$field->uiControlAttributes = array("size"=> 65);
-            $field->description = $this->t('TitleSettingDescription');
-        });
+                $field->description = $this->t('TitleSettingDescription');
+            }
+        );
     }
-    
+
     private function createMessageSetting()
     {
         return $this->makeSetting('message', $default = "", FieldConfig::TYPE_STRING, function (FieldConfig $field) {
@@ -92,8 +102,9 @@ private function createMessageSetting()
             $field->description = $this->t('MessageSettingDescription');
         });
     }
-
-    private function t($translate_token){
-        return Piwik::translate("AdminNotification_".$translate_token);
+
+    private function t($translate_token)
+    {
+        return Piwik::translate("AdminNotification_" . $translate_token);
     }
 }