]> git.immae.eu Git - github/shaarli/Shaarli.git/commitdiff
Merge pull request #619 from ArthurHoaro/plugins/param-desc
authorVirtualTam <virtualtam@flibidi.net>
Sat, 13 Aug 2016 12:48:51 +0000 (14:48 +0200)
committerGitHub <noreply@github.com>
Sat, 13 Aug 2016 12:48:51 +0000 (14:48 +0200)
Add a description to plugin parameters

1  2 
application/PluginManager.php
tests/PluginManagerTest.php

index 1afc8d5c15da095952c472a1ee42c807792a7f68,07bc1da929416ff297da098461e07231763940ab..1e132a7f652c78aa077a86ed3c1013ad58b7c95b
@@@ -185,7 -185,11 +185,11 @@@ class PluginManage
                      continue;
                  }
  
-                 $metaData[$plugin]['parameters'][$param] = '';
+                 $metaData[$plugin]['parameters'][$param]['value'] = '';
+                 // Optional parameter description in parameter.PARAM_NAME=
+                 if (isset($metaData[$plugin]['parameter.'. $param])) {
+                     $metaData[$plugin]['parameters'][$param]['desc'] = $metaData[$plugin]['parameter.'. $param];
+                 }
              }
          }
  
@@@ -210,4 -214,4 +214,4 @@@ class PluginFileNotFoundException exten
      {
          $this->message = 'Plugin "'. $pluginName .'" files not found.';
      }
 -}
 +}
index c751105132f80ea1cd233525fdc1e6c18fd7b260,f4826e2e371d7050279de37d844140e38ae9d603..ddf4818533a1777f422421feb29b44e7243a7afa
@@@ -79,11 -79,17 +79,17 @@@ class PluginManagerTest extends PHPUnit
          $this->pluginManager->load(array(self::$pluginName));
  
          $expectedParameters = array(
-             'pop' => '',
-             'hip' => '',
+             'pop' => array(
+                 'value' => '',
+                 'desc'  => 'pop description',
+             ),
+             'hip' => array(
+                 'value' => '',
+                 'desc' => '',
+             ),
          );
          $meta = $this->pluginManager->getPluginsMeta();
          $this->assertEquals('test plugin', $meta[self::$pluginName]['description']);
          $this->assertEquals($expectedParameters, $meta[self::$pluginName]['parameters']);
      }
 -}
 +}