Ysurac / FlightAirMap

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

require/class.Common.php

Doc Comments +12 added lines, -2 removed lines

@@ -90,6 +90,10 @@ 
 		return strlen($headerLine); // Needed by curl
 	}
 
+	/**
+	 * @param string $url
+	 * @param string $file
+	 */
 	public static function download($url, $file, $referer = '') {
 		global $globalDebug;
 		$fp = fopen($file, 'w');
@@ -190,7 +194,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);
@@ -213,6 +217,9 @@ 
 	}
 
 
+	/**
+	 * @param string $latlong
+	 */
 	public function convertDec($dms,$latlong) {
 		if ($latlong == 'latitude') {
 			$deg = substr($dms, 0, 2);
@@ -224,6 +231,9 @@ 
 		return $deg+(($min*60)/3600);
 	}
 	
+	/**
+	 * @param string $latlong
+	 */
 	public function convertDM($coord,$latlong) {
 		if ($latlong == 'latitude') {
 			if ($coord < 0) $NSEW = 'S';
@@ -352,7 +362,7 @@ 
 	/**
 	* Returns list of available locales
 	*
-	* @return array
+	* @return string[]
 	 */
 	public function listLocaleDir()
 	{

require/class.Marine.php

Doc Comments +2 added lines, -21 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) {
@@ -552,25 +552,6 @@ 
 	*
 	* @param String $fammarine_id the ID
 	* @param String $ident the marine ident
-	* @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 $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 addMarineData($fammarine_id = '', $ident = '', $latitude = '', $longitude = '', $heading = '', $groundspeed = '', $date = '', $mmsi = '',$type = '',$typeid = '',$imo = '',$callsign = '',$arrival_code = '',$arrival_date = '',$status = '',$format_source = '', $source_name = '')
 	{
@@ -1444,7 +1425,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.MarineLive.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;
@@ -762,10 +762,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 = '',$noarchive = false,$format_source = '', $source_name = '', $over_country = '')

require/class.SpotterImport.php

Doc Comments +4 added lines

@@ -46,6 +46,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/class.APRS.php

Doc Comments +7 added lines

@@ -89,6 +89,10 @@ 
 	'y' => 'Yagi At QTH');
 	
 
+    /**
+     * @param integer $n
+     * @param integer $s
+     */
     private function urshift($n, $s) {
 	return ($n >= 0) ? ($n >> $s) :
 	    (($n & 0x7fffffff) >> $s) | 
@@ -475,6 +479,9 @@ 
 	socket_close($this->socket);
     }
     
+    /**
+     * @param string $data
+     */
     public function send($data) {
 	if ($this->connected === false) $this->connect();
 	$send = socket_send( $this->socket  , $data , strlen($data),0);

require/class.Connection.php

Doc Comments +20 added lines

@@ -6,6 +6,9 @@ 
 	public $dbs = array();
 	public $latest_schema = 38;
 	
+	/**
+	 * @param string $dbname
+	 */
 	public function __construct($dbc = null,$dbname = null,$user = null,$pass = null) {
 	    global $globalDBdriver, $globalNoDB;
 	    if (isset($globalNoDB) && $globalNoDB === TRUE) {
@@ -141,6 +144,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param string $table
+	 */
 	public function tableExists($table)
 	{
 		global $globalDBdriver, $globalDBname;
@@ -190,6 +196,11 @@ 
 	/*
 	* Check if index exist
 	*/
+
+	/**
+	 * @param string $table
+	 * @param string $index
+	 */
 	public function indexExists($table,$index)
 	{
 		global $globalDBdriver, $globalDBname;
@@ -232,6 +243,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);
@@ -242,6 +257,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;