phpipam / phpipam

functions/classes/class.Radius.php

Doc Comments +34 added lines

@@ -355,30 +355,45 @@ 
     }

 

 

+    /**
+     * @param integer $packet_code
+     */
     function SetPacketCodeToSend($packet_code)

     {

         $this->_radius_packet_to_send = $packet_code;

     }

 

 

+    /**
+     * @param boolean $debug_mode
+     */
     function SetDebugMode($debug_mode)

     {

         $this->_debug_mode = (TRUE === $debug_mode);

     }

 

 

+    /**
+     * @param string $ip_radius_server
+     */
     function SetIpRadiusServer($ip_radius_server)

     {

         $this->_ip_radius_server = gethostbyname($ip_radius_server);

     }

 

 

+    /**
+     * @param string $shared_secret
+     */
     function SetSharedSecret($shared_secret)

     {

         $this->_shared_secret = $shared_secret;

     }

 

 

+    /**
+     * @param string $radius_suffix
+     */
     function SetRadiusSuffix($radius_suffix)

     {

         $this->_radius_suffix = $radius_suffix;

@@ -468,6 +483,9 @@ 
     }

 

 

+    /**
+     * @param integer $authentication_port
+     */
     function SetAuthenticationPort($authentication_port)

     {

         if ((intval($authentication_port) > 0) && (intval($authentication_port) < 65536))

@@ -477,6 +495,9 @@ 
     }

 

 

+    /**
+     * @param integer $accounting_port
+     */
     function SetAccountingPort($accounting_port)

     {

         if ((intval($accounting_port) > 0) && (intval($accounting_port) < 65536))

@@ -541,6 +562,9 @@ 
     }

 

 

+    /**
+     * @param integer $info_index
+     */
     function GetRadiusPacketInfo($info_index)

     {

         if (isset($this->_radius_packet_info[intval($info_index)]))

@@ -567,6 +591,9 @@ 
     }

 

 

+    /**
+     * @param string $debug_info
+     */
     function DebugInfo($debug_info)

     {

         if ($this->_debug_mode)

@@ -577,6 +604,9 @@ 
     }

 

 

+    /**
+     * @param integer $type
+     */
     function SetAttribute($type, $value)

     {

         $attribute_index = -1;

@@ -631,6 +661,10 @@ 
     }

 

 

+    /**
+     * @param string $attribute_raw_value
+     * @param integer $attribute_format
+     */
     function DecodeAttribute($attribute_raw_value, $attribute_format)

     {

         $attribute_value = NULL;

Braces +55 added lines, -84 removed lines

@@ -330,11 +330,10 @@ 
 
     function GetLastError()
     {
-        if (0 < $this->_last_error_code)
-        {
+        if (0 < $this->_last_error_code) {
             return $this->_last_error_message.' ('.$this->_last_error_code.')';
-        } else
-        {
+        }
+        else {
             return '';
         }
     }
@@ -387,8 +386,7 @@ 
     function SetUsername($username = '')
     {
         $temp_username = $username;
-        if (false === strpos($temp_username, '@'))
-        {
+        if (false === strpos($temp_username, '@')) {
             $temp_username .= $this->_radius_suffix;
         }
 
@@ -403,8 +401,7 @@ 
         $encrypted_password = '';
         $padded_password = $password;
 
-        if (0 != (strlen($password) % 16))
-        {
+        if (0 != (strlen($password) % 16)) {
             $padded_password .= str_repeat(chr(0), (16 - strlen($password) % 16));
         }
 
@@ -432,11 +429,10 @@ 
 
     function SetNasIPAddress($nas_ip_address = '')
     {
-        if (0 < strlen($nas_ip_address))
-        {
+        if (0 < strlen($nas_ip_address)) {
             $this->_nas_ip_address = gethostbyname($nas_ip_address);
-        } else
-        {
+        }
+        else {
             $this->_nas_ip_address = gethostbyname(isset($_SERVER['SERVER_ADDR']) ? $_SERVER['SERVER_ADDR'] : '0.0.0.0');
         }
         $this->SetAttribute(4, $this->_nas_ip_address);
@@ -452,8 +448,7 @@ 
 
     function SetUdpTimeout($udp_timeout = 5)
     {
-        if (intval($udp_timeout) > 0)
-        {
+        if (intval($udp_timeout) > 0) {
             $this->_udp_timeout = intval($udp_timeout);
         }
     }
@@ -468,8 +463,7 @@ 
 
     function SetAuthenticationPort($authentication_port)
     {
-        if ((intval($authentication_port) > 0) && (intval($authentication_port) < 65536))
-        {
+        if ((intval($authentication_port) > 0) && (intval($authentication_port) < 65536)) {
             $this->_authentication_port = intval($authentication_port);
         }
     }
@@ -477,8 +471,7 @@ 
 
     function SetAccountingPort($accounting_port)
     {
-        if ((intval($accounting_port) > 0) && (intval($accounting_port) < 65536))
-        {
+        if ((intval($accounting_port) > 0) && (intval($accounting_port) < 65536)) {
             $this->_accounting_port = intval($accounting_port);
         }
     }
@@ -499,21 +492,19 @@ 
     function GetReadableReceivedAttributes()
     {
         $readable_attributes = '';
-        if (isset($this->_attributes_received))
-        {
+        if (isset($this->_attributes_received)) {
             foreach ($this->_attributes_received as $one_received_attribute)
             {
                 $attributes_info = $this->GetAttributesInfo($one_received_attribute[0]);
                 $readable_attributes .= $attributes_info[0].": ";
-                if (26 == $one_received_attribute[0])
-                {
+                if (26 == $one_received_attribute[0]) {
                     $vendor_array = $this->DecodeVendorSpecificContent($one_received_attribute[1]);
                     foreach ($vendor_array as $vendor_one)
                     {
                         $readable_attributes .= 'Vendor-Id: '.$vendor_one[0].", Vendor-type: ".$vendor_one[1].",  Attribute-specific: ".$vendor_one[2];
                     }
-                } else
-                {
+                }
+                else {
                     $readable_attributes .= $one_received_attribute[1];
                 }
                 $readable_attributes .= "<br />\n";
@@ -528,8 +519,7 @@ 
         $attribute_value = NULL;
         foreach ($this->_attributes_received as $one_received_attribute)
         {
-            if (intval($attribute_type) == $one_received_attribute[0])
-            {
+            if (intval($attribute_type) == $one_received_attribute[0]) {
                 $attribute_value = $one_received_attribute[1];
                 break;
             }
@@ -540,11 +530,10 @@ 
 
     function GetRadiusPacketInfo($info_index)
     {
-        if (isset($this->_radius_packet_info[intval($info_index)]))
-        {
+        if (isset($this->_radius_packet_info[intval($info_index)])) {
             return $this->_radius_packet_info[intval($info_index)];
-        } else
-        {
+        }
+        else {
             return '';
         }
     }
@@ -552,11 +541,10 @@ 
 
     function GetAttributesInfo($info_index)
     {
-        if (isset($this->_attributes_info[intval($info_index)]))
-        {
+        if (isset($this->_attributes_info[intval($info_index)])) {
             return $this->_attributes_info[intval($info_index)];
-        } else
-        {
+        }
+        else {
             return array('', '');
         }
     }
@@ -564,8 +552,7 @@ 
 
     function DebugInfo($debug_info)
     {
-        if ($this->_debug_mode)
-        {
+        if ($this->_debug_mode) {
 	        //save debugging
 	        $this->debug_text[] = date('Y-m-d H:i:s').' DEBUG: '.$debug_info;
         }
@@ -577,8 +564,7 @@ 
         $attribute_index = -1;
         for ($attributes_loop = 0; $attributes_loop < count($this->_attributes_to_send); $attributes_loop++)
         {
-            if ($type == ord(substr($this->_attributes_to_send[$attributes_loop], 0, 1)))
-            {
+            if ($type == ord(substr($this->_attributes_to_send[$attributes_loop], 0, 1))) {
                 $attribute_index = $attributes_loop;
                 break;
             }
@@ -586,10 +572,8 @@ 
 
         $temp_attribute = NULL;
 
-        if (isset($this->_attributes_info[$type]))
-        {
-            switch ($this->_attributes_info[$type][1])
-            {
+        if (isset($this->_attributes_info[$type])) {
+            switch ($this->_attributes_info[$type][1]) {
                 case 'T': // Text, 1-253 octets containing UTF-8 encoded ISO 10646 characters (RFC 2279).
                     $temp_attribute = chr($type).chr(2 + strlen($value)).$value;
                     break;
@@ -611,12 +595,11 @@ 
             }
         }
 
-        if ($attribute_index > -1)
-        {
+        if ($attribute_index > -1) {
             $this->_attributes_to_send[$attribute_index] = $temp_attribute;
             $additional_debug = 'Modified';
-        } else
-        {
+        }
+        else {
             $this->_attributes_to_send[] = $temp_attribute;
             $additional_debug = 'Added';
         }
@@ -629,10 +612,8 @@ 
     {
         $attribute_value = NULL;
 
-        if (isset($this->_attributes_info[$attribute_format]))
-        {
-            switch ($this->_attributes_info[$attribute_format][1])
-            {
+        if (isset($this->_attributes_info[$attribute_format])) {
+            switch ($this->_attributes_info[$attribute_format][1]) {
                 case 'T': // Text, 1-253 octets containing UTF-8 encoded ISO 10646 characters (RFC 2279).
                     $attribute_value = $attribute_raw_value;
                     break;
@@ -690,26 +671,22 @@ 
 
         $this->SetPacketCodeToSend(1); // Access-Request
 
-        if (0 < strlen($username))
-        {
+        if (0 < strlen($username)) {
             $this->SetUsername($username);
         }
 
-        if (0 < strlen($password))
-        {
+        if (0 < strlen($password)) {
             $this->SetPassword($password);
         }
 
-        if ($state !== NULL)
-        {
+        if ($state !== NULL) {
             $this->SetAttribute(24, $state);
-        } else
-        {
+        }
+        else {
             $this->SetAttribute(6, 1); // 1=Login
         }
 
-        if (intval($udp_timeout) > 0)
-        {
+        if (intval($udp_timeout) > 0) {
             $this->SetUdpTimeout($udp_timeout);
         }
 
@@ -732,23 +709,21 @@ 
 
         $_socket_to_server = socket_create(AF_INET, SOCK_DGRAM, 17); // UDP packet = 17
 
-        if ($_socket_to_server === FALSE)
-        {
+        if ($_socket_to_server === FALSE) {
             $this->_last_error_code    = socket_last_error();
             $this->_last_error_message = socket_strerror($this->_last_error_code);
-        } elseif (FALSE === socket_connect($_socket_to_server, $this->_ip_radius_server, $this->_authentication_port))
-        {
+        }
+        elseif (FALSE === socket_connect($_socket_to_server, $this->_ip_radius_server, $this->_authentication_port)) {
             $this->_last_error_code    = socket_last_error();
             $this->_last_error_message = socket_strerror($this->_last_error_code);
-        } elseif (FALSE === socket_write($_socket_to_server, $packet_data, $packet_length))
-        {
+        }
+        elseif (FALSE === socket_write($_socket_to_server, $packet_data, $packet_length)) {
             $this->_last_error_code    = socket_last_error();
             $this->_last_error_message = socket_strerror($this->_last_error_code);
-        } else
-        {
+        }
+        else {
             $this->DebugInfo('<b>Packet type '.$this->_radius_packet_to_send.' ('.$this->GetRadiusPacketInfo($this->_radius_packet_to_send).')'.' sent</b>');
-            if ($this->_debug_mode)
-            {
+            if ($this->_debug_mode) {
                 $readable_attributes = '';
                 foreach ($this->_attributes_to_send as $one_attribute_to_send)
                 {
@@ -762,10 +737,8 @@ 
 
             $received_packet = chr(0);
 
-            if (!(FALSE === socket_select($read_socket_array, $write_socket_array, $except_socket_array, $this->_udp_timeout)))
-            {
-                if (in_array($_socket_to_server, $read_socket_array))
-                {
+            if (!(FALSE === socket_select($read_socket_array, $write_socket_array, $except_socket_array, $this->_udp_timeout))) {
+                if (in_array($_socket_to_server, $read_socket_array)) {
                     if (FALSE === ($received_packet = @socket_read($_socket_to_server, 1024))) {
                         // @ used, than no error is displayed if the connection is closed by the remote host
                     {
@@ -773,13 +746,13 @@ 
                     }
                         $this->_last_error_code    = socket_last_error();
                         $this->_last_error_message = socket_strerror($this->_last_error_code);
-                    } else
-                    {
+                    }
+                    else {
                         socket_close($_socket_to_server);
                     }
                 }
-            } else
-            {
+            }
+            else {
                 socket_close($_socket_to_server);
             }
         }
@@ -788,8 +761,7 @@ 
 
         $this->DebugInfo('<b>Packet type '.$this->_radius_packet_received.' ('.$this->GetRadiusPacketInfo($this->_radius_packet_received).')'.' received</b>');
 
-        if ($this->_radius_packet_received > 0)
-        {
+        if ($this->_radius_packet_received > 0) {
             $this->_identifier_received = intval(ord(substr($received_packet, 1, 1)));
             $packet_length = (intval(ord(substr($received_packet, 2, 1))) * 256) + (intval(ord(substr($received_packet, 3, 1))));
             $this->_response_authenticator = substr($received_packet, 4, 16);
@@ -804,15 +776,14 @@ 
                 $attribute_value = $this->DecodeAttribute($attribute_raw_value, $attribute_type);
 
                 $attribute_info = $this->GetAttributesInfo($attribute_type);
-                if (26 == $attribute_type)
-                {
+                if (26 == $attribute_type) {
                     $vendor_array = $this->DecodeVendorSpecificContent($attribute_value);
                     foreach ($vendor_array as $vendor_one)
                     {
                         $this->DebugInfo('Attribute '.$attribute_type.' ('.$attribute_info[0].'), length '.($attribute_length - 2).', format '.$attribute_info[1].', Vendor-Id: '.$vendor_one[0].", Vendor-type: ".$vendor_one[1].",  Attribute-specific: ".$vendor_one[2]);
                     }
-                } else
-                {
+                }
+                else {
                     $this->DebugInfo('Attribute '.$attribute_type.' ('.$attribute_info[0].'), length '.($attribute_length - 2).', format '.$attribute_info[1].', value <em>'.$attribute_value.'</em>');
                 }
 

functions/classes/class.Result.php

Doc Comments +7 added lines, -7 removed lines

@@ -71,7 +71,7 @@ 
 	 *
 	 * @access public
 	 * @param string $text (default: "No value provided")
-	 * @return void
+	 * @return string
 	 */
 	public function show_cli_message ($text="No value provided") {
 		// array - join
@@ -95,11 +95,11 @@ 
 	 * Show GUI result
 	 *
 	 * @access public
-	 * @param mixed $class
-	 * @param mixed $text
-	 * @param mixed $popup
-	 * @param mixed $popup2
-	 * @return void
+	 * @param string $class
+	 * @param string $text
+	 * @param boolean $popup
+	 * @param boolean $popup2
+	 * @return string
 	 */
 	public function show_message ($class, $text, $popup, $popup2) {
 		// format if array
@@ -144,7 +144,7 @@ 
 	 * Exists with exception for API
 	 *
 	 * @access public
-	 * @param mixed $content
+	 * @param string $content
 	 * @return void
 	 */
 	public function throw_exception ($content) {

Braces +1 added lines, -1 removed lines

@@ -35,7 +35,7 @@
 		$this->die = $die;
 
 		# API - throw exception
-		if($this->exit_method == "exception")  {
+		if($this->exit_method == "exception") {
 			# ok, just return success
 			if ($class=="success") 		{ return true; }
 			else						{ return $this->throw_exception ($text); }

functions/classes/class.Scan.php

Doc Comments +8 added lines, -9 removed lines

@@ -62,7 +62,7 @@ 
 	 * Returns all possible ping types / apps
 	 *
 	 * @access public
-	 * @return array
+	 * @return string[]
 	 */
 	public function ping_fetch_types () {
 		return array("ping", "pear", "fping");
@@ -152,7 +152,6 @@ 
 	 * @param mixed $address
 	 * @param int $count (default: 1)
 	 * @param int $timeout (default: 1)
-	 * @param bool $exit (default: false)
 	 * @return void
 	 */
 	public function ping_address ($address, $count=1, $timeout = 1) {
@@ -178,7 +177,7 @@ 
 	 *
 	 * @access protected
 	 * @param ip $address
-	 * @return void
+	 * @return null|integer
 	 */
 	protected function ping_address_method_ping ($address) {
 		# verify ping path
@@ -276,8 +275,7 @@ 
 	 *	fping cannot be run from web, it needs root privileges to be able to open raw socket :/
 	 *
 	 * @access public
-	 * @param mixed $subnet 	//CIDR
-	 * @return void
+	 * @return null|integer
 	 */
 	public function ping_address_method_fping ($address) {
 		# verify ping path
@@ -329,7 +327,7 @@ 
 	 *	fping cannot be run from web, it needs root privileges to be able to open raw socket :/
 	 *
 	 * @access public
-	 * @param mixed $subnet 	//CIDR
+	 * @param mixed $subnet_cidr 	//CIDR
 	 * @return void
 	 */
 	public function ping_address_method_fping_subnet ($subnet_cidr, $return_result = false) {
@@ -377,8 +375,8 @@ 
 	 * Explains invalid error codes
 	 *
 	 * @access public
-	 * @param mixed $code
-	 * @return void
+	 * @param null|integer $code
+	 * @return string|false
 	 */
 	public function ping_exit_explain ($code) {
 		# fetch explain codes
@@ -396,7 +394,7 @@ 
 	 *	extend if needed for future scripts
 	 *
 	 * @access public
-	 * @return void
+	 * @return string[]
 	 */
 	public function ping_set_exit_code_explains () {
 		$explain_codes[0]  = "SUCCESS";
@@ -523,6 +521,7 @@ 
 	 *
 	 * @access public
 	 * @param mixed $subnetId
+	 * @param boolean $die
 	 * @return void
 	 */
 	public function prepare_addresses_to_discover_subnetId ($subnetId, $die) {

Braces +9 added lines, -9 removed lines

@@ -431,8 +431,7 @@ 
     	# set datetime
     	$datetime = is_null($datetime) ? date("Y-m-d H:i:s") : $datetime;
 		# execute
-		try { $this->Database->updateObject("ipaddresses", array("id"=>$id, "lastSeen"=>$datetime), "id"); }
-		catch (Exception $e) {
+		try { $this->Database->updateObject("ipaddresses", array("id"=>$id, "lastSeen"=>$datetime), "id"); } catch (Exception $e) {
 			!$this->debugging ? : $this->Result->show("danger", $e->getMessage(), false);
 			# log
 			!$this->debugging ? : $this->Log->write ("status_update", _('Failed to update address status'), 0 );
@@ -452,8 +451,7 @@ 
     	if ($date === false)    { $date = date("Y-m-d H:i:s"); }
     	else                    { $date = $date; }
 		# execute
-		try { $this->Database->updateObject("scanAgents", array("id"=>$id, "last_access"=>date("Y-m-d H:i:s")), "id"); }
-		catch (Exception $e) {
+		try { $this->Database->updateObject("scanAgents", array("id"=>$id, "last_access"=>date("Y-m-d H:i:s")), "id"); } catch (Exception $e) {
 		}
 	}
 
@@ -477,7 +475,7 @@ 
 			//failed
 			if (!$conn) {}
 			//success
-			else 		{
+			else {
 				$retval = 0;	//set return as port if alive
 				fclose($conn);
 				break;			//end foreach if success
@@ -531,14 +529,16 @@ 
 
 		//subnet ID is provided, fetch subnet
 		$subnet = $Subnets->fetch_subnet(null, $subnetId);
-		if($subnet===false)	{
+		if($subnet===false) {
 			 if ($die)											{ die(json_encode(array("status"=>1, "error"=>"Invalid subnet ID provided"))); }
 			 else												{ return array(); }
 		}
 
 		// we should support only up to 4094 hosts!
-		if($Subnets->get_max_hosts ($subnet->mask, "IPv4")>4094 && php_sapi_name()!="cli")
-		if ($die)												{ die(json_encode(array("status"=>1, "error"=>"Scanning from GUI is only available for subnets up to /20 or 4094 hosts!"))); }
+		if($Subnets->get_max_hosts ($subnet->mask, "IPv4")>4094 && php_sapi_name()!="cli") {
+				if ($die)												{ die(json_encode(array("status"=>1, "error"=>"Scanning from GUI is only available for subnets up to /20 or 4094 hosts!")));
+		}
+		}
 		else													{ return array(); }
 
 		# set array of addresses to scan, exclude existing!
@@ -548,7 +548,7 @@ 
 		$ip = $this->remove_existing_subnet_addresses ($ip, $subnetId);
 
 		//none to scan?
-		if(sizeof($ip)==0)	{
+		if(sizeof($ip)==0) {
 			if ($die)											{ die(json_encode(array("status"=>1, "error"=>"Didn't find any address to scan!"))); }
 			else												{ return array(); }
 		}

functions/scripts/find_untranslated_files.php

Braces +3 added lines, -1 removed lines

@@ -72,7 +72,9 @@
 function get_string_between($string, $start, $end){
     $string = " ".$string;
     $ini = strpos($string,$start);
-    if ($ini == 0) return "";
+    if ($ini == 0) {
+        return "";
+    }
     $ini += strlen($start);
     $len = strpos($string,$end,$ini) - $ini;
     return substr($string,$ini,$len);

functions/classes/class.Thread.php

Doc Comments +1 added lines, -1 removed lines

@@ -248,7 +248,7 @@
 	/**
 	* alias of stop();
 	*
-	* @return boolean
+	* @return boolean|null
 	*/
     public function kill( $_signal = SIGKILL, $_wait = false ) {
         return $this->stop( $_signal, $_wait );

Braces +18 added lines, -8 removed lines

@@ -133,10 +133,13 @@ 
     public function isAlive() {
         $pid = pcntl_waitpid( $this->pid, $status, WNOHANG );
 
-        if ($pid === 0) { // child is still alive
+        if ($pid === 0) {
+// child is still alive
             return true;
-        } else {
-            if (pcntl_wifexited($status) && $this->exitCode == -1) { // normal exit
+        }
+        else {
+            if (pcntl_wifexited($status) && $this->exitCode == -1) {
+// normal exit
                 $this->exitCode = pcntl_wexitstatus($status);
             }
             return false;
@@ -196,12 +199,17 @@ 
 		$results = null;
 		$pid = pcntl_fork();
 
-		if( $pid == -1 ) { //error forking, no child is created
+		if( $pid == -1 ) {
+//error forking, no child is created
 			throw new Exception( $this->getError( Thread::COULD_NOT_FORK ), Thread::COULD_NOT_FORK );
-		}else if ( $pid ) {// parent
+		}
+		else if ( $pid ) {
+// parent
 			$this->pid = $pid;
 
-		} else { // child
+		}
+		else {
+// child
 			$this->pid = posix_getpid();//pid (child)
 			$this->ppid = posix_getppid();//pid (parent)
 
@@ -209,13 +217,15 @@ 
 			$array_args = func_get_args();
 			if ( !empty( $array_args ) ) {
 				$results = call_user_func_array( $this->runnable, $array_args );
-			}else{
+			}
+			else {
 				$results = call_user_func( $this->runnable );
 			}
 
 			$pipe = "/tmp/pipe_".$this->pid;//pid is known by parent
 
-			if(!file_exists($pipe)) {//child talks to parent using this pipe
+			if(!file_exists($pipe)) {
+//child talks to parent using this pipe
 				umask(0);
 				posix_mkfifo($pipe, 0600);
 			}

functions/classes/class.Install.php

Doc Comments +10 added lines, -10 removed lines

@@ -67,7 +67,7 @@ 
 	 * @param bool $drop_database (default: false)
 	 * @param bool $create_database (default: false)
 	 * @param bool $create_grants (default: false)
-	 * @return void
+	 * @return boolean|null
 	 */
 	public function install_database ($rootuser, $rootpass, $drop_database = false, $create_database = false, $create_grants = false) {
 
@@ -145,7 +145,7 @@ 
 	 * Execute files installation
 	 *
 	 * @access private
-	 * @return void
+	 * @return false|null
 	 */
 	private function install_database_execute () {
 	    # import SCHEMA file queries
@@ -197,7 +197,7 @@ 
 	 *
 	 * @access public
 	 * @param bool $redirect
-	 * @return void
+	 * @return boolean
 	 */
 	public function check_db_connection ($redirect = false) {
 		# try to connect
@@ -217,7 +217,7 @@ 
 	 *
 	 * @access public
 	 * @param mixed $table
-	 * @return void
+	 * @return boolean
 	 */
 	public function check_table ($table, $redirect = false) {
 		# set query
@@ -284,7 +284,7 @@ 
 	 * @param mixed $adminpass
 	 * @param mixed $siteTitle
 	 * @param mixed $siteURL
-	 * @return void
+	 * @return boolean
 	 */
 	function postauth_update($adminpass, $siteTitle, $siteURL) {
 		# update Admin pass
@@ -300,7 +300,7 @@ 
 	 *
 	 * @access public
 	 * @param mixed $adminpass
-	 * @return void
+	 * @return boolean
 	 */
 	public function postauth_update_admin_pass ($adminpass) {
 		try { $this->Database->updateObject("users", array("password"=>$adminpass, "passChange"=>"No","username"=>"Admin"), "username"); }
@@ -314,7 +314,7 @@ 
 	 * @access private
 	 * @param mixed $siteTitle
 	 * @param mixed $siteURL
-	 * @return void
+	 * @return boolean
 	 */
 	private function postauth_update_settings ($siteTitle, $siteURL) {
 		try { $this->Database->updateObject("settings", array("siteTitle"=>$siteTitle, "siteURL"=>$siteURL,"id"=>1), "id"); }
@@ -340,7 +340,7 @@ 
 	 * Upgrade database checks and executes.
 	 *
 	 * @access public
-	 * @return void
+	 * @return null|boolean
 	 */
 	public function upgrade_database () {
 		# first check version
@@ -361,7 +361,7 @@ 
 	 * Execute database upgrade.
 	 *
 	 * @access private
-	 * @return void
+	 * @return boolean
 	 */
 	private function upgrade_database_execute () {
 		# set queries
@@ -408,7 +408,7 @@ 
 	 * Fetch all upgrade queries from DB files
 	 *
 	 * @access public
-	 * @return void
+	 * @return string
 	 */
 	public function get_upgrade_queries () {
 		// save all queries fro UPDATE.sql file

Braces +25 added lines, -25 removed lines

@@ -41,8 +41,7 @@ 
 		# set debugging
 		$this->set_db_params ();
 		# Log object
-		try { $this->Database->connect(); }
-		catch ( Exception $e ) {}
+		try { $this->Database->connect(); } catch ( Exception $e ) {}
 	}
 
 
@@ -109,8 +108,7 @@ 
 	 	# set query
 	    $query = "drop database if exists `". $this->db['name'] ."`;";
 		# execute
-		try { $this->Database_root->runQuery($query); }
-		catch (Exception $e) {	$this->Result->show("danger", $e->getMessage(), true);}
+		try { $this->Database_root->runQuery($query); } catch (Exception $e) {	$this->Result->show("danger", $e->getMessage(), true);}
 	}
 
 	/**
@@ -123,8 +121,7 @@ 
 	 	# set query
 	    $query = "create database `". $this->db['name'] ."`;";
 		# execute
-		try { $this->Database_root->runQuery($query); }
-		catch (Exception $e) {	$this->Result->show("danger", $e->getMessage(), true);}
+		try { $this->Database_root->runQuery($query); } catch (Exception $e) {	$this->Result->show("danger", $e->getMessage(), true);}
 	}
 
 	/**
@@ -137,8 +134,7 @@ 
 	 	# set query
 	    $query = 'grant ALL on `'. $this->db['name'] .'`.* to '. $this->db['user'] .'@localhost identified by "'. $this->db['pass'] .'";';
 		# execute
-		try { $this->Database_root->runQuery($query); }
-		catch (Exception $e) {	$this->Result->show("danger", $e->getMessage(), true);}
+		try { $this->Database_root->runQuery($query); } catch (Exception $e) {	$this->Result->show("danger", $e->getMessage(), true);}
 	}
 
 	/**
@@ -158,14 +154,11 @@ 
 	    foreach($queries as $q) {
 		    //length check
 		    if (strlen($q)>0) {
-				try { $this->Database_root->runQuery($q.";"); }
-				catch (Exception $e) {
+				try { $this->Database_root->runQuery($q.";"); } catch (Exception $e) {
 					//unlock tables
-					try { $this->Database_root->runQuery("UNLOCK TABLES;"); }
-					catch (Exception $e) {}
+					try { $this->Database_root->runQuery("UNLOCK TABLES;"); } catch (Exception $e) {}
 					//drop database
-					try { $this->Database_root->runQuery("drop database if exists `". $this->db['name'] ."`;"); }
-					catch (Exception $e) {
+					try { $this->Database_root->runQuery("drop database if exists `". $this->db['name'] ."`;"); } catch (Exception $e) {
 						$this->Result->show("danger", 'Cannot drop database: '.$e->getMessage(), true);
 					}
 					//print error
@@ -201,8 +194,7 @@ 
 	 */
 	public function check_db_connection ($redirect = false) {
 		# try to connect
-		try { $res = $this->Database->connect(); }
-		catch (Exception $e) 	{
+		try { $res = $this->Database->connect(); } catch (Exception $e) 	{
 			$this->exception = $e->getMessage();
 			# redirect ?
 			if($redirect == true)  	{ $this->redirect_to_install (); }
@@ -223,10 +215,21 @@ 
 		# set query
 		$query = "SELECT COUNT(*) AS `cnt` FROM information_schema.tables WHERE table_schema = '".$this->db['name']."' AND table_name = '$table';";
 		# try to fetch count
-		try { $table = $this->Database->getObjectQuery($query); }
-		catch (Exception $e) 	{ if($redirect === true) $this->redirect_to_install ();	else return false; }
+		try { $table = $this->Database->getObjectQuery($query); } catch (Exception $e) 	{ if($redirect === true) {
+		    $this->redirect_to_install ();
+		}
+		else {
+		    return false;
+		}
+		}
 		# redirect if it is not existing
-		if($table->cnt!=1) 	 	{ if($redirect === true) $this->redirect_to_install ();	else return false; }
+		if($table->cnt!=1) 	 	{ if($redirect === true) {
+		    $this->redirect_to_install ();
+		}
+		else {
+		    return false;
+		}
+		}
 		# ok
 		return true;
 	}
@@ -303,8 +306,7 @@ 
 	 * @return void
 	 */
 	public function postauth_update_admin_pass ($adminpass) {
-		try { $this->Database->updateObject("users", array("password"=>$adminpass, "passChange"=>"No","username"=>"Admin"), "username"); }
-		catch (Exception $e) { $this->Result->show("danger", $e->getMessage(), false); }
+		try { $this->Database->updateObject("users", array("password"=>$adminpass, "passChange"=>"No","username"=>"Admin"), "username"); } catch (Exception $e) { $this->Result->show("danger", $e->getMessage(), false); }
 		return true;
 	}
 
@@ -317,8 +319,7 @@ 
 	 * @return void
 	 */
 	private function postauth_update_settings ($siteTitle, $siteURL) {
-		try { $this->Database->updateObject("settings", array("siteTitle"=>$siteTitle, "siteURL"=>$siteURL,"id"=>1), "id"); }
-		catch (Exception $e) { $this->Result->show("danger", $e->getMessage(), false); }
+		try { $this->Database->updateObject("settings", array("siteTitle"=>$siteTitle, "siteURL"=>$siteURL,"id"=>1), "id"); } catch (Exception $e) { $this->Result->show("danger", $e->getMessage(), false); }
 		return true;
 	}
 
@@ -378,8 +379,7 @@ 
 	    # execute all queries
 	    foreach($queries as $query) {
     	    if (strlen($query)>5) {
-    			try { $this->Database->runQuery($query); }
-    			catch (Exception $e) {
+    			try { $this->Database->runQuery($query); } catch (Exception $e) {
     				$this->Log = new Logging ($this->Database);
     				# write log
     				$this->Log->write( "Database upgrade", $e->getMessage()."<br>query: ".$query, 2 );

api/controllers/Responses.php

Doc Comments +4 added lines, -5 removed lines

@@ -80,7 +80,6 @@ 
 	 * Sets header based on provided HTTP code
 	 *
 	 * @access private
-	 * @param mixed $code
 	 * @return void
 	 */
 	private function set_header () {
@@ -99,7 +98,7 @@ 
 	 *
 	 * @access public
 	 * @param mixed $result
-	 * @return void
+	 * @return string
 	 */
 	public function formulate_result ($result) {
 		// make sure result is array
@@ -210,7 +209,7 @@ 
 	 * Outputs result
 	 *
 	 * @access private
-	 * @return void
+	 * @return string
 	 */
 	private function create_result () {
 		// reorder
@@ -239,7 +238,7 @@ 
 	 * Creates XML result
 	 *
 	 * @access private
-	 * @return void
+	 * @return string|false
 	 */
 	private function create_xml () {
 		// convert whole object to array
@@ -329,7 +328,7 @@ 
 	 * Creates JSON result
 	 *
 	 * @access private
-	 * @return void
+	 * @return string
 	 */
 	private function create_json () {
 		return json_encode((array) $this->result);

Braces +12 added lines, -5 removed lines

@@ -270,7 +270,9 @@ 
 		    if(strpos($key, " ")>0)	{ $key = str_replace(" ", "_", $key); }
 
 		    // if key is numeric append item
-		    if(is_numeric($key)) $key = "item".$key;
+		    if(is_numeric($key)) {
+		        $key = "item".$key;
+		    }
 
 			// if array add child
 	        if (is_array($value)) {
@@ -300,8 +302,9 @@ 
 	 * @license CC-BY-3.0 <http://spdx.org/licenses/CC-BY-3.0>
 	 */
 	public function xml_to_array ( $xmlObject, $out = array () ) {
-	    foreach ( (array) $xmlObject as $index => $node )
-	        $out[$index] = ( is_object ( $node ) ) ? $this->xml_to_array ( $node ) : $node;
+	    foreach ( (array) $xmlObject as $index => $node ) {
+	    	        $out[$index] = ( is_object ( $node ) ) ? $this->xml_to_array ( $node ) : $node;
+	    }
 
 	    return $out;
 	}
@@ -315,14 +318,18 @@ 
 	 */
 	private function object_to_array ($obj) {
 		// object to array
-	    if(is_object($obj)) $obj = (array) $obj;
+	    if(is_object($obj)) {
+	        $obj = (array) $obj;
+	    }
 	    if(is_array($obj)) {
 	        $new = array();
 	        foreach($obj as $key => $val) {
 	            $new[$key] = $this->object_to_array($val);
 	        }
 	    }
-	    else $new = $obj;
+	    else {
+	        $new = $obj;
+	    }
 	    return $new;
 	}
 

api/controllers/User.php

Doc Comments +2 added lines, -2 removed lines

@@ -330,7 +330,7 @@ 
 	 * Validates users token from database
 	 *
 	 * @access private
-	 * @return void
+	 * @return boolean
 	 */
 	private function validate_user_token () {
 		// is set
@@ -412,7 +412,7 @@ 
 	 * Checks if token has expired
 	 *
 	 * @access private
-	 * @return void
+	 * @return boolean
 	 */
 	private function validate_token_expiration () {
 		return strtotime($this->token_expires) < time() ? true : false;

functions/classes/class.Rackspace.php

Doc Comments +10 added lines, -10 removed lines

@@ -152,7 +152,7 @@ 
      * Fetches details about specific rack
      *
      * @access public
-     * @param mixed $id
+     * @param integer $id
      * @return void
      */
     public function fetch_rack_details ($id) {
@@ -169,7 +169,7 @@ 
      * Fetches all devices attached to rack
      *
      * @access public
-     * @param mixed $id
+     * @param integer $id
      * @return void
      */
     public function fetch_rack_devices ($id) {
@@ -247,7 +247,7 @@ 
      * Set active rack devide.
      *
      * @access public
-     * @param mixed $id         // device id
+     * @param boolean $id         // device id
      * @return void
      */
     public function set_active_rack_device ($id) {
@@ -383,7 +383,7 @@ 
      *
      * @access private
      * @param RackContent $content
-     * @param mixed $img
+     * @param resource $img
      * @param mixed $name
      * @return void
      */
@@ -501,7 +501,7 @@ 
      * getSpace function.
      *
      * @access public
-     * @return void
+     * @return integer
      */
     public function getSpace() {
         return $this->space;
@@ -543,7 +543,7 @@ 
      * Checks if item is active
      *
      * @access public
-     * @return void
+     * @return boolean
      */
     public function isActive() {
         return $this->active;
@@ -614,7 +614,7 @@ 
      * returns id
      *
      * @access public
-     * @return void
+     * @return integer
      */
     public function getId() {
         return $this->id;
@@ -656,7 +656,7 @@ 
      * Checks if item is active
      *
      * @access public
-     * @return void
+     * @return boolean
      */
     public function isActive() {
         return $this->active;
@@ -677,7 +677,7 @@ 
      * Returns start position
      *
      * @access public
-     * @return void
+     * @return integer
      */
     public function getStartLocation() {
         return $this->startLocation;
@@ -698,7 +698,7 @@ 
      * Gets rack size.
      *
      * @access public
-     * @return void
+     * @return integer
      */
     public function getSize() {
         return $this->size;

Braces +2 added lines, -1 removed lines

@@ -130,7 +130,8 @@
         if ($this->key_size > 0) {
 
             $out .= ' ' . trim($this->key_data, '.') . '.';
-        } else {
+        }
+        else {
 
             $out .= ' .';
         }