Elgg / Elgg

engine/classes/ElggEntity.php

Doc Comments +15 added lines, -15 removed lines

@@ -459,7 +459,7 @@ 
 	 * @warning Calling this with no $name will clear all metadata on the entity.
 	 *
 	 * @param null|string $name The name of the metadata to remove.
-	 * @return bool
+	 * @return boolean|null
 	 * @since 1.8
 	 */
 	public function deleteMetadata($name = null) {
@@ -484,7 +484,7 @@ 
 	 * If you pass a name, only metadata matching that name will be deleted.
 	 *
 	 * @param null|string $name The name of metadata to delete.
-	 * @return bool
+	 * @return boolean|null
 	 * @since 1.8
 	 */
 	public function deleteOwnedMetadata($name = null) {
@@ -508,7 +508,7 @@ 
 	 * Disables metadata for this entity, optionally based on name.
 	 *
 	 * @param string $name An options name of metadata to disable.
-	 * @return bool
+	 * @return boolean|null
 	 * @since 1.8
 	 */
 	public function disableMetadata($name = '') {
@@ -529,7 +529,7 @@ 
 	 * @warning Before calling this, you must use {@link access_show_hidden_entities()}
 	 *
 	 * @param string $name An options name of metadata to enable.
-	 * @return bool
+	 * @return boolean|null
 	 * @since 1.8
 	 */
 	public function enableMetadata($name = '') {
@@ -682,7 +682,7 @@ 
 	 *
 	 * @param string $name Name of the private setting
 	 *
-	 * @return bool
+	 * @return integer
 	 */
 	public function removePrivateSetting($name) {
 		return remove_private_setting($this->getGUID(), $name);
@@ -695,7 +695,7 @@ 
 	 * @warning Calling this with no or empty arguments will clear all annotations on the entity.
 	 *
 	 * @param null|string $name The annotations name to remove.
-	 * @return bool
+	 * @return boolean|null
 	 * @since 1.8
 	 */
 	public function deleteAnnotations($name = null) {
@@ -715,7 +715,7 @@ 
 	 * If you pass a name, only annotations matching that name will be deleted.
 	 *
 	 * @param null|string $name The name of annotations to delete.
-	 * @return bool
+	 * @return boolean|null
 	 * @since 1.8
 	 */
 	public function deleteOwnedAnnotations($name = null) {
@@ -739,7 +739,7 @@ 
 	 * Disables annotations for this entity, optionally based on name.
 	 *
 	 * @param string $name An options name of annotations to disable.
-	 * @return bool
+	 * @return boolean|null
 	 * @since 1.8
 	 */
 	public function disableAnnotations($name = '') {
@@ -760,7 +760,7 @@ 
 	 * @warning Before calling this, you must use {@link access_show_hidden_entities()}
 	 *
 	 * @param string $name An options name of annotations to enable.
-	 * @return bool
+	 * @return boolean|null
 	 * @since 1.8
 	 */
 	public function enableAnnotations($name = '') {
@@ -807,7 +807,7 @@ 
 	 * @param int    $owner_guid GUID of the annotation owner
 	 * @param string $vartype    The type of annotation value
 	 *
-	 * @return bool|int Returns int if an annotation is saved
+	 * @return integer Returns int if an annotation is saved
 	 */
 	public function annotate($name, $value, $access_id = ACCESS_PRIVATE, $owner_guid = 0, $vartype = "") {
 		if ((int) $this->guid > 0) {
@@ -1113,7 +1113,7 @@ 
 	 *
 	 * @param int $container_guid The ID of the container.
 	 *
-	 * @return bool
+	 * @return integer
 	 */
 	public function setContainerGUID($container_guid) {
 		return $this->container_guid = (int) $container_guid;
@@ -1192,7 +1192,7 @@ 
 	/**
 	 * Saves icons using a file located in the data store as the source.
 	 *
-	 * @param string $file   An ElggFile instance
+	 * @param ElggFile $file   An ElggFile instance
 	 * @param string $type   The name of the icon. e.g., 'icon', 'cover_photo'
 	 * @param array  $coords An array of cropping coordinates x1, y1, x2, y2
 	 * @return bool
@@ -1217,7 +1217,7 @@ 
 	 * Removes all icon files and metadata for the passed type of icon.
 	 *
 	 * @param string $type The name of the icon. e.g., 'icon', 'cover_photo'
-	 * @return bool
+	 * @return boolean|null
 	 */
 	public function deleteIcon($type = 'icon') {
 		return _elgg_services()->iconService->deleteIcon($this, $type);
@@ -1252,7 +1252,7 @@ 
 	 * Plugins can register for the 'entity:icon:url', <type> plugin hook
 	 * to customize the icon for an entity.
 	 *
-	 * @param mixed $params A string defining the size of the icon (e.g. tiny, small, medium, large)
+	 * @param string $params A string defining the size of the icon (e.g. tiny, small, medium, large)
 	 *                      or an array of parameters including 'size'
 	 * @return string The URL
 	 * @since 1.8.0
@@ -2073,7 +2073,7 @@ 
 	 * This is used by the system log. It can be called on any Loggable object.
 	 *
 	 * @param int $id GUID.
-	 * @return int GUID
+	 * @return ElggEntity GUID
 	 */
 	public function getObjectFromID($id) {
 		return get_entity($id);

engine/classes/Elgg/Application/CacheHandler.php

Unused Use Statements -1 removed lines

@@ -6,7 +6,6 @@
 use Elgg\Http\Request;
 use Symfony\Component\HttpFoundation\BinaryFileResponse;
 use Symfony\Component\HttpFoundation\Response;
-use Symfony\Component\HttpFoundation\StreamedResponse;
 
 /**
  * Simplecache handler

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/ElggInstaller.php

Unused Use Statements -1 removed lines

@@ -1,6 +1,5 @@
 <?php
 
-use Elgg\Filesystem\Directory;
 use Elgg\Application;
 use Elgg\Config;
 use Elgg\Database\DbConfig;

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/classes/ElggRewriteTester.php

Unused Use Statements -1 removed lines

@@ -1,7 +1,6 @@
 <?php
 
 use Elgg\Filesystem\Directory;
-use Elgg\Application;
 use Elgg\Project\Paths;
 use Elgg\Http\Request;
 

engine/classes/Elgg/UpgradeService.php

Unused Use Statements -3 removed lines

@@ -1,8 +1,5 @@
 <?php
 namespace Elgg;
-use Elgg\Filesystem\Directory\Local;
-use Phinx\Console\PhinxApplication;
-use Phinx\Wrapper\TextWrapper;
 
 /**
  * Upgrade service for Elgg

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.
  *

Unused Use Statements -2 removed lines

@@ -1,8 +1,6 @@
 <?php
 
-use Elgg\Mail\Address;
 use Zend\Mail\Message;
-use Elgg\Project\Paths;
 
 /**
  * Adding a New Notification Event