From 4a553914ddcbae2f1f602f943883c3cf4f412f0b Mon Sep 17 00:00:00 2001
From: Ad Schellevis <ad@opnsense.org>
Date: Wed, 21 Jan 2015 22:05:14 +0100
Subject: [PATCH] work in progress new frontend model, setup basic mvc
 structure. Lots of work to do here..

---
 .../OPNsense/Base/ControllerBase.php          | 32 +++++++++++++
 .../OPNsense/Base/IndexController.php         | 31 +++++++++++++
 .../OPNsense/Core/IndexController.php         | 30 +++++++++++++
 .../OPNsense/Sample/IndexController.php       | 29 ++++++++++++
 .../OPNsense/Sample/PageController.php        | 29 ++++++++++++
 .../mvc/app/models/OPNsense/Base/Model.php    | 45 +++++++++++++++++++
 .../mvc/app/models/OPNsense/Sample/Sample.php | 36 +++++++++++++--
 7 files changed, 229 insertions(+), 3 deletions(-)
 create mode 100644 src/opnsense/mvc/app/models/OPNsense/Base/Model.php

diff --git a/src/opnsense/mvc/app/controllers/OPNsense/Base/ControllerBase.php b/src/opnsense/mvc/app/controllers/OPNsense/Base/ControllerBase.php
index 432e51df5..fdfe7ad74 100644
--- a/src/opnsense/mvc/app/controllers/OPNsense/Base/ControllerBase.php
+++ b/src/opnsense/mvc/app/controllers/OPNsense/Base/ControllerBase.php
@@ -1,4 +1,36 @@
 <?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.
+
+    --------------------------------------------------------------------------------------
+    package : Frontend Controller Base
+    function: implements core controller for OPNsense framework
+
+*/
+
 namespace OPNsense\Base;
 
 use Phalcon\Mvc\Controller;
diff --git a/src/opnsense/mvc/app/controllers/OPNsense/Base/IndexController.php b/src/opnsense/mvc/app/controllers/OPNsense/Base/IndexController.php
index e13e6244b..77426a667 100644
--- a/src/opnsense/mvc/app/controllers/OPNsense/Base/IndexController.php
+++ b/src/opnsense/mvc/app/controllers/OPNsense/Base/IndexController.php
@@ -1,4 +1,35 @@
 <?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.
+
+    --------------------------------------------------------------------------------------
+    package : Frontend Index Controller
+    function: implements base index controller, shared functionality
+
+*/
 namespace OPNsense\Base;
 
 class IndexController extends \OPNsense\Base\ControllerBase
diff --git a/src/opnsense/mvc/app/controllers/OPNsense/Core/IndexController.php b/src/opnsense/mvc/app/controllers/OPNsense/Core/IndexController.php
index 0fd7897fe..b04a6fa82 100644
--- a/src/opnsense/mvc/app/controllers/OPNsense/Core/IndexController.php
+++ b/src/opnsense/mvc/app/controllers/OPNsense/Core/IndexController.php
@@ -1,4 +1,34 @@
 <?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.
+
+    --------------------------------------------------------------------------------------
+    package : Index controller for core package
+
+*/
 namespace OPNsense\Core;
 
 class IndexController extends \OPNsense\Base\IndexController
diff --git a/src/opnsense/mvc/app/controllers/OPNsense/Sample/IndexController.php b/src/opnsense/mvc/app/controllers/OPNsense/Sample/IndexController.php
index 09ac99a64..f905ddcf1 100644
--- a/src/opnsense/mvc/app/controllers/OPNsense/Sample/IndexController.php
+++ b/src/opnsense/mvc/app/controllers/OPNsense/Sample/IndexController.php
@@ -1,4 +1,33 @@
 <?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;
 
diff --git a/src/opnsense/mvc/app/controllers/OPNsense/Sample/PageController.php b/src/opnsense/mvc/app/controllers/OPNsense/Sample/PageController.php
index 9dd773568..525b3cdb0 100644
--- a/src/opnsense/mvc/app/controllers/OPNsense/Sample/PageController.php
+++ b/src/opnsense/mvc/app/controllers/OPNsense/Sample/PageController.php
@@ -1,4 +1,33 @@
 <?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;
 
 use Phalcon\Mvc\Controller;
diff --git a/src/opnsense/mvc/app/models/OPNsense/Base/Model.php b/src/opnsense/mvc/app/models/OPNsense/Base/Model.php
new file mode 100644
index 000000000..7a5c0a117
--- /dev/null
+++ b/src/opnsense/mvc/app/models/OPNsense/Base/Model.php
@@ -0,0 +1,45 @@
+<?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.
+
+    --------------------------------------------------------------------------------------
+    package : Frontend Model Base
+    function: implements base model to bind config and definition to object
+
+*/
+
+namespace OPNsense\Base;
+
+abstract class BaseModel
+{
+
+    public function __construct()
+    {
+        $class_info = new \ReflectionClass($this);
+        $class_info->getFileName();
+    }
+
+}
\ No newline at end of file
diff --git a/src/opnsense/mvc/app/models/OPNsense/Sample/Sample.php b/src/opnsense/mvc/app/models/OPNsense/Sample/Sample.php
index d45d0ee02..e0fdb9b65 100644
--- a/src/opnsense/mvc/app/models/OPNsense/Sample/Sample.php
+++ b/src/opnsense/mvc/app/models/OPNsense/Sample/Sample.php
@@ -1,9 +1,39 @@
 <?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;
 
-class Sample
-{
-    public $title = "xx";
+use OPNsense\Base\BaseModel;
 
+class Sample extends BaseModel
+{
+    public $title = "123456";
 
 }
\ No newline at end of file