From: garvinhicking <garvinhicking>
Date: Fri, 7 Jul 2006 10:46:50 +0000 (+0000)
Subject: Document BC break
X-Git-Url: http://git.mjollnir.org/gw?a=commitdiff_plain;h=ead5c3fe5d55ae0fff7050ce027a7424ead4567d;p=s9y.git

Document BC break
---

diff --git a/docs/NEWS b/docs/NEWS
index 6c3de92..fe2e2c3 100644
--- a/docs/NEWS
+++ b/docs/NEWS
@@ -3,6 +3,21 @@
 Version 1.1-alpha7()
 ------------------------------------------------------------------------
 
+    * BC-Break / Plugin API change: The serendipity_getTemplate() file
+      now no longer returns FALSE when a file is not found, but instead
+      the filename without a path. This is required so that the smarty-
+      created error message contains the missing filename instead of an
+      empty '' string.
+      Plugins based on this function need to make sure that they will
+      now properly use a file_exists() check on the returned function,
+      if they want to probe different locations of a file.
+      All template files containing the string "plugin" will still return
+      FALSE for the function call, to circumvent problems with spartacus
+      plugins.
+      Bottom line: Plugins that use "*plugin*.tpl" filenames or check
+      via file_exists() on the returned variable are safe.
+      (garvinhicking)
+      
     * Added arabic (sa) language by Way
 
     * Add patch to allow entryproperties plugin to define passwords for
diff --git a/include/plugin_api.inc.php b/include/plugin_api.inc.php
index b55889e..42a9a00 100644
--- a/include/plugin_api.inc.php
+++ b/include/plugin_api.inc.php
@@ -922,7 +922,6 @@ class serendipity_plugin_api {
         }
 
         $plugins = serendipity_plugin_api::enum_plugins('event');
-
         if (!is_array($plugins)) {
             return $false;
         }
diff --git a/serendipity_config.inc.php b/serendipity_config.inc.php
index 4b99b44..21e45f6 100644
--- a/serendipity_config.inc.php
+++ b/serendipity_config.inc.php
@@ -344,7 +344,6 @@ if (isset($_SESSION['serendipityUser'])) {
 if (isset($_SESSION['serendipityEmail'])) {
     $serendipity['email'] = $_SESSION['serendipityEmail'];
 }
-
 serendipity_plugin_api::hook_event('frontend_configure', $serendipity);
 
 /* vim: set sts=4 ts=4 expandtab : */