1
0
mirror of https://github.com/phpbb/phpbb.git synced 2025-08-06 08:47:45 +02:00

[feature/template-engine] Remaining documentation.

PHPBB3-9726
This commit is contained in:
Oleg Pudeyev
2011-08-07 19:07:27 -04:00
parent 02fc533066
commit f3befa4b29
7 changed files with 57 additions and 1 deletions

View File

@@ -32,6 +32,11 @@ class phpbb_template_compile
*/
private $allow_php;
/**
* Constructor.
*
* @param bool @allow_php Whether PHP code will be allowed in templates (inline PHP code, PHP tag and INCLUDEPHP tag)
*/
public function __construct($allow_php)
{
$this->allow_php = $allow_php;
@@ -40,6 +45,7 @@ class phpbb_template_compile
/**
* Compiles template in $source_file and writes compiled template to
* cache directory
*
* @param string $handle Template handle to compile
* @param string $source_file Source template file
* @return bool Return true on success otherwise false
@@ -71,7 +77,9 @@ class phpbb_template_compile
/**
* Compiles a template located at $source_file.
*
* Returns PHP source suitable for eval().
*
* @param string $source_file Source template file
* @return string|bool Return compiled code on successful compilation otherwise false
*/