Elgg / Elgg

engine/classes/Elgg/Database/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 get($id) {
 		return _elgg_get_metastring_based_object_from_id($id, 'annotation');

engine/classes/Elgg/Http/Request.php

Doc Comments +1 added lines

@@ -105,6 +105,7 @@
 
 	/**
 	 * {@inheritdoc}
+	 * @return string
 	 */
 	public function getClientIp() {
 		$ip = parent::getClientIp();

Unused Use Statements -1 removed lines

@@ -2,7 +2,6 @@
 namespace Elgg\Http;
 
 use Symfony\Component\HttpFoundation\Request as SymfonyRequest;
-use Elgg\Application;
 
 /**
  * Elgg HTTP request.

engine/classes/ElggBatch.php

Doc Comments +1 added lines, -1 removed lines

@@ -174,7 +174,7 @@
 	 * @param array  $options    The options array to pass to the getter function. If limit is
 	 *                           not set, 10 is used as the default. In most cases that is not
 	 *                           what you want.
-	 * @param mixed  $callback   An optional callback function that all results will be passed
+	 * @param null|string  $callback   An optional callback function that all results will be passed
 	 *                           to upon load.  The callback needs to accept $result, $getter,
 	 *                           $options.
 	 * @param int    $chunk_size The number of entities to pull in before requesting more.

engine/classes/ElggData.php

Doc Comments +1 added lines, -1 removed lines

@@ -285,7 +285,7 @@
 	 *
 	 * @param int $offset Offset
 	 *
-	 * @return int
+	 * @return boolean
 	 */
 	public function offsetExists($offset) {
 		return array_key_exists($offset, $this->attributes);

engine/classes/ElggPluginManifest.php

Doc Comments +2 added lines, -2 removed lines

@@ -142,7 +142,7 @@ 
 	/**
 	 * Load a manifest file, XmlElement or path to manifest.xml file
 	 *
-	 * @param mixed  $manifest  A string, XmlElement, or path of a manifest file.
+	 * @param string  $manifest  A string, XmlElement, or path of a manifest file.
 	 * @param string $plugin_id Optional ID of the owning plugin. Used to
 	 *                          fill in some values automatically.
 	 *
@@ -687,7 +687,7 @@ 
 	/**
 	 * Should this plugin be activated when Elgg is installed
 	 *
-	 *  @return bool
+	 *  @return boolean|null
 	 */
 	public function getActivateOnInstall() {
 		$activate = $this->parser->getAttribute('activate_on_install');

engine/classes/ElggPriorityList.php

Doc Comments +2 added lines, -2 removed lines

@@ -231,7 +231,7 @@ 
 	/**
 	 * Sort the elements if they haven't been sorted yet.
 	 *
-	 * @return bool
+	 * @return boolean|null
 	 */
 	private function sortIfUnsorted() {
 		if (!$this->sorted) {
@@ -262,7 +262,7 @@ 
 	 *
 	 * @param mixed $element The element to check for.
 	 * @param bool  $strict  Use strict checking?
-	 * @return mixed False if the element doesn't exists, the priority if it does.
+	 * @return integer False if the element doesn't exists, the priority if it does.
 	 */
 	public function getPriority($element, $strict = false) {
 		return array_search($element, $this->elements, $strict);

engine/lib/admin.php

Doc Comments +1 added lines, -1 removed lines

@@ -806,7 +806,7 @@
  * @param string $type
  * @param \ElggUser $user
  *
- * @return null|true
+ * @return boolean|null
  * @access private
  */
 function _elgg_add_admin_widgets($event, $type, $user) {

engine/lib/cache.php

Doc Comments +1 added lines, -1 removed lines

@@ -214,7 +214,7 @@
  * Deletes all cached views in the simplecache and sets the lastcache and
  * lastupdate time to 0 for every valid viewtype.
  *
- * @return bool
+ * @return boolean|null
  * @since 1.7.4
  */
 function elgg_invalidate_simplecache() {

engine/lib/sessions.php

Doc Comments +2 added lines, -2 removed lines

@@ -130,7 +130,7 @@ 
  * @param string $username The username
  * @param string $password The password
  *
- * @return true|string True or an error message on failure
+ * @return string|boolean True or an error message on failure
  * @access private
  */
 function elgg_authenticate($username, $password) {
@@ -314,7 +314,7 @@ 
  * @param \ElggUser $user       A valid Elgg user object
  * @param boolean   $persistent Should this be a persistent login?
  *
- * @return true or throws exception
+ * @return boolean or throws exception
  * @throws LoginException
  */
 function login(\ElggUser $user, $persistent = false) {