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;

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) {

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) {

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 );

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

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);

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;

functions/classes/class.FirewallZones.php

Doc Comments +1 added lines, -1 removed lines

@@ -239,7 +239,7 @@
 	 * Fetches zone mapping from database, depending on id
 	 *
 	 * @access public
-	 * @param mixed $id
+	 * @param string $id
 	 * @return void
 	 */
 	public function get_zone_mapping ($id) {