Style convention applied (incomplete), pre/post filters added for form handler

[shipsimu.git] / inc / classes / main / controller / class_BaseController.php

diff --git a/inc/classes/main/controller/class_BaseController.php b/inc/classes/main/controller/class_BaseController.php
index 607e042af3541c0177bf87c042d6ee5c40ba3e23..a2bf81158444abaea1aef399342006ba2683eee4 100644 (file)
--- a/inc/classes/main/controller/class_BaseController.php
+++ b/inc/classes/main/controller/class_BaseController.php
@@ -1,6 +1,8 @@
 <?php
 /**
 <?php
 /**

- * A generic controller class
+ * A generic controller class. You should extend this base class if you want to
+ * write your own controller. You get the advantage that you can use the pre and
+ * post filters.

  *
  * @author             Roland Haeder <webmaster@ship-simu.org>
  * @version            0.0.0
  *
  * @author             Roland Haeder <webmaster@ship-simu.org>
  * @version            0.0.0


@@ -58,7 +60,6 @@ class BaseController extends BaseFrameworkSystem {
        /**
         * Getter for a command resolver instance
         *
        /**
         * Getter for a command resolver instance
         *

-        * @

         * @return      $resolverInstance       An instance of a command resolver class
         */
        public final function getResolverInstance () {
         * @return      $resolverInstance       An instance of a command resolver class
         */
        public final function getResolverInstance () {


@@ -105,6 +106,7 @@ class BaseController extends BaseFrameworkSystem {
         * @return      void
         */
        protected function executePreFilters (Requestable $requestInstance, Responseable $responseInstance) {
         * @return      void
         */
        protected function executePreFilters (Requestable $requestInstance, Responseable $responseInstance) {

+               // Execute all pre filters

                $this->preFilterChain->processFilters($requestInstance, $responseInstance);
        }
 
                $this->preFilterChain->processFilters($requestInstance, $responseInstance);
        }
 


@@ -116,6 +118,7 @@ class BaseController extends BaseFrameworkSystem {
         * @return      void
         */
        protected function executePostFilters (Requestable $requestInstance, Responseable $responseInstance) {
         * @return      void
         */
        protected function executePostFilters (Requestable $requestInstance, Responseable $responseInstance) {

+               // Execute all post filters

                $this->postFilterChain->processFilters($requestInstance, $responseInstance);
        }
 }
                $this->postFilterChain->processFilters($requestInstance, $responseInstance);
        }
 }