Elgg / Elgg

mod/web_services/lib/tokens.php

Doc Comments +2 added lines, -2 removed lines

@@ -9,7 +9,7 @@ 
  * @param string $username The username
  * @param int    $expire   Minutes until token expires (default is 60 minutes)
  *
- * @return bool
+ * @return false|string
  */
 function create_user_token($username, $expire = 60) {
 	$dbprefix = elgg_get_config('dbprefix');
@@ -59,7 +59,7 @@ 
  *
  * @param string $token The Token.
  *
- * @return mixed The user id attached to the token if not expired or false.
+ * @return integer The user id attached to the token if not expired or false.
  */
 function validate_user_token($token) {
 	$dbprefix = elgg_get_config('dbprefix');

engine/classes/Elgg/Email.php

Doc Comments +1 added lines, -1 removed lines

@@ -51,7 +51,7 @@
 	 *                       'body' - body string
 	 *                       'params' - additional parameters
 	 *                       'headers' - HTTP/IMF headers
-	 * @return \self
+	 * @return Email
 	 */
 	public static function factory(array $options = []) {
 		$from = elgg_extract('from', $options);

engine/classes/Elgg/Notifications/NotificationsService.php

Doc Comments +6 added lines

@@ -91,6 +91,8 @@ 
 	/**
 	 * @see elgg_register_notification_event()
 	 * @access private
+	 * @param string $type
+	 * @param string $subtype
 	 */
 	public function registerEvent($type, $subtype, array $actions = []) {
 
@@ -112,6 +114,8 @@ 
 	/**
 	 * @see elgg_unregister_notification_event()
 	 * @access private
+	 * @param string $type
+	 * @param string $subtype
 	 */
 	public function unregisterEvent($type, $subtype) {
 
@@ -134,6 +138,7 @@ 
 	/**
 	 * @see elgg_register_notification_method()
 	 * @access private
+	 * @param string $name
 	 */
 	public function registerMethod($name) {
 		$this->methods[$name] = $name;
@@ -142,6 +147,7 @@ 
 	/**
 	 * @see elgg_unregister_notification_method()
 	 * @access private
+	 * @param string $name
 	 */
 	public function unregisterMethod($name) {
 		if (isset($this->methods[$name])) {

engine/classes/Elgg/Translit.php

Doc Comments +2 added lines, -2 removed lines

@@ -124,7 +124,7 @@ 
 	/**
 	 * Get array of UTF-8 (NFC) character replacements.
 	 *
-	 * @return array
+	 * @return string
 	 */
 	static public function getAsciiTranslitMap() {
 		return [
@@ -257,7 +257,7 @@ 
 	/**
 	 * Tests that "normalizer_normalize" exists and works
 	 *
-	 * @return bool
+	 * @return boolean|null
 	 */
 	static public function hasNormalizerSupport() {
 		static $ret = null;

mod/groups/start.php

Doc Comments +2 added lines, -2 removed lines

@@ -587,7 +587,7 @@ 
  * @elgg_plugin_hook access_collection:display_name access_collection
  *
  * @param \Elgg\Hook $hook Hook
- * @return array
+ * @return null|string
  */
 function groups_set_access_collection_name(\Elgg\Hook $hook) {
 
@@ -811,7 +811,7 @@ 
 /**
  * Runs unit tests for groups
  *
- * @return array
+ * @return string[]
  */
 function groups_test($hook, $type, $value, $params) {
 	$value[] = elgg_get_plugins_path() . 'groups/tests/write_access.php';

engine/classes/Elgg/Notifications/Event.php

Doc Comments +1 added lines, -1 removed lines

@@ -90,7 +90,7 @@
 	 * may have been deleted/disabled since the event was serialized and
 	 * stored in the database.
 	 *
-	 * @return ElggData|false|null
+	 * @return string
 	 */
 	public function getObject() {
 		return $this->object;

engine/classes/Elgg/PersistentLoginService.php

Doc Comments +1 added lines, -1 removed lines

@@ -223,7 +223,7 @@
 	 * @param \DatabaseException $exception The exception to handle
 	 * @param string             $default   The value to return if the table doesn't exist yet
 	 *
-	 * @return mixed
+	 * @return string|null
 	 *
 	 * @throws \DatabaseException
 	 */

mod/diagnostics/start.php

Doc Comments +1 added lines, -1 removed lines

@@ -48,7 +48,7 @@
  * Recursively list through a directory tree producing a hash of all installed files
  *
  * @param starting dir $dir
- * @param buffer       $buffer
+ * @param string $dir
  */
 function diagnostics_md5_dir($dir) {
 	$extensions_allowed = ['.php', '.js', '.css'];

mod/search/start.php

Doc Comments +2 added lines, -3 removed lines

@@ -283,7 +283,7 @@ 
  * (Unless the entire query is < ft_min_word_chars, in which case
  * it's taken literally.)
  *
- * @param array $query
+ * @param string $query
  * @param str   $format Return as an array or a string
  * @return mixed
  */
@@ -307,7 +307,6 @@ 
  * Passes results, and original params to the view functions for
  * search type.
  *
- * @param array  $results
  * @param array  $params
  * @param string $view_type = list, entity or layout
  * @return string
@@ -356,7 +355,7 @@ 
  * Returns a where clause for a search query.
  *
  * @param str   $table  Prefix for table to search on
- * @param array $fields Fields to match against
+ * @param string[] $fields Fields to match against
  * @param array $params Original search params
  * @return str
  */