OpencachingDeutschland / oc-server3

htdocs/lib2/translate_filescan.class.php

Doc Comments +8 added lines

@@ -76,6 +76,10 @@ 
         }
     }
 
+    /**
+     * @param string $sCode
+     * @param integer $nStartSearch
+     */
     public function findEndOfPHPString($sCode, $nStartSearch)
     {
         $nEnd = 0;
@@ -116,6 +120,10 @@ 
     }
 
     // TODO: performance ... scan once at __construct and store line positions
+
+    /**
+     * @param integer $nPos
+     */
     public function findLineOfPos($nPos)
     {
         $nLine = 1;

htdocs/lib2/util.inc.php

Doc Comments +13 added lines

@@ -246,11 +246,21 @@ 
     return $ret;
 }
 
+/**
+ * @param string $name
+ * @param string $default
+ *
+ * @return string
+ */
 function getSysConfig($name, $default)
 {
     return sql_value("SELECT `value` FROM `sysconfig` WHERE `name`='&1'", $default, $name);
 }
 
+/**
+ * @param string $name
+ * @param string $value
+ */
 function setSysConfig($name, $value)
 {
     sql(
@@ -333,6 +343,9 @@ 
 }
 
 
+/**
+ * @return string
+ */
 function escape_javascript($text)
 {
     return str_replace('\'', '\\\'', str_replace('"', '"', $text));

htdocs/mydetails.php

Doc Comments +3 added lines

@@ -128,6 +128,9 @@
 }
 
 
+/**
+ * @param boolean $include_editor
+ */
 function assignFromDB($userid, $include_editor)
 {
     global $tpl, $opt, $smilies, $_REQUEST;

htdocs/myprofile.php

Doc Comments +3 added lines

@@ -182,6 +182,9 @@
     $tpl->display();
 }
 
+/**
+ * @param user $user
+ */
 function assignFromUser($user)
 {
     global $tpl;

htdocs/okapi/core.php

Doc Comments +32 added lines

@@ -188,6 +188,9 @@ 
         }
     }
 
+    /**
+     * @return string
+     */
     public static function removeSensitiveData($message)
     {
         return str_replace(
@@ -553,6 +556,10 @@ 
         return mysql_affected_rows();
     }
 
+    /**
+     * @param string $table
+     * @param string $field
+     */
     public static function field_exists($table, $field)
     {
         if (!preg_match("/[a-z0-9_]+/", $table.$field))
@@ -679,6 +686,9 @@ 
     public $consumer_key;
     public $token_type;
 
+    /**
+     * @param string $token_type
+     */
     public function __construct($key, $secret, $consumer_key, $token_type)
     {
         parent::__construct($key, $secret);
@@ -755,6 +765,7 @@ 
      * options. If $token_required == false, it doesn't throw an exception when
      * there is no token specified. You may also change the token_type required
      * for this request.
+     * @param OAuthRequest $request
      */
     public function verify_request2(&$request, $token_type = 'access', $token_required = true)
     {
@@ -1052,6 +1063,7 @@ 
      * Save a variable to okapi_vars. WARNING: The entire content of okapi_vars table
      * is loaded on EVERY execution. Do not store data in this table, unless it's
      * frequently needed.
+     * @param string $varname
      */
     public static function set_var($varname, $value)
     {
@@ -1330,6 +1342,7 @@ 
 
     /**
      * Split the array into groups of max. $size items.
+     * @param integer $size
      */
     public static function make_groups($array, $size)
     {
@@ -1476,6 +1489,7 @@ 
      * Generate a string of random characters, suitable for keys as passwords.
      * Troublesome characters like '0', 'O', '1', 'l' will not be used.
      * If $user_friendly=true, then it will consist from numbers only.
+     * @param integer $length
      */
     public static function generate_key($length, $user_friendly = false)
     {
@@ -1496,6 +1510,7 @@ 
      * Register new OKAPI Consumer, send him an email with his key-pair, etc.
      * This method does not verify parameter values, check if they are in
      * a correct format prior the execution.
+     * @param string $appname
      */
     public static function register_new_consumer($appname, $appurl, $email)
     {
@@ -1565,6 +1580,8 @@ 
     /**
      * Return an SQL formula for calculating distance between two geopoints.
      * Parameters should be either numberals or strings (SQL field references).
+     * @param null|string $lat2
+     * @param null|string $lon2
      */
     public static function get_distance_sql($lat1, $lon1, $lat2, $lon2)
     {
@@ -2044,6 +2061,9 @@ 
         return $html;
     }
 
+    /**
+     * @param string $variable
+     */
     function php_ini_get_bytes($variable)
     {
         $value = trim(ini_get($variable));
@@ -2077,6 +2097,7 @@ 
      *
      * If $timeout is null, then the object will be treated as persistent
      * (the Cache will do its best to NEVER remove it).
+     * @param string $key
      */
     public static function set($key, $value, $timeout)
     {
@@ -2099,6 +2120,8 @@ 
     /**
      * Scored version of set. Elements set up this way will expire when they're
      * not used.
+     * @param string $key
+     * @param string $value
      */
     public static function set_scored($key, $value)
     {
@@ -2201,6 +2224,7 @@ 
 
     /**
      * Delete key $key from the cache.
+     * @param string $key
      */
     public static function delete($key)
     {
@@ -2226,6 +2250,9 @@ 
  */
 class FileCache
 {
+    /**
+     * @param string $key
+     */
     public static function get_file_path($key)
     {
         $filename = Okapi::get_var_dir()."/okapi_filecache_".md5($key);
@@ -2238,6 +2265,8 @@ 
      * Note, there is no $timeout (time to live) parameter. Currently,
      * OKAPI will delete every old file after certain amount of time.
      * See CacheCleanupCronJob for details.
+     * @param string $key
+     * @param string $value
      */
     public static function set($key, $value)
     {
@@ -2274,6 +2303,7 @@ 
     /**
      * Return request parameter, or NULL when not found. Use this instead of
      * $_GET or $_POST or $_REQUEST.
+     * @param string $name
      */
     public abstract function get_parameter($name);
 
@@ -2310,6 +2340,7 @@ 
     /**
      * You may use "null" values in parameters if you want them skipped
      * (null-ized keys will be removed from parameters).
+     * @param OkapiConsumer|null $consumer
      */
     public function __construct($consumer, $token, $parameters)
     {
@@ -2526,6 +2557,7 @@ 
     /**
      * Return request parameter, or NULL when not found. Use this instead of
      * $_GET or $_POST or $_REQUEST.
+     * @param string $name
      */
     public function get_parameter($name)
     {

htdocs/okapi/cronjobs.php

Doc Comments +3 added lines

@@ -64,6 +64,7 @@ 
     /**
      * Execute all scheduled cronjobs of given type, reschedule, and return
      * UNIX timestamp of the nearest scheduled event.
+     * @param string $type
      */
     public static function run_jobs($type)
     {
@@ -127,6 +128,7 @@ 
     /**
      * Force a specified cronjob to run. Throw an exception if cronjob not found.
      * $job_name mast equal one of the names returned by ->get_name() method.
+     * @param string $job_name
      */
     public static function force_run($job_name)
     {
@@ -146,6 +148,7 @@ 
     /**
      * Reset the schedule of a specified cronjob. This will force the job to
      * run on nearest occasion (but not NOW).
+     * @param string $job_name
      */
     public static function reset_job_schedule($job_name)
     {

htdocs/okapi/lib/tbszip.php

Doc Comments +48 added lines

@@ -77,6 +77,9 @@ 
         $this->AddInfo = array();
     }
 
+    /**
+     * @param string $Name
+     */
     function FileAdd($Name, $Data, $DataType=self::TBSZIP_STRING, $Compress=true) {
 
         if ($Data===false) return $this->FileCancelModif($Name, false); // Cancel a previously added file
@@ -127,6 +130,9 @@ 
         return true;
     }
 
+    /**
+     * @param string $cd_info
+     */
     function CentralDirRead_End($cd_info) {
         $b = $cd_info.$this->_ReadData(18);
         $x = array();
@@ -142,6 +148,9 @@ 
         return $x;
     }
 
+    /**
+     * @param integer $idx
+     */
     function CentralDirRead_File($idx) {
 
         $b = $this->_ReadData(46);
@@ -175,6 +184,9 @@ 
         return $x;
     }
 
+    /**
+     * @param string $Msg
+     */
     function RaiseError($Msg) {
         if ($this->DisplayError) {
             if (PHP_SAPI==='cli') {
@@ -310,6 +322,9 @@ 
 
     }
 
+    /**
+     * @param boolean $ReadData
+     */
     function _ReadFile($idx, $ReadData) {
     // read the file header (and maybe the data ) in the archive, assuming the cursor in at a new file position
 
@@ -625,6 +640,10 @@ 
     // output functions
     // ----------------
 
+    /**
+     * @param integer $Render
+     * @param string $ContentType
+     */
     function OutputOpen($Render, $File, $ContentType) {
 
         if (($Render & self::TBSZIP_FILE)==self::TBSZIP_FILE) {
@@ -697,6 +716,9 @@ 
     // Reading functions
     // ----------------
 
+    /**
+     * @param integer $relative
+     */
     function _MoveTo($pos, $relative = SEEK_SET) {
         fseek($this->ArchHnd, $pos, $relative);
     }
@@ -714,6 +736,10 @@ 
     // Take info from binary data
     // ----------------
 
+    /**
+     * @param integer $pos
+     * @param integer $len
+     */
     function _GetDec($txt, $pos, $len) {
         $x = substr($txt, $pos, $len);
         $z = 0;
@@ -724,11 +750,21 @@ 
         return $z;
     }
 
+    /**
+     * @param string $txt
+     * @param integer $pos
+     * @param integer $len
+     */
     function _GetHex($txt, $pos, $len) {
         $x = substr($txt, $pos, $len);
         return 'h:'.bin2hex(strrev($x));
     }
 
+    /**
+     * @param string $txt
+     * @param integer $pos
+     * @param integer $len
+     */
     function _GetBin($txt, $pos, $len) {
         $x = substr($txt, $pos, $len);
         $z = '';
@@ -749,6 +785,10 @@ 
     // Put info into binary data
     // ----------------
 
+    /**
+     * @param integer $pos
+     * @param integer $len
+     */
     function _PutDec(&$txt, $val, $pos, $len) {
         $x = '';
         for ($i=0;$i<$len;$i++) {
@@ -802,6 +842,7 @@ 
      * Return the position of the record in the file.
      * Return false if the record is not found. The comment cannot exceed 65335 bytes (=FFFF).
      * The method is read backwards a block of 256 bytes and search the key in this block.
+     * @param string $cd_info
      */
     function _FindCDEnd($cd_info) {
         $nbr = 1;
@@ -825,6 +866,9 @@ 
         return false;
     }
 
+    /**
+     * @param integer $PosLoc
+     */
     function _DataOuputAddedFile($Idx, $PosLoc) {
 
         $Ref =& $this->AddInfo[$Idx];
@@ -885,6 +929,10 @@ 
 
     }
 
+    /**
+     * @param integer $DataType
+     * @param boolean $Compress
+     */
     function _DataCreateNewRef($Data, $DataType, $Compress, $Diff, $NameOrIdx) {
 
         $file_time = false;

htdocs/okapi/oauth.php

Doc Comments +22 added lines

@@ -104,6 +104,10 @@ 
     $extras['reason_stack'][] = 'missing_parameter';
     $extras['parameter'] = $this->param_name;
   }
+
+  /**
+   * @param string $param_name
+   */
   public function __construct($param_name) {
     parent::__construct("Missing '$param_name' parameter. This parameter is required.");
     $this->param_name = $param_name;
@@ -151,6 +155,12 @@ 
     $extras['difference'] = $this->ourTimestamp - $this->usersTimestamp;
     $extras['threshold'] = $this->threshold;
   }
+
+  /**
+   * @param integer $users
+   * @param integer $ours
+   * @param integer $threshold
+   */
   public function __construct($users, $ours, $threshold) {
     $this->usersTimestamp = $users;
     $this->ourTimestamp = $ours;
@@ -352,6 +362,12 @@ 
   // (1) do a lookup in a table of trusted certs keyed off of consumer
   //
   // Either way should return a string representation of the certificate
+
+  /**
+   * @param OAuthRequest $request
+   *
+   * @return string
+   */
   protected abstract function fetch_private_cert(&$request);
 
   public function build_signature($request, $consumer, $token) {
@@ -481,6 +497,9 @@ 
     return new OAuthRequest($http_method, $http_url, $parameters);
   }
 
+  /**
+   * @param string $name
+   */
   public function set_parameter($name, $value, $allow_duplicates = true) {
     if ($allow_duplicates && isset($this->parameters[$name])) {
       // We have already added parameter(s) with this name, so add to the list
@@ -665,6 +684,9 @@ 
     $this->data_store = $data_store;
   }
 
+  /**
+   * @param OAuthSignatureMethod_HMAC_SHA1 $signature_method
+   */
   public function add_signature_method($signature_method) {
     $this->signature_methods[$signature_method->get_name()] =
       $signature_method;

htdocs/okapi/services/caches/map/tile.php

Doc Comments +4 added lines

@@ -55,6 +55,10 @@
         );
     }
 
+    /**
+     * @param OkapiRequest $request
+     * @param string $name
+     */
     private static function require_uint($request, $name, $min_value = 0)
     {
         $val = $request->get_parameter($name);