phpdoc comments inserted

qfq/AbstractBuildForm.php

 <?php
-
+/**
+ * Created by PhpStorm.
+ * User: crose
+ * Date: 1/6/16
+ * Time: 8:02 PM
+ */
 namespace qfq;
 
 use qfq;
@@ -14,10 +19,8 @@ require_once(__DIR__ . '/../qfq/exceptions/UserException.php');
 require_once(__DIR__ . '/../qfq/Database.php');
 
 /**
- * Created by PhpStorm.
- * User: crose
- * Date: 1/6/16
- * Time: 8:02 PM
+ * Class AbstractBuildForm
+ * @package qfq
  */
 abstract class AbstractBuildForm {
     protected $formSpec = array();  // copy of the loaded form

qfq/BuildFormBootstrap.php

@@ -13,8 +13,15 @@ use qfq;
 require_once(__DIR__ . '/../qfq/Constants.php');
 require_once(__DIR__ . '/../qfq/AbstractBuildForm.php');
 
+/**
+ * Class BuildFormBootstrap
+ * @package qfq
+ */
 class BuildFormBootstrap extends AbstractBuildForm {
 
+    /**
+     *
+     */
     public function fillWrap() {
         $this->wrap[WRAP_SETUP_TITLE][WRAP_SETUP_START] = '<h3>';
         $this->wrap[WRAP_SETUP_TITLE][WRAP_SETUP_END] = '</h3>';
@@ -30,10 +37,16 @@ class BuildFormBootstrap extends AbstractBuildForm {
         $this->wrap[WRAP_SETUP_NOTE][WRAP_SETUP_END] = '';
     }
 
+    /**
+     * @return string
+     */
     public function getProcessFilter() {
         return FORM_ELEMENTS_NATIVE_SUBRECORD;
     }
 
+    /**
+     * @return string
+     */
     public function doSubrecords() {
         return '';
     }
@@ -50,6 +63,12 @@ class BuildFormBootstrap extends AbstractBuildForm {
         return $html;
     }
 
+    /**
+     * @param $htmlFormElementId
+     * @param $formElement
+     * @param $value
+     * @return string
+     */
     public function wrapElement($htmlFormElementId, $formElement, $value) {
         $html = '';
 

qfq/BuildFormPlain.php

@@ -13,8 +13,15 @@ use qfq;
 require_once(__DIR__ . '/../qfq/Constants.php');
 require_once(__DIR__ . '/../qfq/AbstractBuildForm.php');
 
+/**
+ * Class BuildFormPlain
+ * @package qfq
+ */
 class BuildFormPlain extends AbstractBuildForm {
 
+    /**
+     *
+     */
     public function fillWrap() {
         $this->wrap[WRAP_SETUP_TITLE][WRAP_SETUP_START] = '<h3>';
         $this->wrap[WRAP_SETUP_TITLE][WRAP_SETUP_END] = '</h3>';
@@ -30,10 +37,16 @@ class BuildFormPlain extends AbstractBuildForm {
         $this->wrap[WRAP_SETUP_NOTE][WRAP_SETUP_END] = '';
     }
 
+    /**
+     * @return string
+     */
     public function getProcessFilter() {
         return FORM_ELEMENTS_NATIVE;
     }
 
+    /**
+     * @return string
+     */
     public function doSubrecords() {
         return $this->elements($this->store->getVar(SIP_RECORD_ID, STORE_SIP), FORM_ELEMENTS_SUBRECORD);
     }
@@ -50,6 +63,12 @@ class BuildFormPlain extends AbstractBuildForm {
         return $html;
     }
 
+    /**
+     * @param $htmlFormElementId
+     * @param $formElement
+     * @param $value
+     * @return string
+     */
     public function wrapElement($htmlFormElementId, $formElement, $value) {
         $html = '';
 

qfq/BuildFormTable.php

@@ -13,10 +13,15 @@ use qfq;
 require_once(__DIR__ . '/../qfq/Constants.php');
 require_once(__DIR__ . '/../qfq/AbstractBuildForm.php');
 
-
+/**
+ * Class BuildFormTable
+ * @package qfq
+ */
 class BuildFormTable extends AbstractBuildForm {
 
-
+    /**
+     *
+     */
     public function fillWrap() {
         $this->wrap[WRAP_SETUP_TITLE][WRAP_SETUP_START] = '<h3>';
         $this->wrap[WRAP_SETUP_TITLE][WRAP_SETUP_END] = '</h3>';
@@ -35,10 +40,16 @@ class BuildFormTable extends AbstractBuildForm {
         $this->wrap[WRAP_SETUP_SUBRECORD][WRAP_SETUP_END] = '</p>';
     }
 
+    /**
+     * @return string
+     */
     public function getProcessFilter() {
         return FORM_ELEMENTS_NATIVE;
     }
 
+    /**
+     * @return string
+     */
     public function doSubrecords() {
         return $this->elements($this->store->getVar(SIP_RECORD_ID, STORE_SIP), FORM_ELEMENTS_SUBRECORD);
     }
@@ -56,6 +67,12 @@ class BuildFormTable extends AbstractBuildForm {
         return $html;
     }
 
+    /**
+     * @param $htmlFormElementId
+     * @param $formElement
+     * @param $value
+     * @return string
+     */
     public function wrapElement($htmlFormElementId, $formElement, $value) {
         $html = '';
 

qfq/Database.php

@@ -22,7 +22,10 @@ require_once(__DIR__ . '/../qfq/exceptions/DbException.php');
 
 require_once(__DIR__ . '/../qfq/store/Store.php');
 
-
+/**
+ * Class Database
+ * @package qfq
+ */
 class Database {
 
     /**

qfq/Evaluate.php

@@ -14,7 +14,10 @@ use qfq\store\Store;
 require_once(__DIR__ . '/../qfq/store/Store.php');
 require_once(__DIR__ . '/../qfq/Database.php');
 
-
+/**
+ * Class Evaluate
+ * @package qfq
+ */
 class Evaluate {
     private $store = null;
     private $db = null;

qfq/Form.php

@@ -41,6 +41,10 @@ require_once(__DIR__ . '/../qfq/BuildFormBootstrap.php');
  *  <further individual variables>
  */
 
+/**
+ * Class Form
+ * @package qfq
+ */
 class Form {
 
     /**

qfq/FormBuildBootstrap.php

+<?php
+/**
+ * Created by PhpStorm.
+ * User: crose
+ * Date: 1/10/16
+ * Time: 4:29 PM
+ */
+
+namespace qfq;
+
+
+class FormBuildBootstrap {
+
+}
\ No newline at end of file

qfq/helper/OnArray.php

@@ -11,6 +11,10 @@ namespace qfq\helper;
 
 require_once(__DIR__ . '/../../qfq/Constants.php');
 
+/**
+ * Class OnArray
+ * @package qfq\helper
+ */
 class OnArray {
 
     /**

qfq/helper/Sanatize.php

@@ -13,7 +13,10 @@ use qfq\exceptions\CodeException;
 
 require_once(__DIR__ . '/../../qfq/Constants.php');
 
-
+/**
+ * Class Sanatize
+ * @package qfq
+ */
 class Sanatize {
 
     private function __construct() {

qfq/helper/Sort.php

-<?php
-/**
- * Created by PhpStorm.
- * User: crose
- * Date: 1/12/16
- * Time: 8:53 AM
- */
-
-namespace qfq\helper;
-
-
-class Sort {
-    /**
-     * @param array $a
-     */
-    public static function byKey(array &$a) {
-
-        $result = array();
-
-        $keys = array_keys($a);
-        sort($keys);
-        foreach ($keys as $key) {
-            $result[$key] = $a[$key];
-        }
-        $a = $result;
-
-        return;
-    }
-}
\ No newline at end of file

qfq/store/Sip.php

@@ -18,7 +18,10 @@ require_once(__DIR__ . '/../../qfq/helper/OnArray.php');
 require_once(__DIR__ . '/../../qfq/Constants.php');
 require_once(__DIR__ . '/../../qfq/exceptions/CodeException.php');
 
-
+/**
+ * Class Sip
+ * @package qfq\store
+ */
 class Sip {
 
 //    $_SESSION['fe_user_uid'] = <fe_user_uid>

qfq/store/Store.php

@@ -28,6 +28,10 @@ require_once(__DIR__ . '/../../qfq/Database.php');
  * - formElement
  */
 
+/**
+ * Class Store
+ * @package qfq\store
+ */
 class Store {
 
     /**