Updated documentations of template plugin interfaces
authorMatthias Schmidt <gravatronics@live.com>
Wed, 10 Aug 2011 14:02:50 +0000 (16:02 +0200)
committerMatthias Schmidt <gravatronics@live.com>
Wed, 10 Aug 2011 14:02:50 +0000 (16:02 +0200)
wcfsetup/install/files/lib/system/template/ITemplatePluginBlock.class.php
wcfsetup/install/files/lib/system/template/ITemplatePluginCompiler.class.php
wcfsetup/install/files/lib/system/template/ITemplatePluginFunction.class.php
wcfsetup/install/files/lib/system/template/ITemplatePluginModifier.class.php
wcfsetup/install/files/lib/system/template/ITemplatePluginPrefilter.class.php

index 175f44611ac3c4dafaca7ce15ab7cb8790c949f5..9c6487ef5401f7f9faea4105157bbb0c3095fd3e 100644 (file)
@@ -17,7 +17,7 @@ interface ITemplatePluginBlock {
         * 
         * @param       array                   $tagArgs
         * @param       string                  $blockContent
-        * @param       TemplateEngine          $tplObj
+        * @param       wcf\system\template\TemplateEngine      $tplObj
         * @return      string                  output
         */
        public function execute($tagArgs, $blockContent, TemplateEngine $tplObj);
@@ -26,14 +26,14 @@ interface ITemplatePluginBlock {
         * Initialises this template block.
         * 
         * @param       array                   $tagArgs
-        * @param       TemplateEngine          $tplObj
+        * @param       wcf\system\template\TemplateEngine      $tplObj
         */
        public function init($tagArgs, TemplateEngine $tplObj);
        
        /**
         * This function is called before every execution of this block function.
         * 
-        * @param       TemplateEngine          $tplObj
+        * @param       wcf\system\template\TemplateEngine      $tplObj
         * @return      boolean
         */
        public function next(TemplateEngine $tplObj);
index beeb84fa3145a5d2a6c67d4befc5e24149a93913..ab579e9dba2b867e6ae1fc116cadf5df24669a12 100644 (file)
@@ -15,17 +15,17 @@ interface ITemplatePluginCompiler {
        /**
         * Executes the start tag of this compiler function.
         * 
-        * @param       array                           $tagArgs                
-        * @param       TemplateScriptingCompiler       $compiler
-        * @return      string                                          php code        
+        * @param       array           $tagArgs                
+        * @param       wcf\system\template\TemplateScriptingCompiler   $compiler
+        * @return      string          php code        
         */
        public function executeStart($tagArgs, TemplateScriptingCompiler $compiler);
        
        /**
         * Executes the end tag of this compiler function.
         * 
-        * @param       TemplateScriptingCompiler       $compiler       
-        * @return      string                                          php code        
+        * @param       wcf\system\template\TemplateScriptingCompiler   $compiler
+        * @return      string          php code        
         */
-       public function executeEnd(TemplateScriptingCompiler $tplObj);
+       public function executeEnd(TemplateScriptingCompiler $compiler);
 }
index 48a526f8643d100aa8daf4b193543cbdfe31a795..ac0b7d222c6d0df32ed7ded2e00c7ac434018f56 100644 (file)
@@ -15,9 +15,9 @@ interface ITemplatePluginFunction {
        /**
         * Executes this template function.
         * 
-        * @param       array                   $tagArgs
-        * @param       TemplateEngine          $tplObj
-        * @return      string                          output
+        * @param       array           $tagArgs
+        * @param       wcf\system\template\TemplateEngine      $tplObj
+        * @return      string          output
         */
        public function execute($tagArgs, TemplateEngine $tplObj);
 }
index 66f0461ab76a064bb8a327abc8cbc562d1bcd038..478ebfd7fcd9324e90265712bb251498c6328539 100644 (file)
@@ -16,9 +16,9 @@ interface ITemplatePluginModifier {
        /**
         * Executes this modifier.
         * 
-        * @param       array                   $tagArgs                
-        * @param       TemplateEngine          $tplObj
-        * @return      string                  output          
+        * @param       array           $tagArgs                
+        * @param       wcf\system\template\TemplateEngine      $tplObj
+        * @return      string          output          
         */
        public function execute($tagArgs, TemplateEngine $tplObj);
 }
index a66a4a89320d687cbd485b40fc4a2763db4a421a..4701713b3798d574b336a6a36f96e8e2a94e4aa1 100644 (file)
@@ -15,10 +15,10 @@ interface ITemplatePluginPrefilter {
        /**
         * Executes this prefilter.
         * 
-        * @param       string                          $templateName
-        * @param       string                          $sourceContent  
-        * @param       TemplateScriptingCompiler       $compiler       
-        * @return      string                          $sourceContent
+        * @param       string          $templateName
+        * @param       string          $sourceContent  
+        * @param       wcf\system\template\TemplateScriptingCompiler   $compiler
+        * @return      string
         */
        public function execute($templateName, $sourceContent, TemplateScriptingCompiler $compiler);
 }