Elgg / Elgg

engine/classes/Elgg/Application/Database.php

Doc Comments +2 added lines, -2 removed lines

@@ -94,7 +94,7 @@ 
 	 * @note WARNING! update_data() has the 2nd and 3rd arguments reversed.
 	 *
 	 * @param string $query        The query to run.
-	 * @param bool   $get_num_rows Return the number of rows affected (default: false).
+	 * @param bool   $getNumRows Return the number of rows affected (default: false).
 	 * @param array  $params       Query params. E.g. [1, 'steve'] or [':id' => 1, ':name' => 'steve']
 	 *
 	 * @return bool|int
@@ -148,7 +148,7 @@ 
 	 *
 	 * @param string $type The type of link we want: "read", "write" or "readwrite".
 	 *
-	 * @return Connection
+	 * @return \Doctrine\DBAL\Connection
 	 * @throws \DatabaseException
 	 * @access private
 	 */

engine/classes/Elgg/Database/Seeds/Seeding.php

Doc Comments +2 added lines, -2 removed lines

@@ -397,7 +397,7 @@ 
 	 * @param array $attributes Object entity attributes
 	 * @param array $metadata   Object entity metadata
 	 *
-	 * @return ElggObject
+	 * @return \ElggSite
 	 */
 	public function createSite(array $attributes = [], array $metadata = []) {
 		// We don't want to create more than one site
@@ -436,7 +436,7 @@ 
 	 *
 	 * @param int[] $exclude GUIDs to exclude
 	 *
-	 * @return ElggGroup|false
+	 * @return ElggEntity
 	 */
 	public function getRandomGroup(array $exclude = []) {
 

engine/classes/Elgg/Printer.php

Doc Comments +1 added lines, -2 removed lines

@@ -12,9 +12,8 @@
 	/**
 	 * Prints data
 	 *
-	 * @param mixed $message Data to print
 	 * @param bool  $display If display is expected by the logger
-	 * @param null  $level   Logging level
+	 * @param integer  $level   Logging level
 	 *
 	 * @return mixed
 	 */

engine/classes/Elgg/Cli/Command.php

Doc Comments +1 added lines, -1 removed lines

@@ -114,7 +114,7 @@
 	 * @param int    $linenum  The line number the error was raised at
 	 * @param array  $vars     An array that points to the active symbol table where error occurred
 	 *
-	 * @return true
+	 * @return boolean
 	 * @throws \Exception
 	 * @access private
 	 */

engine/classes/Elgg/EventsService.php

Doc Comments +4 added lines, -1 removed lines

@@ -42,6 +42,8 @@ 
 
 	/**
 	 * {@inheritdoc}
+	 * @param string $name
+	 * @param string $type
 	 */
 	public function registerHandler($name, $type, $callback, $priority = 500) {
 		if (in_array($type, ['member', 'friend', 'attached'])
@@ -59,6 +61,7 @@ 
 	 * @see elgg_trigger_event
 	 * @see elgg_trigger_after_event
 	 * @access private
+	 * @param string|null $type
 	 */
 	public function trigger($name, $type, $object = null, array $options = []) {
 		$options = array_merge([
@@ -142,7 +145,7 @@ 
 	 * @param string $object_type The object type
 	 * @param string $object      The object involved in the event
 	 *
-	 * @return true
+	 * @return boolean
 	 *
 	 * @see triggerBefore
 	 * @since 2.0.0

engine/lib/users.php

Doc Comments +3 added lines, -3 removed lines

@@ -293,7 +293,7 @@ 
  *                                      registered multiple times?
  * @param string $subtype               Subtype of the user entity
  *
- * @return int|false The new user's GUID; false on failure
+ * @return integer The new user's GUID; false on failure
  * @throws RegistrationException
  */
 function register_user($username, $password, $name, $email, $allow_multiple_emails = false, $subtype = null) {
@@ -415,7 +415,7 @@ 
 /**
  * Sets the last action time of the given user to right now.
  *
- * @param ElggUser|int $user The user or GUID
+ * @param ElggUser $user The user or GUID
  * @return void
  */
 function set_last_action($user) {
@@ -587,7 +587,7 @@ 
  * /avatar/edit/<username>
  *
  * @param array $page
- * @return bool
+ * @return boolean|null
  * @access private
  */
 function elgg_avatar_page_handler($page) {

engine/classes/Elgg/I18n/Translator.php

Doc Comments +2 added lines, -2 removed lines

@@ -79,7 +79,7 @@ 
 	/**
 	 * Get a map of all loaded translations
 	 *
-	 * @return array
+	 * @return string
 	 */
 	public function getLoadedTranslations() {
 		return $this->translations;
@@ -595,7 +595,7 @@ 
 	/**
 	 * Returns an array of language codes.
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	public static function getAllLanguageCodes() {
 		return [

engine/classes/Elgg/UploadService.php

Doc Comments +2 added lines, -2 removed lines

@@ -41,7 +41,7 @@ 
 	 * Returns an array of uploaded file objects regardless of upload status/errors
 	 *
 	 * @param string $input_name Form input name
-	 * @return UploadedFile[]
+	 * @return Http\UploadedFile[]
 	 */
 	public function getFiles($input_name) {
 		$files = $this->request->getFiles($input_name);
@@ -58,7 +58,7 @@ 
 	 * @param string $input_name Form input name
 	 * @param bool   $check_for_validity If there is an uploaded file, is it required to be valid
 	 *
-	 * @return UploadedFile[]|false
+	 * @return string
 	 */
 	public function getFile($input_name, $check_for_validity = true) {
 		$file = $this->request->getFile($input_name, $check_for_validity);

engine/lib/deprecated-2.3.php

Doc Comments +3 added lines, -3 removed lines

@@ -40,7 +40,7 @@ 
  *
  * @param string $input_name The name of the file input field on the submission form
  *
- * @return mixed|false The contents of the file, or false on failure.
+ * @return false|string The contents of the file, or false on failure.
  * @deprecated 2.3
  */
 function get_uploaded_file($input_name) {
@@ -94,7 +94,7 @@ 
  *                           dimensions on all size; the image will be cropped.
  * @param bool   $upscale    Resize images smaller than $maxwidth x $maxheight?
  *
- * @return false|mixed The contents of the resized image, or false on failure
+ * @return false|string The contents of the resized image, or false on failure
  * @deprecated 2.3
  */
 function get_resized_image_from_uploaded_file($input_name, $maxwidth, $maxheight,
@@ -137,7 +137,7 @@ 
  * @param int    $y2         y coordinate for bottom, right corner
  * @param bool   $upscale    Resize images smaller than $maxwidth x $maxheight?
  *
- * @return false|mixed The contents of the resized image, or false on failure
+ * @return false|string The contents of the resized image, or false on failure
  * @deprecated 2.3
  */
 function get_resized_image_from_existing_file($input_name, $maxwidth, $maxheight,