Ysurac / FlightAirMap

require/class.Connection.php

Doc Comments +20 added lines

@@ -6,6 +6,9 @@ 
 	public $dbs = array();
 	public $latest_schema = 47;
 
+	/**
+	 * @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) {
@@ -584,25 +584,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 = '')
 	{
@@ -1195,6 +1176,7 @@ 
 	/**
 	* Counts all hours
 	*
+	* @param string $orderby
 	* @return Array the hour list
 	*
 	*/
@@ -1546,7 +1528,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.Stats.php

Doc Comments +51 added lines

@@ -21,6 +21,10 @@ 
 		if ($this->db === null) die('Error: No DB connection. (Stats)');
 	}
 
+	/**
+	 * @param string $type
+	 * @param string $stats_date
+	 */
 	public function addLastStatsUpdate($type,$stats_date) {
 		$query = "DELETE FROM config WHERE name = :type;
 			    INSERT INTO config (name,value) VALUES (:type,:stats_date);";
@@ -1415,6 +1419,10 @@ 
 		$all = $sth->fetchAll(PDO::FETCH_ASSOC);
 		return $all;
 	}
+
+	/**
+	 * @param string $type
+	 */
 	public function deleteStatsByType($type,$stats_airline = '', $filter_name = '') {
 		if ($filter_name == '') $filter_name = $this->filter_name;
 		$query = "DELETE FROM stats WHERE stats_type = :type AND stats_airline = :stats_airline AND filter_name = :filter_name";
@@ -1426,6 +1434,11 @@ 
 			echo "error : ".$e->getMessage();
 		}
 	}
+
+	/**
+	 * @param string $type
+	 * @param string $year
+	 */
 	public function getSumStats($type,$year,$stats_airline = '',$filter_name = '',$month = '') {
 		if ($filter_name == '') $filter_name = $this->filter_name;
 		global $globalArchiveMonths, $globalDBdriver;
@@ -1625,6 +1638,10 @@ 
 		else return 0;
 	}
 
+	/**
+	 * @param string $type
+	 * @param string $stats_date
+	 */
 	public function addStat($type,$cnt,$stats_date,$stats_airline = '',$filter_name = '') {
 		global $globalDBdriver;
 		if ($filter_name == '') $filter_name = $this->filter_name;
@@ -1678,6 +1695,9 @@ 
         }
         */
 
+	/**
+	 * @param string $stats_type
+	 */
 	public function getStatsSource($stats_type,$year = '',$month = '',$day = '') {
 		global $globalDBdriver;
 		$query = "SELECT * FROM stats_source WHERE stats_type = :stats_type";
@@ -1721,6 +1741,9 @@ 
 		return $all;
 	}
 
+	/**
+	 * @param string $stats_type
+	 */
 	public function addStatSource($data,$source_name,$stats_type,$date) {
 		global $globalDBdriver;
 		if ($globalDBdriver == 'mysql') {
@@ -1736,6 +1759,10 @@ 
 			return "error : ".$e->getMessage();
 		}
 	}
+
+	/**
+	 * @param string $type
+	 */
 	public function addStatFlight($type,$date_name,$cnt,$stats_airline = '',$filter_name = '') {
 		$query = "INSERT INTO stats_flight (stats_type,flight_date,cnt,stats_airline,filter_name) VALUES (:type,:flight_date,:cnt,:stats_airline,:filter_name)";
 		$query_values = array(':type' => $type,':flight_date' => $date_name,':cnt' => $cnt, ':stats_airline' => $stats_airline,':filter_name' => $filter_name);
@@ -1746,6 +1773,10 @@ 
 			return "error : ".$e->getMessage();
 		}
 	}
+
+	/**
+	 * @param string $type
+	 */
 	public function addStatMarine($type,$date_name,$cnt,$filter_name = '') {
 		$query = "INSERT INTO stats_marine (stats_type,marine_date,cnt,filter_name) VALUES (:type,:flight_date,:cnt,:filter_name)";
 		$query_values = array(':type' => $type,':flight_date' => $date_name,':cnt' => $cnt,':filter_name' => $filter_name);
@@ -1756,6 +1787,10 @@ 
 			return "error : ".$e->getMessage();
 		}
 	}
+
+	/**
+	 * @param string $type
+	 */
 	public function addStatTracker($type,$date_name,$cnt,$filter_name = '') {
 		$query = "INSERT INTO stats_tracker (stats_type,tracker_date,cnt,filter_name) VALUES (:type,:flight_date,:cnt,:filter_name)";
 		$query_values = array(':type' => $type,':flight_date' => $date_name,':cnt' => $cnt,':filter_name' => $filter_name);
@@ -2068,6 +2103,10 @@ 
 			return "error : ".$e->getMessage();
 		}
 	}
+
+	/**
+	 * @param string $type
+	 */
 	public function deleteStatFlight($type) {
 		$query = "DELETE FROM stats_flight WHERE stats_type = :type";
 		$query_values = array(':type' => $type);
@@ -2078,6 +2117,10 @@ 
 			return "error : ".$e->getMessage();
 		}
 	}
+
+	/**
+	 * @param string $type
+	 */
 	public function deleteStatMarine($type) {
 		$query = "DELETE FROM stats_marine WHERE stats_type = :type";
 		$query_values = array(':type' => $type);
@@ -2088,6 +2131,10 @@ 
 			return "error : ".$e->getMessage();
 		}
 	}
+
+	/**
+	 * @param string $type
+	 */
 	public function deleteStatTracker($type) {
 		$query = "DELETE FROM stats_tracker WHERE stats_type = :type";
 		$query_values = array(':type' => $type);
@@ -2098,6 +2145,10 @@ 
 			return "error : ".$e->getMessage();
 		}
 	}
+
+	/**
+	 * @param string $type
+	 */
 	public function deleteStatAirport($type) {
 		$query = "DELETE FROM stats_airport WHERE stats_type = :type";
 		$query_values = array(':type' => $type);

require/class.Tracker.php

Doc Comments +3 added lines, -32 removed lines

@@ -16,7 +16,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) {
@@ -487,9 +487,6 @@ 
 	/**
 	* Update ident tracker 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)
@@ -511,10 +508,6 @@ 
 	/**
 	* Update latest tracker 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 = '')
@@ -536,29 +529,6 @@ 
 	/**
 	* Adds a new tracker 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 = '')
 	{
@@ -1132,6 +1102,7 @@ 
 	/**
 	* Counts all hours
 	*
+	* @param string $orderby
 	* @return Array the hour list
 	*
 	*/
@@ -1483,7 +1454,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
 	*
 	*/