Elgg / Elgg

engine/classes/ElggAnnotation.php

Unused Use Statements -2 removed lines

@@ -1,7 +1,5 @@
 <?php
 
-use Elgg\Database\EntityTable\UserFetchFailureException;
-
 /**
  * Elgg Annotations
  *

engine/classes/ElggMenuBuilder.php

Doc Comments +2 added lines, -2 removed lines

@@ -27,8 +27,8 @@
 	/**
 	 * Get a prepared menu array
 	 *
-	 * @param mixed $sort_by Method to sort the menu by. @see \ElggMenuBuilder::sort()
-	 * @return array
+	 * @param callable $sort_by Method to sort the menu by. @see \ElggMenuBuilder::sort()
+	 * @return ElggMenuItem[]
 	 */
 	public function getMenu($sort_by = 'text') {
 

engine/classes/ElggPluginPackage.php

Doc Comments +3 added lines, -3 removed lines

@@ -473,7 +473,7 @@ 
 	 * Checks if $plugins meets the requirement by $dep.
 	 *
 	 * @param array $dep     An Elgg manifest.xml deps array
-	 * @param array $plugins A list of plugins as returned by elgg_get_plugins();
+	 * @param ElggPlugin[] $plugins A list of plugins as returned by elgg_get_plugins();
 	 * @param bool  $inverse Inverse the results to use as a conflicts.
 	 * @return bool
 	 */
@@ -491,7 +491,7 @@ 
 	 * Checks if $plugins meets the requirement by $dep.
 	 *
 	 * @param array $dep     An Elgg manifest.xml deps array
-	 * @param array $plugins A list of plugins as returned by elgg_get_plugins();
+	 * @param ElggPlugin[] $plugins A list of plugins as returned by elgg_get_plugins();
 	 * @param bool  $inverse Inverse the results to use as a conflicts.
 	 * @return bool
 	 */
@@ -553,7 +553,7 @@ 
 	 * Checks if $elgg_version meets the requirement by $dep.
 	 *
 	 * @param array $dep          An Elgg manifest.xml deps array
-	 * @param array $elgg_version An Elgg version (either YYYYMMDDXX or X.Y.Z)
+	 * @param string|false $elgg_version An Elgg version (either YYYYMMDDXX or X.Y.Z)
 	 * @param bool  $inverse      Inverse the result to use as a conflicts.
 	 * @return bool
 	 */

mod/discussions/start.php

Doc Comments +2 added lines, -2 removed lines

@@ -238,7 +238,7 @@ 
  * @param string $type
  * @param string $return
  * @param array  $params
- * @return bool
+ * @return false|null
  */
 function discussion_comment_override($hook, $type, $return, $params) {
 	if (elgg_instanceof($params['entity'], 'object', 'discussion')) {
@@ -447,7 +447,7 @@ 
  * @param string $type   'object'
  * @param array  $return Allowed or not
  * @param array  $params Hook params
- * @return bool
+ * @return null|false
  */
 function discussion_reply_container_logic_override($hook, $type, $return, $params) {
 

mod/likes/start.php

Doc Comments +1 added lines, -1 removed lines

@@ -65,7 +65,7 @@
  * @param array  $return Current value
  * @param array  $params Hook parameters
  *
- * @return bool
+ * @return null|boolean
  */
 function likes_permissions_check_annotate($hook, $type, $return, $params) {
 	if (elgg_extract('annotation_name', $params) !== 'likes') {

engine/classes/Elgg/Database/RelationshipsTable.php

Doc Comments +2 added lines, -2 removed lines

@@ -71,7 +71,7 @@ 
 	 *
 	 * @param int $id The relationship ID
 	 *
-	 * @return \stdClass|false False if no row found
+	 * @return \stdClass False if no row found
 	 * @access private
 	 */
 	public function getRow($id) {
@@ -215,7 +215,7 @@ 
 	 *                                     subject of the relationships.
 	 * @param string $type                 The type of entity related to $guid (defaults to all)
 	 *
-	 * @return true
+	 * @return boolean
 	 */
 	public function removeAll($guid, $relationship = "", $inverse_relationship = false, $type = '') {
 		$guid = (int) $guid;

engine/classes/ElggDiskFilestore.php

Doc Comments +4 added lines, -4 removed lines

@@ -105,9 +105,9 @@ 
 	 * Write data to a file.
 	 *
 	 * @param resource $f    File pointer resource
-	 * @param mixed    $data The data to write.
+	 * @param string    $data The data to write.
 	 *
-	 * @return bool
+	 * @return integer
 	 */
 	public function write($f, $data) {
 		return fwrite($f, $data);
@@ -120,7 +120,7 @@ 
 	 * @param int      $length The number of bytes to read
 	 * @param int      $offset The number of bytes to start after
 	 *
-	 * @return mixed Contents of file or false on fail.
+	 * @return string Contents of file or false on fail.
 	 */
 	public function read($f, $length, $offset = 0) {
 		if ($offset) {
@@ -285,7 +285,7 @@ 
 	 * @param string $dirroot The full path of the directory to create
 	 *
 	 * @throws IOException
-	 * @return true
+	 * @return boolean
 	 */
 	protected function makeDirectoryRoot($dirroot) {
 		if (!file_exists($dirroot)) {

engine/classes/ElggFile.php

Doc Comments +7 added lines, -7 removed lines

@@ -108,7 +108,7 @@ 
 	 * Set the mime type of the file.
 	 *
 	 * @param string $mimetype The mimetype
-	 * @return bool
+	 * @return string
 	 */
 	public function setMimeType($mimetype) {
 		return $this->mimetype = $mimetype;
@@ -120,10 +120,10 @@ 
 	 * @note This method can be called both dynamically and statically
 	 *
 	 * @param mixed $file    The full path of the file to check. For uploaded files, use tmp_name.
-	 * @param mixed $default A default. Useful to pass what the browser thinks it is.
+	 * @param string|null $default A default. Useful to pass what the browser thinks it is.
 	 * @since 1.7.12
 	 *
-	 * @return mixed Detected type on success, false on failure.
+	 * @return string Detected type on success, false on failure.
 	 * @todo Move this out into a utility class
 	 */
 	public function detectMimeType($file = null, $default = null) {
@@ -172,7 +172,7 @@ 
 	 *
 	 * @param string $description The description.
 	 *
-	 * @return bool
+	 * @return boolean|null
 	 */
 	public function setDescription($description) {
 		$this->description = $description;
@@ -216,7 +216,7 @@ 
 	 *
 	 * @param string $data The data
 	 *
-	 * @return bool
+	 * @return integer
 	 */
 	public function write($data) {
 		return $this->getFilestore()->write($this->handle, $data);
@@ -228,7 +228,7 @@ 
 	 * @param int $length Amount to read.
 	 * @param int $offset The offset to start from.
 	 *
-	 * @return mixed Data or false
+	 * @return string Data or false
 	 */
 	public function read($length, $offset = 0) {
 		return $this->getFilestore()->read($this->handle, $length, $offset);
@@ -237,7 +237,7 @@ 
 	/**
 	 * Gets the full contents of this file.
 	 *
-	 * @return mixed The file contents.
+	 * @return string The file contents.
 	 */
 	public function grabFile() {
 		return $this->getFilestore()->grabFile($this);

engine/classes/Elgg/Database.php

Doc Comments +3 added lines, -3 removed lines

@@ -215,7 +215,7 @@ 
 	 * @param callable $callback A callback function to apply to the row
 	 * @param array    $params   Query params. E.g. [1, 'steve'] or [':id' => 1, ':name' => 'steve']
 	 *
-	 * @return mixed A single database result object or the result of the callback function.
+	 * @return \stdClass A single database result object or the result of the callback function.
 	 * @throws \DatabaseException
 	 */
 	public function getDataRow($query, $callback = null, array $params = []) {
@@ -230,7 +230,7 @@ 
 	 * @param string $query  The query to execute.
 	 * @param array  $params Query params. E.g. [1, 'steve'] or [':id' => 1, ':name' => 'steve']
 	 *
-	 * @return int|false The database id of the inserted row if a AUTO_INCREMENT field is
+	 * @return integer The database id of the inserted row if a AUTO_INCREMENT field is
 	 *                   defined, 0 if not, and false on failure.
 	 * @throws \DatabaseException
 	 */
@@ -721,7 +721,7 @@ 
 	 * Handle magic property reads
 	 *
 	 * @param string $name Property name
-	 * @return mixed
+	 * @return string
 	 */
 	public function __get($name) {
 		if ($name === 'prefix') {