MPOS / php-mpos

include/classes/base.class.php

Doc Comments +4 added lines

@@ -43,6 +43,10 @@
   public function setSmarty($smarty) {
     $this->smarty = $smarty;
   }
+
+  /**
+   * @param User $user
+   */
   public function setUser($user) {
     $this->user = $user;
   }

include/classes/bitcoin.class.php

Doc Comments +2 added lines, -8 removed lines

@@ -38,7 +38,7 @@ 
    * Convert a hex string into a (big) integer
    *
    * @param string $hex
-   * @return int
+   * @return string
    * @access private
    */
   private function decodeHex($hex) {
@@ -252,14 +252,8 @@ 
    * 	Server password
    * @param string $address
    * 	Server hostname or IP address
-   * @param mixed $port
-   * 	Server port (string or integer)
    * @param string $certificate_path
    * 	Path on the local filesystem to server's PEM certificate (ignored if $scheme != "https")
-   * @param integer $debug_level
-   * 	0 (default) = no debugging;
-   * 	1 = echo JSON-RPC messages received to stdout;
-   * 	2 = log transmitted messages also
    * @return jsonrpc_client
    * @access public
    * @throws BitcoinClientException
@@ -284,7 +278,7 @@ 
    * The check is done by calling the server's getinfo() method and checking
    * for a fault.
    *
-   * @return mixed boolean TRUE if successful, or a fault string otherwise
+   * @return string|boolean boolean TRUE if successful, or a fault string otherwise
    * @access public
    * @throws none
    */

include/classes/csrftoken.class.php

Doc Comments +4 added lines, -1 removed lines

@@ -19,7 +19,7 @@ 
    * Returns +1 min and +1 hour rollovers hashes
    * @param string $user user or IP/host address
    * @param string $type page name or other unique per-page identifier
-   * @return array 1min and 1hour hashes
+   * @return string[] 1min and 1hour hashes
    */
   public function checkAdditional($user, $type) {
     $date = date('m/d/y/H/i');
@@ -89,6 +89,9 @@ 
     return $string;
   }
   
+  /**
+   * @param string $string
+   */
   private function getHash($string) {
     return hash('sha256', $this->salty.$string.$this->salt);
   }

include/classes/debug.class.php

Doc Comments -4 removed lines

@@ -68,11 +68,7 @@
     /**
      * We fill our data array here
      * @param string $msg Debug Message
-     * @param string $file [optional] File name
-     * @param integer $line [optional] Line inside the $file
      * @param integer $debug [optional] Debugging level, default 1
-     * @param string $class [optional] Class this is called from
-     * @param string $method [optional] Method this is called from
      * @return none
      */
     function append($msg, $debug=1) {

include/classes/template.class.php

Doc Comments +3 added lines

@@ -137,6 +137,9 @@
 
   }
 
+  /**
+   * @param string $path
+   */
   private function _getTemplatesTreeRecursive($path) {
     if( !is_dir($path) ) {
       return preg_match("/\.tpl$/", $path);

include/classes/transaction.class.php

Doc Comments +4 added lines

@@ -394,6 +394,10 @@
   public function createDebitAPRecord($account_id, $coin_address, $amount) {
     return $this->createDebitRecord($account_id, $coin_address, $amount, 'Debit_AP');
   }
+
+  /**
+   * @param string $type
+   */
   private function createDebitRecord($account_id, $coin_address, $amount, $type) {
     // Calculate and deduct txfee from amount
     $type == 'Debit_MP' ? $txfee = $this->config['txfee_manual'] : $txfee = $this->config['txfee_auto'];

include/classes/user.class.php

Doc Comments +30 added lines, -1 removed lines

@@ -34,6 +34,10 @@ 
   public function getUserNameAnon($id) {
     return $this->getSingle($id, 'is_anonymous', 'id');
   }
+
+  /**
+   * @param string $email
+   */
   public function getUserNameByEmail($email) {
     return $this->getSingle($email, 'username', 'email', 's');
   }
@@ -46,12 +50,20 @@ 
   public function getUserEmail($username, $lower=false) {
     return $this->getSingle($username, 'email', 'username', 's', $lower);
   }
+
+  /**
+   * @param integer $id
+   */
   public function getUserEmailById($id) {
     return $this->getSingle($id, 'email', 'id', 'i');
   }
   public function getUserPasswordHashById($id) {
     return $this->getSingle($id, 'pass', 'id', 'i');
   }
+
+  /**
+   * @param integer $id
+   */
   public function getUserPinHashById($id) {
     return $this->getSingle($id, 'pin', 'id', 'i');
   }
@@ -73,6 +85,10 @@ 
   public function getLastLogin($id) {
     return $this->getSingle($id, 'last_login', 'id');
   }
+
+  /**
+   * @param string $email
+   */
   public function getEmail($email) {
     return $this->getSingle($email, 'email', 'email', 's');
   }
@@ -99,6 +115,10 @@ 
     $this->log->log("warn", $this->getUserName($id)." changed no_fees to ".$this->isNoFee($id));
     return $this->updateSingle($id, $field);
   }
+
+  /**
+   * @param integer $value
+   */
   public function setLocked($id, $value) {
     $field = array('name' => 'is_locked', 'type' => 'i', 'value' => $value);
     $this->log->log("warn", $this->getUserName($id)." changed is_locked to $value");
@@ -113,6 +133,11 @@ 
     $field = array( 'name' => 'failed_logins', 'type' => 'i', 'value' => $value);
     return $this->updateSingle($id, $field);
   }
+
+  /**
+   * @param integer $id
+   * @param integer $value
+   */
   public function setUserPinFailed($id, $value) {
     $field = array( 'name' => 'failed_pins', 'type' => 'i', 'value' => $value);
     return $this->updateSingle($id, $field);
@@ -121,6 +146,10 @@ 
     $field = array( 'name' => 'failed_logins', 'type' => 'i', 'value' => $this->getUserFailed($id) + 1);
     return $this->updateSingle($id, $field);
   }
+
+  /**
+   * @param integer $id
+   */
   private function incUserPinFailed($id) {
     $field = array( 'name' => 'failed_pins', 'type' => 'i', 'value' => $this->getUserPinFailed($id) + 1);
     return $this->updateSingle($id, $field);
@@ -694,7 +723,7 @@ 
 
   /**
    * Fetch this classes table name
-   * @return table string This classes table name
+   * @return string string This classes table name
    **/
   public function getTableName() {
     $this->debug->append("STA " . __METHOD__, 4);

include/classes/pushnotification.class.php

Doc Comments +3 added lines

@@ -2,6 +2,9 @@
 	class PushNotification extends Base {
 		var $tableSettings = 'push_notification_settings';
 		
+		/**
+		 * @param string $file
+		 */
 		private static function getClassesInFile($file){
 			$classes = array();
 			$tokens = token_get_all(file_get_contents($file));

include/classes/usersettings.class.php

Doc Comments +3 added lines

@@ -8,6 +8,9 @@
 		protected $account_id = null;
 		private $__lazyWrite;
 		
+		/**
+		 * @param integer $account_id
+		 */
 		public function __construct($account_id, $lazy_write = true){
 			$this->account_id = $account_id;
 			$this->__lazyWrite = $lazy_write;