/include/html.php

Description

Tools for HTML generation

Includes
require_once ('conf/config.php') (line 15)

General configuration file

require_once ('lang/strings_'.$GLOBALS['lang'].'.inc.php') (line 20)

Output is language dependant

Functions
date_add_days (line 350)

Add a number of days to a date

  • return: Result date
string date_add_days (string $date, integer $nb)
  • string $date: Input date (format : YYYY-MM-DD, must be valid)
  • integer $nb: Number of days to add
format_duration (line 323)

Format duration string

Output format is : [[<h>h]<m>']<s>"<t>

  • return: Duration formatted string
string format_duration (integer $elapsed_10)
  • integer $elapsed_10: Duration in seconds * 10
html_login_form (line 261)

Generate HTML login form

  • return: Buffer containing HTML
string html_login_form ([string $action = ''], [boolean $ajax_tips = false], [string $email = null], [string $password = null])
  • string $action: Page to navigate to (default : current page)
  • boolean $ajax_tips: true to use Ajax tips, else false (default)
  • string $email: To fill email input value instead of $_POST['email'] if not null
  • string $password: To fill password input value if not null
html_logout_form (line 298)

Generate HTML logout form

  • return: Buffer containing HTML
string html_logout_form ([string $action = ''], [boolean $ajax_tips = false])
  • string $action: Page to navigate to (default : current page)
  • boolean $ajax_tips: true to use Ajax tips, else false (default)
html_main_menu (line 91)

Display HTML page footer

  • return: Buffer containing HTML menu
string html_main_menu (boolean $ajax_tips, boolean $hide_home)
  • boolean $ajax_tips: true to enable Ajax tips, else false
  • boolean $hide_home: true to hide home button, else false
html_page_footer (line 232)

Display HTML page footer

void html_page_footer ([integer $break_lines = 0], [boolean $footer = true])
  • integer $break_lines: Number of
    to display to avoid scroll problem with tips
  • boolean $footer: true to display footer content, else false
html_page_header (line 37)

Display HTML page header

void html_page_header (string $title, [array $options = null])
  • string $title: Page title
  • array $options: Associative array of options :
    • 'ajax_tips' : true to use Ajax tips, else false (default)
    • 'show_menu' : true to display user menu (default), else false (only if user logged in)
    • 'hide_home' : true to hide home button, else false (default)
    • 'keywords' : META tag string : List of keywords
    • 'description' : META tag string : Page description
    • 'onload' : Java script to call after loading HTML page

Documentation generated on Sat, 28 Mar 2009 23:15:20 +0000 by phpDocumentor 1.4.1