Ysurac / FlightAirMap

install/class.create_db.php

Doc Comments +4 added lines

@@ -3,6 +3,10 @@
 require_once(dirname(__FILE__).'/../require/class.Connection.php');
 
 class create_db {
+
+	/**
+	 * @param string $filename
+	 */
 	public static function import_file($filename) {
 		$filename = filter_var($filename,FILTER_SANITIZE_STRING);
 		$Connection = new Connection();

install/class.update_db.php

Doc Comments +31 added lines

@@ -10,6 +10,9 @@ 
 class update_db {
 	public static $db_sqlite;
 
+	/**
+	 * @param string $file
+	 */
 	public static function download($url, $file, $referer = '') {
 		$fp = fopen($file, 'w+');
 		$ch = curl_init();
@@ -23,6 +26,9 @@ 
 		curl_close($ch);
 	}
 
+	/**
+	 * @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
@@ -40,6 +46,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $in_file
+	 */
 	public static function unzip($in_file) {
 		if ($in_file != '' && file_exists($in_file)) {
 			$path = pathinfo(realpath($in_file), PATHINFO_DIRNAME);
@@ -61,6 +70,9 @@ 
 		}
 	}
 	
+	/**
+	 * @param string $database_file
+	 */
 	public static function retrieve_route_sqlite_to_dest($database_file) {
 		global $globalDebug, $globalTransaction;
 		//$query = 'TRUNCATE TABLE routes';
@@ -103,6 +115,10 @@ 
 		}
                 return '';
 	}
+
+	/**
+	 * @param string $database_file
+	 */
 	public static function retrieve_modes_sqlite_to_dest($database_file) {
 		global $globalTransaction;
 		//$query = 'TRUNCATE TABLE aircraft_modes';
@@ -168,6 +184,9 @@ 
 		return '';
 	}
 
+	/**
+	 * @param string $database_file
+	 */
 	public static function retrieve_modes_flarmnet($database_file) {
 		global $globalTransaction;
 		$Common = new Common();
@@ -237,6 +256,9 @@ 
 		return '';
 	}
 
+	/**
+	 * @param string $database_file
+	 */
 	public static function retrieve_modes_ogn($database_file) {
 		global $globalTransaction;
 		//$query = 'TRUNCATE TABLE aircraft_modes';
@@ -305,6 +327,9 @@ 
 		return '';
 	}
 
+	/**
+	 * @param string $database_file
+	 */
 	public static function retrieve_owner($database_file,$country = 'F') {
 		global $globalTransaction;
 		//$query = 'TRUNCATE TABLE aircraft_modes';
@@ -937,6 +962,9 @@ 
 
 	}
 */
+	/**
+	 * @param string $filename
+	 */
 	public static function waypoints($filename) {
 		//require_once(dirname(__FILE__).'/../require/class.Spotter.php');
 		global $tmp_dir, $globalTransaction;
@@ -993,6 +1021,9 @@ 
 		return '';
         }
 
+	/**
+	 * @param string $filename
+	 */
 	public static function ivao_airlines($filename) {
 		//require_once(dirname(__FILE__).'/../require/class.Spotter.php');
 		global $tmp_dir, $globalTransaction;

install/libs/simple_html_dom.php

Doc Comments +43 added lines

@@ -68,6 +68,9 @@ 
 // -----------------------------------------------------------------------------
 // get html dom from file
 // $maxlen is defined in the code as PHP_STREAM_COPY_ALL which is defined as -1.
+/**
+ * @param string $url
+ */
 function file_get_html($url, $use_include_path = false, $context=null, $offset = -1, $maxLen=-1, $lowercase = true, $forceTagsClosed=true, $target_charset = DEFAULT_TARGET_CHARSET, $stripRN=true, $defaultBRText=DEFAULT_BR_TEXT, $defaultSpanText=DEFAULT_SPAN_TEXT)
 {
 	// We DO force the tags to be terminated.
@@ -125,6 +128,9 @@ 
 	public $tag_start = 0;
 	private $dom = null;
 
+	/**
+	 * @param simple_html_dom $dom
+	 */
 	function __construct($dom)
 	{
 		$this->dom = $dom;
@@ -1501,6 +1507,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 +1549,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 +1565,10 @@ 
 	}
 
 	// as a text node
+
+	/**
+	 * @param string $tag
+	 */
 	protected function as_text_node($tag)
 	{
 		$node = new simple_html_dom_node($this);
@@ -1559,12 +1579,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 +1601,9 @@ 
 		return substr($this->doc, $pos, $len);
 	}
 
+	/**
+	 * @param string $chars
+	 */
 	protected function copy_until($chars)
 	{
 		$pos = $this->pos;
@@ -1584,6 +1613,9 @@ 
 		return substr($this->doc, $pos, $len);
 	}
 
+	/**
+	 * @param string $char
+	 */
 	protected function copy_until_char($char)
 	{
 		if ($this->char===null) return '';
@@ -1602,6 +1634,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 +1668,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 +1697,10 @@ 
 	}
 
 	// restore noise to html content
+
+	/**
+	 * @param string|null $text
+	 */
 	function restore_noise($text)
 	{
 		global $debug_object;

install/libs/sparqllib.php

Doc Comments +10 added lines

@@ -13,6 +13,9 @@ 
 function sparql_connect( $endpoint ) { return new sparql_connection( $endpoint ); }
 
 function sparql_ns( $short, $long, $db = null ) { return _sparql_a_connection( $db )->ns( $short, $long ); }
+/**
+ * @param string $sparql
+ */
 function sparql_query( $sparql, $db = null ) { return _sparql_a_connection( $db )->query( $sparql ); }
 function sparql_errno( $db = null ) { return _sparql_a_connection( $db )->errno(); }
 function sparql_error( $db = null ) { return _sparql_a_connection( $db )->error(); }
@@ -84,6 +87,9 @@ 
 		$this->params = $params;
 	}
 
+	/**
+	 * @param integer $timeout
+	 */
 	function query( $query, $timeout=null )
 	{	
 		$prefixes = "";
@@ -324,6 +330,10 @@ 
 	var $fields;
 	var $db;
 	var $i = 0;
+
+	/**
+	 * @param sparql_connection $db
+	 */
 	function __construct( $db, $rows, $fields )
 	{
 		$this->rows = $rows;

require/class.ACARS.php

Doc Comments -2 removed lines

@@ -809,8 +809,6 @@
 	/**
 	* Get Message title from label from DB
 	*
-	* @param String $ident
-	* @return Array Return ACARS data in array
 	*/
 	public function getTitlefromLabel($label) {
 		$Connection = new Connection($this->db);

require/class.APRS.php

Doc Comments +5 added lines

@@ -1,5 +1,10 @@
 <?php
 class aprs {
+
+    /**
+     * @param integer $n
+     * @param integer $s
+     */
     private function urshift($n, $s) {
 	return ($n >= 0) ? ($n >> $s) :
     	    (($n & 0x7fffffff) >> $s) | 

require/class.Common.php

Doc Comments +5 added lines, -2 removed lines

@@ -160,7 +160,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);
@@ -183,6 +183,9 @@ 
 	}
 
 
+	/**
+	 * @param string $latlong
+	 */
 	public function convertDec($dms,$latlong) {
 		if ($latlong == 'latitude') {
 			$deg = substr($dms, 0, 2);
@@ -274,7 +277,7 @@ 
 	/**
 	* Returns list of available locales
 	*
-	* @return array
+	* @return string[]
 	 */
 	public function listLocaleDir()
 	{

require/class.Connection.php

Doc Comments +6 added lines

@@ -6,6 +6,9 @@ 
 	public $dbs = array();
 	public $latest_schema = 23;
 	
+	/**
+	 * @param string $dbname
+	 */
 	public function __construct($dbc = null,$dbname = null) {
 	    global $globalDBdriver;
 	    if ($dbc === null) {
@@ -102,6 +105,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param string $table
+	 */
 	public function tableExists($table)
 	{
 		global $globalDBdriver, $globalDBname;

require/class.Image.php

Doc Comments +3 added lines

@@ -327,6 +327,9 @@
     }
 
 
+    /**
+     * @param string $aircraft_icao
+     */
     public function fromIvaoMtl($aircraft_icao,$airline_icao) {
 	$Common = new Common();
 	//echo "\n".'SEARCH IMAGE : http://mtlcatalog.ivao.aero/images/aircraft/'.$aircraft_icao.$airline_icao.'.jpg';