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: Period

Source Location: /core/class.period.php

Class Period

Class Overview
Class Overview | Property Summary | Properties Detail | Method Summary | Methods Detail

Class for actions dealing with date periods

This class encapsulates all actions dealing with time intervals. It handles data storage, and retrieval, as well as formatting and access.

Located in /core/class.period.php [line 30] 



		
				Author(s):
		
		
		
Information Tags:



				
Copyright:  Logical Outcome Ltd. 2005 - 2007

				
Link:  http://www.mantisbt.org

	

				

				
		
Properties

		
				
		
				
		
Methods

		
				
		
		

		
[ Top ]

	







	
	

		
Property Summary

		

			Class Overview
									| Property Summary | Properties Detail
												| Method Summary | Methods Detail
							    				

		

			

			

					

					

																									
string  
					$end  
					

				
													
string  
					$start  
					

				
										

			

			
[ Top ]

		

	


	
	

		
Method Summary

		

			Class Overview
																		| Property Summary | Properties Detail
							    					| Method Summary | Methods Detail
		

		

			

				

											

											

											

											

											

											

											

											

											

											

											

											

											

											

											

											

											

											

											

											

											

											

											

											

											

											

																																																																																																																																																																																																																																
Period  
										Period()  
					Constructor

				
																
void  
										a_month()  
					set dates for a month

				
																
void  
										a_quarter()  
					set dates for a quarter

				
																
void  
										a_week()  
					set dates for a week

				
																
void  
										a_year()  
					set dates for a year

				
																
void  
										get_elapsed_days()  
					get number of days in interval

				
																
void  
										get_end_formatted()  
					get formatted end date

				
																
void  
										get_end_timestamp()  
					get end date in unix timestamp format

				
																
string  
										get_sql_clause()  
					return a matching SQL clause

				
																
void  
										get_start_formatted()  
					get formatted start date

				
																
void  
										get_start_timestamp()  
					get start date in unix timestamp format

				
																
string  
										get_text_clause()  
					return a matching text clause

				
																
void  
										last_month()  
					set dates for last month

				
																
void  
										last_quarter()  
					set dates for last month

				
																
void  
										last_week()  
					set dates for last week

				
																
void  
										last_year()  
					set dates for last year

				
																
void  
										month_to_date()  
					set dates for this month to date

				
																
void  
										period_selector()  
					print a period selector

				
																
void  
										quarter_to_date()  
					set dates for this quarter to date

				
																
void  
										set_period_from_selector()  
					set date based on period selector

				
																
void  
										this_month()  
					set dates for this month

				
																
void  
										this_quarter()  
					set dates for this quarter

				
																
void  
										this_week()  
					set dates for this week

				
																
void  
										this_year()  
					set dates for this year

				
																
void  
										week_to_date()  
					set dates for this week to date

				
																
void  
										year_to_date()  
					set dates for current year, ending today

				
												

			

			
[ Top ]

		

	


	
	

		
Properties

		

			Class Overview
													| Property Summary | Properties Detail
															| Method Summary | Methods Detail
												

		

			



	

		
			string  
			$end
			 =  ''			[line 40]
		
	


		

	
		

	
[ Top ]







	

		
			string  
			$start
			 =  ''			[line 35]
		
	


		

	
		

	
[ Top ]



		

	


	
	

		
Methods

		

			Class Overview
																		| Property Summary | Properties Detail
																	| Method Summary | Methods Detail
					

		

			







	Constructor Period  [line 46]





	

    

    
 
		Period Period(
)
    

    



	
Constructor



	

	

		
		

	
[ Top ]









	a_month  [line 150]





	

    

    
 
		void a_month(
string
$p_when 
)
    

    



	
set dates for a month



			Parameters:

			

					

				string  
				
				$p_when: 
				
				 date string to expand to a month			

				


	

	

		
		

	
[ Top ]









	a_quarter  [line 187]





	

    

    
 
		void a_quarter(
string
$p_when 
)
    

    



	
set dates for a quarter



			Parameters:

			

					

				string  
				
				$p_when: 
				
				 date string to expand to a quarter			

				


	

	

		
		

	
[ Top ]









	a_week  [line 112]





	

    

    
 
		void a_week(
string
$p_when, [int
$p_weeks = 1] 
)
    

    



	
set dates for a week



			Parameters:

			

					

				string  
				
				$p_when: 
				
				 date string to expand to a week (Sun to Sat)			

					

				int  
				
				$p_weeks: 
				
				 number of weeks			

				


	

	

		
		

	
[ Top ]









	a_year  [line 226]





	

    

    
 
		void a_year(
string
$p_when 
)
    

    



	
set dates for a year



			Parameters:

			

					

				string  
				
				$p_when: 
				
				 date string to expand to a year			

				


	

	

		
		

	
[ Top ]









	get_elapsed_days  [line 294]





	

    

    
 
		void get_elapsed_days(
)
    

    



	
get number of days in interval



	

	

		
		

	
[ Top ]









	get_end_formatted  [line 286]





	

    

    
 
		void get_end_formatted(
)
    

    



	
get formatted end date



	

	

		
		

	
[ Top ]









	get_end_timestamp  [line 270]





	

    

    
 
		void get_end_timestamp(
)
    

    



	
get end date in unix timestamp format



	

	

		
		

	
[ Top ]









	get_sql_clause  [line 62]





	

    

    
 
		string get_sql_clause(
)
    

    



	
return a matching SQL clause



create an SQL clause that matches the set date.

	

	API Tags:



  

    Return:  SQL clause
  







		
		

	
[ Top ]









	get_start_formatted  [line 278]





	

    

    
 
		void get_start_formatted(
)
    

    



	
get formatted start date



	

	

		
		

	
[ Top ]









	get_start_timestamp  [line 262]





	

    

    
 
		void get_start_timestamp(
)
    

    



	
get start date in unix timestamp format



	

	

		
		

	
[ Top ]









	get_text_clause  [line 86]





	

    

    
 
		string get_text_clause(
)
    

    



	
return a matching text clause



create an text clause that matches the set date.

	

	API Tags:



  

    Return:  SQL clause
  







		
		

	
[ Top ]









	last_month  [line 168]





	

    

    
 
		void last_month(
)
    

    



	
set dates for last month



	

	

		
		

	
[ Top ]









	last_quarter  [line 206]





	

    

    
 
		void last_quarter(
)
    

    



	
set dates for last month



	

	

		
		

	
[ Top ]









	last_week  [line 132]





	

    

    
 
		void last_week(
[int
$p_weeks = 1] 
)
    

    



	
set dates for last week



			Parameters:

			

					

				int  
				
				$p_weeks: 
				
				 number of weeks			

				


	

	

		
		

	
[ Top ]









	last_year  [line 254]





	

    

    
 
		void last_year(
)
    

    



	
set dates for last year



	

	

		
		

	
[ Top ]









	month_to_date  [line 176]





	

    

    
 
		void month_to_date(
)
    

    



	
set dates for this month to date



	

	

		
		

	
[ Top ]









	period_selector  [line 303]





	

    

    
 
		void period_selector(
string
$p_control_name 
)
    

    



	
print a period selector



			Parameters:

			

					

				string  
				
				$p_control_name: 
				
							

				


	

	

		
		

	
[ Top ]









	quarter_to_date  [line 214]





	

    

    
 
		void quarter_to_date(
)
    

    



	
set dates for this quarter to date



	

	

		
		

	
[ Top ]









	set_period_from_selector  [line 343]





	

    

    
 
		void set_period_from_selector(
string
$p_control_name, [string
$p_start_field = 'start_date'], [string
$p_end_field = 'end_date'] 
)
    

    



	
set date based on period selector



			Parameters:

			

					

				string  
				
				$p_control_name: 
				
							

					

				string  
				
				$p_start_field: 
				
							

					

				string  
				
				$p_end_field: 
				
							

				


	

	

		
		

	
[ Top ]









	this_month  [line 160]





	

    

    
 
		void this_month(
)
    

    



	
set dates for this month



	

	

		
		

	
[ Top ]









	this_quarter  [line 198]





	

    

    
 
		void this_quarter(
)
    

    



	
set dates for this quarter



	

	

		
		

	
[ Top ]









	this_week  [line 123]





	

    

    
 
		void this_week(
)
    

    



	
set dates for this week



	

	

		
		

	
[ Top ]









	this_year  [line 236]





	

    

    
 
		void this_year(
)
    

    



	
set dates for this year



	

	

		
		

	
[ Top ]









	week_to_date  [line 140]





	

    

    
 
		void week_to_date(
)
    

    



	
set dates for this week to date



	

	

		
		

	
[ Top ]









	year_to_date  [line 244]





	

    

    
 
		void year_to_date(
)
    

    



	
set dates for current year, ending today



	

	

		
		

	
[ Top ]



		

	



        

		    

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