gctools-outilsgc / gcconnex

mod/missions_organization/lib/missions-organization.php

Doc Comments +9 added lines

@@ -46,6 +46,9 @@ 
  * Function to format the dropdown menu input.
  * If the input is not an entity then it returns false.
  */
+/**
+ * @param integer $input
+ */
 function mo_format_input_node($input) {
 	if(elgg_entity_exists($input)) {
 		return 'MOrg:' . $input;
@@ -118,6 +121,9 @@ 
 /*
  * Function which gets all the ancestors and then creates a string out of their names.
  */
+/**
+ * @param string|false $node_string
+ */
 function mo_string_all_ancestors($node_string) {
 	$ancestor_guids = mo_get_all_ancestors($node_string);
 	$ancestor_names_english = array();
@@ -145,6 +151,9 @@ 
 /*
  * Extracts node guid from the stored data.
  */
+/**
+ * @return integer
+ */
 function mo_extract_node_guid($node_string) {
 	$node_array = explode(':', $node_string);
 	return $node_array[1];

mod/gc_lang_url_handler/start.php

Doc Comments +1 added lines, -1 removed lines

@@ -14,7 +14,7 @@
  * @param $type
  * @param $returnvalue
  * @param $params
- * @return False to stop processing the response, True will let elgg handle the response
+ * @return null|boolean to stop processing the response, True will let elgg handle the response
  */
 function global_url_handler($hook, $type, $returnvalue, $params) {
 

mod/gc_mobile_api/models/bookmark.php

Doc Comments +3 added lines

@@ -126,6 +126,9 @@
   return $bookmarks;
 }//end get_bookmark
 
+/**
+ * @param ElggUser $user_entity
+ */
 function foreach_bookmark($bookmarks, $user_entity, $lang)
 {
   foreach ($bookmarks as $bookmark){

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) {