A probléma: Gyakori igény (riportok, lekérdezések ...), hogy olyan metodusokat futtassunk aminek futásideje nem fér bele a standard böngésző timeout értékeibe. Ez egyrészt kényelmetlen, másrészt a felhasználói élménynek sem tesz túl jót ha hosszú másodpercekig vár az eredményre. Ha ezek az igények elszaparodnak akkor többnyire valamilyen cron mechanizmushoz nyúlunk ami működő, viszont nagyon sok járulékos fejlesztéssel jár (táblák, státuszok managelés stb..).

Erre a problémára ad megoldást ez a System modul aminek segítségével direkt webes hívással háttérfolyamat indítható (mintha az a metodus CLI-n keresztül lett volna meghívva)
A megoldás egyúttal arra is eszköz, hogy ha neadjisten konténeren belül kell bármilyen tetszőleges metodust futtatni akkor innentől fogva ez CLI-n keresztül megtehető minden külön rákészülés nélkül (dev ágak létrehozása stb)

Az elv: Az, hogy PHP-n keresztül háttérfolyamat indítható nem újdonság (proc eszköztár). A modul és a metodusai ennek a lehetőségnek a minél könyebb kezelhetőségét hivatott beépíteni az eszköztárba, azzal a kis kiegésztéssel, hogy a háttérben futó hívásmechanizmus a CLI kiterjesztésen keresztül ugyanúgy ellöki a keretrendszert így ugyanazok a hívásmechanizmusok használhatóak, mint bárhol máshol.
A modul használhatához mindenképpen szükséges a CLI kiterjesztés bekapcsolása!
Ez a commit részletesen megmutatja, hogy hova mit kell betenni a támogatás érdekében: Skeleton Gitlab (Commit 8a0b3072)

Minta háttér metodus

<?php // Background process public function bgprocessorExampleMethod($param = null) { $this->logger->info("Start", [ 'method' => __METHOD__, 'args' => func_get_args() // Dynamic arguments ]); for ($x = 0; $x <= $param; $x++) { $this->logger->info("Number: ".$x); sleep(1); } $this->logger->info("Stop"); }

Háttérfolyamat indítása

<?php /* Indíts el az alábbi metodust ami a konténer standard outputjára másodpercenként küld egy sort (annyi másodperdig amennyit paraméterként atadtunk) */ $this->proc->run("@Documentation\MainAction->bgprocessorExampleMethod(300)"); $this->proc->start(); /* Az elindított folyamat processID-ja (PID) ez az amit tárolni érdemes illetve ennek segítségével kérdezhető le később a folyamat haladása */ $pID = $this->proc->getProcessId(); // pID return example: (int) 321 /* Monolog */ $this->logger->info("Start method");

Háttérfolyamat státusza

<?php /* PID érték beállítása (start után visszakapott, tárolt) */ $this->proc->setProcessId(321); /* Logikai visszatérési érték (működik vagy sem) */ $this->proc->status(); /* Futásidő (másodpercben) */ $this->proc->getRunningTime();

Háttérfolyamat leállítása

<?php /* PID érték beállítása (start után visszakapott, tárolt) */ $this->proc->setProcessId(321); $this->proc->stop(); /* Monolog */ $this->logger->info("Stop method");

Konténerben való tetszőleges metodus futtatás

:~# php /var/www/html/bin/run /proc?run="@Documentation\MainAction->bgprocessorExampleMethod(300)" GET

Twig-be ágyazható kódrész ami a megkapott running time alapján (getRunningTime method) számlálót indít

<script> // record start time var startTime; function display() { // later record end time var endTime = new Date(); // time difference in ms var timeDiff = endTime - startTime; // strip the miliseconds timeDiff /= 1000; /// #################### TWIG-BŐL ÁTADOTT VÁLTOZÓ #################### timeDiff = timeDiff + Number("{{ runningTime }}"); // timeDiff = timeDiff +840; // get seconds var seconds = Math.round(timeDiff % 60); // remove seconds from the date timeDiff = Math.floor(timeDiff / 60); // get minutes var minutes = Math.round(timeDiff % 60); // remove minutes from the date timeDiff = Math.floor(timeDiff / 60); // get hours var hours = Math.round(timeDiff % 24); // remove hours from the date timeDiff = Math.floor(timeDiff / 24); // the rest of timeDiff is number of days var days = timeDiff; formatDate = new Date(((hours * 60) * 1000) + ((minutes * 60) * 1000) + (seconds * 1000)).toISOString().slice(11, 19); // $(".time").text(hours + ":" + minutes + ":" + seconds); $("#time").html("<div class=\"spinner-border spinner-border-sm\" role=\"status\"></div> "+ formatDate); setTimeout(display, 1000); } </script> <script> startTime = new Date(); setTimeout(display, 1000); </script> <span class="badge badge-success" id="time"> <div class="spinner-border spinner-border-sm" role="status"></div> </span>