Ysurac / FlightAirMap

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 = '') {
 		$fp = fopen($file, 'w+');
 		$ch = curl_init();
@@ -24,6 +27,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
@@ -45,6 +51,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);
@@ -66,6 +75,9 @@ 
 		}
 	}
 	
+	/**
+	 * @param string $database_file
+	 */
 	public static function retrieve_route_sqlite_to_dest($database_file) {
 		global $globalDebug, $globalTransaction;
 		//$query = 'TRUNCATE TABLE routes';
@@ -108,6 +120,10 @@ 
 		}
                 return '';
 	}
+
+	/**
+	 * @param string $database_file
+	 */
 	public static function retrieve_route_oneworld($database_file) {
 		global $globalDebug, $globalTransaction;
 		//$query = 'TRUNCATE TABLE routes';
@@ -149,6 +165,9 @@ 
                 return '';
 	}
 	
+	/**
+	 * @param string $database_file
+	 */
 	public static function retrieve_route_skyteam($database_file) {
 		global $globalDebug, $globalTransaction;
 		//$query = 'TRUNCATE TABLE routes';
@@ -191,6 +210,10 @@ 
 		}
                 return '';
 	}
+
+	/**
+	 * @param string $database_file
+	 */
 	public static function retrieve_modes_sqlite_to_dest($database_file) {
 		global $globalTransaction;
 		//$query = 'TRUNCATE TABLE aircraft_modes';
@@ -257,6 +280,9 @@ 
 		return '';
 	}
 
+	/**
+	 * @param string $database_file
+	 */
 	public static function retrieve_modes_flarmnet($database_file) {
 		global $globalTransaction;
 		$Common = new Common();
@@ -327,6 +353,9 @@ 
 		return '';
 	}
 
+	/**
+	 * @param string $database_file
+	 */
 	public static function retrieve_modes_ogn($database_file) {
 		global $globalTransaction;
 		//$query = 'TRUNCATE TABLE aircraft_modes';
@@ -395,6 +424,9 @@ 
 		return '';
 	}
 
+	/**
+	 * @param string $database_file
+	 */
 	public static function retrieve_owner($database_file,$country = 'F') {
 		global $globalTransaction, $globalMasterSource;
 		//$query = 'TRUNCATE TABLE aircraft_modes';
@@ -1235,6 +1267,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;
@@ -1367,6 +1403,9 @@ 
 
 	}
 */
+	/**
+	 * @param string $filename
+	 */
 	public static function waypoints($filename) {
 		//require_once(dirname(__FILE__).'/../require/class.Spotter.php');
 		global $tmp_dir, $globalTransaction;
@@ -1414,6 +1453,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.Spotter.php

Doc Comments +4 added lines, -2 removed lines

@@ -57,7 +57,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;
@@ -10171,6 +10171,7 @@ 
 	/**
 	* Counts all hours
 	*
+	* @param string $orderby
 	* @return Array the hour list
 	*
 	*/
@@ -10236,6 +10237,7 @@ 
 	/**
 	* Counts all hours
 	*
+	* @param string $orderby
 	* @return Array the hour list
 	*
 	*/
@@ -11288,7 +11290,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.SpotterLive.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.SpotterArchive.php

Doc Comments +1 added lines, -1 removed lines

@@ -11,7 +11,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.APRS.php

Doc Comments +4 added lines

@@ -84,6 +84,10 @@
 	'y' => 'Yagi At QTH');
 	
 
+    /**
+     * @param integer $n
+     * @param integer $s
+     */
     private function urshift($n, $s) {
 	return ($n >= 0) ? ($n >> $s) :
 	    (($n & 0x7fffffff) >> $s) | 

require/class.Stats.php

Doc Comments +35 added lines

@@ -18,6 +18,10 @@ 
 		$this->db = $Connection->db();
         }
               
+	/**
+	 * @param string $type
+	 * @param string $stats_date
+	 */
 	public function addLastStatsUpdate($type,$stats_date) {
                 $query = "DELETE FROM config WHERE name = :type;
             		INSERT INTO config (name,value) VALUES (:type,:stats_date);";
@@ -961,6 +965,10 @@ 
                 $all = $sth->fetchAll(PDO::FETCH_ASSOC);
                 return $all;
         }
+
+	/**
+	 * @param string $type
+	 */
 	public function deleteStatsByType($type,$stats_airline = '', $filter_name = '') {
 		if ($filter_name == '') $filter_name = $this->filter_name;
                 $query = "DELETE FROM stats WHERE stats_type = :type AND stats_airline = :stats_airline AND filter_name = :filter_name";
@@ -972,6 +980,11 @@ 
                         echo "error : ".$e->getMessage();
                 }
         }
+
+	/**
+	 * @param string $type
+	 * @param string $year
+	 */
 	public function getSumStats($type,$year,$stats_airline = '',$filter_name = '',$month = '') {
 		if ($filter_name == '') $filter_name = $this->filter_name;
     		global $globalArchiveMonths, $globalDBdriver;
@@ -1116,6 +1129,10 @@ 
                 else return 0;
         }
 
+	/**
+	 * @param string $type
+	 * @param string $stats_date
+	 */
 	public function addStat($type,$cnt,$stats_date,$stats_airline = '',$filter_name = '') {
 		global $globalDBdriver;
 		if ($filter_name == '') $filter_name = $this->filter_name;
@@ -1169,6 +1186,9 @@ 
         }
         */
 
+	/**
+	 * @param string $stats_type
+	 */
 	public function getStatsSource($stats_type,$year = '',$month = '',$day = '') {
 		global $globalDBdriver;
 		$query = "SELECT * FROM stats_source WHERE stats_type = :stats_type";
@@ -1212,6 +1232,9 @@ 
 		return $all;
 	}
 
+	/**
+	 * @param string $stats_type
+	 */
 	public function addStatSource($data,$source_name,$stats_type,$date) {
 		global $globalDBdriver;
 		if ($globalDBdriver == 'mysql') {
@@ -1227,6 +1250,10 @@ 
                         return "error : ".$e->getMessage();
                 }
         }
+
+	/**
+	 * @param string $type
+	 */
 	public function addStatFlight($type,$date_name,$cnt,$stats_airline = '',$filter_name = '') {
                 $query = "INSERT INTO stats_flight (stats_type,flight_date,cnt,stats_airline,filter_name) VALUES (:type,:flight_date,:cnt,:stats_airline,:filter_name)";
                 $query_values = array(':type' => $type,':flight_date' => $date_name,':cnt' => $cnt, ':stats_airline' => $stats_airline,':filter_name' => $filter_name);
@@ -1493,6 +1520,10 @@ 
                         return "error : ".$e->getMessage();
                 }
         }
+
+	/**
+	 * @param string $type
+	 */
 	public function deleteStatFlight($type) {
                 $query = "DELETE FROM stats_flight WHERE stats_type = :type";
                 $query_values = array(':type' => $type);
@@ -1503,6 +1534,10 @@ 
                         return "error : ".$e->getMessage();
                 }
         }
+
+	/**
+	 * @param string $type
+	 */
 	public function deleteStatAirport($type) {
                 $query = "DELETE FROM stats_airport WHERE stats_type = :type";
                 $query_values = array(':type' => $type);

require/class.Connection.php

Doc Comments +20 added lines

@@ -6,6 +6,9 @@ 
 	public $dbs = array();
 	public $latest_schema = 37;
 	
+	/**
+	 * @param string $dbname
+	 */
 	public function __construct($dbc = null,$dbname = null,$user = null,$pass = null) {
 	    global $globalDBdriver;
 	    if ($dbc === null) {
@@ -132,6 +135,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param string $table
+	 */
 	public function tableExists($table)
 	{
 		global $globalDBdriver, $globalDBname;
@@ -181,6 +187,11 @@ 
 	/*
 	* Check if index exist
 	*/
+
+	/**
+	 * @param string $table
+	 * @param string $index
+	 */
 	public function indexExists($table,$index)
 	{
 		global $globalDBdriver, $globalDBname;
@@ -223,6 +234,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);
@@ -233,6 +248,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.Tracker.php

Doc Comments +2 added lines, -32 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) {
@@ -486,9 +486,6 @@ 
 	/**
 	* Update ident spotter data
 	*
-	* @param String $flightaware_id the ID from flightaware
-	* @param String $ident the flight ident
-	* @return String success or false
 	*
 	*/	
 	public function updateIdentTrackerData($famtrackid = '', $ident = '',$fromsource = NULL)
@@ -510,10 +507,6 @@ 
 	/**
 	* Update latest spotter data
 	*
-	* @param String $flightaware_id the ID from flightaware
-	* @param String $ident the flight ident
-	* @param String $arrival_airport_icao the arrival airport
-	* @return String success or false
 	*
 	*/	
 	public function updateLatestTrackerData($famtrackid = '', $ident = '', $latitude = '', $longitude = '', $altitude = '', $groundspeed = NULL, $date = '')
@@ -535,29 +528,6 @@ 
 	/**
 	* Adds a new spotter data
 	*
-	* @param String $flightaware_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
-	* @param String $latitude latitude of flight
-	* @param String $longitude latitude of flight
-	* @param String $waypoints waypoints of flight
-	* @param String $altitude altitude 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 addTrackerData($famtrackid = '', $ident = '', $latitude = '', $longitude = '', $altitude = '', $heading = '', $groundspeed = '', $date = '', $comment = '', $type = '',$format_source = '', $source_name = '')
 	{
@@ -1428,7 +1398,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.TrackerLive.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;
@@ -759,10 +759,6 @@ 
 	*
 	* @param String $famtrackid 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 addLiveTrackerData($famtrackid = '', $ident = '', $latitude = '', $longitude = '', $altitude = '', $heading = '', $groundspeed = '', $date = '', $putinarchive = false, $comment = '', $type = '',$noarchive = false,$format_source = '', $source_name = '', $over_country = '')