New init function for plugins, supports errors reporting

[github/shaarli/Shaarli.git] / plugins / readityourself / readityourself.php

diff --git a/plugins/readityourself/readityourself.php b/plugins/readityourself/readityourself.php
index 7bad906d6aac1b47d81e527d8194c09f7780dbe2..961c5bda0c2f79347e9e69e63d4eedfde776c6cb 100644 (file)
--- a/plugins/readityourself/readityourself.php
+++ b/plugins/readityourself/readityourself.php
@@ -1,33 +1,49 @@
 <?php
 
+/**
+ * Plugin readityourself
+ */
+
 // If we're talking about https://github.com/memiks/readityourself
 // it seems kinda dead.
 // Not tested.
 
-// don't raise unnecessary warnings
-if (is_file(PluginManager::$PLUGINS_PATH . '/readityourself/config.php')) {
-    include PluginManager::$PLUGINS_PATH . '/readityourself/config.php';
-}
-
-if (!isset($GLOBALS['plugins']['READITYOUSELF_URL'])) {
-    header('Content-Type: text/plain; charset=utf-8');
-    echo 'ReadItYourself plugin error: '. PHP_EOL;
-    echo '  Please copy "plugins/readityourself/config.php.dist" to config.php and configure your readityourself URL.'. PHP_EOL;
-    echo '  You can also define "$GLOBALS[\'plugins\'][\'READITYOUSELF_URL\']" in your global Shaarli config.php file.';
-    exit;
+/**
+ * Init function, return an error if the server is not set.
+ *
+ * @param $conf ConfigManager instance.
+ *
+ * @return array Eventual error.
+ */
+function readityourself_init($conf)
+{
+    $riyUrl = $conf->get('plugins.READITYOUSELF_URL');
+    if (empty($riyUrl)) {
+        $error = 'Readityourself plugin error: '.
+            'Please define the "READITYOUSELF_URL" setting in the plugin administration page.';
+        return array($error);
+    }
 }
 
 /**
  * Add readityourself icon to link_plugin when rendering linklist.
  *
- * @param $data - linklist data.
+ * @param mixed         $data Linklist data.
+ * @param ConfigManager $conf Configuration Manager instance.
+ *
  * @return mixed - linklist data with readityourself plugin.
  */
-function hook_readityourself_render_linklist($data) {
+function hook_readityourself_render_linklist($data, $conf)
+{
+    $riyUrl = $conf->get('plugins.READITYOUSELF_URL');
+    if (empty($riyUrl)) {
+        return $data;
+    }
+
     $readityourself_html = file_get_contents(PluginManager::$PLUGINS_PATH . '/readityourself/readityourself.html');
 
     foreach ($data['links'] as &$value) {
-        $readityourself = sprintf($readityourself_html, $GLOBALS['plugins']['READITYOUSELF_URL'], $value['url'], PluginManager::$PLUGINS_PATH);
+        $readityourself = sprintf($readityourself_html, $riyUrl, $value['url'], PluginManager::$PLUGINS_PATH);
         $value['link_plugin'][] = $readityourself;
     }