Elgg / Elgg

engine/classes/Elgg/Database/ConfigTable.php

Doc Comments +1 added lines, -1 removed lines

@@ -129,7 +129,7 @@
 	 *
 	 * @param string $name The name of the config value
 	 *
-	 * @return mixed|null
+	 * @return string|boolean
 	 */
 	function get($name) {
 		$sql = "

engine/classes/Elgg/ViewsService.php

Doc Comments +9 added lines

@@ -285,6 +285,7 @@ 
 
 	/**
 	 * @access private
+	 * @param string $viewtype
 	 */
 	public function registerViewtypeFallback($viewtype) {
 		$this->fallbacks[] = $viewtype;
@@ -292,6 +293,7 @@ 
 
 	/**
 	 * @access private
+	 * @param string $viewtype
 	 */
 	public function doesViewtypeFallback($viewtype) {
 		return in_array($viewtype, $this->fallbacks);
@@ -454,6 +456,7 @@ 
 
 	/**
 	 * @access private
+	 * @param string $view
 	 */
 	public function viewExists($view, $viewtype = '', $recurse = true) {
 		$view = self::canonicalizeViewName($view);
@@ -495,6 +498,8 @@ 
 
 	/**
 	 * @access private
+	 * @param string $view
+	 * @param string $view_extension
 	 */
 	public function extendView($view, $view_extension, $priority = 501) {
 		$view = self::canonicalizeViewName($view);
@@ -541,6 +546,8 @@ 
 
 	/**
 	 * @access private
+	 * @param string $view
+	 * @param string $view_extension
 	 */
 	public function unextendView($view, $view_extension) {
 		$view = self::canonicalizeViewName($view);
@@ -562,6 +569,7 @@ 
 
 	/**
 	 * @access private
+	 * @param string $view
 	 */
 	public function registerCacheableView($view) {
 		$view = self::canonicalizeViewName($view);
@@ -571,6 +579,7 @@ 
 
 	/**
 	 * @access private
+	 * @param string $view
 	 */
 	public function isCacheableView($view) {
 		$view = self::canonicalizeViewName($view);

engine/classes/ElggMemcache.php

Doc Comments +1 added lines, -1 removed lines

@@ -113,7 +113,7 @@
 	 * @param int    $unused1 Unused
 	 * @param int    $unused2 Unused
 	 *
-	 * @return mixed
+	 * @return ElggEntity
 	 */
 	public function load($key, $unused1 = 0, $unused2 = null) {
 		$key = $this->makeMemcacheKey($key);

engine/lib/notification.php

Doc Comments +6 added lines, -6 removed lines

@@ -55,7 +55,7 @@ 
  *
  * @param string $object_type    'object', 'user', 'group', 'site'
  * @param string $object_subtype The subtype or name of the entity
- * @param array  $actions        Array of actions or empty array for the action event.
+ * @param string[]  $actions        Array of actions or empty array for the action event.
  *                                An event is usually described by the first string passed
  *                                to elgg_trigger_event(). Examples include
  *                                'create', 'update', and 'publish'. The default is 'create'.
@@ -211,7 +211,7 @@ 
  * @param string $type   Hook type
  * @param bool   $result Has anyone sent a message yet?
  * @param array  $params Hook parameters
- * @return bool
+ * @return null|boolean
  * @access private
  */
 function _elgg_send_email_notification($hook, $type, $result, $params) {
@@ -257,7 +257,7 @@ 
  *
  * @see    https://tools.ietf.org/html/rfc5322#section-3.6.4
  *
- * @return array
+ * @return null|Elgg\Email
  * @access private
  */
 function _elgg_notifications_smtp_default_message_id_header($hook, $type, $email) {
@@ -284,7 +284,7 @@ 
  * @param string      $type  "system:email"
  * @param \Elgg\Email $email Email instance
  *
- * @return array
+ * @return null|Elgg\Email
  * @access private
  */
 function _elgg_notifications_smtp_thread_headers($hook, $type, $email) {
@@ -356,12 +356,12 @@ 
 /**
  * Notify a user via their preferences.
  *
- * @param mixed  $to               Either a guid or an array of guid's to notify.
+ * @param integer  $to               Either a guid or an array of guid's to notify.
  * @param int    $from             GUID of the sender, which may be a user, site or object.
  * @param string $subject          Message subject.
  * @param string $message          Message body.
  * @param array  $params           Misc additional parameters specific to various methods.
- * @param mixed  $methods_override A string, or an array of strings specifying the delivery
+ * @param string[]  $methods_override A string, or an array of strings specifying the delivery
  *                                 methods to use - or leave blank for delivery using the
  *                                 user's chosen delivery methods.
  *

engine/lib/annotations.php

Doc Comments +1 added lines, -1 removed lines

@@ -33,7 +33,7 @@
  *
  * @param int $id The id of the annotation object being retrieved.
  *
- * @return \ElggAnnotation|false
+ * @return ElggExtender
  */
 function elgg_get_annotation_from_id($id) {
 	return _elgg_services()->annotations->get($id);

engine/lib/elgglib.php

Doc Comments +10 added lines, -10 removed lines

@@ -249,7 +249,7 @@ 
  *
  * @param string $location 'head' or 'footer'
  *
- * @return array
+ * @return string[]
  * @since 1.8.0
  */
 function elgg_get_loaded_js($location = 'head') {
@@ -300,7 +300,7 @@ 
 /**
  * Get the loaded CSS URLs
  *
- * @return array
+ * @return string[]
  * @since 1.8.0
  */
 function elgg_get_loaded_css() {
@@ -355,7 +355,7 @@ 
  * @param string $type     Type of file: js or css
  * @param string $location Page location
  *
- * @return array
+ * @return string[]
  * @since 1.8.0
  */
 function elgg_get_loaded_external_files($type, $location) {
@@ -370,7 +370,7 @@ 
  * @param string $directory  Directory to look in
  * @param array  $exceptions Array of filenames to ignore
  * @param array  $list       Array of files to append to
- * @param mixed  $extensions Array of extensions to allow, null for all. Use a dot: array('.php').
+ * @param string[]  $extensions Array of extensions to allow, null for all. Use a dot: array('.php').
  *
  * @return array Filenames in $directory, in the form $directory/filename.
  */
@@ -438,7 +438,7 @@ 
 /**
  * Display a system message on next page load.
  *
- * @param string|array $message Message or messages to add
+ * @param string $message Message or messages to add
  *
  * @return bool
  */
@@ -635,7 +635,7 @@ 
  * @param string $object_type The object type
  * @param string $object      The object involved in the event
  *
- * @return true
+ * @return boolean
  *
  * @see elgg_trigger_before_event
  */
@@ -816,7 +816,7 @@ 
  * @param string $hook Hook name
  * @param string $type Hook type
  *
- * @return array
+ * @return callable[]
  *
  * @since 2.0.0
  */
@@ -830,7 +830,7 @@ 
  * @param string $event Event name
  * @param string $type  Object type
  *
- * @return array
+ * @return callable[]
  *
  * @since 2.0.0
  */
@@ -880,7 +880,7 @@ 
  * A {@elgg_plugin_hook debug log} is called.  If a handler returns
  * false, it will stop the default logging method.
  *
- * @param mixed $value     The value
+ * @param string $value     The value
  * @param bool  $to_screen Display to screen?
  * @return void
  * @since 1.7.0
@@ -1222,7 +1222,7 @@ 
  * Extract class names from an array with key "class", optionally merging into a preexisting set.
  *
  * @param array           $array    Source array
- * @param string|string[] $existing Existing name(s)
+ * @param string[] $existing Existing name(s)
  * @return string[]
  *
  * @since 2.3.0

engine/lib/relationships.php

Doc Comments +1 added lines, -1 removed lines

@@ -87,7 +87,7 @@
  *                                     subject of the relationships.
  * @param string $type                 The type of entity related to $guid (defaults to all)
  *
- * @return true
+ * @return boolean
  */
 function remove_entity_relationships($guid, $relationship = "", $inverse_relationship = false, $type = '') {
 	return _elgg_services()->relationshipsTable->removeAll($guid, $relationship, $inverse_relationship, $type);

engine/classes/Elgg/Application.php

Doc Comments +3 added lines, -3 removed lines

@@ -457,7 +457,7 @@ 
 	/**
 	 * Elgg's front controller. Handles basically all incoming URL requests.
 	 *
-	 * @return bool True if Elgg will handle the request, false if the server should (PHP-CLI server)
+	 * @return boolean|null True if Elgg will handle the request, false if the server should (PHP-CLI server)
 	 */
 	public static function index() {
 		$req = Request::createFromGlobals();
@@ -474,7 +474,7 @@ 
 	/**
 	 * Routes the request, booting core if not yet booted
 	 *
-	 * @return bool False if Elgg wants the PHP CLI server to handle the request
+	 * @return boolean|null False if Elgg wants the PHP CLI server to handle the request
 	 */
 	public function run() {
 		$config = $this->_services->config;
@@ -852,7 +852,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/lib/access.php

Doc Comments +1 added lines, -1 removed lines

@@ -301,7 +301,7 @@
  * @param string $name       The name of the collection.
  * @param int    $owner_guid The GUID of the owner (default: currently logged in user).
  *
- * @return int|false The collection ID if successful and false on failure.
+ * @return integer The collection ID if successful and false on failure.
  * @see update_access_collection()
  * @see delete_access_collection()
  */