X-Git-Url: https://git.llucax.com/mecon/meconlib.git/blobdiff_plain/c1e6f790144affb8d7a518bef7d5734f078ed248..HEAD:/lib/MLIB/Tpl/FileDir.php?ds=sidebyside diff --git a/lib/MLIB/Tpl/FileDir.php b/lib/MLIB/Tpl/FileDir.php index e088b89..f5c12ab 100644 --- a/lib/MLIB/Tpl/FileDir.php +++ b/lib/MLIB/Tpl/FileDir.php @@ -31,7 +31,6 @@ require_once 'MLIB/Tpl.php'; * Hooks vs IT (HIT) is a simple template implementation, based on hooks and IT * template systems. * - * @exapmle MLIB/Tpl/FileDir/test.php * * @note This class was originally created as a part of BIFE. * @author Leandro Lucarella @@ -114,7 +113,11 @@ class MLIB_Tpl_FileDir extends /* implements */ MLIB_Tpl } /** - * @copydoc MLIB_Tpl::pushGroup() + * 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 = '') { @@ -122,7 +125,10 @@ class MLIB_Tpl_FileDir extends /* implements */ MLIB_Tpl } /** - * @copydoc MLIB_Tpl::popGroup() + * Pops the actual group from the group array. + * + * @return mixed. + * @todo Add an example. */ function popGroup() { @@ -130,7 +136,10 @@ class MLIB_Tpl_FileDir extends /* implements */ MLIB_Tpl } /** - * @copydoc MLIB_Tpl::getGroup() + * Returns the last element of the group array. + * + * @return mixed. + * @todo Add an example. */ function getGroup() { @@ -138,7 +147,14 @@ class MLIB_Tpl_FileDir extends /* implements */ MLIB_Tpl } /** - * @copydoc MLIB_Tpl::exists() + * 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) { @@ -196,4 +212,12 @@ class MLIB_Tpl_FileDir extends /* implements */ MLIB_Tpl } +/** + * @example Tpl/FileDir/test.php + * + * This example will create an HTML page with a header, body and a footer. + * In order to do this, I will use three template groups (header, body, footer). + * All this templates are located in TPLS directory. + */ + ?>