gctools-outilsgc / gcconnex

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');