chrismichaels84 / mistletoe

src/Application/Commands/AbstractCommand.php

Doc Comments +1 added lines, -1 removed lines

@@ -127,7 +127,7 @@
      * of a mistletoe config file.
      *
      * @param $path
-     * @return mixed
+     * @return TaskPlanner
      * @throws \Exception
      */
     private function loadTaskPlanner($path)

src/Contracts/TaskBagInterface.php

Doc Comments +6 added lines

@@ -150,6 +150,9 @@ 
      */
     public function addWeekday($weekday);
 
+    /**
+     * @return TaskBag
+     */
     public function setEnvironments($environments);
 
     /**
@@ -193,6 +196,7 @@ 
 
     /**
      * @param ExpressionBuilderInterface $expressionBuilder
+     * @return void
      */
     public function setExpressionBuilder($expressionBuilder);
 
@@ -206,6 +210,7 @@ 
      * @param string $currentTime
      * @param int $nth
      * @param bool $allowCurrentDate
+     * @return void
      */
     public function getNextRunDate($currentTime = 'now', $nth = 0, $allowCurrentDate = false);
 
@@ -213,6 +218,7 @@ 
      * @param string $currentTime
      * @param int $nth
      * @param bool $allowCurrentDate
+     * @return void
      */
     public function getPreviousRunDate($currentTime = 'now', $nth = 0, $allowCurrentDate = false);
 }
\ No newline at end of file

src/CronSchedule.php

Doc Comments +17 added lines

@@ -145,6 +145,12 @@ 
      *                'hasInterval'        TRUE if a range is specified. FALSE otherwise
      *                'interval'            The interval if a range is specified.
      */
+
+    /**
+     * @param integer $rangeMin
+     * @param integer $rangeMax
+     * @param string $errorName
+     */
     final private function cronInterpret($specification, $rangeMin, $rangeMax, $namedItems, $errorName)
     {
 
@@ -476,6 +482,9 @@ 
     // Result:        FALSE if current did not overflow (reset back to the earliest possible value). TRUE if it did.
     //
 
+    /**
+     * @param integer $rangeMin
+     */
     final private function advanceItem($arrItems, $rangeMin, $rangeMax, & $current)
     {
 
@@ -654,6 +663,9 @@ 
     // Result:        FALSE if current did not overflow (reset back to the highest possible value). TRUE if it did.
     //
 
+    /**
+     * @param integer $rangeMin
+     */
     final private function recedeItem($arrItems, $rangeMin, $rangeMax, & $current)
     {
 
@@ -1027,6 +1039,11 @@ 
         return (strlen($number) == 1 ? '0' : '').$number;
     }
 
+    /**
+     * @param string $id
+     *
+     * @return boolean|string
+     */
     final private function natlangApply($id, $p1 = FALSE, $p2 = FALSE, $p3 = FALSE, $p4 = FALSE, $p5 = FALSE, $p6 = FALSE)
     {
         $txt = $this->_lang[$id];

src/ExpressionBuilder.php

Doc Comments +2 added lines, -2 removed lines

@@ -56,7 +56,7 @@ 
 
     /**
      * Builds expression from a string expression
-     * @param $string
+     * @param null|string $string
      * @return CronExpression
      */
     public function buildFrom($string)
@@ -113,7 +113,7 @@ 
 
     /**
      * Returns the part from the bag with * as default
-     * @param $part
+     * @param string $part
      * @return string
      */
     protected function getPartWithDefault($part)

src/Runners/AbstractTaskRunner.php

Doc Comments +1 added lines, -1 removed lines

@@ -39,7 +39,7 @@
     }
 
     /**
-     * @return mixed
+     * @return string
      */
     public function getCurrentTime()
     {

src/TaskBag.php

Doc Comments +8 added lines, -8 removed lines

@@ -48,7 +48,7 @@ 
 
     /**
      * TaskBag constructor.
-     * @param null $task
+     * @param string $task
      */
     public function __construct($task = null)
     {
@@ -74,7 +74,7 @@ 
     }
 
     /**
-     * @param $task
+     * @param string $task
      * @return $this
      */
     public function setTask($task)
@@ -92,7 +92,7 @@ 
     }
 
     /**
-     * @param $interval
+     * @param string $interval
      * @return $this
      */
     public function setInterval($interval)
@@ -116,7 +116,7 @@ 
     }
 
     /**
-     * @param $time
+     * @param string $time
      * @return $this
      */
     public function addTime($time)
@@ -156,7 +156,7 @@ 
     }
 
     /**
-     * @param string|int|array $month
+     * @param integer $month
      * @return $this
      */
     public function setMonth($month)
@@ -184,7 +184,7 @@ 
     }
 
     /**
-     * @param string|int|array $day
+     * @param integer $day
      * @return $this
      */
     public function setDay($day)
@@ -441,7 +441,7 @@ 
     }
 
     /**
-     * @param $date
+     * @param string $date
      * @return array
      */
     protected function parseDate($date)
@@ -456,7 +456,7 @@ 
     }
 
     /**
-     * @param $key
+     * @param string $key
      * @param $value
      * @param string $deliminator
      */

src/TaskPlanner.php

Doc Comments +7 added lines, -4 removed lines

@@ -64,7 +64,7 @@ 
     /* Schedule a full expression */
     /**
      * Add a full expression
-     * @param $expression
+     * @param string $expression
      * @return $this
      */
     public function schedule($expression)
@@ -475,7 +475,7 @@ 
     }
 
     /**
-     * @return $this
+     * @return TaskRunnerInterface
      */
     public function getTaskRunner()
     {
@@ -550,7 +550,7 @@ 
     /* Internal Methods */
     /**
      * @param string $task
-     * @param null $body
+     * @param \Closure|null $body
      */
     protected function createNewTask($task, $body = null)
     {
@@ -578,6 +578,9 @@ 
         return $this->currentTask;
     }
 
+    /**
+     * @return null|string
+     */
     private function getNextClosureIncrement()
     {
         $this->closureIncrement++;
@@ -585,7 +588,7 @@ 
     }
 
     /**
-     * @return mixed
+     * @return string
      */
     public function getCurrentTime()
     {

Unused Use Statements +1 added lines, -1 removed lines

@@ -1,7 +1,7 @@
 <?php
 namespace Mistletoe;
-use Mistletoe\Runners\GenericTaskRunner;
 use Mistletoe\Contracts\TaskRunnerInterface;
+use Mistletoe\Runners\GenericTaskRunner;
 
 /**
  * Class TaskPlanner