Revize 70a3df53

+ Re #8086
+ php refactoring and comments

website/src/Controller/HeatmapController.php

@@ -11 +11 @@
 
 class HeatmapController extends AbstractController {
     /**
+     * Map page controller.
+     *
+     * @param IOpenDataManager $manager connection to database autowired
+     *
      * @Route("/heatmap", name="heatmap")
      */
     public function index(Request $request, IOpenDataManager $manager) {
@@ -22 +26 @@
         $isSubmitted = $form->isSubmitted();
         if ($isSubmitted) {
             $dataSet = $form->getData();
+            // Chceck whether the data is valid i.e. such a collection exists
             if (false == $manager->isCollectionAvailable($dataSet->getType(), $dataSet->getDate())) {
+                // Not? Populate form with empty data
                 $dataSet = new DataSet();
             }
             $form = $this->createForm(DataSetType::class, $dataSet);
@@ -39 +45 @@
     }
 
     /**
+     * Provides specific dataset information i.e. position, number and other informations depending on data type.
+     *
+     * @param IOpenDataManager $manager connection to database autowired
+     * @param string           $name    dataset name
+     * @param string           $date    dataset date in format YYYY-mm-dd
+     * @param string           $time    dataset time, number between 0 - 23
+     *
+     * @return json with dataset information
+     *
      * @Route("heatmap/opendata/{name}/{date}/{time}", name="opendata")
      */
     public function opendata(IOpenDataManager $manager, $name = 'NONE', $date = '2020-01-01', $time = '1') {
@@ -49 +64 @@
     }
 
     /**
+     * Provides available datasets in given date.
+     *
+     * @param IOpenDataManager $manager connection to database autowired
+     * @param string           $date    dataset date in format YYYY-mm-dd
+     *
+     * @return json with available datasets names
+     *
      * @Route("heatmap/available/{date}", name="available")
      */
     public function availableDatasets(IOpenDataManager $manager, $date = '2020-01-01') {
@@ -56 +78 @@
     }
 
     /**
+     * Provides dates with at least one available dataset.
+     *
+     * @param IOpenDataManager $manager connection to database
+     *
+     * @return json with dates with at least one available dataset in format YYYY-mm-dd
+     *
      * @Route("heatmap/dates", name="dates")
      */
     public function datesWithAvailableDatasets(IOpenDataManager $manager) {
@@ -63 +91 @@
     }
 
     /**
+     * Provides for dataset with given name all locations.
+     *
+     * @param IOpenDataManager $manager connection to database autowired
+     * @param string           $name    dataset name
+     *
+     * @return json with all locations for dataset with given name as [x => lat, y => lng]
+     *
      * @Route("heatmap/positions/{name}", name="positions")
      */
     public function dataSourcePoistions(IOpenDataManager $manager, $name = 'NONE') {
@@ -70 +105 @@
     }
 
     /**
+     * Provides last available date for each available dataset type.
+     *
+     * @param IOpenDataManager $manager connection to database autowired
+     *
+     * @return json with last available date for each available dataset type as [collection-type-name => YYYY-mm-dd]
+     *
      * @Route("heatmap/last", name="last")
      */
     public function lastAvailableCollections(IOpenDataManager $manager) {