]> git.llucax.com Git - mecon/meconlib.git/commitdiff
Se agrega documentacion a los metodos
authorMartín Marrese <marrese@gmail.com>
Wed, 4 Aug 2004 14:03:07 +0000 (14:03 +0000)
committerMartín Marrese <marrese@gmail.com>
Wed, 4 Aug 2004 14:03:07 +0000 (14:03 +0000)
- popGroup
- pushGroup
- getGroup
- exists

lib/MLIB/Tpl/FileDir.php

index db5721e0d7257e078170880bfc67c9f0d36a379b..f5c12ab07bc011ec3999eb0e6b064b2612d576b2 100644 (file)
@@ -112,21 +112,50 @@ class MLIB_Tpl_FileDir extends /* implements */ MLIB_Tpl
         }
     }
 
+    /**
+     * Push a new item into the group array.
+     *
+     * @param group Item to be added on the group array.
+     *
+     * @todo Add an example.
+     */
     function pushGroup($group = '')
     {
         $this->group[] = $group;
     }
 
+    /**
+     * Pops the actual group from the group array.
+     *
+     * @return mixed.
+     * @todo Add an example.
+     */
     function popGroup()
     {
         return array_pop($this->group);
     }
 
+    /**
+     * Returns the last element of the group array.
+     *
+     * @return mixed.
+     * @todo Add an example.
+     */
     function getGroup()
     {
         return end($this->group);
     }
 
+    /**
+     * Checks if a certain template file exists.
+     *
+     * @param name Template file name.
+     * @param group If it is true, search in the group directory, otherwise
+     *              checks only in the root path.
+     *
+     * @return bool.
+     * @todo Add an example.
+     */
     function exists($name, $group = null)
     {
         $tpl = $this->getFileContent($this->getFilename($name, $group));