Elgg / Elgg

engine/lib/views.php

Doc Comments +1 added lines, -1 removed lines

@@ -1938,7 +1938,7 @@
  * @param array   $vars     View vars
  * @param string  $viewtype Temporary viewtype ('' to leave current)
  *
- * @return mixed
+ * @return string
  * @access private
  */
 function _elgg_view_under_viewtype($view, $vars, $viewtype) {

Unused Use Statements -1 removed lines

@@ -48,7 +48,6 @@
 
 use Elgg\Menu\Menu;
 use Elgg\Menu\UnpreparedMenu;
-use Elgg\Includer;
 use Elgg\Project\Paths;
 
 /**

engine/classes/Elgg/ActionsService.php

Doc Comments +6 added lines

@@ -211,6 +211,7 @@ 
 	/**
 	 * @see elgg_unregister_action
 	 * @access private
+	 * @param string $action
 	 */
 	public function unregister($action) {
 		if (isset($this->actions[$action])) {
@@ -317,6 +318,7 @@ 
 	}
 
 	/**
+	 * @param string $action
 	 * @return bool
 	 * @see action_gatekeeper
 	 * @access private
@@ -388,6 +390,7 @@ 
 	/**
 	 * @see elgg_action_exists
 	 * @access private
+	 * @param string $action
 	 */
 	public function exists($action) {
 		return (isset($this->actions[$action]) && file_exists($this->actions[$action]['file']));
@@ -397,6 +400,9 @@ 
 	 * @see ajax_forward_hook
 	 * @access private
 	 * @deprecated 2.3
+	 * @param string $hook
+	 * @param string $reason
+	 * @param string $forward_url
 	 */
 	public function ajaxForwardHook($hook, $reason, $forward_url, $params) {
 		if (!elgg_is_xhr()) {

engine/classes/Elgg/Database/PrivateSettingsTable.php

Doc Comments +2 added lines, -2 removed lines

@@ -412,7 +412,7 @@ 
 	 *
 	 * @param int    $entity_guid The Entity GUID
 	 * @param string $name        The name of the setting
-	 * @return bool
+	 * @return integer
 	 */
 	public function remove($entity_guid, $name) {
 		$this->cache->clear($entity_guid);
@@ -435,7 +435,7 @@ 
 	 * Deletes all private settings for an entity
 	 *
 	 * @param int $entity_guid The Entity GUID
-	 * @return bool
+	 * @return integer
 	 */
 	public function removeAllForEntity($entity_guid) {
 		$this->cache->clear($entity_guid);

engine/classes/ElggUpgrade.php

Doc Comments +2 added lines, -2 removed lines

@@ -96,7 +96,7 @@ 
 	/**
 	 * Return instance of the class that processes the data
 	 *
-	 * @return Batch|false
+	 * @return integer
 	 */
 	public function getBatch() {
 		return _elgg_services()->upgradeLocator->getBatch($this->class);
@@ -106,7 +106,7 @@ 
 	 * Sets the timestamp for when the upgrade completed.
 	 *
 	 * @param int $time Timestamp when upgrade finished. Defaults to now.
-	 * @return bool
+	 * @return integer
 	 */
 	public function setCompletedTime($time = null) {
 		if (!$time) {

engine/lib/comments.php

Doc Comments +2 added lines, -2 removed lines

@@ -38,7 +38,7 @@ 
  * Page handler for generic comments manipulation.
  *
  * @param array $segments
- * @return bool
+ * @return boolean|null
  * @access private
  */
 function _elgg_comments_page_handler($segments) {
@@ -166,7 +166,7 @@ 
  * @param boolean $return Can the current user write to this container?
  * @param array   $params Array of parameters (container, user, subtype)
  *
- * @return array
+ * @return boolean
  * @access private
  * @todo this doesn't seem to make a difference if a user can comment or not
  */

Unused Use Statements -2 removed lines

@@ -7,8 +7,6 @@
  * @since 1.9
  */
 
-use Elgg\Project\Paths;
-
 /**
  * Comments initialization function
  *

engine/lib/widgets.php

Doc Comments +5 added lines, -5 removed lines

@@ -33,7 +33,7 @@ 
  * @param string $context    The context for this widget
  * @param int    $access_id  If not specified, it is set to the default access level
  *
- * @return int|false Widget GUID or false on failure
+ * @return integer Widget GUID or false on failure
  * @since 1.8.0
  */
 function elgg_create_widget($owner_guid, $handler, $context, $access_id = null) {
@@ -60,10 +60,10 @@ 
  *
  * This should be called by plugins in their init function.
  *
- * @param string|array $handler     An array of options or the identifier for the widget handler
+ * @param string $handler     An array of options or the identifier for the widget handler
  * @param string       $name        The name of the widget type
  * @param string       $description A description for the widget type
- * @param array        $context     An array of contexts where this widget is allowed
+ * @param string[]        $context     An array of contexts where this widget is allowed
  * @param bool         $multiple    Whether or not multiple instances of this widget
  *                                  are allowed in a single layout (default: false)
  *
@@ -166,7 +166,7 @@ 
  *
  * @param array $page Array of pages
  *
- * @return bool
+ * @return null|boolean
  * @access private
  */
 function _elgg_widgets_page_handler($page) {
@@ -342,7 +342,7 @@ 
  * @param string $type   The type of entity being created.
  * @param string $return Value
  * @param mixed  $params Params
- * @return true|null
+ * @return boolean|null
  * @access private
  */
 function _elgg_default_widgets_permissions_override($hook, $type, $return, $params) {

mod/pages/start.php

Doc Comments +2 added lines, -2 removed lines

@@ -327,7 +327,7 @@ 
  * @param bool   $returnvalue
  * @param array  $params
  *
- * @return bool
+ * @return null|boolean
  */
 function pages_write_permission_check($hook, $entity_type, $returnvalue, $params) {
 	if (!pages_is_page($params['entity'])) {
@@ -370,7 +370,7 @@ 
  * @param bool   $returnvalue
  * @param array  $params
  *
- * @return bool
+ * @return null|boolean
  */
 function pages_container_permission_check($hook, $entity_type, $returnvalue, $params) {
 	$container = elgg_extract('container', $params);

engine/lib/pagehandler.php

Doc Comments +1 added lines, -1 removed lines

@@ -244,7 +244,7 @@
 /**
  * Front page handler
  *
- * @return bool
+ * @return Elgg\Http\OkResponse
  */
 function elgg_front_page_handler() {
 	return elgg_ok_response(elgg_view_resource('index'));

mod/legacy_urls/start.php

Doc Comments +10 added lines, -10 removed lines

@@ -30,7 +30,7 @@ 
  * c) Silently forwards to the new URL
  *
  * @param string $url Relative or absolute URL
- * @return mixed
+ * @return boolean|null
  */
 function legacy_urls_redirect($url) {
 	$method = elgg_get_plugin_setting('redirect_method', 'legacy_urls');
@@ -91,7 +91,7 @@ 
  * Handle requests for /tag/<tag string>
  *
  * @param array $segments URL segments
- * @return mixed
+ * @return boolean|null
  */
 function legacy_urls_tag_handler($segments) {
 	$tag = $segments[0];
@@ -103,7 +103,7 @@ 
  * Handle requests for URLs that start with /pg/
  *
  * @param array $segments URL segments
- * @return mixed
+ * @return boolean|null
  */
 function legacy_urls_pg_handler($segments) {
 	$url = implode('/', $segments);
@@ -123,7 +123,7 @@ 
  * @param $hook   string "route"
  * @param $type   string "blog"
  * @param $result mixed  Old identifier and segments
- * @return mixed
+ * @return false|null
  */
 function legacy_urls_blog_forward($hook, $type, $result) {
 
@@ -202,7 +202,7 @@ 
  * @param $hook   string "route"
  * @param $type   string "bookmarks"
  * @param $result mixed  Old identifier and segments
- * @return mixed
+ * @return false|null
  */
 function legacy_urls_bookmarks_forward($hook, $type, $result) {
 
@@ -276,7 +276,7 @@ 
  * @param $hook   string "route"
  * @param $type   string "file"
  * @param $result mixed  Old identifier and segments
- * @return mixed
+ * @return false|null
  */
 function legacy_urls_file_forward($hook, $type, $result) {
 
@@ -300,7 +300,7 @@ 
  * @param $hook   string "route"
  * @param $type   string "groups"
  * @param $result mixed  Old identifier and segments
- * @return mixed
+ * @return false|null
  */
 function legacy_urls_groups_forward($hook, $type, $result) {
 
@@ -331,7 +331,7 @@ 
  * @param $hook   string "route"
  * @param $type   string "settings"
  * @param $result mixed  Old identifier and segments
- * @return mixed
+ * @return false|null
  */
 function legacy_urls_settings_forward($hook, $type, $result) {
 
@@ -357,7 +357,7 @@ 
  * /forum/.*
  *
  * @param array $page URL segments
- * @return mixed
+ * @return boolean
  */
 function legacy_urls_forum_handler($page) {
 	switch ($page[0]) {
@@ -377,7 +377,7 @@ 
  * @param $hook   string "route"
  * @param $type   string "messageboard"
  * @param $result mixed  Old identifier and segments
- * @return mixed
+ * @return false|null
  */
 function legacy_urls_messageboard_forward($hook, $type, $result) {