Thread: [Gemstracker-svn] SF.net SVN: gemstracker:[762] trunk/library/classes/MUtil

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 422-6466

Revision: 762
          http://gemstracker.svn.sourceforge.net/gemstracker/?rev=762&view=rev
Author:   mennodekker
Date:     2012-06-14 13:56:33 +0000 (Thu, 14 Jun 2012)
Log Message:
-----------
Allow different SnippetLoaders to be used, that only implement the interface instead of extending the base class

Modified Paths:
--------------
    trunk/library/classes/MUtil/Html.php
    trunk/library/classes/MUtil/Snippets/SnippetLoader.php

Added Paths:
-----------
    trunk/library/classes/MUtil/Snippets/SnippetLoaderInterface.php

Modified: trunk/library/classes/MUtil/Html.php
===================================================================

--- trunk/library/classes/MUtil/Html.php	2012-06-14 13:06:26 UTC (rev 761)
+++ trunk/library/classes/MUtil/Html.php	2012-06-14 13:56:33 UTC (rev 762)
@@ -282,10 +282,10 @@
     /**
      * Set the snippet loader for use by self::snippet().
      *
-     * @param MUtil_Snippets_SnippetLoader $snippetLoader
+     * @param MUtil_Snippets_SnippetLoaderInterface $snippetLoader
      * @return MUtil_Snippets_SnippetLoader
      */
-    public static function setSnippetLoader(MUtil_Snippets_SnippetLoader $snippetLoader)
+    public static function setSnippetLoader(MUtil_Snippets_SnippetLoaderInterface $snippetLoader)
     {
         self::$_snippetLoader = $snippetLoader;
         return self::$_snippetLoader;

Modified: trunk/library/classes/MUtil/Snippets/SnippetLoader.php
===================================================================
--- trunk/library/classes/MUtil/Snippets/SnippetLoader.php	2012-06-14 13:06:26 UTC (rev 761)
+++ trunk/library/classes/MUtil/Snippets/SnippetLoader.php	2012-06-14 13:56:33 UTC (rev 762)
@@ -45,7 +45,7 @@
  * @license    New BSD License
  * @since      Class available since version 1.4
  */
-class MUtil_Snippets_SnippetLoader
+class MUtil_Snippets_SnippetLoader implements MUtil_Snippets_SnippetLoaderInterface
 {
     /**
      * The file locations where to look for snippets.
@@ -83,7 +83,7 @@
      * @param string $dir
      * @return MUtil_Snippets_SnippetLoader
      */
-    public function addDirectory($dir, $loadDefaults = true)
+    public function addDirectory($dir)
     {
         if (! in_array($dir, $this->snippetsDirectories)) {
             if (file_exists($dir)) {

Added: trunk/library/classes/MUtil/Snippets/SnippetLoaderInterface.php
===================================================================
--- trunk/library/classes/MUtil/Snippets/SnippetLoaderInterface.php	                        (rev 0)
+++ trunk/library/classes/MUtil/Snippets/SnippetLoaderInterface.php	2012-06-14 13:56:33 UTC (rev 762)
@@ -0,0 +1,108 @@
+<?php
+/**
+ * Copyright (c) 2011, Erasmus MC
+ * All rights reserved.
+ * 
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *    * Redistributions of source code must retain the above copyright
+ *      notice, this list of conditions and the following disclaimer.
+ *    * Redistributions in binary form must reproduce the above copyright
+ *      notice, this list of conditions and the following disclaimer in the
+ *      documentation and/or other materials provided with the distribution.
+ *    * Neither the name of Erasmus MC nor the
+ *      names of its contributors may be used to endorse or promote products
+ *      derived from this software without specific prior written permission.
+ *      
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * @package    MUtil
+ * @subpackage Snippets
+ * @copyright  Copyright (c) 2011 Erasmus MC
+ * @license    New BSD License
+ * @version    $Id: Sample.php 215 2011-07-12 08:52:54Z michiel $
+ */
+
+/**
+ * Handles loading of snippets
+ *
+ * @package    MUtil
+ * @subpackage Snippets
+ * @copyright  Copyright (c) 2011 Erasmus MC
+ * @license    New BSD License
+ * @since      Class available since version 1.5.5
+ */
+interface MUtil_Snippets_SnippetLoaderInterface
+{
+    /**
+     * Sets the source of variables and the first directory for snippets
+     *
+     * @param mixed $source Something that is or can be made into MUtil_Registry_SourceInterface, otheriwse Zend_Registry is used.
+     */
+    public function __construct($source = null);
+
+    /**
+     * Add a directory to the front of the list of places where snippets are loaded from.
+     *
+     * @param string $dir
+     * @return MUtil_Snippets_SnippetLoaderInterface
+     */
+    public function addDirectory($dir);
+
+    /**
+     * Add parameter values to the source for snippets.
+     *
+     * @param mixed $container_or_pairs This function can be called with either a single container or a list of name/value pairs.
+     * @return MUtil_Snippets_SnippetLoaderInterface
+     */
+    public function addSource($container_or_pairs);
+
+    /**
+     * Returns the directories where snippets are loaded from.
+     *
+     * @param array $dirs
+     * @return array
+     */
+    public function getDirectories();
+
+    /**
+     * Searches and loads a .php snippet file.
+     *
+     * @param string $filename The name of the snippet
+     * @param array $extraSourceParameters name/value pairs to add to the source for this snippet
+     * @return MUtil_Snippets_SnippetInterface The snippet
+     */
+    public function getSnippet($filename, array $extraSourceParameters = null);
+
+    /**
+     * Returns a source of values for snippets.
+     *
+     * @return MUtil_Registry_SourceInterface
+     */
+    public function getSource();
+
+    /**
+     * Set the directories where snippets are loaded from.
+     *
+     * @param array $dirs
+     * @return MUtil_Snippets_SnippetLoaderInterface (continuation pattern)
+     */
+    public function setDirectories(array $dirs);
+
+    /**
+     * Sets the source of variables for snippets
+     *
+     * @param MUtil_Registry_SourceInterface $source
+     * @return MUtil_Snippets_SnippetLoaderInterface (continuation pattern)
+     */
+    public function setSource(MUtil_Registry_SourceInterface $source);
+}
\ No newline at end of file

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.





Thread: [Gemstracker-svn] SF.net SVN: gemstracker:[762] trunk/library/classes/MUtil

gemstracker-svn