Removed deprecated HTML tags and fixed PHPDoc descriptions

Geeklog-Core · Aug 17, 2019 · d8615ad · d8615ad
1 parent 27ebf15
commit d8615ad
Show file tree

Hide file tree

Showing 38 changed files with 100 additions and 135 deletions.
diff --git a/plugins/calendar/autoinstall.php b/plugins/calendar/autoinstall.php
@@ -30,10 +30,12 @@
 // +---------------------------------------------------------------------------+
 
 /**
-* Calendar plugin automatic plugin install
-*
-* @package Calendar
-*/
+ * Calendar plugin automatic plugin install
+ *
+ * @package Calendar
+ * @param   string  $pi_name
+ * @return  array
+ */
 
 function plugin_autoinstall_calendar($pi_name)
 {
@@ -151,5 +153,3 @@ function plugin_compatible_with_this_version_calendar($pi_name)
 
     return true;
 }
-
-?>
diff --git a/plugins/calendar/functions.inc b/plugins/calendar/functions.inc
@@ -578,13 +578,13 @@ function plugin_savesubmission_calendar($A)
     $A['end_minute'] = COM_applyFilter($A['end_minute'], true);
 
     if ($A['start_ampm'] == 'pm' && $A['start_hour'] != 12) {
-        $A['start_hour'] = $A['start_hour'] + 12;
+        $A['start_hour'] = (int) $A['start_hour'] + 12;
     }
     if ($A['start_ampm'] == 'am' && $A['start_hour'] == 12) {
         $A['start_hour'] = '00';
     }
     if ($A['end_ampm'] == 'pm' && $A['end_hour'] != 12) {
-        $A['end_hour'] = $A['end_hour'] + 12;
+        $A['end_hour'] = (int) $A['end_hour'] + 12;
     }
     if ($A['end_ampm'] == 'am' && $A['end_hour'] == 12) {
         $A['end_hour'] = '00';
@@ -1133,8 +1133,13 @@ function plugin_submissioncount_calendar()
 
 /**
  * Implements the [event:] autotag.
+ *
+ * @param   string  $op
+ * @param   string  $content
+ * @param   array   $autotag
+ * @return  array|string
  */
-function plugin_autotags_calendar($op, $content = '', $autotag = '')
+function plugin_autotags_calendar($op, $content = '', $autotag = array())
 {
     global $_CONF, $_TABLES, $LANG_CAL_1, $_CA_CONF, $_GROUPS;
 
@@ -1211,6 +1216,8 @@ function plugin_getfeednames_calendar()
  * @param    string $feed   feed ID
  * @param    string $link   link to homepage
  * @param    string $update list of story ids
+ * @param    string $feedType
+ * @param    int    $feedVersion
  * @return   array              content of the feed
  */
 function plugin_getfeedcontent_calendar($feed, &$link, &$update, $feedType, $feedVersion)
@@ -2310,7 +2317,8 @@ function plugin_itemdeleted_calendar($id, $type)
 /**
  * Did user create any events
  *
- * @return   string   number of events user contributed. If nothing leave blank
+ * @param    int     $uid
+ * @return   string        number of events user contributed. If nothing leave blank
  */
 function plugin_usercontributed_calendar($uid)
 {

diff --git a/plugins/calendar/install_defaults.php b/plugins/calendar/install_defaults.php
@@ -223,5 +223,3 @@ function plugin_initconfig_calendar()
 
     return true;
 }
-
-?>
diff --git a/plugins/calendar/install_updates.php b/plugins/calendar/install_updates.php
@@ -68,5 +68,3 @@ function calendar_update_ConfValues_1_1_2()
 
     return true;
 }
-
-?>
diff --git a/plugins/calendar/language/english.php b/plugins/calendar/language/english.php
@@ -252,5 +252,3 @@
     14 => array('No access' => 0, 'Read-Only' => 2),
     15 => array('All' => TOPIC_ALL_OPTION, 'Homepage Only' => TOPIC_HOMEONLY_OPTION, 'Select Topics' => TOPIC_SELECTED_OPTION)
 );
-
-?>
diff --git a/plugins/calendar/language/english_utf-8.php b/plugins/calendar/language/english_utf-8.php
@@ -252,5 +252,3 @@
     14 => array('No access' => 0, 'Read-Only' => 2),
     15 => array('All' => TOPIC_ALL_OPTION, 'Homepage Only' => TOPIC_HOMEONLY_OPTION, 'Select Topics' => TOPIC_SELECTED_OPTION)
 );
-
-?>
diff --git a/plugins/calendar/sql/mysql_install.php b/plugins/calendar/sql/mysql_install.php
@@ -118,5 +118,3 @@
 ";
 
 $_SQL[] = "INSERT INTO {$_TABLES['eventsubmission']} (eid, title, description, location, datestart, dateend, url, allday, zipcode, state, city, address2, address1, event_type, timestart, timeend, owner_id) VALUES ('2008050110130162','Installed the Calendar plugin','Today, you successfully installed the Calendar plugin.','Your webserver',CURDATE(),CURDATE(),'https://www.geeklog.net/',1,NULL,NULL,NULL,NULL,NULL,'',NULL,NULL,1)";
-
-?>
diff --git a/plugins/calendar/sql/mysql_updates.php b/plugins/calendar/sql/mysql_updates.php
@@ -140,5 +140,3 @@ function calendar_update_Zipcode_1_1_2()
 {
     // Nothing to do
 }
-
-?>
diff --git a/plugins/calendar/sql/pgsql_install.php b/plugins/calendar/sql/pgsql_install.php
@@ -118,5 +118,3 @@
 ";
 
 $_SQL[] = "INSERT INTO {$_TABLES['eventsubmission']} (eid, title, description, location, datestart, dateend, url, allday, zipcode, state, city, address2, address1, event_type, timestart, timeend) VALUES ('2008050110130162','Installed the Calendar plugin','Today, you successfully installed the Calendar plugin.','Your webserver',CURDATE(),CURDATE(),'https://www.geeklog.net/',1,NULL,NULL,NULL,NULL,NULL,'',NULL,NULL)";
-
-?>
diff --git a/plugins/calendar/sql/pgsql_updates.php b/plugins/calendar/sql/pgsql_updates.php
@@ -126,5 +126,3 @@ function calendar_update_Zipcode_1_1_2()
         DB_query($sql);
     }
 }
-
-?>
diff --git a/plugins/links/autoinstall.php b/plugins/links/autoinstall.php
@@ -120,14 +120,14 @@ function plugin_load_configuration_links($pi_name)
 }
 
 /**
-* Plugin postinstall
-*
-* We're inserting our default data here since it depends on other stuff that
-* has to happen first ...
-*
-* @return   boolean     true = proceed with install, false = an error occurred
-*
-*/
+ * Plugin postinstall
+ *
+ * We're inserting our default data here since it depends on other stuff that
+ * has to happen first ...
+ *
+ * @param  string $pi_name
+ * @return bool            true = proceed with install, false = an error occurred
+ */
 function plugin_postinstall_links($pi_name)
 {
     global $_CONF, $_TABLES;
@@ -204,5 +204,3 @@ function plugin_compatible_with_this_version_links($pi_name)
 
     return true;
 }
-
-?>
diff --git a/plugins/links/configuration_validation.php b/plugins/links/configuration_validation.php
@@ -95,5 +95,3 @@
 $_CONF_VALIDATE['links']['autotag_permissions_link[3]'] = array(
     'rule' => array('inList', array(0, 2), true)
 );
-
-?>
diff --git a/plugins/links/functions.inc b/plugins/links/functions.inc
@@ -185,10 +185,9 @@ function plugin_getwhatsnew_links()
 * @param    string  $op         operation to perform
 * @param    string  $content    item (e.g. story text), including the autotag
 * @param    array   $autotag    parameters used in the autotag
-* @param    mixed               tag names (for $op='tagname') or formatted content
-*
+* @return   string|array
 */
-function plugin_autotags_links($op, $content = '', $autotag = '')
+function plugin_autotags_links($op, $content = '', $autotag = array())
 {
     global $_CONF, $_TABLES, $LANG_DIRECTION, $LANG_LINKS, $_LI_CONF, $_GROUPS;
 
@@ -301,11 +300,9 @@ function LINKS_countLinksAndClicks()
 * If $showsitestats is 1 then we are to only print the overall stats in the
 * 'site statistics box' otherwise we show the detailed stats
 *
-* @param    int     $showsitestate  Flag to let us know which stats to get
-* @param    string                  HTML for the stats section
-*
+* @return   string
 */
-function plugin_showstats_links ($showsitestats)
+function plugin_showstats_links ()
 {
     global $_CONF, $_TABLES, $LANG_LINKS_STATS;
 
@@ -838,8 +835,7 @@ function plugin_upgrade_links()
 * Called during site migration - handle changed URLs or paths
 *
 * @param    array   $old_conf   contents of the $_CONF array on the old site
-* @param    boolean             true on success, otherwise false
-*
+* @return   bool                true on success, otherwise false
 */
 function plugin_migrate_links($old_conf)
 {
@@ -1152,9 +1148,10 @@ function plugin_save_submit_links($A)
     }
 
     if (($_LI_CONF['linksubmission'] == 1) && !SEC_hasRights('links.submit')) {
-        $result = DB_save($_TABLES['linksubmission'],
-                    'lid,cid,url,description,title,date,owner_id',
-                    "{$A['lid']},'{$A['cid']}','{$A['url']}','{$A['description']}','{$A['title']}',NOW(),$owner_id");
+        DB_save(
+            $_TABLES['linksubmission'], 'lid,cid,url,description,title,date,owner_id',
+    "{$A['lid']},'{$A['cid']}','{$A['url']}','{$A['description']}','{$A['title']}',NOW(),$owner_id"
+        );
 
         if ($_LI_CONF['notification'] == 1) {
             LINKS_sendNotification($_TABLES['linksubmission'], $A);
@@ -1170,9 +1167,10 @@ function plugin_save_submit_links($A)
         }
         SEC_setDefaultPermissions($A, $_LI_CONF['default_permissions']);
 
-        $result = DB_save($_TABLES['links'],
-                    'lid,cid,url,description,title,date,owner_id,group_id,perm_owner,perm_group,perm_members,perm_anon',
-                    "{$A['lid']},'{$A['cid']}','{$A['url']}','{$A['description']}','{$A['title']}',NOW(),$owner_id,{$A['group_id']},{$A['perm_owner']},{$A['perm_group']},{$A['perm_members']},{$A['perm_anon']}");
+        DB_save(
+            $_TABLES['links'], 'lid,cid,url,description,title,date,owner_id,group_id,perm_owner,perm_group,perm_members,perm_anon',
+    "{$A['lid']},'{$A['cid']}','{$A['url']}','{$A['description']}','{$A['title']}',NOW(),$owner_id,{$A['group_id']},{$A['perm_owner']},{$A['perm_group']},{$A['perm_members']},{$A['perm_anon']}"
+        );
 
         PLG_itemSaved($A['lid'], 'links');
 
@@ -1354,10 +1352,9 @@ function links_validateUrl($url)
 {
     global $LANG_LINKS_STATUS;
 
-    $req = new HTTP_Request2($url, HTTP_Request2::METHOD_HEAD);
-    $req->setHeader('User-Agent', 'Geeklog/' . VERSION);
-
     try {
+        $req = new HTTP_Request2($url, HTTP_Request2::METHOD_HEAD);
+        $req->setHeader('User-Agent', 'Geeklog/' . VERSION);
         $response = $req->send();
         $status_code = $response->getStatus();
 
@@ -1917,7 +1914,8 @@ function plugin_group_changed_links($grp_id, $mode)
 /**
  * Did user create any links
  *
- * @return   string   number of links user contributed. If nothing leave blank
+ * @param   int  $uid
+ * @return  string   number of links user contributed. If nothing leave blank
  */
 function plugin_usercontributed_links($uid)
 {

diff --git a/plugins/links/install_defaults.php b/plugins/links/install_defaults.php
@@ -254,5 +254,3 @@ function plugin_initconfig_links()
 
     return true;
 }
-
-?>
diff --git a/plugins/links/install_updates.php b/plugins/links/install_updates.php
@@ -25,5 +25,3 @@ function links_update_ConfValues_2_1_0()
 
     return true;
 }
-
-?>
diff --git a/plugins/links/language/english.php b/plugins/links/language/english.php
@@ -311,5 +311,3 @@
     12 => array('No access' => 0, 'Read-Only' => 2, 'Read-Write' => 3),
     13 => array('No access' => 0, 'Use' => 2)
 );
-
-?>
diff --git a/plugins/links/language/english_utf-8.php b/plugins/links/language/english_utf-8.php
@@ -311,5 +311,3 @@
     12 => array('No access' => 0, 'Read-Only' => 2, 'Read-Write' => 3),
     13 => array('No access' => 0, 'Use' => 2)
 );
-
-?>
diff --git a/plugins/links/sql/mysql_install.php b/plugins/links/sql/mysql_install.php
@@ -102,5 +102,3 @@
   PRIMARY KEY (lid)
 ) ENGINE=MyISAM
 ";
-
-?>
diff --git a/plugins/links/sql/mysql_updates.php b/plugins/links/sql/mysql_updates.php
@@ -139,5 +139,3 @@ function links_update_ConfigSecurity_2_1_0()
     }
 
 }
-
-?>
diff --git a/plugins/links/sql/pgsql_install.php b/plugins/links/sql/pgsql_install.php
@@ -101,5 +101,3 @@
   PRIMARY KEY (lid)
 )
 ";
-
-?>
diff --git a/plugins/links/sql/pgsql_updates.php b/plugins/links/sql/pgsql_updates.php
@@ -78,5 +78,3 @@ function links_update_ConfigSecurity_2_1_0()
     }
 
 }
-
-?>
diff --git a/plugins/polls/functions.inc b/plugins/polls/functions.inc
@@ -748,6 +748,7 @@ function POLLS_pollsave($pid, $aid)
  * @param        int    $scale       Size in pixels to scale formatted results to
  * @param        string $order       'ASC' or 'DESC' for Comment ordering (SQL statment ordering)
  * @param        string $mode        Comment Mode possible values 'nocomment', 'flat', 'nested', 'threaded'
+ * @param        int    $page
  * @param        int    $displaytype Possible values 0 = Normal, 1 = In Block, 2 = autotag
  * @see POLLS_pollVote
  * @see POLLS_showPoll
@@ -1568,10 +1569,10 @@ function plugin_getcommenturlid_polls()
  *
  * @param  string $op
  * @param  string $content
- * @param  string $autotag
- * @return mixed
+ * @param  array $autotag
+ * @return array|string
  */
-function plugin_autotags_polls($op, $content = '', $autotag = '')
+function plugin_autotags_polls($op, $content = '', $autotag = array())
 {
     global $_CONF, $_PO_CONF, $_TABLES, $LANG_POLLS, $_GROUPS;
 

diff --git a/plugins/polls/language/english.php b/plugins/polls/language/english.php
@@ -186,5 +186,3 @@
     14 => array('No access' => 0, 'Read-Only' => 2),
     15 => array('All' => TOPIC_ALL_OPTION, 'Homepage Only' => TOPIC_HOMEONLY_OPTION, 'Select Topics' => TOPIC_SELECTED_OPTION)
 );
-
-?>
diff --git a/plugins/polls/templates/denim/functions.php b/plugins/polls/templates/denim/functions.php
@@ -48,5 +48,3 @@ function polls_js_files_denim()
     // No extra JS files needed by plugin. Assume theme loads all required.
     return array();
 }
-
-?>
diff --git a/plugins/recaptcha/functions.inc b/plugins/recaptcha/functions.inc
@@ -30,6 +30,11 @@
 // |                                                                           |
 // +---------------------------------------------------------------------------+
 
+use ReCaptcha\ReCaptcha;
+use ReCaptcha\RequestMethod\CurlPost;
+use ReCaptcha\RequestMethod\Post;
+use ReCaptcha\RequestMethod\SocketPost;
+
 if (stripos($_SERVER['PHP_SELF'], basename(__FILE__)) !== false) {
     die('This file cannot be used on its own.');
 }
@@ -207,6 +212,7 @@ function plugin_autouninstall_recaptcha()
 /**
  * Return the URL to a given document
  *
+ * @param  string  $file
  * @return string
  */
 function plugin_getdocumentationurl_recaptcha($file)
@@ -336,11 +342,11 @@ function plugin_itemPreSave_recaptcha($type, $content = '')
         }
 
         if (is_callable('curl_init')) {
-            $recaptcha = new \ReCaptcha\ReCaptcha($secretKey, new \ReCaptcha\RequestMethod\CurlPost());
+            $recaptcha = new ReCaptcha($secretKey, new CurlPost());
         } elseif (@ini_get('allow_url_fopen')) {
-            $recaptcha = new \ReCaptcha\ReCaptcha($secretKey, new \ReCaptcha\RequestMethod\Post());
+            $recaptcha = new ReCaptcha($secretKey, new Post());
         } else {
-            $recaptcha = new \ReCaptcha\ReCaptcha($secretKey, new \ReCaptcha\RequestMethod\SocketPost());
+            $recaptcha = new ReCaptcha($secretKey, new SocketPost());
         }
 
         $resp = $recaptcha->verify(@$_POST['g-recaptcha-response'], RECAPTCHA_getIP());

diff --git a/plugins/recaptcha/vendor/ReCaptcha/ReCaptcha.php b/plugins/recaptcha/vendor/ReCaptcha/ReCaptcha.php
@@ -26,6 +26,8 @@
 
 namespace ReCaptcha;
 
+use RuntimeException;
+
 /**
  * reCAPTCHA client.
  */
@@ -54,16 +56,16 @@ class ReCaptcha
      *
      * @param string $secret shared secret between site and reCAPTCHA server.
      * @param RequestMethod $requestMethod method used to send the request. Defaults to POST.
-     * @throws \RuntimeException if $secret is invalid
+     * @throws RuntimeException if $secret is invalid
      */
     public function __construct($secret, RequestMethod $requestMethod = null)
     {
         if (empty($secret)) {
-            throw new \RuntimeException('No secret provided');
+            throw new RuntimeException('No secret provided');
         }
 
         if (!is_string($secret)) {
-            throw new \RuntimeException('The provided secret must be a string');
+            throw new RuntimeException('The provided secret must be a string');
         }
 
         $this->secret = $secret;