| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168 |
- <?xml version="1.0" encoding="iso-8859-1"?>
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <!-- template designed by Marco Von Ballmoos -->
- <title>File Source for plugins.php</title>
- <link rel="stylesheet" href="../media/stylesheet.css" />
- </head>
- <body>
-
<h1>Source for file plugins.php</h1>
- <p>Documentation is available at <a href="../sloodle/_lib---plugins.php.html">plugins.php</a></p>
- <div class="src-code">
- <div class="src-code"><ol><li><div class="src-line"><a name="a1"></a><span class="src-php"><?php</span></div></li>
- <li><div class="src-line"><a name="a2"></a><span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a3"></a><span class="src-doc">* Defines a library class for managing SLOODLE Plugins.</span></div></li>
- <li><div class="src-line"><a name="a4"></a><span class="src-doc">* It is constructed and used through a SloodleSession object.</span></div></li>
- <li><div class="src-line"><a name="a5"></a><span class="src-doc">*</span></div></li>
- <li><div class="src-line"><a name="a6"></a><span class="src-doc">* </span><span class="src-doc-coretag">@package</span><span class="src-doc"> sloodle</span></div></li>
- <li><div class="src-line"><a name="a7"></a><span class="src-doc">* </span><span class="src-doc-coretag">@copyright</span><span class="src-doc"> Copyright (c) 2009 Sloodle (various contributors)</span></div></li>
- <li><div class="src-line"><a name="a8"></a><span class="src-doc">* </span><span class="src-doc-coretag">@license</span><span class="src-doc"> http://www.gnu.org/licenses/gpl-3.0.html GNU GPL v3</span></div></li>
- <li><div class="src-line"><a name="a9"></a><span class="src-doc">*</span></div></li>
- <li><div class="src-line"><a name="a10"></a><span class="src-doc">* </span><span class="src-doc-tag">@contributor</span><span class="src-doc"> Peter R. Bloomfield</span></div></li>
- <li><div class="src-line"><a name="a11"></a><span class="src-doc">*/</span></div></li>
- <li><div class="src-line"><a name="a12"></a> </div></li>
- <li><div class="src-line"><a name="a13"></a> </div></li>
- <li><div class="src-line"><a name="a14"></a><span class="src-comm">// This library expects that the Sloodle config file has already been included</span></div></li>
- <li><div class="src-line"><a name="a15"></a><span class="src-comm">// (along with the Moodle libraries)</span></div></li>
- <li><div class="src-line"><a name="a16"></a> </div></li>
- <li><div class="src-line"><a name="a17"></a><span class="src-doc">/** Include the general Sloodle functionality. */</span></div></li>
- <li><div class="src-line"><a name="a18"></a><span class="src-inc">require_once</span><span class="src-sym">(</span><span class="src-id">SLOODLE_DIRROOT</span>.<span class="src-str">'/lib/general.php'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a19"></a> </div></li>
- <li><div class="src-line"><a name="a20"></a> </div></li>
- <li><div class="src-line"><a name="a21"></a><span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a22"></a><span class="src-doc">* A class to load SLOODLE plugins, and provide a means to access them.</span></div></li>
- <li><div class="src-line"><a name="a23"></a><span class="src-doc">* </span><span class="src-doc-coretag">@package</span><span class="src-doc"> sloodle</span></div></li>
- <li><div class="src-line"><a name="a24"></a><span class="src-doc">*/</span></div></li>
- <li><div class="src-line"><a name="a25"></a><span class="src-key">class </span><a href="../sloodle/SloodlePluginManager.html">SloodlePluginManager</a></div></li>
- <li><div class="src-line"><a name="a26"></a><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a27"></a><span class="src-comm">// DATA //</span></div></li>
- <li><div class="src-line"><a name="a28"></a> </div></li>
- <li><div class="src-line"><a name="a29"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a30"></a><span class="src-doc"> * Internal only - reference to the containing </span><span class="src-doc-inlinetag">{@link SloodleSession}</span><span class="src-doc"> object.</span></div></li>
- <li><div class="src-line"><a name="a31"></a><span class="src-doc"> * Note: always check that it is not null before use!</span></div></li>
- <li><div class="src-line"><a name="a32"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@var </span><span class="src-doc-type">object </span></div></li>
- <li><div class="src-line"><a name="a33"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@access</span><span class="src-doc"> protected</span></div></li>
- <li><div class="src-line"><a name="a34"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a35"></a> <span class="src-key">var </span><a href="../sloodle/SloodlePluginManager.html#var$_session">$_session</a> = <span class="src-id">null</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a36"></a> </div></li>
- <li><div class="src-line"><a name="a37"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a38"></a><span class="src-doc"> * Plugin instance cache.</span></div></li>
- <li><div class="src-line"><a name="a39"></a><span class="src-doc"> * Stores the plugins which have already been created, to prevent new ones being instantiated unnecessarily.</span></div></li>
- <li><div class="src-line"><a name="a40"></a><span class="src-doc"> * Is an associative array of plugin names to plugin objects.</span></div></li>
- <li><div class="src-line"><a name="a41"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@var </span><span class="src-doc-type">array </span></div></li>
- <li><div class="src-line"><a name="a42"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@access</span><span class="src-doc"> protected</span></div></li>
- <li><div class="src-line"><a name="a43"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a44"></a> <span class="src-key">var </span><a href="../sloodle/SloodlePluginManager.html#var$plugin_cache">$plugin_cache</a> = <span class="src-key">array</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a45"></a> </div></li>
- <li><div class="src-line"><a name="a46"></a> </div></li>
- <li><div class="src-line"><a name="a47"></a><span class="src-comm">// FUNCTIONS //</span></div></li>
- <li><div class="src-line"><a name="a48"></a> </div></li>
- <li><div class="src-line"><a name="a49"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a50"></a><span class="src-doc"> * Class constructor.</span></div></li>
- <li><div class="src-line"><a name="a51"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">object </span><span class="src-doc-var">&$_session </span><span class="src-doc">Reference to the containing </span><span class="src-doc-inlinetag">{@link SloodleSession}</span><span class="src-doc"> object, if available.</span></div></li>
- <li><div class="src-line"><a name="a52"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@access</span><span class="src-doc"> public</span></div></li>
- <li><div class="src-line"><a name="a53"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a54"></a> <span class="src-key">function </span><a href="../sloodle/SloodlePluginManager.html#methodSloodlePluginManager">SloodlePluginManager</a><span class="src-sym">(</span><span class="src-sym">&</span><span class="src-var">$_session</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a55"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a56"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><a href="http://www.php.net/is_null">is_null</a><span class="src-sym">(</span><span class="src-var">$_session</span><span class="src-sym">)) </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodlePluginManager.html#var$_session">_session</a> = <span class="src-sym">&</span><span class="src-var">$_session</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a57"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a58"></a> </div></li>
- <li><div class="src-line"><a name="a59"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a60"></a><span class="src-doc"> * Loads all available plugins from the specified folder.</span></div></li>
- <li><div class="src-line"><a name="a61"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$folder </span><span class="src-doc">Name of the folder to load plugins from. This is a sub-folder of the 'sloodle/plugin' folder. It will only load files which are directly contained inside it.</span></div></li>
- <li><div class="src-line"><a name="a62"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">bool </span><span class="src-doc">True if successful, or false if it fails. (It will only report failure if the folder does not exist, or there is an error accessing it.)</span></div></li>
- <li><div class="src-line"><a name="a63"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a64"></a> <span class="src-key">function </span><a href="../sloodle/SloodlePluginManager.html#methodload_plugins">load_plugins</a><span class="src-sym">(</span><span class="src-var">$folder</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a65"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a66"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-key">empty</span><span class="src-sym">(</span><span class="src-var">$folder</span><span class="src-sym">)) </span><span class="src-key">return </span><span class="src-id">false</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a67"></a> </div></li>
- <li><div class="src-line"><a name="a68"></a> <span class="src-comm">// Get a list of all the files in the specified folder</span></div></li>
- <li><div class="src-line"><a name="a69"></a> <span class="src-var">$pluginFolder </span>= <span class="src-id"><a href="../sloodle/_sl_config.php.html#defineSLOODLE_DIRROOT">SLOODLE_DIRROOT</a></span>.<span class="src-str">'/plugin/'</span>.<span class="src-var">$folder</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a70"></a> <span class="src-var">$files </span>= <a href="../sloodle/_lib---general.php.html#functionsloodle_get_files">sloodle_get_files</a><span class="src-sym">(</span><span class="src-var">$pluginFolder</span><span class="src-sym">, </span><span class="src-id">true</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a71"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-var">$files</span><span class="src-sym">) </span><span class="src-key">return </span><span class="src-id">false</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a72"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/count">count</a><span class="src-sym">(</span><span class="src-var">$files</span><span class="src-sym">) </span>== <span class="src-num">0</span><span class="src-sym">) </span><span class="src-key">return </span><span class="src-id">true</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a73"></a> </div></li>
- <li><div class="src-line"><a name="a74"></a> <span class="src-comm">// Start by including the relevant base class files, if they are available</span></div></li>
- <li><div class="src-line"><a name="a75"></a> <span class="src-sym">@</span><span class="src-inc">include_once</span><span class="src-sym">(</span><span class="src-id"><a href="../sloodle/_sl_config.php.html#defineSLOODLE_DIRROOT">SLOODLE_DIRROOT</a></span>.<span class="src-str">'/plugin/_base.php'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a76"></a> <span class="src-sym">@</span><span class="src-inc">include_once</span><span class="src-sym">(</span><span class="src-var">$pluginFolder</span>.<span class="src-str">'/_base.php'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a77"></a> </div></li>
- <li><div class="src-line"><a name="a78"></a> <span class="src-comm">// Go through each filename</span></div></li>
- <li><div class="src-line"><a name="a79"></a> <span class="src-key">foreach </span><span class="src-sym">(</span><span class="src-var">$files </span><span class="src-key">as </span><span class="src-var">$file</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a80"></a> <span class="src-comm">// Include the specified file</span></div></li>
- <li><div class="src-line"><a name="a81"></a> <span class="src-inc">include_once</span><span class="src-sym">(</span><span class="src-var">$pluginFolder</span>.<span class="src-str">'/'</span>.<span class="src-var">$file</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a82"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a83"></a> </div></li>
- <li><div class="src-line"><a name="a84"></a> <span class="src-key">return </span><span class="src-id">true</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a85"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a86"></a> </div></li>
- <li><div class="src-line"><a name="a87"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a88"></a><span class="src-doc"> * Gets an array of the names of all SLOODLE plugins derived from the specified type.</span></div></li>
- <li><div class="src-line"><a name="a89"></a><span class="src-doc"> * By default, this gets all plugins. Specify a different base class to get others.</span></div></li>
- <li><div class="src-line"><a name="a90"></a><span class="src-doc"> * NOTE: this will search all plugins loaded by all plugin managers in the current PHP script.</span></div></li>
- <li><div class="src-line"><a name="a91"></a><span class="src-doc"> * (There is no way to tell which manager loaded which plugins.)</span></div></li>
- <li><div class="src-line"><a name="a92"></a><span class="src-doc"> * Plugin names correspond to class names, with the 'SloodlePlugin' prefix.</span></div></li>
- <li><div class="src-line"><a name="a93"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$type </span><span class="src-doc">Name of a plugin base class.</span></div></li>
- <li><div class="src-line"><a name="a94"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">array </span><span class="src-doc">Numeric array of plugin names. These names correspond to class names.</span></div></li>
- <li><div class="src-line"><a name="a95"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a96"></a> <span class="src-key">function </span><a href="../sloodle/SloodlePluginManager.html#methodget_plugin_names">get_plugin_names</a><span class="src-sym">(</span><span class="src-var">$type </span>= <span class="src-str">'SloodlePluginBase'</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a97"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a98"></a> <span class="src-comm">// We want to create an array of plugin names</span></div></li>
- <li><div class="src-line"><a name="a99"></a> <span class="src-var">$plugins </span>= <span class="src-key">array</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a100"></a> </div></li>
- <li><div class="src-line"><a name="a101"></a> <span class="src-comm">// Go through all declared classes</span></div></li>
- <li><div class="src-line"><a name="a102"></a> <span class="src-var">$classes </span>= <a href="http://www.php.net/get_declared_classes">get_declared_classes</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a103"></a> <span class="src-key">foreach </span><span class="src-sym">(</span><span class="src-var">$classes </span><span class="src-key">as </span><span class="src-var">$className</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a104"></a> <span class="src-comm">// Make sure this is a SLOODLE plugin by checking that it starts "SloodlePlugin" but not "SloodlePluginbase"</span></div></li>
- <li><div class="src-line"><a name="a105"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/strpos">strpos</a><span class="src-sym">(</span><span class="src-var">$className</span><span class="src-sym">, </span><span class="src-str">'SloodlePlugin'</span><span class="src-sym">) </span>!== <span class="src-num">0 </span>|| <a href="http://www.php.net/strpos">strpos</a><span class="src-sym">(</span><span class="src-var">$className</span><span class="src-sym">, </span><span class="src-str">'SloodlePluginBase'</span><span class="src-sym">) </span>=== <span class="src-num">0</span><span class="src-sym">) </span><span class="src-key">continue</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a106"></a> <span class="src-comm">// Make sure this is not one of the supporting classes</span></div></li>
- <li><div class="src-line"><a name="a107"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$className </span>== <span class="src-str">'SloodlePluginBase' </span>|| <span class="src-var">$className </span>== <span class="src-str">'SloodlePluginManager'</span><span class="src-sym">) </span><span class="src-key">continue</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a108"></a> </div></li>
- <li><div class="src-line"><a name="a109"></a> <span class="src-comm">// Make sure it is in fact a plugin by ensuring it is appropriately derived from the given base plugin class</span></div></li>
- <li><div class="src-line"><a name="a110"></a> <span class="src-var">$tempPlugin </span>= <span class="src-sym">@</span><span class="src-key">new </span><span class="src-var">$className</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a111"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><a href="http://www.php.net/is_subclass_of">is_subclass_of</a><span class="src-sym">(</span><span class="src-var">$tempPlugin</span><span class="src-sym">, </span><span class="src-var">$type</span><span class="src-sym">)) </span><span class="src-key">continue</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a112"></a> </div></li>
- <li><div class="src-line"><a name="a113"></a> <span class="src-comm">// Remove the 'SloodlePlugin' prefix from the class name</span></div></li>
- <li><div class="src-line"><a name="a114"></a> <span class="src-var">$className </span>= <a href="http://www.php.net/substr">substr</a><span class="src-sym">(</span><span class="src-var">$className</span><span class="src-sym">, </span><span class="src-num">13</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a115"></a> <span class="src-var">$plugins</span><span class="src-sym">[</span><span class="src-sym">] </span>= <span class="src-var">$className</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a116"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a117"></a> </div></li>
- <li><div class="src-line"><a name="a118"></a> <span class="src-key">return </span><span class="src-var">$plugins</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a119"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a120"></a> </div></li>
- <li><div class="src-line"><a name="a121"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a122"></a><span class="src-doc"> * Gets an instance of the specified plugin type.</span></div></li>
- <li><div class="src-line"><a name="a123"></a><span class="src-doc"> * This only works if the plugin has been loaded, and if it is derived from SloodlePluginBase.</span></div></li>
- <li><div class="src-line"><a name="a124"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$name </span><span class="src-doc">Name of the plugin type to get. If it does not start with "SloodlePlugin", then that is added to the start.</span></div></li>
- <li><div class="src-line"><a name="a125"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">bool </span><span class="src-doc-var">$forcenew </span><span class="src-doc">If false (default) then a cached instance of the plugin will be returned. Set this to true to force the manager to create a new plugin instance.</span></div></li>
- <li><div class="src-line"><a name="a126"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">object</span><span class="src-doc">|</span><span class="src-doc-type">bool</span><span class="src-doc">An object descended from SloodlePluginBase if successful, or false on failure.</span></div></li>
- <li><div class="src-line"><a name="a127"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a128"></a> <span class="src-key">function </span><a href="../sloodle/SloodlePluginManager.html#methodget_plugin">get_plugin</a><span class="src-sym">(</span><span class="src-var">$name</span><span class="src-sym">, </span><span class="src-var">$forcenew </span>= <span class="src-id">false</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a129"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a130"></a> <span class="src-comm">// Prepend 'SloodlePlugin' if necessary</span></div></li>
- <li><div class="src-line"><a name="a131"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/strpos">strpos</a><span class="src-sym">(</span><span class="src-var">$name</span><span class="src-sym">, </span><span class="src-str">'SloodlePlugin'</span><span class="src-sym">) </span>!== <span class="src-num">0</span><span class="src-sym">) </span><span class="src-var">$name </span>= <span class="src-str">'SloodlePlugin'</span>.<span class="src-var">$name</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a132"></a> <span class="src-comm">// Make sure the specified class exists</span></div></li>
- <li><div class="src-line"><a name="a133"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><a href="http://www.php.net/class_exists">class_exists</a><span class="src-sym">(</span><span class="src-var">$name</span><span class="src-sym">)) </span><span class="src-key">return </span><span class="src-id">false</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a134"></a> <span class="src-comm">// Do we have a cached plugin of this type?</span></div></li>
- <li><div class="src-line"><a name="a135"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$forcenew </span>== <span class="src-id">false </span>&& <span class="src-sym">!</span><span class="src-key">empty</span><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodlePluginManager.html#var$plugin_cache">plugin_cache</a><span class="src-sym">[</span><span class="src-var">$name</span><span class="src-sym">]</span><span class="src-sym">) </span>&& <a href="http://www.php.net/is_a">is_a</a><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodlePluginManager.html#var$plugin_cache">plugin_cache</a><span class="src-sym">[</span><span class="src-var">$name</span><span class="src-sym">]</span><span class="src-sym">, </span><span class="src-var">$name</span><span class="src-sym">)) </span><span class="src-key">return </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodlePluginManager.html#var$plugin_cache">plugin_cache</a><span class="src-sym">[</span><span class="src-var">$name</span><span class="src-sym">]</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a136"></a> </div></li>
- <li><div class="src-line"><a name="a137"></a> <span class="src-comm">// Attempt to construct an instance of the plugin</span></div></li>
- <li><div class="src-line"><a name="a138"></a> <span class="src-var">$plugin </span>= <span class="src-key">new </span><span class="src-var">$name</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a139"></a> <span class="src-comm">// Make sure it is a valid plugin</span></div></li>
- <li><div class="src-line"><a name="a140"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/is_subclass_of">is_subclass_of</a><span class="src-sym">(</span><span class="src-var">$plugin</span><span class="src-sym">, </span><span class="src-str">'SloodlePluginBase'</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a141"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodlePluginManager.html#var$plugin_cache">plugin_cache</a><span class="src-sym">[</span><span class="src-var">$name</span><span class="src-sym">] </span>= <span class="src-var">$plugin</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a142"></a> <span class="src-key">return </span><span class="src-var">$plugin</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a143"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a144"></a> <span class="src-key">return </span><span class="src-id">false</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a145"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a146"></a> </div></li>
- <li><div class="src-line"><a name="a147"></a><span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a148"></a> </div></li>
- <li><div class="src-line"><a name="a149"></a><span class="src-php">?></span></div></li>
- </ol></div>
- </div>
- <p class="notes" id="credit">
- Documentation generated on Fri, 17 Jul 2009 11:02:22 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
- </p>
- </body>
- </html>
|