From 04f8a47af5dc09fc3f62143a902477e860f80814 Mon Sep 17 00:00:00 2001 From: Dominique Fournier Date: Mon, 27 Jun 2016 09:30:19 +0000 Subject: [PATCH] outputhtml : update phpdoc git-svn-id: https://svn.fournier38.fr/svn/ProgSVN/trunk@2767 bf3deb0d-5f1a-0410-827f-c0cc1f45334c --- outputhtml.php | 32 +++++++++++++++++--------------- 1 file changed, 17 insertions(+), 15 deletions(-) diff --git a/outputhtml.php b/outputhtml.php index a4aa6a5..895b280 100644 --- a/outputhtml.php +++ b/outputhtml.php @@ -8,17 +8,19 @@ require_once ("output.php"); class outputhtml extends output { /** Data is printed by viewClass->viewmethod, in the middle of $layout - title is put in the title of the HTML page - $replacement modify the result (it can do title too : - array ("{title}"=>"title to display") - @param mixed $data Data to display on the 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 $viewMethod Method in the class in views - @param string|null $layout Layout file in views - @param array|null $replacement Replace the {key}=>value - @param array|null $variable PHP variables send to the view and to layout - (can be processed by foreach, if...) */ + * title is put in the title of the HTML page + * $replacement modify the result (it can do title too : + * array ("{title}"=>"title to display") + * @param mixed $data Data to display on the 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 $viewMethod Method in the class in views + * @param string|null $layout Layout file in views + * @param array|null $replacement Replace the {key}=>value + * @param array|null $variable PHP variables send to the view and to layout + * (can be processed by foreach, if...) + * @return Exit from PHP at the end of HTML display + */ public function out ($data, $title = FALSE, $viewClass = FALSE, $viewMethod = FALSE, $layout = FALSE, $replacement = array(), @@ -97,10 +99,10 @@ EOT; } /** Get the layout and provide it the variables. The variables will be push in - global to the layout (they can be used like $XX) - @param string the layout file to load - @param array $variables The variables array to push to the layout - @return string the Layout with variables interpreted */ + * global to the layout (they can be used like $XX) + * @param string the layout file to load + * @param array $variables The variables array to push to the layout + * @return string the Layout with variables interpreted */ private function layoutVariables ($layout, $variables) { // The layout can be a external layout file or the HTML page itself.