minor code cleanups and first (simple) ideas for a (rest) api implementation.

src/opnsense/mvc/app/controllers/OPNsense/Base/ApiControllerBase.php

+<?php
+/**
+ *    Copyright (C) 2015 Deciso B.V.
+ *
+ *    All rights reserved.
+ *
+ *    Redistribution and use in source and binary forms, with or without
+ *    modification, are permitted provided that the following conditions are met:
+ *
+ *    1. Redistributions of source code must retain the above copyright notice,
+ *       this list of conditions and the following disclaimer.
+ *
+ *    2. Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in the
+ *       documentation and/or other materials provided with the distribution.
+ *
+ *    THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
+ *    INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
+ *    AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ *    AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
+ *    OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ *    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ *    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ *    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ *    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ *    POSSIBILITY OF SUCH DAMAGE.
+ *
+ */
+namespace OPNsense\Base;
+
+use Phalcon\Mvc\Controller;
+
+/**
+ * Class ApiControllerBase, inherit this class to implement API calls
+ * @package OPNsense\Base
+ */
+class ApiControllerBase extends Controller
+{
+    /**
+     * Initialize API controller
+     */
+    public function initialize()
+    {
+        // disable view processing
+        $this->view->disable();
+    }
+
+    /**
+     * before routing event
+     * @param Event $event
+     * @param Dispatcher $dispatcher
+     */
+    public function beforeExecuteRoute(Event $event, Dispatcher $dispatcher)
+    {
+
+        //$auth = $this->session->get('auth');
+    }
+
+        /**
+     * process API results, serialize return data to json.
+     * @param $dispatcher
+     * @return string json data
+     */
+    protected function afterExecuteRoute($dispatcher)
+    {
+        // exit when reponse headers are already set
+        if ($this->response->getHeaders()->get("Status") != null) {
+            return false;
+        } else {
+            // process response, serialize to json object
+            $data = $dispatcher->getReturnedValue();
+            if (is_array($data)) {
+                $this->response->setContentType('application/json', 'UTF-8');
+                echo json_encode($data) ;
+            }
+        }
+
+        return true;
+    }
+}

src/opnsense/mvc/app/controllers/OPNsense/Sample/Api/IndexController.php

+<?php
+/**
+ *    Copyright (C) 2015 Deciso B.V.
+ *
+ *    All rights reserved.
+ *
+ *    Redistribution and use in source and binary forms, with or without
+ *    modification, are permitted provided that the following conditions are met:
+ *
+ *    1. Redistributions of source code must retain the above copyright notice,
+ *       this list of conditions and the following disclaimer.
+ *
+ *    2. Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in the
+ *       documentation and/or other materials provided with the distribution.
+ *
+ *    THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
+ *    INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
+ *    AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ *    AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
+ *    OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ *    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ *    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ *    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ *    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ *    POSSIBILITY OF SUCH DAMAGE.
+ *
+ */
+namespace OPNsense\Sample\Api;
+
+use \OPNsense\Base\ApiControllerBase;
+
+/**
+ * Class IndexController
+ * @package OPNsense\Sample
+ */
+class IndexController extends ApiControllerBase
+{
+    /**
+     * @return array
+     */
+    public function indexAction()
+    {
+        return array("message" => "test");
+    }
+}

src/opnsense/mvc/app/models/OPNsense/Base/BaseModel.php

@@ -355,7 +355,6 @@ abstract class BaseModel
 
     /**
      * find node by reference starting at the root node
-     * @param BaseField $node source node
      * @param string $reference node reference (point separated "node.subnode.subsubnode")
      * @return BaseField|null field node by reference (or null if not found)
      */

src/opnsense/mvc/app/models/OPNsense/Base/FieldTypes/BaseField.php

@@ -345,5 +345,4 @@ abstract class BaseField
         $parts = explode("\\", get_class($this));
         return $parts[count($parts)-1];
     }
-
 }

src/opnsense/mvc/app/models/OPNsense/Core/Backend.php

@@ -49,7 +49,7 @@ class Backend
 
     /**
      * send event to backend
-     * @param $event event string
+     * @param string $event event string
      * @param int $timeout timeout in seconds
      * @return string
      * @throws \Exception