Ysurac / FlightAirMap

require/class.Common.php

Doc Comments +15 added lines, -2 removed lines

@@ -100,6 +100,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');
@@ -124,6 +128,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
@@ -285,7 +292,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);
@@ -309,6 +316,9 @@ 
 	}
 
 
+	/**
+	 * @param string $latlong
+	 */
 	public function convertDec($dms,$latlong) {
 		if ($latlong == 'latitude') {
 			$deg = substr($dms, 0, 2);
@@ -343,6 +353,9 @@ 
 		return array('latitude' => round($latitude,5),'longitude' => round($longitude,5));
 	}
 	
+	/**
+	 * @param string $latlong
+	 */
 	public function convertDM($coord,$latlong) {
 		if ($latlong == 'latitude') {
 			if ($coord < 0) $NSEW = 'S';
@@ -480,7 +493,7 @@ 
 	/**
 	* Returns list of available locales
 	*
-	* @return array
+	* @return string[]
 	 */
 	public function listLocaleDir()
 	{

require/class.Connection.php

Doc Comments +20 added lines

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

Doc Comments +3 added lines, -21 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) {
@@ -694,25 +694,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 = '',$statusid = '',$format_source = '', $source_name = '', $captain_id = '',$captain_name = '',$race_id = '', $race_name = '')
 	{
@@ -1310,6 +1291,7 @@ 
 	/**
 	* Counts all hours
 	*
+	* @param string $orderby
 	* @return Array the hour list
 	*
 	*/
@@ -1661,7 +1643,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

@@ -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;
@@ -915,10 +915,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 = '')