phpDocumentor MantisBT
classes
[ class tree: MantisBT ] [ index: MantisBT ] [ all elements ]
MantisBT
Packages:
MantisBT
CoreAPI
DisposableEmail
MantisPlugin
Projax
RSS
Tests

Files:
account_delete.php
account_manage_columns_page.php
account_page.php
account_prefs_inc.php
account_prefs_page.php
account_prefs_reset.php
account_prefs_update.php
account_prof_edit_page.php
account_prof_menu_page.php
account_prof_update.php
account_sponsor_page.php
account_sponsor_update.php
account_update.php
adm_config_delete.php
adm_config_report.php
adm_config_set.php
adm_permissions_report.php
billing_inc.php
billing_page.php
browser_search_plugin.php
bugnote_add.php
bugnote_add_inc.php
bugnote_delete.php
bugnote_edit_page.php
bugnote_set_view_state.php
bugnote_stats_inc.php
bugnote_update.php
bugnote_view_inc.php
bug_actiongroup.php
bug_actiongroup_add_note_inc.php
bug_actiongroup_attach_tags_inc.php
bug_actiongroup_ext.php
bug_actiongroup_ext_page.php
bug_actiongroup_page.php
bug_actiongroup_update_product_build_inc.php
bug_assign.php
bug_assign_reporter.php
bug_change_status_page.php
bug_file_add.php
bug_file_delete.php
bug_file_upload_inc.php
bug_graph_bycategory.php
bug_graph_bystatus.php
bug_graph_page.php
bug_monitor.php
bug_monitor_list_view_inc.php
bug_relationship_add.php
bug_relationship_delete.php
bug_relationship_graph.php
bug_relationship_graph_img.php
bug_reminder.php
bug_reminder_page.php
bug_report.php
bug_report_advanced_page.php
bug_report_page.php
bug_set_sponsorship.php
bug_sponsorship_list_view_inc.php
bug_update.php
bug_update_advanced_page.php
bug_update_page.php
bug_view_advanced_page.php
bug_view_inc.php
bug_view_page.php
cfdef_standard.php
changelog_page.php
check.php
checkin.php
config.php
config_defaults_inc.php
config_edit.php
config_filter_defaults_inc.php
constant_inc.php
copy_field.php
core.php
csv_export.php
db_stats.php
events_inc.php
excel_xml_export.php
export.php
file_download.php
graph_assigned_to_me.php
graph_by_category.php
graph_by_cumulative.php
graph_by_daily_delta.php
graph_by_release_delta.php
graph_by_severity.php
graph_by_severity_status.php
graph_reported_by_me.php
history_inc.php
import.php
ImportXml.php
import_action.php
index.php
index.php
install.php
install_functions.php
install_helper_functions.php
Interface.php
Issue.php
issues_rss.php
jump_to_bug.php
login.php
login_anon.php
login_cookie_test.php
login_page.php
login_select_proj_page.php
logout_page.php
lost_pwd.php
lost_pwd_page.php
main_page.php
make_captcha_img.php
manage_columns_copy.php
manage_columns_inc.php
manage_config_columns_page.php
manage_config_columns_reset.php
manage_config_columns_set.php
manage_config_email_page.php
manage_config_email_set.php
manage_config_revert.php
manage_config_workflow_page.php
manage_config_workflow_set.php
manage_config_work_threshold_page.php
manage_config_work_threshold_set.php
manage_custom_field_create.php
manage_custom_field_delete.php
manage_custom_field_edit_page.php
manage_custom_field_page.php
manage_custom_field_proj_add.php
manage_custom_field_update.php
manage_overview_page.php
manage_plugin_install.php
manage_plugin_page.php
manage_plugin_uninstall.php
manage_plugin_update.php
manage_plugin_upgrade.php
manage_prof_menu_page.php
manage_proj_cat_add.php
manage_proj_cat_copy.php
manage_proj_cat_delete.php
manage_proj_cat_edit_page.php
manage_proj_cat_update.php
manage_proj_create.php
manage_proj_create_page.php
manage_proj_custom_field_add_existing.php
manage_proj_custom_field_copy.php
manage_proj_custom_field_remove.php
manage_proj_custom_field_update.php
manage_proj_delete.php
manage_proj_edit_page.php
manage_proj_page.php
manage_proj_subproj_add.php
manage_proj_subproj_delete.php
manage_proj_update.php
manage_proj_update_children.php
manage_proj_user_add.php
manage_proj_user_copy.php
manage_proj_user_remove.php
manage_proj_ver_add.php
manage_proj_ver_copy.php
manage_proj_ver_delete.php
manage_proj_ver_edit_page.php
manage_proj_ver_update.php
manage_tags_page.php
manage_user_create.php
manage_user_create_page.php
manage_user_delete.php
manage_user_edit_page.php
manage_user_page.php
manage_user_proj_add.php
manage_user_proj_delete.php
manage_user_prune.php
manage_user_reset.php
manage_user_update.php
mantisconnect.php
MantisCoreFormatting.php
Mapper.php
mc_account_api.php
mc_api.php
mc_config_api.php
mc_config_defaults_inc.php
mc_core.php
mc_custom_field_api.php
mc_enum_api.php
mc_file_api.php
mc_filter_api.php
mc_issue_api.php
mc_issue_attachment_api.php
mc_project_api.php
mc_project_attachment_api.php
meta_inc.php
move_db2disk.php
my_view_inc.php
my_view_page.php
news_add.php
news_edit_page.php
news_list_page.php
news_menu_page.php
news_rss.php
news_update.php
news_view_page.php
obsolete.php
permalink_page.php
plugin.php
plugin_file.php
print_all_bug_options_inc.php
print_all_bug_options_page.php
print_all_bug_options_reset.php
print_all_bug_options_update.php
print_all_bug_page.php
print_all_bug_page_word.php
print_bugnote_inc.php
print_bug_page.php
project_page.php
proj_doc_add.php
proj_doc_add_page.php
proj_doc_delete.php
proj_doc_edit_page.php
proj_doc_page.php
proj_doc_update.php
query_delete.php
query_delete_page.php
query_store.php
query_store_page.php
query_view_page.php
return_dynamic_filters.php
roadmap_page.php
schema.php
search.php
send_emails.php
set_project.php
signup.php
signup_page.php
summary_graph_bycategory.php
summary_graph_bycategory_pct.php
summary_graph_bydeveloper.php
summary_graph_bypriority.php
summary_graph_bypriority_mix.php
summary_graph_bypriority_pct.php
summary_graph_byreporter.php
summary_graph_byresolution.php
summary_graph_byresolution_mix.php
summary_graph_byresolution_pct.php
summary_graph_byseverity.php
summary_graph_byseverity_mix.php
summary_graph_byseverity_pct.php
summary_graph_bystatus.php
summary_graph_bystatus_pct.php
summary_graph_cumulative_bydate.php
summary_graph_imp_category.php
summary_graph_imp_priority.php
summary_graph_imp_resolution.php
summary_graph_imp_severity.php
summary_graph_imp_status.php
summary_jpgraph_page.php
summary_page.php
system_utils.php
tag_attach.php
tag_create.php
tag_delete.php
tag_detach.php
tag_update.php
tag_update_page.php
tag_view_page.php
test.php
test_config_get_set.php
test_icons.php
test_langs.php
test_string_sanitize_url.php
upgrade_unattended.php
upgrade_warning.php
verify.php
view.php
view_all_bug_page.php
view_all_inc.php
view_all_set.php
view_filters_page.php
view_user_page.php
wiki.php
xmlhttprequest.php
classes
class.period.php
MantisCoreWikiPlugin.class.php
MantisEnum.class.php
MantisFormattingPlugin.class.php
MantisPlugin.class.php
MantisWikiPlugin.class.php

Interfaces:
ImportXml_Interface
Classes:
classes
BugData
BugnoteData
MantisCoreDokuwikiPlugin
MantisCoreFormattingPlugin
MantisCoreMediaWikiPlugin
MantisCorePlugin
MantisCoreTwikiPlugin
MantisCoreWikiPlugin
MantisCoreWikkaWikiPlugin
MantisCoreXwikiPlugin
MantisEnum
MantisFormattingPlugin
MantisPlugin
MantisWikiPlugin
Period
ImportXML
ImportXml_Issue
ImportXml_Mapper
masc_captcha
SourceData

Class: MantisEnum

Source Location: /core/classes/MantisEnum.class.php

Class MantisEnum

Class Overview
Class Overview | Method Summary | Methods Detail | Constants Summary | Constants Detail

A class that handles MantisBT Enumerations.

For example: 10:lablel1,20:label2

Located in /core/classes/MantisEnum.class.php [line 31] 



		
		
		
				

		
				
		
Methods

		
				
		
		

		
[ Top ]

	






	
	

		
Constant Summary

		

			Class Overview
									| Constants Summary | Constants Detail
															| Method Summary | Methods Detail
									

		

			

			

					

					

							

					TUPLE_SEPARATOR  
					Separator that is used to separate the enum tuples within an enumeration definition.

				
								

					VALUE_LABEL_SEPARATOR  
					Separator that is used to separate the enum values from their labels.

				
								

			

			
[ Top ]

		

	



	
	

		
Method Summary

		

			Class Overview
									    		    			    				| Constants Summary | Constants Detail
    			    					| Method Summary | Methods Detail
		

		

			

				

					

					

					

					

					

					

					

												
static
											associate  
					
					getAssocArrayIndexedByLabels()  
					Get an associate array for the tuples of the enum where the labels  are the array indices and the values are the array values.

				
																
static
											associate  
					
					getAssocArrayIndexedByValues()  
					Get an associate array for the tuples of the enum where the values  are the array indices and the labels are the array values.

				
																
static
											string  
					
					getLabel()  
					Get the string associated with the $p_enum value

				
																
static
											the  
					
					getLocalizedLabel()  
					Gets the localized label corresponding to a value.  Note that this method  takes in the standard / localized enums so that if the value is in the localized  enum but not the standard one, then it returns not found.

				
																
static
											integer  
					
					getValue()  
					Gets the value associated with the specified label.

				
																
static
											array  
					
					getValues()  
					Gets an array with all values in the enum.

				
																
static
											bool  
					
					hasValue()  
					Checks if the specified enum string contains the specified value.

				
																																																																								

			

			
[ Top ]

		

	



	
	

		
Methods

		

			Class Overview
																					| Constants Summary | Constants Detail
														| Method Summary | Methods Detail
					

		

			






	static method getAssocArrayIndexedByLabels  [line 139]





	

    

    
 
		static associate getAssocArrayIndexedByLabels(
string
$enumString 
)
    

    



	
Get an associate array for the tuples of the enum where the labels  are the array indices and the values are the array values.



			Parameters:

			

					

				string  
				
				$enumString: 
				
							

				


	

	API Tags:



  

    Return:  array indexed by labels.
  

  

    Access:  public
  







		
		

	
[ Top ]









	static method getAssocArrayIndexedByValues  [line 103]





	

    

    
 
		static associate getAssocArrayIndexedByValues(
string
$enumString 
)
    

    



	
Get an associate array for the tuples of the enum where the values  are the array indices and the labels are the array values.



			Parameters:

			

					

				string  
				
				$enumString: 
				
							

				


	

	API Tags:



  

    Return:  array indexed by labels.
  

  

    Access:  public
  







		
		

	
[ Top ]









	static method getLabel  [line 49]





	

    

    
 
		static string getLabel(
string
$enumString, int
$value 
)
    

    



	
Get the string associated with the $p_enum value



			Parameters:

			

					

				string  
				
				$enumString: 
				
							

					

				int  
				
				$value: 
				
							

				


	

	API Tags:



  

    Access:  public
  







		
		

	
[ Top ]









	static method getLocalizedLabel  [line 71]





	

    

    
 
		static the getLocalizedLabel(
string
$enumString, string
$localizedEnumString, integer
$value 
)
    

    



	
Gets the localized label corresponding to a value.  Note that this method  takes in the standard / localized enums so that if the value is in the localized  enum but not the standard one, then it returns not found.



			Parameters:

			

					

				string  
				
				$enumString: 
				
				 The standard enum string.			

					

				string  
				
				$localizedEnumString: 
				
				 The localized enum string.			

					

				integer  
				
				$value: 
				
				 The value to lookup.			

				


	

	API Tags:



  

    Return:  label or the decorated value to represent not found.
  

  

    Access:  public
  







		
		

	
[ Top ]









	static method getValue  [line 86]





	

    

    
 
		static integer getValue(
string
$enumString, string
$label 
)
    

    



	
Gets the value associated with the specified label.



			Parameters:

			

					

				string  
				
				$enumString: 
				
				 The enumerated string.			

					

				string  
				
				$label: 
				
				 The label to map.			

				


	

	API Tags:



  

    Return:  value of the enum or false if not found.
  

  

    Access:  public
  







		
		

	
[ Top ]









	static method getValues  [line 149]





	

    

    
 
		static array getValues(
$enumString
$enumString 
)
    

    



	
Gets an array with all values in the enum.



			Parameters:

			

					

				$enumString  
				
				$enumString: 
				
							

				


	

	API Tags:



  

    Return:  of unique values.
  

  

    Access:  public
  







		
		

	
[ Top ]









	static method hasValue  [line 160]





	

    

    
 
		static bool hasValue(
string
$enumString, integer
$value 
)
    

    



	
Checks if the specified enum string contains the specified value.



			Parameters:

			

					

				string  
				
				$enumString: 
				
				 The enumeration string.			

					

				integer  
				
				$value: 
				
				 The value to chec,			

				


	

	API Tags:



  

    Return:  true if found, false otherwise.
  

  

    Access:  public
  







		
		

	
[ Top ]




		

	


	
	

		
Constants

		

			Class Overview
										| Constants Summary | Constants Detail
																		| Method Summary | Methods Detail
									

		

			



	

		
			TUPLE_SEPARATOR
			 =  ','
			[line 40]
		
	


	
Separator that is used to separate the enum tuples within an enumeration definition.


	

	

	
[ Top ]







	

		
			VALUE_LABEL_SEPARATOR
			 =  ':'
			[line 35]
		
	


	
Separator that is used to separate the enum values from their labels.


	

	

	
[ Top ]



		

	


        

		    

		    Documentation generated on Sun, 05 Apr 2009 23:01:23 +0100 by phpDocumentor 1.4.1