CronExpression::getNextRunDate( string|DateTime $currentTime = 'now', int $nth, bool $allowCurrentDate = false )

Get a next run date relative to the current date or a specific date

Contents

Description Description

Parameters Parameters

$currentTime

(Optional) (optional) Relative calculation date

Default value: 'now'

$nth

(Required) (optional) Number of matches to skip before returning a matching next run date. 0, the default, will return the current date and time if the next run date falls on the current date and time. Setting this value to 1 will skip the first match and go to the second match. Setting this value to 2 will skip the first 2 matches and so on.

$allowCurrentDate

(Optional) (optional) Set to TRUE to return the current date if it matches the cron expression

Default value: false

Top ↑

Return Return

(DateTime)

Top ↑

Source Source

File: packages/action-scheduler/lib/cron-expression/CronExpression.php 


			

			

				
					Expand full source code
					Collapse full source code
				
				
			

			


	

	

		
Top ↑


					

				
Top ↑
Uses Uses

				

					Uses
					
						

							Uses
							Description
						

					
					
												

							
								packages/action-scheduler/lib/cron-expression/CronExpression.php:
								CronExpression::getRunDate()
							
							
								
Get the next or previous run date of the expression relative to a date

									
						

											
				


							

		
					
			

				
Top ↑
Used By Used By

				

					Used By
					
						

							Used By
							Description
						

					
					
												

							
								packages/action-scheduler/lib/cron-expression/CronExpression.php:
								CronExpression::isDue()
							
							
								
Determine if the cron is due to run based on the current date or a specific date.  This method assumes that the current number of seconds are irrelevant, and should be called once per minute.

									
						

											
				


							

			

		

	

		
Top ↑
User Contributed Notes User Contributed Notes

		



	
	
			

		
 
You must log in before being able to contribute a note or feedback.