PHPDocBlöcke überarbeitet
authorMarkus Bröker<broeker.markus@googlemail.com>
Sat, 19 Dec 2015 02:32:12 +0100
changeset 31 3a5ee3ba6006
parent 30 5751ca5a55c0
child 32 067edf3db6d7
PHPDocBlöcke überarbeitet
classes/bfw/Configuration.php
classes/bfw/Dispatcher.php
classes/bfw/Request.php
classes/bfw/Response.php
classes/bfw/core/Controller.php
classes/bfw/core/ReadonlyEntity.php
classes/bfw/core/View.php
classes/bfw/database/DBInterface.php
classes/bfw/database/Database.php
classes/bfw/entities/TGroup.php
classes/bfw/entities/TUser.php
classes/bfw/mvc/controller/BenutzerverwaltungController.php
classes/bfw/mvc/controller/DokumentationController.php
classes/bfw/mvc/controller/ErrorController.php
classes/bfw/mvc/controller/HomeController.php
classes/bfw/mvc/model/benutzerverwaltung/DataModel.php
classes/bfw/mvc/model/dokumentation/DataModel.php
classes/bfw/mvc/model/error/DataModel.php
classes/bfw/mvc/model/home/DataModel.php
--- a/classes/bfw/Configuration.php
+++ b/classes/bfw/Configuration.php
@@ -9,6 +9,9 @@
 
 use PDO;
 
+/**
+ * Class Configuration
+ */
 class Configuration {
 
     /**
--- a/classes/bfw/Dispatcher.php
+++ b/classes/bfw/Dispatcher.php
@@ -11,6 +11,9 @@
 use ReflectionClass;
 use ReflectionException;
 
+/**
+ * Class Dispatcher
+ */
 class Dispatcher {
 
     private $request;
--- a/classes/bfw/Request.php
+++ b/classes/bfw/Request.php
@@ -14,8 +14,15 @@
  */
 class Request {
 
+    /**
+     *
+     * @var Logger
+     */
     protected $logger = null;
 
+    /**
+     * Default Constructor
+     */
     public function __construct() {
         $this->logger = Logger::getLogger('__CLASS__');
 
@@ -25,7 +32,6 @@
     /**
      * <b>Initialisiert die Session für das jeweilige Projekt</b>
      *
-     *
      */
     public function initSession() {
         if (!isset($_SESSION['prefix'])) {
@@ -68,6 +74,7 @@
      *
      * @param $param
      * @param string $default
+     *
      * @return string
      */
     public static function session($param, $default = '') {
@@ -86,6 +93,7 @@
      *
      * @param $param
      * @param string $default
+     *
      * @return string
      */
     public static function getParameter($param, $default = '') {
@@ -182,6 +190,7 @@
      * filter_input kann nur mit GET/POST umgehen, diese Methode mit Allem.
      *
      * @param string $param
+     *
      * @return string|array
      */
     public static function filter($param) {
@@ -202,6 +211,7 @@
      *
      * @param $key
      * @param $value
+     * @param $storage
      */
     public function setKey($key, $value, $storage = null) {
         if ($storage != null) {
@@ -232,6 +242,8 @@
      * <b>Liefert einen gefilterten GET-Wert</b>
      *
      * @param $param
+     * @param $default
+     *
      * @return string
      */
     public function get($param, $default = '') {
@@ -248,6 +260,8 @@
      * <b>Liefert einen gefilterten POST-Wert</b>
      *
      * @param $param
+     * @param $default
+     *
      * @return string
      */
     public function post($param, $default = '') {
--- a/classes/bfw/Response.php
+++ b/classes/bfw/Response.php
@@ -7,6 +7,9 @@
 
 namespace bfw;
 
+/**
+ * Class Response
+ */
 class Response {
 
     private $headers;
--- a/classes/bfw/core/Controller.php
+++ b/classes/bfw/core/Controller.php
@@ -12,7 +12,7 @@
 use Logger;
 
 /**
- *
+ * Class Controller
  */
 abstract class Controller {
 
--- a/classes/bfw/core/ReadonlyEntity.php
+++ b/classes/bfw/core/ReadonlyEntity.php
@@ -8,7 +8,7 @@
 namespace bfw\core;
 
 /**
- * Class ReadonlyView
+ * Class ReadonlyEntity
  *
  * @method string getId()
  */
--- a/classes/bfw/core/View.php
+++ b/classes/bfw/core/View.php
@@ -11,6 +11,9 @@
 
 require_once 'library/smarty/libs/Smarty.class.php';
 
+/**
+ * Class View
+ */
 class View {
 
     /**
--- a/classes/bfw/database/DBInterface.php
+++ b/classes/bfw/database/DBInterface.php
@@ -7,6 +7,9 @@
 
 namespace bfw\database;
 
+/**
+ * Interface DBInterface
+ */
 interface DBInterface {
     /* fetch methods */
 
--- a/classes/bfw/database/Database.php
+++ b/classes/bfw/database/Database.php
@@ -12,6 +12,9 @@
 use PDO;
 use PDOException;
 
+/**
+ * Class Database
+ */
 class Database implements DBInterface {
 
     private static $handle = null;
--- a/classes/bfw/entities/TGroup.php
+++ b/classes/bfw/entities/TGroup.php
@@ -7,6 +7,9 @@
 
 namespace bfw\entities;
 
+/**
+ * Class TGroup
+ */
 class TGroup extends \bfw\entities\core\TGroup {
 
     const SYSTEM = 1;
--- a/classes/bfw/entities/TUser.php
+++ b/classes/bfw/entities/TUser.php
@@ -8,7 +8,7 @@
 namespace bfw\entities;
 
 /**
- * 
+ * Class TUser
  */
 class TUser extends \bfw\entities\core\TUser {
 
--- a/classes/bfw/mvc/controller/BenutzerverwaltungController.php
+++ b/classes/bfw/mvc/controller/BenutzerverwaltungController.php
@@ -11,6 +11,9 @@
 use bfw\Dispatcher;
 use bfw\entities\TGroup;
 
+/**
+ * Class BenutzerverwaltungsController
+ */
 class BenutzerverwaltungController extends Controller {
 
     /**
--- a/classes/bfw/mvc/controller/DokumentationController.php
+++ b/classes/bfw/mvc/controller/DokumentationController.php
@@ -8,7 +8,6 @@
 namespace bfw\mvc\controller;
 
 use bfw\core\Controller;
-use bfw\mvc\model\TUser;
 
 /**
  * Class DokumentationController
--- a/classes/bfw/mvc/controller/ErrorController.php
+++ b/classes/bfw/mvc/controller/ErrorController.php
@@ -10,7 +10,7 @@
 use bfw\core\Controller;
 
 /**
- * Copyright(C) 2015 Markus Bröker<broeker.markus@googlemail.com>
+ * Class ErrorController
  *
  */
 class ErrorController extends Controller {
--- a/classes/bfw/mvc/controller/HomeController.php
+++ b/classes/bfw/mvc/controller/HomeController.php
@@ -9,6 +9,9 @@
 
 use bfw\core\Controller;
 
+/**
+ * Class HomeController
+ */
 class HomeController extends Controller {
 
     /**
--- a/classes/bfw/mvc/model/benutzerverwaltung/DataModel.php
+++ b/classes/bfw/mvc/model/benutzerverwaltung/DataModel.php
@@ -9,6 +9,9 @@
 
 use bfw\core\Model;
 
+/**
+ * Class DataModel
+ */
 class DataModel extends Model {
     
 }
--- a/classes/bfw/mvc/model/dokumentation/DataModel.php
+++ b/classes/bfw/mvc/model/dokumentation/DataModel.php
@@ -9,6 +9,9 @@
 
 use bfw\core\Model;
 
+/**
+ * Class DataModel
+ */
 class DataModel extends Model {
     
 }
--- a/classes/bfw/mvc/model/error/DataModel.php
+++ b/classes/bfw/mvc/model/error/DataModel.php
@@ -9,6 +9,9 @@
 
 use bfw\core\Model;
 
+/**
+ * Class DataModel
+ */
 class DataModel extends Model {
     
 }
--- a/classes/bfw/mvc/model/home/DataModel.php
+++ b/classes/bfw/mvc/model/home/DataModel.php
@@ -9,6 +9,9 @@
 
 use bfw\core\Model;
 
+/**
+ * Class DataModel
+ */
 class DataModel extends Model {
     
 }