add comments to user class

diff --git a/lang/de.lang.php b/lang/de.lang.php
index 1da27257152bc31ba77a72c44258a09b746d619b..0c13536f1d35528fd9d2b8ee9cd34cd7479fd489 100644 (file)
--- a/lang/de.lang.php
+++ b/lang/de.lang.php
@@ -20,4 +20,4 @@ $lang['button.delete'] = 'Löschen';
 $lang['button.enable'] = 'Aktivieren';
 $lang['button.disable'] = 'Deaktivieren';
 $lang['domain.disabled'] = 'Deaktiviert';
-$lang['footer.copyright'] = '<a href="http://stricted.net"><strong>Domain Control Panel 3.0.0</strong>, entwickelt von <strong>stricted.net</strong></a>';
+$lang['footer.copyright'] = '<a href="http://stricted.net"><strong>Domain Control Panel {$smarty.const.DNS_VERSION}</strong>, entwickelt von <strong>stricted.net</strong></a>';

diff --git a/lang/en.lang.php b/lang/en.lang.php
index 21b696ec6de7c4a28e0632c19169f357ec18997f..2d813b755248d4a62cf7a5b77881711996d76666 100644 (file)
--- a/lang/en.lang.php
+++ b/lang/en.lang.php
@@ -20,4 +20,4 @@ $lang['button.delete'] = 'Delete';
 $lang['button.enable'] = 'Enable';
 $lang['button.disable'] = 'Disable';
 $lang['domain.disabled'] = 'Disabled';
-$lang['footer.copyright'] = '<a href="http://stricted.net"><strong>Domain Control Panel 3.0.0</strong>, developed by <strong>stricted.net</strong></a>';
+$lang['footer.copyright'] = '<a href="http://stricted.net"><strong>Domain Control Panel {$smarty.const.DNS_VERSION}</strong>, developed by <strong>stricted.net</strong></a>';

diff --git a/lib/system/DNS.class.php b/lib/system/DNS.class.php
index 66b9f52b1ec599029f53e4e947de59cf5685d0dd..e005242d5dea60f16b185fbbd34abcfe5778024e 100644 (file)
--- a/lib/system/DNS.class.php
+++ b/lib/system/DNS.class.php
@@ -1,6 +1,8 @@
 <?php
 namespace dns\system;
 
+if (!defined('DNS_VERSION')) define('DNS_VERSION', '3.0.0 Beta');
+
 /**
  * @author      Jan Altensen (Stricted)
  * @license     GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
@@ -190,8 +192,6 @@ class DNS {
                
                self::getTPL()->setTemplateDir(DNS_DIR."/templates/".$tpl);
                self::getTPL()->setCompileDir(DNS_DIR."/templates/compiled/".$tpl);
-               /*self::getTPL()->setTemplateDir(DNS_DIR."/templates");*/
-               /*self::getTPL()->setCompileDir(DNS_DIR."/templates/compiled");*/
                self::getTPL()->setPluginsDir(DNS_DIR."/lib/api/smarty/plugins");
                self::getTPL()->loadFilter('pre', 'hascontent');
                
@@ -199,11 +199,6 @@ class DNS {
                        self::getTPL()->loadFilter('output', 'trimwhitespace');
                }
                
-               /*
-               self::getTPL()->loadFilter('pre', 'url');
-               self::getTPL()->loadFilter('output', 'url');
-               */
-               
                /* assign language variables */
                self::getTPL()->assign(array(
                                "language" => $this->language,

diff --git a/lib/system/User.class.php b/lib/system/User.class.php
index 33eba57f26f2678eef6677aa1f5597989d491738..baa0d18b3b1f0209ea2a3628c9a9ed96e8ae8b98 100644 (file)
--- a/lib/system/User.class.php
+++ b/lib/system/User.class.php
@@ -24,6 +24,11 @@ class User {
                return false;
        }
        
+       /**
+        * check if user is an Admin
+        *
+        * @return      boolean
+        */
        public static function isAdmin () {
                if (DNS::getSession()->status !== null && DNS::getSession()->status == 2) {
                        return true;
@@ -32,6 +37,11 @@ class User {
                return false;
        }
        
+       /**
+        * check if user is an Reseller
+        *
+        * @return      boolean
+        */
        public static function isReseller () {
                if (self::isAdmin() === true) {
                        return true;
@@ -44,6 +54,13 @@ class User {
                return false;
        }
        
+       /**
+        * check if user has an login cookie
+        *
+        * @param       integer $userID
+        * @param       string  $hash
+        * @return      boolean
+        */
        public static function cookieLogin ($userID, $hash) {
                $query = DNS::getDB()->query("SELECT * FROM dns_user WHERE SHA1(userID) = ?", array($userID));
                $row = DNS::getDB()->fetch_array($query);
@@ -64,6 +81,14 @@ class User {
                return false;
        }
        
+       /**
+        * login the user
+        *
+        * @param       string  $username
+        * @param       string  $password
+        * @param       boolean $remember
+        * @return      boolean
+        */
        public static function login ($username, $password, $remember = false) {
                $query = DNS::getDB()->query("SELECT * FROM dns_user WHERE username = ?", array($username));
                $row = DNS::getDB()->fetch_array($query);
@@ -90,6 +115,9 @@ class User {
                return false;
        }
        
+       /**
+        * log the user out
+        */
        public static function logout () {              
                if (isset($_COOKIE["userID"])) {
                        setcookie("userID", '', time() - 3600);
@@ -103,6 +131,17 @@ class User {
                session_destroy();
        }
        
+       /**
+        * create a new user
+        *
+        * @param       string  $username
+        * @param       string  $email
+        * @param       string  $password
+        * @param       string  $password2
+        * @param       integer $reseller
+        * @param       integer $status
+        * @return      boolean
+        */
        public static function createUser ($username, $email, $password, $password2, $reseller = 0, $status = 0) {
                $res = DNS::getDB()->query("SELECT * FROM dns_user WHERE username = ?", array($username));
                $row = DNS::getDB()->fetch_array($res);
@@ -118,10 +157,24 @@ class User {
                return false;
        }
        
+       /**
+        * delete specific user
+        *
+        * @param       integer $userID
+        */
        public static function deleteUser ($userID) {
                DNS::getDB()->query("DELETE FROM dns_user WHERE userID = ?", array($userID));
        }
        
+       /**
+        * change user password
+        *
+        * @param       integer $userID
+        * @param       string  $oldpassword
+        * @param       string  $newpassword
+        * @param       string  $newpassword2
+        * @return      boolean
+        */
        public static function change_password ($userID, $oldpassword, $newpassword, $newpassword2) {
                $res = DNS::getDB()->query("SELECT * FROM dns_user WHERE userID = ?", array($userID));
                $row = DNS::getDB()->fetch_array($res);
@@ -139,6 +192,11 @@ class User {
                return false;
        }
        
+       /**
+        * generate new password salt
+        *
+        * @return      string
+        */
        public static function generateSalt() {
                $blowfishCharacters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789./';
                $maxIndex = strlen($blowfishCharacters) - 1;
@@ -152,6 +210,12 @@ class User {
                return '$2a$08$' . $salt;
        }
        
+       /**
+        * get accessible domains for given user
+        *
+        * @param       integer $userID
+        * @return      array
+        */
        public static function getAccessibleDomains ($userID = 0) {
                $data = array();