Add all the phpdocs to the domframework

git-svn-id: https://svn.fournier38.fr/svn/ProgSVN/trunk@1246 bf3deb0d-5f1a-0410-827f-c0cc1f45334c
This commit is contained in:
2014-03-24 19:44:34 +00:00
parent 1b52b410c3
commit 350aa1dea8
28 changed files with 472 additions and 148 deletions

View File

@@ -1,9 +1,17 @@
<?php
/** DomFramework
@package domframework
@author Dominique Fournier <dominique@fournier38.fr> */
/** Display the datas in HTML with a FLASH method to display the errors */
class renderer
{
/** The result in construction */
public $result = NULL;
/** The output type */
public $output = NULL;
public $title = " "; // Title by default : space to be compatible with HTML5
/** Title by default : space to be compatible with HTML5 */
public $title = " ";
/** Filename of class containing the presentation layer */
public $viewClass = FALSE;
/** Method apply to class object to display the $result */
@@ -28,8 +36,9 @@ class renderer
/** Add a flash message to the user, on the next HTML page.
In CLI, display the message immediately.
Message must be translated before sending to the function
Priority is 1:success, 2:info, 3:warning, 4:error
or textual : SUCCESS, INFO, WARNING, ERROR */
@param integer|string $priority Priority 1:success, 2:info, 3:warning,
4:error or textual : SUCCESS, INFO, WARNING, ERROR
@param string $message Message to display */
static public function flash ($priority, $message)
{
if (php_sapi_name () === "cli")