gctools-outilsgc / gcconnex

mod/gc_mobile_api/models/event.php

Doc Comments +3 added lines

@@ -202,6 +202,9 @@
 	return $event;
 }
 
+/**
+ * @param ElggUser $user_entity
+ */
 function foreach_events($params, $from, $to, $user_entity, $lang)
 {
 	$now = time();

mod/cp_notifications/start.php

Doc Comments +5 added lines, -6 removed lines

@@ -132,7 +132,7 @@ 
  * @param mixed  $value   The current value of the plugin hook
  * @param mixed  $params  Data passed from the trigger
  *
- * @return mixed if not null, this will be the new value of the plugin hook
+ * @return boolean if not null, this will be the new value of the plugin hook
  */
 function minor_save_hook_handler($hook, $type, $value, $params) {
 
@@ -620,7 +620,6 @@ 
 /**
  * returns the headers for ical
  *
- * @param string 		$type_event
  * @param ElggObject 	$event
  * @param string 		$start_date
  * @param string 		$end_date
@@ -1486,6 +1485,9 @@ 
 }
 
 
+/**
+ * @param string $error_message
+ */
 function notification_logging($error_message) {
 	// logging mechanism
 	if (elgg_is_active_plugin('wet4')) {
@@ -1536,8 +1538,6 @@ 
  * run crontab, retrieve users, send digest, reset timer (update timestamp)
  *
  * @param string $hook    The name of the plugin hook
- * @param string $type    The type of the plugin hook
- * @param mixed  $value   The current value of the plugin hook
  * @param mixed  $params  Data passed from the trigger
  */
 function cp_digest_weekly_cron_handler($hook, $entity_type, $return_value, $params) {
@@ -1580,6 +1580,7 @@ 
  * @param string $entity_type    The type of the plugin hook
  * @param mixed  $return_value   The current value of the plugin hook
  * @param mixed  $params  Data passed from the trigger
+ * @param string $cron_freq
  */
 function cp_digest_email_handler($hook, $entity_type, $return_value, $params, $cron_freq) {
 	$dbprefix = elgg_get_config('dbprefix');
@@ -1771,7 +1772,6 @@ 
  *
  * @param string $hook    The name of the plugin hook
  * @param string $type    The type of the plugin hook
- * @param mixed  $value   The current value of the plugin hook
  * @param mixed  $params  Data passed from the trigger
  */
 function cpn_email_handler_hook($hook, $type, $notification, $params) {
@@ -1785,7 +1785,6 @@ 
  *
  * @param string $hook    The name of the plugin hook
  * @param string $type    The type of the plugin hook
- * @param mixed  $value   The current value of the plugin hook
  * @param mixed  $params  Data passed from the trigger
  *
  * @return mixed if not null, this will be the new value of the plugin hook

mod/cp_notifications/lib/functions.php

Doc Comments +9 added lines, -1 removed lines

@@ -6,6 +6,7 @@ 
  * @param integer 	$entity_guid_static
  * @param integer 	$entity_guid
  *
+ * @return integer
  */
 function get_forum_in_group($entity_guid_static, $entity_guid) {
 	$entity = get_entity($entity_guid);
@@ -159,7 +160,7 @@ 
  * @param ElggEntity 	$entity
  * @param ElggUser 		$send_to
  * @param string 		$entity_url (default value empty)
- * @return Success 		true/false
+ * @return boolean 		true/false
  */
 function create_digest($invoked_by, $subtype, $entity, $send_to, $entity_url = '') {
 
@@ -945,6 +946,7 @@ 
 
 /**
  * Helper functions for digest processing queue
+ * @param integer $user_guid
  */
 function enqueue( $user_guid ) {
 	// add to queue
@@ -964,6 +966,9 @@ 
  * to get closer to 'exactly once', the digest function can enqueue failed attempts
  * NOTE: this won't work so well with a split read-write db setup, will likely need to be done without using elgg db functions
  */
+/**
+ * @return integer
+ */
 function dequeue() {
 	$query_init = "SET @uid := NULL";	// mostly for termination
 	$query_delete = "DELETE FROM notification_digest_queue WHERE user_guid = @uid := user_guid LIMIT 1";			// remove a row from queue and prepare the guid to be returned
@@ -980,6 +985,9 @@ 
 	return enqueue(0) == 0;		// there is no user with guid = 0, but only one instance will successfuly insert this with user_guid being the primary key
 }
 
+/**
+ * @param string $frequency
+ */
 function initialize_queue( $frequency ){
 	$dbprefix = elgg_get_config('dbprefix');
 

mod/talent_cloud_invite_api/actions/invite.php

Doc Comments +3 added lines

@@ -138,6 +138,9 @@
 
 	};
 
+	/**
+	 * @param string $emailaddress
+	 */
 	function invitationExists($emailaddress){
 		$query = "SELECT * FROM email_invitations WHERE `email` = '" . $emailaddress . "'";
 		$result = get_data($query);

mod/missions/api/v0/export.php

Doc Comments +3 added lines

@@ -182,6 +182,9 @@
       return str_replace('::version::', self::$version, self::$help);
     }
 
+    /**
+     * @param string $object_type
+     */
     function __construct($object_type, $subtype = false, $guid = null,
       $since = null, $before = null, $limit = null, $resume = null,
       $sort = false, $omit = null, $count = false) {

mod/embed_extender/lib/custom.php

Doc Comments +4 added lines

@@ -8,6 +8,10 @@
 	}
 
 	//Generic embed functions - Don't touch here!
+
+	/**
+	 * @param string $guid
+	 */
 	function custom_videoembed_create_embed_object($url, $guid, $videowidth=0, $input) {
 		
 		if (!$input) {

engine/lib/plugins.php

Doc Comments +4 added lines, -4 removed lines

@@ -155,7 +155,7 @@ 
  * Returns an ordered list of plugins
  *
  * @param string $status    The status of the plugins. active, inactive, or all.
- * @param mixed  $site_guid Optional site guid
+ * @param integer  $site_guid Optional site guid
  * @return \ElggPlugin[]
  * @since 1.8.0
  */
@@ -226,7 +226,7 @@ 
  * @param string $type The type of provides to return
  * @param string $name A specific provided name to return. Requires $provide_type.
  *
- * @return array
+ * @return string|null
  * @since 1.8.0
  * @access private
  */
@@ -366,7 +366,7 @@ 
  *
  * @param string $name      The name of the setting.
  * @param string $plugin_id The plugin ID (Required)
- * @param mixed  $default   The default value to return if none is set
+ * @param integer  $default   The default value to return if none is set
  *
  * @return mixed
  * @since 1.8.0
@@ -458,7 +458,7 @@ 
  * @param string $event  deactivate
  * @param string $type   plugin
  * @param array  $params Parameters array containing entry with ELggPlugin instance under 'plugin_entity' key
- * @return bool  false to block plugin deactivation action
+ * @return false|null  false to block plugin deactivation action
  *
  * @access private
  */

mod/gc_mobile_api/inc/functions.php

Doc Comments +3 added lines

@@ -136,6 +136,9 @@
 	return $text;
 }
 
+/**
+ * @param string $text
+ */
 function clean_text($text)
 {
 	return trim(preg_replace('/ +/', ' ', preg_replace('/[^A-Za-z0-9 ]/', ' ', urldecode(html_entity_decode(strip_tags($text))))));

engine/classes/ElggEntity.php

Doc Comments +19 added lines, -19 removed lines

@@ -269,7 +269,7 @@ 
 	 * Return the value of an attribute or metadata
 	 *
 	 * @param string $name Name
-	 * @return mixed Returns the value of a given value, or null.
+	 * @return string Returns the value of a given value, or null.
 	 * @deprecated 1.9
 	 */
 	public function get($name) {
@@ -462,7 +462,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) {
@@ -487,7 +487,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) {
@@ -513,7 +513,7 @@ 
 	 * @warning Calling this with no or empty arguments will clear all metadata on the entity.
 	 *
 	 * @param string $name The name of the metadata to clear
-	 * @return mixed bool
+	 * @return boolean|null bool
 	 * @deprecated 1.8 Use deleteMetadata()
 	 */
 	public function clearMetadata($name = '') {
@@ -525,7 +525,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 = '') {
@@ -546,7 +546,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 = '') {
@@ -714,7 +714,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) {
@@ -734,7 +734,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) {
@@ -758,7 +758,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 = '') {
@@ -779,7 +779,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 = '') {
@@ -896,7 +896,7 @@ 
 	 * all annotations on the entity.
 	 *
 	 * @param string $name Annotation name
-	 * @return bool
+	 * @return boolean|null
 	 * @deprecated 1.8 Use ->deleteAnnotations()
 	 */
 	public function clearAnnotations($name = "") {
@@ -1309,7 +1309,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;
@@ -1320,7 +1320,7 @@ 
 	 *
 	 * @param int $container_guid The ID of the container.
 	 *
-	 * @return bool
+	 * @return integer
 	 * @deprecated 1.8 use setContainerGUID()
 	 */
 	public function setContainer($container_guid) {
@@ -1438,7 +1438,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
@@ -1822,7 +1822,7 @@ 
 	/**
 	 * Loads attributes from the entities table into the object.
 	 *
-	 * @param mixed $guid GUID of entity or \stdClass object from entities table
+	 * @param stdClass $guid GUID of entity or \stdClass object from entities table
 	 *
 	 * @return bool
 	 */
@@ -2295,7 +2295,7 @@ 
 	 * @param int $year     If ommitted, now is assumed.
 	 * @param int $duration Duration of event, remainder of the day is assumed.
 	 *
-	 * @return true
+	 * @return boolean
 	 * @deprecated 1.9
 	 */
 	public function setCalendarTimeAndDuration($hour = null, $minute = null, $second = null,
@@ -2343,7 +2343,7 @@ 
 	/**
 	 * Returns an array of fields which can be exported.
 	 *
-	 * @return array
+	 * @return string[]
 	 * @deprecated 1.9 Use toObject()
 	 */
 	public function getExportableValues() {
@@ -2455,7 +2455,7 @@ 
 	 *
 	 * @param ODD $data XML data
 	 *
-	 * @return true
+	 * @return boolean
 	 *
 	 * @throws InvalidParameterException
 	 * @deprecated 1.9 Use toObject()
@@ -2499,7 +2499,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);