CoreAPI
[ class tree: CoreAPI ] [ index: CoreAPI ] [ all elements ]

Procedural File: html_api.php

Source Location: /core/html_api.php



Page Details:

These functions control the display of each page

This is the call order of these functions, should you need to figure out which to modify or which to leave out.

html_page_top1 html_begin html_head_begin html_css html_content_type html_rss_link (html_meta_redirect) html_title html_page_top2 html_page_top2a html_head_end html_body_begin html_header html_top_banner html_login_info (print_project_menu_bar) print_menu

...Page content here...

html_page_bottom1 (print_menu) html_page_bottom1a html_bottom_banner html_footer html_body_end html_end




Tags:

copyright:  Copyright (C) 2002 - 2010 MantisBT Team - mantisbt-dev@lists.sourceforge.net
copyright:  Copyright (C) 2000 - 2002 Kenzaburo Ito - kenito@300baud.org
link:  http://www.mantisbt.org
uses:  lang_api.php


Includes:

require_once('rss_api.php') [line 90]
requires rss_api

require_once('user_api.php') [line 86]
requires user_api

require_once('php_api.php') [line 94]
requires php_api

require_once('authentication_api.php') [line 82]
requires authentication_api

require_once('bug_api.php') [line 70]
requires bug_api

require_once('project_api.php') [line 74]
requires project_api

require_once('string_api.php') [line 66]
requires string_api

require_once('helper_api.php') [line 78]
requires helper_api

require_once('current_user_api.php') [line 62]
requires current_user_api







html_begin [line 296]

null html_begin( )

(1) Print the document type and the opening <html> tag



[ Top ]



html_body_begin [line 426]

null html_body_begin( )

(8) Begin the <body> section



[ Top ]



html_body_end [line 671]

null html_body_end( )

(14) End the <body> section



[ Top ]



html_bottom_banner [line 568]

null html_bottom_banner( )

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



[ Top ]



html_button [line 1313]

null html_button( string $p_action, $p_button_text, [array $p_fields = null], [string $p_method = 'post'], string $p_buttion_text)

Print an html button inside a form



Parameters

string   $p_action  
string   $p_buttion_text  
array   $p_fields  
string   $p_method  
   $p_button_text  
[ Top ]



html_buttons_view_bug_page [line 1612]

null html_buttons_view_bug_page( int $p_bug_id)

Print all buttons for view bug pages



Parameters

int   $p_bug_id  
[ Top ]



html_button_bug_assign_to [line 1406]

null html_button_bug_assign_to( int $p_bug_id)

Print Assign To: combo box of possible handlers



Parameters

int   $p_bug_id  
[ Top ]



html_button_bug_change_status [line 1363]

null html_button_bug_change_status( int $p_bug_id)

Print Change Status to: button This code is similar to print_status_option_list except there is no masking, except for the current state



Parameters

int   $p_bug_id  
[ Top ]



html_button_bug_create_child [line 1518]

null html_button_bug_create_child( int $p_bug_id)

Print a button to move the given bug to a different project



Parameters

int   $p_bug_id  
[ Top ]



html_button_bug_delete [line 1588]

null html_button_bug_delete( int $p_bug_id)

Print a button to delete the given bug



Parameters

int   $p_bug_id  
[ Top ]



html_button_bug_monitor [line 1545]

null html_button_bug_monitor( int $p_bug_id)

Print a button to monitor the given bug



Parameters

int   $p_bug_id  
[ Top ]



html_button_bug_move [line 1505]

null html_button_bug_move( int $p_bug_id)

Print a button to move the given bug to a different project



Parameters

int   $p_bug_id  
[ Top ]



html_button_bug_reopen [line 1529]

null html_button_bug_reopen( int $p_bug_id)

Print a button to reopen the given bug



Parameters

int   $p_bug_id  
[ Top ]



html_button_bug_stick [line 1566]

null html_button_bug_stick( int $p_bug_id)

Print a button to stick the given bug



Parameters

int   $p_bug_id  
[ Top ]



html_button_bug_unmonitor [line 1557]

null html_button_bug_unmonitor( int $p_bug_id)

Print a button to unmonitor the given bug

no reason to ever disallow someone from unmonitoring a bug




Parameters

int   $p_bug_id  
[ Top ]



html_button_bug_unstick [line 1577]

null html_button_bug_unstick( int $p_bug_id)

Print a button to unstick the given bug



Parameters

int   $p_bug_id  
[ Top ]



html_button_bug_update [line 1349]

null html_button_bug_update( int $p_bug_id)

Print a button to update the given bug



Parameters

int   $p_bug_id  
[ Top ]



html_button_wiki [line 1599]

null html_button_wiki( int $p_bug_id)

Print a button to create a wiki page



Parameters

int   $p_bug_id  
[ Top ]



html_content_type [line 313]

null html_content_type( )

(3) Print the content-type



[ Top ]



html_css [line 342]

null html_css( )

(5) Print the link to include the css file



[ Top ]



html_end [line 681]

null html_end( )

(15) Print the closing <html> tag



[ Top ]



html_footer [line 581]

null html_footer( [string $p_file = null])

(13) Print the page footer information



Parameters

string   $p_file  
[ Top ]



html_header [line 436]

null html_header( )

(9) Print the title displayed at the top of the page



[ Top ]



html_head_begin [line 305]

null html_head_begin( )

(2) Begin the <head> section



[ Top ]



html_head_end [line 416]

null html_head_end( )

(7) End the <head> section



[ Top ]



html_head_javascript [line 397]

null html_head_javascript( )

(6a) Javascript...



[ Top ]



html_javascript_link [line 148]

null html_javascript_link( string $p_filename)

Prints a <script> tag to include a javascript file.

This includes either minimal or development file from /javascript depending on whether mantis is set for debug/production use




Parameters

string   $p_filename  
[ Top ]



html_login_info [line 491]

null html_login_info( )

(11) Print the user's account information

Also print the select box where users can switch projects




[ Top ]



html_meta_redirect [line 370]

boolean html_meta_redirect( string $p_url, [integer $p_time = null], [boolean $p_sanitize = true])

(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.




Parameters

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



html_page_bottom [line 249]

null html_page_bottom( [string $p_file = null])

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




Parameters

string   $p_file   should always be the __FILE__ variable. This is passed to show source
[ Top ]



html_page_bottom1 [line 259]

null html_page_bottom1( [string $p_file = null])

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




Parameters

string   $p_file   should always be the __FILE__ variable. This is passed to show source
[ Top ]



html_page_bottom1a [line 281]

null html_page_bottom1a( [string $p_file = null])

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.



Parameters

string   $p_file   should always be the __FILE__ variable.
[ Top ]



html_page_top [line 162]

null html_page_top( [string $p_page_title = null], [string $p_redirect_url = null])

Defines the top of a HTML page



Parameters

string   $p_page_title   html page title
string   $p_redirect_url   url to redirect to if necessary
[ Top ]



html_page_top1 [line 175]

null html_page_top1( [string $p_page_title = null])

Print the part of the page that comes before meta redirect tags should be inserted



Parameters

string   $p_page_title   page title
[ Top ]



html_page_top2 [line 206]

null html_page_top2( )

Print the part of the page that comes after meta tags, but before the actual page content



[ Top ]



html_page_top2a [line 233]

null html_page_top2a( )

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




[ Top ]



html_robots_noindex [line 125]

null html_robots_noindex( )

This method must be called before the html_page_top* methods. It marks the page as not for indexing.



[ Top ]



html_rss_link [line 134]

null html_rss_link( )

Prints the link that allows auto-detection of the associated feed.



[ Top ]



html_set_rss_link [line 113]

null html_set_rss_link( string $p_rss_feed_url)

Sets the url for the rss link associated with the current page.

null: means no feed (default).




Parameters

string   $p_rss_feed_url   rss feed url
[ Top ]



html_status_legend [line 1211]

null html_status_legend( [string 0 = ])

Print the color legend for the status colors



Parameters

string   0  
[ Top ]



html_status_percentage_legend [line 1253]

null html_status_percentage_legend( )

Print the legend for the status percentage



[ Top ]



html_title [line 322]

null html_title( [string $p_page_title = null])

(4) Print the window title



Parameters

string   $p_page_title   window title
[ Top ]



html_top_banner [line 447]

null html_top_banner( )

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



[ Top ]



prepare_custom_menu_options [line 690]

array prepare_custom_menu_options( string $p_config)

Prepare an array of additional menu options from a config variable



Parameters

string   $p_config   config name
[ Top ]



print_account_menu [line 1081]

null print_account_menu( [string $p_page = ''])

Print the menu for the account section



Parameters

string   $p_page   specifies the current page name so it's link can be disabled
[ Top ]



print_doc_menu [line 1147]

null print_doc_menu( [string $p_page = ''])

Print the menu for the docs section



Parameters

string   $p_page   specifies the current page name so it's link can be disabled
[ Top ]



print_manage_config_menu [line 1014]

null print_manage_config_menu( [string $p_page = ''])

Print the menu for the manage configuration section



Parameters

string   $p_page   specifies the current page name so it's link can be disabled
[ Top ]



print_manage_menu [line 930]

null print_manage_menu( [string $p_page = ''])

Print the menu for the manage section



Parameters

string   $p_page   specifies the current page name so it's link can be disabled
[ Top ]



print_menu [line 710]

null print_menu( )

Print the main menu



[ Top ]



print_project_menu_bar [line 860]

null print_project_menu_bar( )

Print the menu bar with a list of projects to which the user has access



[ Top ]



print_subproject_menu_bar [line 882]

null print_subproject_menu_bar( $p_project_id, [ $p_parents = ''])

Print the menu bar with a list of projects to which the user has access



Parameters

   $p_project_id  
   $p_parents  
[ Top ]



print_summary_menu [line 1176]

null print_summary_menu( [string $p_page = ''])

Print the menu for the summary section



Parameters

string   $p_page   specifies the current page name so it's link can be disabled
[ Top ]



print_summary_submenu [line 896]

null print_summary_submenu( )

Print the menu for the graph summary section



[ Top ]



Documentation generated on Sun, 12 Dec 2010 23:50:32 +0900 by phpDocumentor 1.4.3
inserted by FC2 system