Ysurac / FlightAirMap

require/class.SpotterArchive.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 +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';
@@ -1393,6 +1425,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;
@@ -1442,6 +1478,9 @@ 
 		return '';
         }
 
+	/**
+	 * @param string $filename
+	 */
 	public static function satellite_ucsdb($filename) {
 		global $tmp_dir, $globalTransaction;
 		$query = "DELETE FROM satellite";
@@ -1488,6 +1527,9 @@ 
 		return '';
 	}
 
+	/**
+	 * @param string $filename
+	 */
 	public static function satellite_celestrak($filename) {
 		global $tmp_dir, $globalTransaction;
 		$satcat_sources = array(
@@ -1815,6 +1857,9 @@ 
 
 	}
 */
+	/**
+	 * @param string $filename
+	 */
 	public static function waypoints($filename) {
 		//require_once(dirname(__FILE__).'/../require/class.Spotter.php');
 		global $tmp_dir, $globalTransaction;
@@ -1883,6 +1928,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $filename
+	 */
 	public static function ivao_airlines($filename) {
 		//require_once(dirname(__FILE__).'/../require/class.Spotter.php');
 		global $tmp_dir, $globalTransaction;

require/class.Source.php

Doc Comments +9 added lines

@@ -110,6 +110,12 @@ 
 		return $all;
 	}
 
+	/**
+	 * @param string $name
+	 * @param string $city
+	 * @param string $country
+	 * @param string $source
+	 */
 	public function addLocation($name,$latitude,$longitude,$altitude,$city,$country,$source,$logo = 'antenna.png',$type = '',$source_id = 0,$location_id = 0,$last_seen = '', $description = '') {
 		if ($last_seen == '') $last_seen = date('Y-m-d H:i:s');
 		$query = "INSERT INTO source_location (name,latitude,longitude,altitude,country,city,logo,source,type,source_id,last_seen,location_id,description) VALUES (:name,:latitude,:longitude,:altitude,:country,:city,:logo,:source,:type,:source_id,:last_seen,:location_id,:description)";
@@ -168,6 +174,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $type
+	 */
 	public function deleteLocationByType($type) {
 		$query = "DELETE FROM source_location WHERE type = :type";
 		$query_values = array(':type' => $type);

require/class.Stats.php

Doc Comments +35 added lines

@@ -19,6 +19,10 @@ 
 		if ($this->db === null) die('Error: No DB connection. (Stats)');
 	}
 
+	/**
+	 * @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);";
@@ -1369,6 +1373,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";
@@ -1380,6 +1388,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;
@@ -1579,6 +1592,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;
@@ -1632,6 +1649,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";
@@ -1675,6 +1695,9 @@ 
 		return $all;
 	}
 
+	/**
+	 * @param string $stats_type
+	 */
 	public function addStatSource($data,$source_name,$stats_type,$date) {
 		global $globalDBdriver;
 		if ($globalDBdriver == 'mysql') {
@@ -1690,6 +1713,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);
@@ -1956,6 +1983,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);
@@ -1966,6 +1997,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.AIS.php

Doc Comments +31 added lines

@@ -68,6 +68,10 @@ 
        't', 'u', 'v', 'w' // 119
     ); // char 64
     */
+
+	/**
+	 * @param integer $ascii
+	 */
 	private function asciidec_2_8bit($ascii) {
 		//only process in the following range: 48-87, 96-119
 		if ($ascii < 48) { }
@@ -93,6 +97,10 @@ 
 		return(substr($bin, -6)); 
 	}
 
+	/**
+	 * @param integer $_start
+	 * @param integer $_size
+	 */
 	private function binchar($_str, $_start, $_size) {
 		//  ' ' --- '?', // 0x20 - 0x3F
 		//  '@' --- '_', // 0x40 - 0x5F
@@ -118,6 +126,10 @@ 
 	}
 
 	// function for decoding the AIS Message ITU Payload
+
+	/**
+	 * @param string $_aisdata
+	 */
 	private function decode_ais($_aisdata) {
 		$ro = new stdClass(); // return object
 		$ro->cls = 0; // AIS class undefined, also indicate unparsed msg
@@ -351,6 +363,12 @@ 
 		elseif ($code == 99) return 'Other Type, no additional information';
 	}
 
+	/**
+	 * @param string $_itu
+	 * @param integer $_len
+	 * @param integer $_filler
+	 * @param string $aux
+	 */
 	public function process_ais_itu($_itu, $_len, $_filler, $aux /*, $ais_ch*/) {
 		global $port; // tcpip port...
 		
@@ -371,6 +389,10 @@ 
 
 	// char* - AIS \r terminated string
 	// TCP based streams which send messages in full can use this instead of calling process_ais_buf
+
+	/**
+	 * @param string $rawdata
+	 */
 	public function process_ais_raw($rawdata, $aux = '') { // return int
 		static $num_seq; // 1 to 9
 		static $seq; // 1 to 9
@@ -513,6 +535,9 @@ 
 		return $lond;
 	}
 
+	/**
+	 * @param integer $max_len
+	 */
 	private function char2bin($name, $max_len) {
 		$len = strlen($name);
 		if ($len > $max_len) $name = substr($name,0,$max_len);
@@ -540,6 +565,9 @@ 
 		return $rv.$pad;
 	}
 
+	/**
+	 * @param string $_enc
+	 */
 	private function mk_ais($_enc, $_part=1,$_total=1,$_seq='',$_ch='A') {
 		$len_bit = strlen($_enc);
 		$rem6 = $len_bit % 6;
@@ -593,6 +621,9 @@ 
 		return $result;
 	}
 
+	/**
+	 * @param string $mmsi
+	 */
 	public function mmsitype($mmsi) {
 		if (strlen($mmsi) == 9) {
 			if (substr($mmsi,0,3) == '974') return 'EPIRB (Emergency Position Indicating Radio Beacon) AIS';