Cleanup comments, tweak lock file creation

Author: trentrichardson

Diff for: src/Shell/SchedulerShell.php

@@ -43,43 +43,42 @@
 
 class SchedulerShell extends Shell{
 
-	public $tasks = [];
-
-/**
- * The array of scheduled tasks.
- */
+	/**
+	 * The array of scheduled tasks.
+	 */
 	private $schedule = [];
 
-/**
- * The key which you set Configure::read() for your jobs
- */
+	/**
+	 * The key which you set Configure::read() for your jobs
+	 */
 	private $configKey = 'SchedulerShell';
 
-/**
- * The path where the store file is placed. null will store in Config folder
- */
-	private $storePath = null;
+	/**
+	 * The path where the store file is placed. null will store in Config folder
+	 */
+	private $storePath = TMP;
 
-/**
- * The file name of the store
- */
+	/**
+	 * The file name of the store
+	 */
 	private $storeFile = 'cron_scheduler.json';
 
-/**
- * The number of seconds to wait before running a parallel SchedulerShell
- */
-	private $processingTimeout = 600;
+	/**
+	 * The file name of the processing flag file (indicates that existing job is running)
+	 */
+	private $processingFlagFile = '.cron_scheduler_processing_flag';
 
-/**
- * The main method which you want to schedule for the most frequent interval
- */
+	/**
+	 * The number of seconds to wait before running a parallel SchedulerShell
+	 */
+	private $processingTimeout = 600;
 
-/**
- * main function.
- *
- * @access public
- * @return void
- */
+	/**
+	 * The main method which you want to schedule for the most frequent interval
+	 *
+	 * @access public
+	 * @return void
+	 */
 	public function main() {
 
 		// read in the config
@@ -93,6 +92,10 @@ public function main() {
 				$this->storeFile = $config['storeFile'];
 			}
 
+			if (isset($config['processingFlagFile'])) {
+				$this->processingFlagFile = $config['processingFlagFile'];
+			}
+
 			if (isset($config['processingTimeout'])) {
 				$this->processingTimeout = $config['processingTimeout'];
 			}
@@ -110,17 +113,17 @@ public function main() {
 		$this->runjobs();
 	}
 
-/**
- * The connect method adds tasks to the schedule
- *
- * @access public
- * @param string $name - unique name for this job, isn't bound to anything and doesn't matter what it is
- * @param string $interval - date interval string "PT5M" (every 5 min) or a relative Date string "next day 10:00"
- * @param string $task - name of the cake task to call
- * @param string $action - name of the method within the task to call
- * @param array  $pass - array of arguments to pass to the method
- * @return void
- */
+	/**
+	 * The connect method adds tasks to the schedule
+	 *
+	 * @access public
+	 * @param string $name - unique name for this job, isn't bound to anything and doesn't matter what it is
+	 * @param string $interval - date interval string "PT5M" (every 5 min) or a relative Date string "next day 10:00"
+	 * @param string $task - name of the cake task to call
+	 * @param string $action - name of the method within the task to call
+	 * @param array  $pass - array of arguments to pass to the method
+	 * @return void
+	 */
 	public function connect($name, $interval, $task, $action = 'main', $pass = []) {
 		$this->schedule[$name] = [
 			'name' => $name,
@@ -133,18 +136,18 @@ public function connect($name, $interval, $task, $action = 'main', $pass = []) {
 		];
 	}
 
-/**
- * Process the tasks when they need to run
- *
- * @access private
- * @return void
- */
+	/**
+	 * Process the tasks when they need to run
+	 *
+	 * @access private
+	 * @return void
+	 */
 	private function runjobs() {
-		$dir = new Folder(TMP);
+		$dir = new Folder($this->storePath);
 
 		// set processing flag so function takes place only once at any given time
-		$processing = count($dir->find('\.scheduler_running_flag'));
-		$processingFlag = new File($dir->slashTerm($dir->pwd()) . '.scheduler_running_flag');
+		$processingFlag = new File($dir->slashTerm($dir->pwd()) . $this->processingFlagFile, false);
+		$processing = $processingFlag->exists();
 
 		if ($processing && (time() - $processingFlag->lastChange()) < $this->processingTimeout) {
 			$this->out("Scheduler already running! Exiting.");
@@ -154,10 +157,6 @@ private function runjobs() {
 			$processingFlag->create();
 		}
 
-		if (!$this->storePath) {
-			$this->storePath = TMP;
-		}
-
 		// look for a store of the previous run
 		$store = "";
 		$storeFilePath = $this->storePath.$this->storeFile;