Ysurac / FlightAirMap

require/class.SBS.php

Doc Comments +8 added lines

@@ -190,12 +190,20 @@
 		return 1;
 	}
 
+	/**
+	 * @param double $lat
+	 * @param integer $isodd
+	 */
 	private function cprN($lat,$isodd) {
 		$nl = $this->cprNL($lat) - $isodd;
 		if ($nl > 1) return $nl;
 		else return 1;
 	}
 
+	/**
+	 * @param string $msg
+	 * @param string $bin
+	 */
 	private function parityCheck($msg, $bin) {
 		$modes_checksum_table = array(
 		    0x3935ea, 0x1c9af5, 0xf1b77e, 0x78dbbf, 0xc397db, 0x9e31e9, 0xb0e2f0, 0x587178,

require/class.AIS.php

Doc Comments +25 added lines

@@ -156,6 +156,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) { }
@@ -181,6 +185,10 @@ 
 		return(substr($bin, -6)); 
 	}
 
+	/**
+	 * @param integer $_start
+	 * @param integer $_size
+	 */
 	private function binchar($_str, $_start, $_size) {
 		//  ' ' --- '?', // 0x20 - 0x3F
 		//  '@' --- '_', // 0x40 - 0x5F
@@ -206,6 +214,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
@@ -378,6 +390,12 @@ 
 		else return 0;
 	}
 
+	/**
+	 * @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...
 		static $debug_counter = 0;
@@ -397,6 +415,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
@@ -622,6 +644,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';

require/class.NOTAM.php

Doc Comments +14 added lines

@@ -1126,6 +1126,10 @@ 
 		else return array();
 	}
 
+	/**
+	 * @param string $type
+	 * @param string $rules
+	 */
 	public function addNOTAM($ref,$title,$type,$fir,$code,$rules,$scope,$lower_limit,$upper_limit,$center_latitude,$center_longitude,$radius,$date_begin,$date_end,$permanent,$text,$full_notam) {
 		$query = "INSERT INTO notam (ref,title,notam_type,fir,code,rules,scope,lower_limit,upper_limit,center_latitude,center_longitude,radius,date_begin,date_end,permanent,notam_text,full_notam) VALUES (:ref,:title,:type,:fir,:code,:rules,:scope,:lower_limit,:upper_limit,:center_latitude,:center_longitude,:radius,:date_begin,:date_end,:permanent,:text,:full_notam)";
 		$query_values = array(':ref' => $ref,':title' => $title,':type' => $type,':fir' => $fir,':code' => $code,':rules' => $rules,':scope' => $scope,':lower_limit' => $lower_limit,':upper_limit' => $upper_limit,':center_latitude' => $center_latitude,':center_longitude' => $center_longitude,':radius' => $radius,':date_begin' => $date_begin,':date_end' => $date_end,':permanent' => $permanent,':text' => $text,':full_notam' => $full_notam);
@@ -1207,6 +1211,10 @@ 
 			}
 		}
 	}
+
+	/**
+	 * @param string $filename
+	 */
 	public function updateNOTAMfromTextFile($filename) {
 		global $globalTransaction, $globalDebug;
 		$alldata = $this->parseNOTAMtextFile($filename);
@@ -1261,6 +1269,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $icao
+	 */
 	public function downloadNOTAM($icao) {
 		date_default_timezone_set("UTC");
 		$Common = new Common();
@@ -1416,6 +1427,9 @@ 
 		return $result;
 	}
 	
+	/**
+	 * @param string $code
+	 */
 	public function parse_code($code) {
 		$code = str_split($code);
 		$code_fp = $code[1].$code[2];

require/class.Language.php

Doc Comments +4 added lines, -1 removed lines

@@ -77,7 +77,7 @@ 
 	/**
 	* Returns list of available locales
 	*
-	* @return array
+	* @return string[]
 	*/
 	public function listLocaleDir()
 	{
@@ -97,6 +97,9 @@ 
 		return $result;
 	}
 
+	/**
+	 * @param string $locale
+	 */
 	public function getLocale($locale)
 	{
 		return array($locale,$this->all_languages[$locale][1],$this->all_languages[$locale][2],$locale.'.utf8',$locale.'.UTF8');

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

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.Source.php

Doc Comments +3 added lines

@@ -179,6 +179,9 @@
 		}
 	}
 
+	/**
+	 * @param string $type
+	 */
 	public function deleteLocationByType($type) {
 		$query = "DELETE FROM source_location WHERE type = :type";
 		$query_values = array(':type' => $type);

install/class.update_db.php

Doc Comments +48 added lines

@@ -20,6 +20,9 @@ 
 		return $writable;
 	}
 
+	/**
+	 * @param string $file
+	 */
 	public static function download($url, $file, $referer = '') {
 		global $globalProxy, $globalForceIPv4;
 		$fp = fopen($file, 'w');
@@ -44,6 +47,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
@@ -65,6 +71,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);
@@ -86,6 +95,9 @@ 
 		}
 	}
 	
+	/**
+	 * @param string $database_file
+	 */
 	public static function retrieve_route_sqlite_to_dest($database_file) {
 		global $globalDebug, $globalTransaction;
 		//$query = 'TRUNCATE TABLE routes';
@@ -128,6 +140,10 @@ 
 		}
                 return '';
 	}
+
+	/**
+	 * @param string $database_file
+	 */
 	public static function retrieve_route_oneworld($database_file) {
 		global $globalDebug, $globalTransaction;
 		//$query = 'TRUNCATE TABLE routes';
@@ -169,6 +185,9 @@ 
                 return '';
 	}
 	
+	/**
+	 * @param string $database_file
+	 */
 	public static function retrieve_route_skyteam($database_file) {
 		global $globalDebug, $globalTransaction;
 		//$query = 'TRUNCATE TABLE routes';
@@ -211,6 +230,10 @@ 
 		}
                 return '';
 	}
+
+	/**
+	 * @param string $database_file
+	 */
 	public static function retrieve_modes_sqlite_to_dest($database_file) {
 		global $globalTransaction;
 		//$query = 'TRUNCATE TABLE aircraft_modes';
@@ -277,6 +300,9 @@ 
 		return '';
 	}
 
+	/**
+	 * @param string $database_file
+	 */
 	public static function retrieve_modes_flarmnet($database_file) {
 		global $globalTransaction;
 		$Common = new Common();
@@ -347,6 +373,9 @@ 
 		return '';
 	}
 
+	/**
+	 * @param string $database_file
+	 */
 	public static function retrieve_modes_ogn($database_file) {
 		global $globalTransaction;
 		//$query = 'TRUNCATE TABLE aircraft_modes';
@@ -416,6 +445,9 @@ 
 		return '';
 	}
 
+	/**
+	 * @param string $database_file
+	 */
 	public static function retrieve_owner($database_file,$country = 'F') {
 		global $globalTransaction, $globalMasterSource;
 		//$query = 'TRUNCATE TABLE aircraft_modes';
@@ -1448,6 +1480,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;
@@ -1497,6 +1533,9 @@ 
 		return '';
         }
 
+	/**
+	 * @param string $filename
+	 */
 	public static function satellite_ucsdb($filename) {
 		global $tmp_dir, $globalTransaction;
 		
@@ -1545,6 +1584,9 @@ 
 		return '';
 	}
 
+	/**
+	 * @param string $filename
+	 */
 	public static function satellite_celestrak($filename) {
 		global $tmp_dir, $globalTransaction, $globalDebug;
 		$satcat_sources = array(
@@ -1871,6 +1913,9 @@ 
 
 	}
 */
+	/**
+	 * @param string $filename
+	 */
 	public static function waypoints($filename) {
 		//require_once(dirname(__FILE__).'/../require/class.Spotter.php');
 		global $tmp_dir, $globalTransaction;
@@ -1948,6 +1993,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $filename
+	 */
 	public static function ivao_airlines($filename) {
 		//require_once(dirname(__FILE__).'/../require/class.Spotter.php');
 		global $tmp_dir, $globalTransaction;