gctools-outilsgc / gcconnex

mod/cp_notifications/lib/functions.php

Doc Comments +6 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
@@ -971,6 +973,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/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 $frequency
  */
 function cp_digest_email_handler($hook, $entity_type, $return_value, $params, $frequency) {
 	elgg_load_library('elgg:gc_notification:functions');
@@ -1779,7 +1780,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) {
@@ -1793,7 +1793,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