Ysurac / FlightAirMap

require/class.MarineArchive.php

Doc Comments +1 added lines, -1 removed lines

@@ -14,7 +14,7 @@
 	/**
 	* Get SQL query part for filter used
 	* @param Array $filter the filter
-	* @return Array the SQL part
+	* @return string the SQL part
 	*/
 	public function getFilter($filter = array(),$where = false,$and = false) {
 		global $globalFilter, $globalStatsFilters, $globalFilterName, $globalDBdriver;

install/class.update_db.php

Doc Comments +42 added lines

@@ -10,6 +10,9 @@ 
 class update_db {
 	public static $db_sqlite;
 
+	/**
+	 * @param string $file
+	 */
 	public static function download($url, $file, $referer = '') {
 		//$file = str_replace('/',DIRECTORY_SEPARATOR,$file);
 		$fp = fopen($file, 'w+');
@@ -25,6 +28,9 @@ 
 		fclose($fp);
 	}
 
+	/**
+	 * @param string $in_file
+	 */
 	public static function gunzip($in_file,$out_file_name = '') {
 		//echo $in_file.' -> '.$out_file_name."\n";
 		$buffer_size = 4096; // read 4kb at a time
@@ -46,6 +52,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $in_file
+	 */
 	public static function unzip($in_file) {
 		if ($in_file != '' && file_exists($in_file)) {
 			$path = pathinfo(realpath($in_file), PATHINFO_DIRNAME);
@@ -67,6 +76,9 @@ 
 		}
 	}
 	
+	/**
+	 * @param string $database_file
+	 */
 	public static function retrieve_route_sqlite_to_dest($database_file) {
 		global $globalDebug, $globalTransaction;
 		//$query = 'TRUNCATE TABLE routes';
@@ -109,6 +121,10 @@ 
 		}
                 return '';
 	}
+
+	/**
+	 * @param string $database_file
+	 */
 	public static function retrieve_route_oneworld($database_file) {
 		global $globalDebug, $globalTransaction;
 		//$query = 'TRUNCATE TABLE routes';
@@ -150,6 +166,9 @@ 
                 return '';
 	}
 	
+	/**
+	 * @param string $database_file
+	 */
 	public static function retrieve_route_skyteam($database_file) {
 		global $globalDebug, $globalTransaction;
 		//$query = 'TRUNCATE TABLE routes';
@@ -192,6 +211,10 @@ 
 		}
                 return '';
 	}
+
+	/**
+	 * @param string $database_file
+	 */
 	public static function retrieve_modes_sqlite_to_dest($database_file) {
 		global $globalTransaction;
 		//$query = 'TRUNCATE TABLE aircraft_modes';
@@ -258,6 +281,9 @@ 
 		return '';
 	}
 
+	/**
+	 * @param string $database_file
+	 */
 	public static function retrieve_modes_flarmnet($database_file) {
 		global $globalTransaction;
 		$Common = new Common();
@@ -328,6 +354,9 @@ 
 		return '';
 	}
 
+	/**
+	 * @param string $database_file
+	 */
 	public static function retrieve_modes_ogn($database_file) {
 		global $globalTransaction;
 		//$query = 'TRUNCATE TABLE aircraft_modes';
@@ -396,6 +425,9 @@ 
 		return '';
 	}
 
+	/**
+	 * @param string $database_file
+	 */
 	public static function retrieve_owner($database_file,$country = 'F') {
 		global $globalTransaction, $globalMasterSource;
 		//$query = 'TRUNCATE TABLE aircraft_modes';
@@ -1276,6 +1308,10 @@ 
 		return '';
         }
 
+	/**
+	 * @param string $filename
+	 * @param string $tletype
+	 */
 	public static function tle($filename,$tletype) {
 		require_once(dirname(__FILE__).'/../require/class.Spotter.php');
 		global $tmp_dir, $globalTransaction;
@@ -1408,6 +1444,9 @@ 
 
 	}
 */
+	/**
+	 * @param string $filename
+	 */
 	public static function waypoints($filename) {
 		//require_once(dirname(__FILE__).'/../require/class.Spotter.php');
 		global $tmp_dir, $globalTransaction;
@@ -1455,6 +1494,9 @@ 
 		return '';
         }
 
+	/**
+	 * @param string $filename
+	 */
 	public static function ivao_airlines($filename) {
 		//require_once(dirname(__FILE__).'/../require/class.Spotter.php');
 		global $tmp_dir, $globalTransaction;

require/class.Marine.php

Doc Comments +2 added lines, -21 removed lines

@@ -13,7 +13,7 @@ 
 	/**
 	* Get SQL query part for filter used
 	* @param Array $filter the filter
-	* @return Array the SQL part
+	* @return string the SQL part
 	*/
 	
 	public function getFilter($filter = array(),$where = false,$and = false) {
@@ -566,25 +566,6 @@ 
 	*
 	* @param String $fammarine_id the ID
 	* @param String $ident the marine ident
-	* @param String $departure_airport_icao the departure airport
-	* @param String $arrival_airport_icao the arrival airport
-	* @param String $latitude latitude of flight
-	* @param String $longitude latitude of flight
-	* @param String $waypoints waypoints of flight
-	* @param String $heading heading of flight
-	* @param String $groundspeed speed of flight
-	* @param String $date date of flight
-	* @param String $departure_airport_time departure time of flight
-	* @param String $arrival_airport_time arrival time of flight
-	* @param String $squawk squawk code of flight
-	* @param String $route_stop route stop of flight
-	* @param String $highlight highlight or not
-	* @param String $ModeS ModesS code of flight
-	* @param String $registration registration code of flight
-	* @param String $pilot_id pilot id of flight (for virtual airlines)
-	* @param String $pilot_name pilot name of flight (for virtual airlines)
-	* @param String $verticalrate vertival rate of flight
-	* @return String success or false
 	*/
 	public function addMarineData($fammarine_id = '', $ident = '', $latitude = '', $longitude = '', $heading = '', $groundspeed = '', $date = '', $mmsi = '',$type = '',$typeid = '',$imo = '',$callsign = '',$arrival_code = '',$arrival_date = '',$status = '',$statusid = '',$format_source = '', $source_name = '')
 	{
@@ -1467,7 +1448,7 @@ 
 	/**
 	* Parses the direction degrees to working
 	*
-	* @param Float $direction the direction in degrees
+	* @param integer $direction the direction in degrees
 	* @return Array the direction information
 	*
 	*/

require/class.MarineLive.php

Doc Comments +1 added lines, -5 removed lines

@@ -14,7 +14,7 @@ 
 	/**
 	* Get SQL query part for filter used
 	* @param Array $filter the filter
-	* @return Array the SQL part
+	* @return string the SQL part
 	*/
 	public function getFilter($filter = array(),$where = false,$and = false) {
 		global $globalFilter, $globalStatsFilters, $globalFilterName, $globalDBdriver;
@@ -794,10 +794,6 @@ 
 	*
 	* @param String $fammarine_id the ID from flightaware
 	* @param String $ident the flight ident
-	* @param String $aircraft_icao the aircraft type
-	* @param String $departure_airport_icao the departure airport
-	* @param String $arrival_airport_icao the arrival airport
-	* @return String success or false
 	*
 	*/
 	public function addLiveMarineData($fammarine_id = '', $ident = '', $latitude = '', $longitude = '', $heading = '', $groundspeed = '', $date = '', $putinarchive = false, $mmsi = '',$type = '',$typeid = '',$imo = '', $callsign = '',$arrival_code = '',$arrival_date = '',$status = '',$statusid = '',$noarchive = false,$format_source = '', $source_name = '', $over_country = '')

require/class.TrackerArchive.php

Doc Comments +1 added lines, -1 removed lines

@@ -14,7 +14,7 @@
 	/**
 	* Get SQL query part for filter used
 	* @param Array $filter the filter
-	* @return Array the SQL part
+	* @return string the SQL part
 	*/
 	public function getFilter($filter = array(),$where = false,$and = false) {
 		global $globalFilter, $globalStatsFilters, $globalFilterName, $globalDBdriver;

require/class.Elevation.php

Doc Comments +11 added lines, -1 removed lines

@@ -52,6 +52,10 @@ 
 		$this->openedFiles = [];
 	}
 
+	/**
+	 * @param double $row
+	 * @param double $column
+	 */
 	private function getElevationAtPosition($fileName, $row, $column) {
 		if (!array_key_exists($fileName, $this->openedFiles)) {
 			if (!file_exists($this->htgFilesDestination . DIRECTORY_SEPARATOR . $fileName)) {
@@ -85,7 +89,7 @@ 
 	 * @param float $lon
 	 * @param null  $fName
 	 *
-	 * @return mixed
+	 * @return double
 	 * @throws \Exception
 	 */
 	public function getElevation($lat, $lon, &$fName = null) {
@@ -142,6 +146,9 @@ 
 		return $zN;
 	}
 
+	/**
+	 * @param integer $numPrefix
+	 */
 	private function getDeg($deg, $numPrefix) {
 		$deg = abs($deg);
 		$d   = floor($deg);     // round degrees
@@ -156,6 +163,9 @@ 
 		return $d;
 	}
 
+	/**
+	 * @param double $deg
+	 */
 	private function getSec($deg) {
 		$deg = abs($deg);
 		$sec = round($deg * 3600, 4);

require/class.Common.php

Doc Comments +15 added lines, -2 removed lines

@@ -90,6 +90,10 @@ 
 		return strlen($headerLine); // Needed by curl
 	}
 
+	/**
+	 * @param string $url
+	 * @param string $file
+	 */
 	public static function download($url, $file, $referer = '') {
 		global $globalDebug;
 		$fp = fopen($file, 'w');
@@ -106,6 +110,9 @@ 
 		fclose($fp);
 	}
 
+	/**
+	 * @param string $in_file
+	 */
 	public static function gunzip($in_file,$out_file_name = '') {
 		//echo $in_file.' -> '.$out_file_name."\n";
 		$buffer_size = 4096; // read 4kb at a time
@@ -211,7 +218,7 @@ 
 	* Check is distance realistic
 	* @param int $timeDifference the time between the reception of both messages
 	* @param float $distance distance covered
-	* @return whether distance is realistic
+	* @return boolean distance is realistic
 	*/
 	public function withinThreshold ($timeDifference, $distance) {
 		$x = abs($timeDifference);
@@ -234,6 +241,9 @@ 
 	}
 
 
+	/**
+	 * @param string $latlong
+	 */
 	public function convertDec($dms,$latlong) {
 		if ($latlong == 'latitude') {
 			$deg = substr($dms, 0, 2);
@@ -245,6 +255,9 @@ 
 		return $deg+(($min*60)/3600);
 	}
 	
+	/**
+	 * @param string $latlong
+	 */
 	public function convertDM($coord,$latlong) {
 		if ($latlong == 'latitude') {
 			if ($coord < 0) $NSEW = 'S';
@@ -382,7 +395,7 @@ 
 	/**
 	* Returns list of available locales
 	*
-	* @return array
+	* @return string[]
 	 */
 	public function listLocaleDir()
 	{

require/class.GeoidHeight.php

Doc Comments +4 added lines

@@ -91,6 +91,10 @@
 		$this->rlatres = (($this->height - 1) / 180.0);
 	}
 
+	/**
+	 * @param integer $ix
+	 * @param integer $iy
+	 */
 	private function _rawval($ix,$iy) {
 		if (($iy < 0)) {
 			$iy = -$iy;

require/class.APRS.php

Doc Comments +7 added lines

@@ -165,6 +165,10 @@ 
 	'\~' => 'TNC Stream SW');
 	
 
+    /**
+     * @param integer $n
+     * @param integer $s
+     */
     private function urshift($n, $s) {
 	return ($n >= 0) ? ($n >> $s) :
 	    (($n & 0x7fffffff) >> $s) | 
@@ -565,6 +569,9 @@ 
 	socket_close($this->socket);
     }
     
+    /**
+     * @param string $data
+     */
     public function send($data) {
 	global $globalDebug;
 	if ($this->connected === false) $this->connect();