comodojo / extender.framework

src/Comodojo/Extender/Components/Ipc.php

Doc Comments +7 added lines

@@ -48,6 +48,9 @@ 
 
     }
 
+    /**
+     * @param integer $uid
+     */
     public function init($uid) {
 
         $this->ipc[$uid] = [];
@@ -72,6 +75,10 @@ 
 
     }
 
+    /**
+     * @param integer $uid
+     * @param string $data
+     */
     public function write($uid, $data) {
 
         $writer = $this->ipc[$uid][self::WRITER];

src/Comodojo/Extender/Orm/Entities/Schedule.php

Doc Comments +3 added lines, -3 removed lines

@@ -136,7 +136,7 @@ 
     /**
      * Get cron expression of this schedule
      *
-     * @return string
+     * @return CronExpression
      */
     public function getExpression() {
 
@@ -147,7 +147,7 @@ 
     /**
      * set cron expression for this schedule
      *
-     * @param srting $expression A cron-compatible expression
+     * @param CronExpression $expression A cron-compatible expression
      * @return Schedule
      */
     public function setExpression(CronExpression $expression) {
@@ -177,7 +177,7 @@ 
     /**
      * Set enable/disable status
      *
-     * @param bool $enable
+     * @param boolean $enabled
      * @return Schedule
      */
     public function setEnabled($enabled) {

src/Comodojo/Extender/Components/Database.php

Doc Comments +3 added lines

@@ -58,6 +58,9 @@
 
     }
 
+    /**
+     * @return \Doctrine\ORM\EntityManagerInterface
+     */
     public function getEntityManager() {
 
         if ( $this->entity_manager === null ) {

Spacing +3 added lines, -3 removed lines

@@ -84,7 +84,7 @@ 
                 false
             ];
 
-            switch (strtoupper($metadata_mode)) {
+            switch ( strtoupper($metadata_mode) ) {
 
                 case 'YAML':
                     $db_config = Setup::createYAMLMetadataConfiguration(...$config_args);
@@ -178,7 +178,7 @@ 
         $repos = $configuration->get('database-repositories');
 
         return array_map(function($repo) use ($base_folder) {
-            return substr($repo, 0, 1 ) === "/" ? $repo : "$base_folder/$repo";
+            return substr($repo, 0, 1) === "/" ? $repo : "$base_folder/$repo";
         }, $repos);
 
     }
@@ -188,7 +188,7 @@ 
         $base_folder = $configuration->get('base-path');
         $folder = $configuration->get('database-proxies');
 
-        return substr($folder, 0, 1 ) === "/" ? $folder : "$base_folder/$folder";
+        return substr($folder, 0, 1) === "/" ? $folder : "$base_folder/$folder";
 
     }
 

src/Comodojo/Extender/Queue/Manager.php

Doc Comments -1 removed lines

@@ -41,7 +41,6 @@
      *
      * @param Configuration $configuration
      * @param LoggerInterface $logger
-     * @param TasksTable $tasks
      * @param EventsManager $events
      * @param EntityManager $em
      */

Spacing +4 added lines, -4 removed lines

@@ -79,11 +79,11 @@ 
 
     public function flush(array $queue) {
 
-        $this->getEvents()->emit( new QueueEvent('flush', null, $queue) );
+        $this->getEvents()->emit(new QueueEvent('flush', null, $queue));
 
         $em = $this->getEntityManager();
 
-        foreach ($queue as $record) {
+        foreach ( $queue as $record ) {
             $em->remove($record);
         }
 
@@ -109,7 +109,7 @@ 
 
         $records = [];
 
-        foreach ($queue as $name => $request) {
+        foreach ( $queue as $name => $request ) {
             $records[] = $request instanceof Request ? $this->doAddRequest($request, $em) : false;
         }
 
@@ -121,7 +121,7 @@ 
 
     protected function doAddRequest(Request $request, EntityManager $em) {
 
-        $this->getEvents()->emit( new QueueEvent('add', $request) );
+        $this->getEvents()->emit(new QueueEvent('add', $request));
 
         $record = new Queue();
         $record->setName($request->getName())->setRequest($request);

src/Comodojo/Extender/Task/Manager.php

Doc Comments +9 added lines, -2 removed lines

@@ -75,12 +75,10 @@ 
     /**
      * Class constructor
      *
-     * @param string $manager_name
      * @param Configuration $configuration
      * @param LoggerInterface $logger
      * @param TasksTable $tasks
      * @param EventsManager $events
-     * @param EntityManager $em
      */
     public function __construct(
         Locker $locker,
@@ -413,6 +411,9 @@ 
 
     }
 
+    /**
+     * @param string $message
+     */
     private function generateSyntheticResult($uid, $message, $jid = null, $success = true) {
 
         return new Result([
@@ -437,6 +438,9 @@ 
 
     }
 
+    /**
+     * @param null|integer $pid
+     */
     private function updateTrackerSetRunning($uid, $pid) {
 
         $this->tracker->setRunning($uid, $pid);
@@ -466,6 +470,9 @@ 
 
     }
 
+    /**
+     * @param Result $result
+     */
     private function updateTrackerSetAborted($uid, $result) {
 
         $this->tracker->setAborted($uid, $result);

Spacing +4 added lines, -4 removed lines

@@ -128,9 +128,9 @@ 
 
     public function addBulk(array $requests) {
 
-        foreach ($requests as $id => $request) {
+        foreach ( $requests as $id => $request ) {
 
-            if ($request instanceof \Comodojo\Extender\Task\Request) {
+            if ( $request instanceof \Comodojo\Extender\Task\Request ) {
                 $this->add($request);
             } else {
                 $this->logger->error("Skipping invalid request with local id $id: class mismatch");
@@ -163,7 +163,7 @@ 
 
         $this->installErrorHandler();
 
-        foreach ($this->tracker->getQueued() as $uid => $request) {
+        foreach ( $this->tracker->getQueued() as $uid => $request ) {
 
             if ( $this->multithread === false ) {
 
@@ -191,7 +191,7 @@ 
 
                 if ( $this->max_childs > 0 && $this->tracker->countRunning() >= $this->max_childs ) {
 
-                    while( $this->tracker->countRunning() >= $this->max_childs ) {
+                    while ( $this->tracker->countRunning() >= $this->max_childs ) {
 
                         $this->catcher();
 

src/Comodojo/Extender/Task/Runner.php

Doc Comments +12 added lines

@@ -190,6 +190,15 @@ 
 
     }
 
+    /**
+     * @param integer $uid
+     * @param integer $puid
+     * @param string $name
+     * @param integer $jid
+     * @param string $task
+     * @param TaskParameters $parameters
+     * @param \DateTime $start
+     */
     protected function openWorklog(
         $uid,
         $puid,
@@ -221,6 +230,9 @@ 
 
     }
 
+    /**
+     * @param \DateTime $end
+     */
     protected function closeWorklog(
         $status,
         $result,

Spacing +7 added lines, -7 removed lines

@@ -88,7 +88,7 @@ 
 
             $thetask = $this->table->get($task)->getInstance($name, $parameters);
 
-            $this->events->emit( new TaskEvent('start', $thetask) );
+            $this->events->emit(new TaskEvent('start', $thetask));
 
             $pid = $thetask->getPid();
 
@@ -111,7 +111,7 @@ 
 
                 $status = Worklog::STATUS_COMPLETE;
 
-                $this->events->emit( new TaskEvent('complete', $thetask) );
+                $this->events->emit(new TaskEvent('complete', $thetask));
 
             } catch (TaskException $te) {
 
@@ -119,7 +119,7 @@ 
 
                 $result = $te->getMessage();
 
-                $this->events->emit( new TaskEvent('abort', $thetask) );
+                $this->events->emit(new TaskEvent('abort', $thetask));
 
             } catch (Exception $e) {
 
@@ -127,13 +127,13 @@ 
 
                 $result = $e->getMessage();
 
-                $this->events->emit( new TaskEvent('error', $thetask) );
+                $this->events->emit(new TaskEvent('error', $thetask));
 
             }
 
             $this->restoreErrorHandler();
 
-            $this->events->emit( new TaskEvent('stop', $thetask) );
+            $this->events->emit(new TaskEvent('stop', $thetask));
 
             $this->stopwatch->stop();
 
@@ -167,7 +167,7 @@ 
 
         ob_end_clean();
 
-        $this->events->emit( new TaskEvent(self::statusToEvent($status), $thetask, $result) );
+        $this->events->emit(new TaskEvent(self::statusToEvent($status), $thetask, $result));
 
         return $result;
 
@@ -276,7 +276,7 @@ 
 
     protected function statusToEvent($status) {
 
-        switch ($status) {
+        switch ( $status ) {
             case Worklog::STATUS_COMPLETE:
                 return 'complete';
                 break;

src/Comodojo/Extender/Task/Tracker.php

Doc Comments -1 removed lines

@@ -44,7 +44,6 @@
     /**
      * Tracker constructor
      *
-     * @param string $name
      * @param Configuration $configuration
      * @param LoggerInterface $logger
      */

src/Comodojo/Extender/Schedule/Manager.php

Doc Comments -1 removed lines

@@ -41,7 +41,6 @@
      *
      * @param Configuration $configuration
      * @param LoggerInterface $logger
-     * @param TasksTable $tasks
      * @param EventsManager $events
      * @param EntityManager $em
      */

Spacing +1 added lines, -1 removed lines

@@ -144,7 +144,7 @@
         $records = [];
         $em = $this->getEntityManager();
 
-        foreach ($schedules as $key => $schedule) {
+        foreach ( $schedules as $key => $schedule ) {
 
             try {
 

src/Comodojo/Extender/Schedule/Updater.php

Doc Comments -2 removed lines

@@ -38,9 +38,7 @@
     *
     * @param Configuration $configuration
     * @param LoggerInterface $logger
-    * @param TasksTable $tasks
     * @param EventsManager $events
-    * @param EntityManager $em
     */
     public function __construct(
         Configuration $configuration,

Indentation +8 added lines, -8 removed lines

@@ -34,14 +34,14 @@
     use EventsTrait;
 
     /**
-    * Class constructor
-    *
-    * @param Configuration $configuration
-    * @param LoggerInterface $logger
-    * @param TasksTable $tasks
-    * @param EventsManager $events
-    * @param EntityManager $em
-    */
+     * Class constructor
+     *
+     * @param Configuration $configuration
+     * @param LoggerInterface $logger
+     * @param TasksTable $tasks
+     * @param EventsManager $events
+     * @param EntityManager $em
+     */
     public function __construct(
         Configuration $configuration,
         LoggerInterface $logger,

Spacing +2 added lines, -2 removed lines

@@ -58,7 +58,7 @@ 
 
         $em = Database::init($this->getConfiguration())->getEntityManager();
 
-        foreach ($results as $result) {
+        foreach ( $results as $result ) {
 
             $id = $result->jid;
 
@@ -93,7 +93,7 @@ 
         $date = new DateTime();
         $timestamps = [];
 
-        foreach ($items as $schedule) {
+        foreach ( $items as $schedule ) {
 
             $timestamps[] = $schedule->getNextPlannedRun($date)->getTimestamp();