Elgg / Elgg

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,

engine/classes/Elgg/EntityIconService.php

Doc Comments +1 added lines, -1 removed lines

@@ -418,7 +418,7 @@
 	 * @param string     $type          The name of the icon. e.g., 'icon', 'cover_photo'
 	 * @param bool       $retain_master Keep the master icon (default: false)
 	 *
-	 * @return bool
+	 * @return boolean|null
 	 */
 	public function deleteIcon(ElggEntity $entity, $type = 'icon', $retain_master = false) {
 		$delete = $this->hooks->trigger("entity:$type:delete", $entity->getType(), [

engine/classes/Elgg/AttributeLoader.php

Doc Comments +3 added lines, -3 removed lines

@@ -129,7 +129,7 @@ 
 	 * Get primary attributes missing that are missing
 	 *
 	 * @param \stdClass $row Database row
-	 * @return array
+	 * @return boolean
 	 */
 	protected function isMissingPrimaries($row) {
 		return array_diff(self::$primary_attr_names, array_keys($row)) !== [];
@@ -139,7 +139,7 @@ 
 	 * Get secondary attributes that are missing
 	 *
 	 * @param \stdClass $row Database row
-	 * @return array
+	 * @return boolean
 	 */
 	protected function isMissingSecondaries($row) {
 		return array_diff($this->secondary_attr_names, array_keys($row)) !== [];
@@ -176,7 +176,7 @@ 
 	 * "secondary" attributes (e.g. those in {prefix}users_entity), but can load all at once if a
 	 * combined loader is available.
 	 *
-	 * @param mixed $row a row loaded from DB (array or \stdClass)
+	 * @param \stdClass $row a row loaded from DB (array or \stdClass)
 	 * @return array will be empty if failed to load all attributes (access control or entity doesn't exist)
 	 *
 	 * @throws \InvalidArgumentException|\LogicException|\IncompleteEntityException

engine/classes/ElggPlugin.php

Doc Comments +11 added lines, -11 removed lines

@@ -94,7 +94,7 @@ 
 	 * Save the plugin object.  Make sure required values exist.
 	 *
 	 * @see \ElggObject::save()
-	 * @return bool
+	 * @return boolean|null
 	 */
 	public function save() {
 		// own by the current site so users can be deleted without affecting plugins
@@ -195,7 +195,7 @@ 
 	 * Sets the location of this plugin.
 	 *
 	 * @param string $id The path to the plugin's dir.
-	 * @return bool
+	 * @return string
 	 */
 	public function setID($id) {
 		return $this->title = $id;
@@ -234,7 +234,7 @@ 
 	/**
 	 * Sets the priority of the plugin
 	 *
-	 * @param mixed $priority The priority to set. One of +1, -1, first, last, or a number.
+	 * @param string $priority The priority to set. One of +1, -1, first, last, or a number.
 	 *                        If given a number, this will displace all plugins at that number
 	 *                        and set their priorities +1
 	 * @return bool
@@ -403,7 +403,7 @@ 
 	 *
 	 * @param string $name The setting name to remove
 	 *
-	 * @return bool
+	 * @return integer
 	 */
 	public function unsetSetting($name) {
 		return remove_private_setting($this->guid, $name);
@@ -415,7 +415,7 @@ 
 	 * @todo Should be a better way to do this without dropping to raw SQL.
 	 * @todo If we could namespace the plugin settings this would be cleaner.
 	 * @todo this shouldn't work because ps_prefix will be empty string
-	 * @return bool
+	 * @return integer
 	 */
 	public function unsetAllSettings() {
 		_elgg_services()->pluginSettingsCache->clear($this->guid);
@@ -510,7 +510,7 @@ 
 	 * @param string $value     The setting value
 	 * @param int    $user_guid The user GUID
 	 *
-	 * @return mixed The new setting ID or false
+	 * @return boolean The new setting ID or false
 	 */
 	public function setUserSetting($name, $value, $user_guid = 0) {
 		$user_guid = (int) $user_guid;
@@ -582,7 +582,7 @@ 
 	 * @todo fix that
 	 *
 	 * @param int $user_guid The user GUID to remove user settings.
-	 * @return bool
+	 * @return integer
 	 */
 	public function unsetAllUserSettings($user_guid) {
 		$db = $this->getDatabase();
@@ -601,7 +601,7 @@ 
 	 * Use {@link removeAllUserSettings()} if you just want to remove
 	 * settings for a single user.
 	 *
-	 * @return bool
+	 * @return integer
 	 */
 	public function unsetAllUsersSettings() {
 		$db = $this->getDatabase();
@@ -841,7 +841,7 @@ 
 	 * Start the plugin.
 	 *
 	 * @param int $flags Start flags for the plugin. See the constants in lib/plugins.php for details.
-	 * @return true
+	 * @return boolean
 	 * @throws PluginException
 	 */
 	public function start($flags) {
@@ -1094,7 +1094,7 @@ 
 	 * Registers the plugin's languages
 	 *
 	 * @throws PluginException
-	 * @return true
+	 * @return boolean
 	 */
 	protected function registerLanguages() {
 		return _elgg_services()->translator->registerPluginTranslations($this->path);
@@ -1104,7 +1104,7 @@ 
 	 * Registers the plugin's classes
 	 *
 	 * @throws PluginException
-	 * @return true
+	 * @return boolean
 	 */
 	protected function registerClasses() {
 		$classes_path = "$this->path/classes";