Ysurac / FlightAirMap

require/class.Common.php

Doc Comments +15 added lines, -2 removed lines

@@ -97,6 +97,10 @@ 
 		return strlen($headerLine); // Needed by curl
 	}
 
+	/**
+	 * @param string $url
+	 * @param string $file
+	 */
 	public static function download($url, $file, $referer = '') {
 		global $globalDebug, $globalProxy, $globalForceIPv4;
 		$fp = fopen($file, 'w');
@@ -121,6 +125,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
@@ -272,7 +279,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);
@@ -295,6 +302,9 @@ 
 	}
 
 
+	/**
+	 * @param string $latlong
+	 */
 	public function convertDec($dms,$latlong) {
 		if ($latlong == 'latitude') {
 			$deg = substr($dms, 0, 2);
@@ -306,6 +316,9 @@ 
 		return $deg+(($min*60)/3600);
 	}
 	
+	/**
+	 * @param string $latlong
+	 */
 	public function convertDM($coord,$latlong) {
 		if ($latlong == 'latitude') {
 			if ($coord < 0) $NSEW = 'S';
@@ -443,7 +456,7 @@ 
 	/**
 	* Returns list of available locales
 	*
-	* @return array
+	* @return string[]
 	 */
 	public function listLocaleDir()
 	{

require/class.APRS.php

Doc Comments +4 added lines

@@ -174,6 +174,10 @@
 		'\|' => 'TNC Stream SW',
 		'\~' => 'TNC Stream SW');
 
+	/**
+	 * @param integer $n
+	 * @param integer $s
+	 */
 	private function urshift($n, $s) {
 		return ($n >= 0) ? ($n >> $s) :
 		    (($n & 0x7fffffff) >> $s) | 

require/class.Connection.php

Doc Comments +20 added lines

@@ -6,6 +6,9 @@ 
 	public $dbs = array();
 	public $latest_schema = 50;
 
+	/**
+	 * @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.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];