[ Index ]

PHP Cross Reference of MantisBT

title

Body

[close]

/core/ -> html_api.php (summary)

HTML API These functions control the HTML output of each page.

Copyright: Copyright (C) 2000 - 2002 Kenzaburo Ito - kenito@300baud.org
Copyright: Copyright (C) 2002 - 2011 MantisBT Team - mantisbt-dev@lists.sourceforge.net
File Size: 1729 lines (57 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 57 functions

  html_set_rss_link()
  html_robots_noindex()
  html_rss_link()
  html_javascript_link()
  html_page_top()
  html_page_top1()
  html_page_top2()
  html_page_top2a()
  html_page_bottom()
  html_page_bottom1()
  html_page_bottom1a()
  html_begin()
  html_head_begin()
  html_content_type()
  html_title()
  require_css()
  html_css()
  html_css_link()
  html_meta_redirect()
  require_js()
  html_head_javascript()
  html_head_end()
  html_body_begin()
  html_header()
  html_top_banner()
  html_login_info()
  html_bottom_banner()
  html_footer()
  html_body_end()
  html_end()
  prepare_custom_menu_options()
  print_menu()
  print_project_menu_bar()
  print_subproject_menu_bar()
  print_summary_submenu()
  print_manage_menu()
  print_manage_config_menu()
  print_account_menu()
  print_doc_menu()
  print_summary_menu()
  html_status_legend()
  html_status_percentage_legend()
  html_button()
  html_button_bug_update()
  html_button_bug_change_status()
  html_button_bug_assign_to()
  html_button_bug_move()
  html_button_bug_create_child()
  html_button_bug_reopen()
  html_button_bug_monitor()
  html_button_bug_unmonitor()
  html_button_bug_stick()
  html_button_bug_unstick()
  html_button_bug_delete()
  html_button_wiki()
  html_buttons_view_bug_page()
  html_get_status_css_class()

Functions
Functions that are not part of a class:

html_set_rss_link( $p_rss_feed_url )   X-Ref
Sets the url for the rss link associated with the current page.
null: means no feed (default).

param: string $p_rss_feed_url rss feed url
return: null

html_robots_noindex()   X-Ref
This method must be called before the html_page_top* methods.  It marks the page as not
for indexing.

return: null

html_rss_link()   X-Ref
Prints the link that allows auto-detection of the associated feed.

return: null

html_javascript_link( $p_filename)   X-Ref
Prints a <script> tag to include a JavaScript file.

param: string $p_filename Name of JavaScript file (with extension) to include
return: null

html_page_top( $p_page_title = null, $p_redirect_url = null )   X-Ref
Defines the top of a HTML page

param: string $p_page_title html page title
param: string $p_redirect_url url to redirect to if necessary
return: null

html_page_top1( $p_page_title = null )   X-Ref
Print the part of the page that comes before meta redirect tags should be inserted

param: string $p_page_title page title
return: null

html_page_top2()   X-Ref
Print the part of the page that comes after meta tags, but before the actual page content

return: null

html_page_top2a()   X-Ref
Print the part of the page that comes after meta tags and before the
actual page content, but without login info or menus.  This is used
directly during the login process and other times when the user may
not be authenticated

return: null

html_page_bottom( $p_file = null )   X-Ref
Print the part of the page that comes below the page content
$p_file should always be the __FILE__ variable. This is passed to show source

param: string $p_file should always be the __FILE__ variable. This is passed to show source
return: null

html_page_bottom1( $p_file = null )   X-Ref
Print the part of the page that comes below the page content
$p_file should always be the __FILE__ variable. This is passed to show source

param: string $p_file should always be the __FILE__ variable. This is passed to show source
return: null

html_page_bottom1a( $p_file = null )   X-Ref
Print the part of the page that comes below the page content but leave off
the menu.  This is used during the login process and other times when the
user may not be authenticated.

param: string $p_file should always be the __FILE__ variable.
return: null

html_begin()   X-Ref
(1) Print the document type and the opening <html> tag

return: null

html_head_begin()   X-Ref
(2) Begin the <head> section

return: null

html_content_type()   X-Ref
(3) Print the content-type

return: null

html_title( $p_page_title = null )   X-Ref
(4) Print the window title

param: string $p_page_title window title
return: null

require_css( $p_stylesheet_path )   X-Ref
No description

html_css()   X-Ref
(5) Print the link to include the css file

return: null

html_css_link( $p_filename )   X-Ref
Prints a css link

return: null

html_meta_redirect( $p_url, $p_time = null, $p_sanitize = true )   X-Ref
(6) Print an HTML meta tag to redirect to another page
This function is optional and may be called by pages that need a redirect.
$p_time is the number of seconds to wait before redirecting.
If we have handled any errors on this page and the 'stop_on_errors' config
option is turned on, return false and don't redirect.

param: string $p_url The page to redirect: has to be a relative path
param: integer $p_time seconds to wait for before redirecting
param: boolean $p_sanitize apply string_sanitize_url to passed url
return: boolean

require_js( $p_script_path )   X-Ref
No description

html_head_javascript()   X-Ref
(6a) Javascript...

return: null

html_head_end()   X-Ref
(7) End the <head> section

return: null

html_body_begin()   X-Ref
(8) Begin the <body> section

return: null

html_header()   X-Ref
(9) Print the title displayed at the top of the page

return: null

html_top_banner()   X-Ref
(10) Print a user-defined banner at the top of the page if there is one.

return: null

html_login_info()   X-Ref
(11) Print the user's account information
Also print the select box where users can switch projects

return: null

html_bottom_banner()   X-Ref
(12) Print a user-defined banner at the bottom of the page if there is one.

return: null

html_footer( $p_file = null )   X-Ref
(13) Print the page footer information

param: string $p_file
return: null

html_body_end()   X-Ref
(14) End the <body> section

return: null

html_end()   X-Ref
(15) Print the closing <html> tag

return: null

prepare_custom_menu_options( $p_config )   X-Ref
Prepare an array of additional menu options from a config variable

param: string $p_config config name
return: array

print_menu()   X-Ref
Print the main menu

return: null

print_project_menu_bar()   X-Ref
Print the menu bar with a list of projects to which the user has access

return: null

print_subproject_menu_bar( $p_project_id, $p_parents = '' )   X-Ref
Print the menu bar with a list of projects to which the user has access

return: null

print_summary_submenu()   X-Ref
Print the menu for the graph summary section

return: null

print_manage_menu( $p_page = '' )   X-Ref
Print the menu for the manage section

param: string $p_page specifies the current page name so it's link can be disabled
return: null

print_manage_config_menu( $p_page = '' )   X-Ref
Print the menu for the manage configuration section

param: string $p_page specifies the current page name so it's link can be disabled
return: null

print_account_menu( $p_page = '' )   X-Ref
Print the menu for the account section

param: string $p_page specifies the current page name so it's link can be disabled
return: null

print_doc_menu( $p_page = '' )   X-Ref
Print the menu for the docs section

param: string $p_page specifies the current page name so it's link can be disabled
return: null

print_summary_menu( $p_page = '' )   X-Ref
Print the menu for the summary section

param: string $p_page specifies the current page name so it's link can be disabled
return: null

html_status_legend()   X-Ref
Print the color legend for the status colors

param: string
return: null

html_status_percentage_legend()   X-Ref
Print the legend for the status percentage

return: null

html_button( $p_action, $p_button_text, $p_fields = null, $p_method = 'post' )   X-Ref
Print an html button inside a form

param: string $p_action
param: string $p_buttion_text
param: array $p_fields
param: string $p_method
return: null

html_button_bug_update( $p_bug_id )   X-Ref
Print a button to update the given bug

param: int $p_bug_id
return: null

html_button_bug_change_status( $p_bug_id )   X-Ref
Print Change Status to: button
This code is similar to print_status_option_list except
there is no masking, except for the current state

param: int $p_bug_id
return: null

html_button_bug_assign_to( $p_bug_id )   X-Ref
Print Assign To: combo box of possible handlers

param: int $p_bug_id
return: null

html_button_bug_move( $p_bug_id )   X-Ref
Print a button to move the given bug to a different project

param: int $p_bug_id
return: null

html_button_bug_create_child( $p_bug_id )   X-Ref
Print a button to move the given bug to a different project

param: int $p_bug_id
return: null

html_button_bug_reopen( $p_bug_id )   X-Ref
Print a button to reopen the given bug

param: int $p_bug_id
return: null

html_button_bug_monitor( $p_bug_id )   X-Ref
Print a button to monitor the given bug

param: int $p_bug_id
return: null

html_button_bug_unmonitor( $p_bug_id )   X-Ref
Print a button to unmonitor the given bug
no reason to ever disallow someone from unmonitoring a bug

param: int $p_bug_id
return: null

html_button_bug_stick( $p_bug_id )   X-Ref
Print a button to stick the given bug

param: int $p_bug_id
return: null

html_button_bug_unstick( $p_bug_id )   X-Ref
Print a button to unstick the given bug

param: int $p_bug_id
return: null

html_button_bug_delete( $p_bug_id )   X-Ref
Print a button to delete the given bug

param: int $p_bug_id
return: null

html_button_wiki( $p_bug_id )   X-Ref
Print a button to create a wiki page

param: int $p_bug_id
return: null

html_buttons_view_bug_page( $p_bug_id )   X-Ref
Print all buttons for view bug pages

param: int $p_bug_id
return: null

html_get_status_css_class( $p_status )   X-Ref
get the css class name for the given status

param: int $p_status
return: string



Generated: Thu Jul 28 15:48:31 2011 Cross-referenced by PHPXref 0.7