Ysurac / FlightAirMap

require/class.Marine.php

Doc Comments +3 added lines, -21 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) {
@@ -1003,25 +1003,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 = '', $captain_id = '',$captain_name = '',$race_id = '', $race_name = '', $distance = '',$race_rank = '', $race_time = '')
 	{
@@ -1624,6 +1605,7 @@ 
 	/**
 	* Counts all hours
 	*
+	* @param string $orderby
 	* @return Array the hour list
 	*
 	*/
@@ -1975,7 +1957,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

@@ -15,7 +15,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;
@@ -923,10 +923,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 = '',$captain_id = '',$captain_name = '',$race_id = '', $race_name = '', $distance = '', $race_rank = '', $race_time = '')

require/class.Elevation.php

Doc Comments +11 added lines

@@ -53,6 +53,11 @@ 
 		$this->openedFiles = [];
 	}
 
+	/**
+	 * @param string $fileName
+	 * @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)) {
@@ -153,6 +158,9 @@ 
 		else return $zN;
 	}
 
+	/**
+	 * @param integer $numPrefix
+	 */
 	private function getDeg($deg, $numPrefix) {
 		$deg = abs($deg);
 		$d   = floor($deg);     // round degrees
@@ -167,6 +175,9 @@ 
 		return $d;
 	}
 
+	/**
+	 * @param double $deg
+	 */
 	private function getSec($deg) {
 		$deg = abs($deg);
 		$sec = round($deg * 3600, 4);

install/class.update_db.php

Doc Comments +48 added lines

@@ -10,6 +10,9 @@ 
 class update_db {
 	public static $db_sqlite;
 
+	/**
+	 * @param string $file
+	 */
 	public static function download($url, $file, $referer = '') {
 		global $globalProxy, $globalForceIPv4;
 		$fp = fopen($file, 'w');
@@ -34,6 +37,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
@@ -55,6 +61,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);
@@ -76,6 +85,9 @@ 
 		}
 	}
 	
+	/**
+	 * @param string $database_file
+	 */
 	public static function retrieve_route_sqlite_to_dest($database_file) {
 		global $globalDebug, $globalTransaction;
 		//$query = 'TRUNCATE TABLE routes';
@@ -118,6 +130,10 @@ 
 		}
                 return '';
 	}
+
+	/**
+	 * @param string $database_file
+	 */
 	public static function retrieve_route_oneworld($database_file) {
 		global $globalDebug, $globalTransaction;
 		//$query = 'TRUNCATE TABLE routes';
@@ -159,6 +175,9 @@ 
                 return '';
 	}
 	
+	/**
+	 * @param string $database_file
+	 */
 	public static function retrieve_route_skyteam($database_file) {
 		global $globalDebug, $globalTransaction;
 		//$query = 'TRUNCATE TABLE routes';
@@ -201,6 +220,10 @@ 
 		}
                 return '';
 	}
+
+	/**
+	 * @param string $database_file
+	 */
 	public static function retrieve_modes_sqlite_to_dest($database_file) {
 		global $globalTransaction;
 		//$query = 'TRUNCATE TABLE aircraft_modes';
@@ -267,6 +290,9 @@ 
 		return '';
 	}
 
+	/**
+	 * @param string $database_file
+	 */
 	public static function retrieve_modes_flarmnet($database_file) {
 		global $globalTransaction;
 		$Common = new Common();
@@ -337,6 +363,9 @@ 
 		return '';
 	}
 
+	/**
+	 * @param string $database_file
+	 */
 	public static function retrieve_modes_ogn($database_file) {
 		global $globalTransaction;
 		//$query = 'TRUNCATE TABLE aircraft_modes';
@@ -406,6 +435,9 @@ 
 		return '';
 	}
 
+	/**
+	 * @param string $database_file
+	 */
 	public static function retrieve_owner($database_file,$country = 'F') {
 		global $globalTransaction, $globalMasterSource;
 		//$query = 'TRUNCATE TABLE aircraft_modes';
@@ -1438,6 +1470,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;
@@ -1487,6 +1523,9 @@ 
 		return '';
         }
 
+	/**
+	 * @param string $filename
+	 */
 	public static function satellite_ucsdb($filename) {
 		global $tmp_dir, $globalTransaction;
 		
@@ -1535,6 +1574,9 @@ 
 		return '';
 	}
 
+	/**
+	 * @param string $filename
+	 */
 	public static function satellite_celestrak($filename) {
 		global $tmp_dir, $globalTransaction;
 		$satcat_sources = array(
@@ -1862,6 +1904,9 @@ 
 
 	}
 */
+	/**
+	 * @param string $filename
+	 */
 	public static function waypoints($filename) {
 		//require_once(dirname(__FILE__).'/../require/class.Spotter.php');
 		global $tmp_dir, $globalTransaction;
@@ -1930,6 +1975,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $filename
+	 */
 	public static function ivao_airlines($filename) {
 		//require_once(dirname(__FILE__).'/../require/class.Spotter.php');
 		global $tmp_dir, $globalTransaction;

require/class.Connection.php

Doc Comments +20 added lines

@@ -6,6 +6,9 @@ 
 	public $dbs = array();
 	public $latest_schema = 55;
 
+	/**
+	 * @param string $dbname
+	 */
 	public function __construct($dbc = null,$dbname = null,$user = null,$pass = null) {
 		global $globalNoDB;
 		if (isset($globalNoDB) && $globalNoDB === TRUE) {
@@ -142,6 +145,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param string $table
+	 */
 	public function tableExists($table)
 	{
 		global $globalDBdriver, $globalDBname;
@@ -192,6 +198,11 @@ 
 	/*
 	* Check if index exist
 	*/
+
+	/**
+	 * @param string $table
+	 * @param string $index
+	 */
 	public function indexExists($table,$index)
 	{
 		global $globalDBdriver, $globalDBname;
@@ -234,6 +245,10 @@ 
 		return $columns;
 	}
 
+	/**
+	 * @param string $table
+	 * @param string $column
+	 */
 	public function getColumnType($table,$column) {
 		$select = $this->db->query('SELECT '.$column.' FROM '.$table);
 		$tomet = $select->getColumnMeta(0);
@@ -244,6 +259,11 @@ 
 	* Check if a column name exist in a table
 	* @return Boolean column exist or not
 	*/
+
+	/**
+	 * @param string $table
+	 * @param string $name
+	 */
 	public function checkColumnName($table,$name)
 	{
 		global $globalDBdriver, $globalDBname;

require/class.Common.php

Doc Comments +11 added lines, -2 removed lines

@@ -126,6 +126,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
@@ -287,7 +290,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);
@@ -311,6 +314,9 @@ 
 	}
 
 
+	/**
+	 * @param string $latlong
+	 */
 	public function convertDec($dms,$latlong) {
 		if ($latlong == 'latitude') {
 			$deg = substr($dms, 0, 2);
@@ -345,6 +351,9 @@ 
 		return array('latitude' => round($latitude,5),'longitude' => round($longitude,5));
 	}
 	
+	/**
+	 * @param string $latlong
+	 */
 	public function convertDM($coord,$latlong) {
 		if ($latlong == 'latitude') {
 			if ($coord < 0) $NSEW = 'S';
@@ -482,7 +491,7 @@ 
 	/**
 	* Returns list of available locales
 	*
-	* @return array
+	* @return string[]
 	 */
 	public function listLocaleDir()
 	{