Ysurac / FlightAirMap

require/class.NOTAM.php

Doc Comments +14 added lines

@@ -1098,6 +1098,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);
@@ -1179,6 +1183,10 @@ 
 			}
 		}
 	}
+
+	/**
+	 * @param string $filename
+	 */
 	public function updateNOTAMfromTextFile($filename) {
 		$alldata = $this->parseNOTAMtextFile($filename);
 		if (count($alldata) > 0) {
@@ -1223,6 +1231,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $icao
+	 */
 	public function downloadNOTAM($icao) {
 		date_default_timezone_set("UTC");
 		$Common = new Common();
@@ -1359,6 +1370,9 @@ 
 		return $result;
 	}
 	
+	/**
+	 * @param string $code
+	 */
 	public function parse_code($code) {
 		$code = str_split($code);
 		$code_fp = $code[1].$code[2];

require/class.SBS.php

Doc Comments +8 added lines

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

require/class.SpotterImport.php

Doc Comments +4 added lines

@@ -40,6 +40,10 @@
 	}
     }
 
+    /**
+     * @param string $id
+     * @param string $ident
+     */
     public function get_Schedule($id,$ident) {
 	global $globalDebug, $globalFork, $globalSchedulesFetch;
 	// Get schedule here, so it's done only one time

require/libs/simple_html_dom.php

Doc Comments +40 added lines

@@ -125,6 +125,9 @@ 
 	public $tag_start = 0;
 	private $dom = null;
 
+	/**
+	 * @param simple_html_dom $dom
+	 */
 	function __construct($dom)
 	{
 		$this->dom = $dom;
@@ -1501,6 +1504,11 @@ 
 	}
 
 	// parse attributes
+
+	/**
+	 * @param simple_html_dom_node $node
+	 * @param string[] $space
+	 */
 	protected function parse_attr($node, $name, &$space)
 	{
 		// Per sourceforge: http://sourceforge.net/tracker/?func=detail&aid=3061408&group_id=218559&atid=1044037
@@ -1538,6 +1546,11 @@ 
 	}
 
 	// link node's parent
+
+	/**
+	 * @param simple_html_dom_node $node
+	 * @param boolean $is_child
+	 */
 	protected function link_nodes(&$node, $is_child)
 	{
 		$node->parent = $this->parent;
@@ -1549,6 +1562,10 @@ 
 	}
 
 	// as a text node
+
+	/**
+	 * @param string $tag
+	 */
 	protected function as_text_node($tag)
 	{
 		$node = new simple_html_dom_node($this);
@@ -1559,12 +1576,18 @@ 
 		return true;
 	}
 
+	/**
+	 * @param string $chars
+	 */
 	protected function skip($chars)
 	{
 		$this->pos += strspn($this->doc, $chars, $this->pos);
 		$this->char = ($this->pos<$this->size) ? $this->doc[$this->pos] : null; // next
 	}
 
+	/**
+	 * @param string $chars
+	 */
 	protected function copy_skip($chars)
 	{
 		$pos = $this->pos;
@@ -1575,6 +1598,9 @@ 
 		return substr($this->doc, $pos, $len);
 	}
 
+	/**
+	 * @param string $chars
+	 */
 	protected function copy_until($chars)
 	{
 		$pos = $this->pos;
@@ -1584,6 +1610,9 @@ 
 		return substr($this->doc, $pos, $len);
 	}
 
+	/**
+	 * @param string $char
+	 */
 	protected function copy_until_char($char)
 	{
 		if ($this->char===null) return '';
@@ -1602,6 +1631,9 @@ 
 		return substr($this->doc, $pos_old, $pos-$pos_old);
 	}
 
+	/**
+	 * @param string $char
+	 */
 	protected function copy_until_char_escape($char)
 	{
 		if ($this->char===null) return '';
@@ -1633,6 +1665,10 @@ 
 
 	// remove noise from html content
 	// save the noise in the $this->noise array.
+
+	/**
+	 * @param string $pattern
+	 */
 	protected function remove_noise($pattern, $remove_tag=false)
 	{
 		global $debug_object;
@@ -1658,6 +1694,10 @@ 
 	}
 
 	// restore noise to html content
+
+	/**
+	 * @param string|null $text
+	 */
 	function restore_noise($text)
 	{
 		global $debug_object;

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.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 = '')

require/class.AIS.php

Doc Comments +25 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
@@ -589,6 +611,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';