Variable 'cityMode' is not available here + added initial documentation file

for all used tasks.

Signed-off-by: Roland Haeder <roland@mxchange.org>

diff --git a/application/city/main/filter/city_daemon/class_CityDaemonInitializationFilter.php b/application/city/main/filter/city_daemon/class_CityDaemonInitializationFilter.php
index 108b6c5a4e21f4bc5291334a575e35bb8a64f20e..2a64d19f0bd6b9d5d89fe8c203be84c6c4979f34 100644 (file)
--- a/application/city/main/filter/city_daemon/class_CityDaemonInitializationFilter.php
+++ b/application/city/main/filter/city_daemon/class_CityDaemonInitializationFilter.php
@@ -60,11 +60,11 @@ class CityDaemonInitializationFilter extends BaseCityFilter implements Filterabl
                } catch (ClassNotFoundException $e) {
                        // This exception means, the city mode is invalid.
                        // @TODO Can we rewrite this to app_exit() ?
-                       $this->debugBackTrace('[' . __METHOD__ . ':' . __LINE__ . ']:  city mode ' . $cityMode . ' is invalid.');
+                       $this->debugBackTrace('[' . __METHOD__ . ':' . __LINE__ . ']:  City daemon could not be initialized: ' . $e->getMessage());
                }
 
                // Debug message
-               /* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE-INIT-FILTER[' . __METHOD__ . ':' . __LINE__ . ']: City daemon ' . $cityMode . ' has been added to registry.');
+               /* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE-INIT-FILTER[' . __METHOD__ . ':' . __LINE__ . ']: City daemon has been added to registry.');
        }
 }
 

diff --git a/application/city/main/filter/task/city_daemon/class_CityDaemonTaskHandlerInitializerFilter.php b/application/city/main/filter/task/city_daemon/class_CityDaemonTaskHandlerInitializerFilter.php
index 31f284832a5f4c9de6e92a2720628fa351662c63..b2d3e4c15470c7416b6ff049e949e4d497767330 100644 (file)
--- a/application/city/main/filter/task/city_daemon/class_CityDaemonTaskHandlerInitializerFilter.php
+++ b/application/city/main/filter/task/city_daemon/class_CityDaemonTaskHandlerInitializerFilter.php
@@ -64,7 +64,7 @@ class CityDaemonTaskHandlerInitializerFilter extends BaseCityFilter implements F
                // Put the task handler in registry
                Registry::getRegistry()->addInstance('task_handler', $handlerInstance);
 
-               // Prepare a map-expanding task
+               // Prepare a city map expansion task
                $taskInstance = ObjectFactory::createObjectByConfiguredName('city_daemon_map_expander_task_class');
 
                // Register it

diff --git a/docs/tasks.txt b/docs/tasks.txt
new file mode 100644 (file)
index 0000000..364a88d
--- /dev/null
+++ b/docs/tasks.txt
@@ -0,0 +1,28 @@
+The following tasks are used:
+-----------------------------
+
+Name          | Description
+--------------+--------------------------------
+ map_expander | Expands the city map if needed
+--------------+--------------------------------
+
+- - - - -
+
+Task 'map_expander':
+--------------------
+
+The task is responsible for expanding the city map around outer-most zones and
+roads. It also initializes the map at first startup (if the city has been
+"founded").
+
+For doing this, around the outer-most zones/roads the map is expanded for a
+configurable value (default: 100). After the first road has been constructed,
+the map is not expanded directly as this would cause permanent expansion of it
+which leads to more system load.
+
+Instead, the map is being expanded if the outer-most zone/road has come to
+close ("city border threashold") to the border (default: 10). If that value
+has reached or surpassed (to close, e.g. by constructing a long road) the map
+is expanded (default: 10+100 from outer-most).
+
+[EOF]