outputhtml : update phpdoc

git-svn-id: https://svn.fournier38.fr/svn/ProgSVN/trunk@2767 bf3deb0d-5f1a-0410-827f-c0cc1f45334c
This commit is contained in:
2016-06-27 09:30:19 +00:00
parent 4c470b9306
commit 04f8a47af5

View File

@@ -8,17 +8,19 @@ require_once ("output.php");
class outputhtml extends output class outputhtml extends output
{ {
/** Data is printed by viewClass->viewmethod, in the middle of $layout /** Data is printed by viewClass->viewmethod, in the middle of $layout
title is put in the title of the HTML page * title is put in the title of the HTML page
$replacement modify the result (it can do title too : * $replacement modify the result (it can do title too :
array ("{title}"=>"title to display") * array ("{title}"=>"title to display")
@param mixed $data Data to display on the page * @param mixed $data Data to display on the page
@param string|null $title Title to put on head of page * @param string|null $title Title to put on head of page
@param string|null $viewClass Class in views to use to display * @param string|null $viewClass Class in views to use to display
@param string|null $viewMethod Method in the class in views * @param string|null $viewMethod Method in the class in views
@param string|null $layout Layout file in views * @param string|null $layout Layout file in views
@param array|null $replacement Replace the {key}=>value * @param array|null $replacement Replace the {key}=>value
@param array|null $variable PHP variables send to the view and to layout * @param array|null $variable PHP variables send to the view and to layout
(can be processed by foreach, if...) */ * (can be processed by foreach, if...)
* @return Exit from PHP at the end of HTML display
*/
public function out ($data, $title = FALSE, public function out ($data, $title = FALSE,
$viewClass = FALSE, $viewMethod = FALSE, $viewClass = FALSE, $viewMethod = FALSE,
$layout = FALSE, $replacement = array(), $layout = FALSE, $replacement = array(),
@@ -97,10 +99,10 @@ EOT;
} }
/** Get the layout and provide it the variables. The variables will be push in /** Get the layout and provide it the variables. The variables will be push in
global to the layout (they can be used like $XX) * global to the layout (they can be used like $XX)
@param string the layout file to load * @param string the layout file to load
@param array $variables The variables array to push to the layout * @param array $variables The variables array to push to the layout
@return string the Layout with variables interpreted */ * @return string the Layout with variables interpreted */
private function layoutVariables ($layout, $variables) private function layoutVariables ($layout, $variables)
{ {
// The layout can be a external layout file or the HTML page itself. // The layout can be a external layout file or the HTML page itself.