gctools-outilsgc / gcconnex

mod/missions/lib/missions.php

Doc Comments +30 added lines

@@ -10,6 +10,9 @@ 
 /*
  * Packs the language variables for a single language into a single string.
  */
+/**
+ * @param string|null $lang
+ */
 function mm_pack_language($lwc, $lwe, $lop, $lang)
 {
     $returner = '';
@@ -41,6 +44,9 @@ 
 /*
  * Unpacks a language string into an array of its component variable.
  */
+/**
+ * @param string|null $lang
+ */
 function mm_unpack_language($data_string, $lang)
 {
     $returner = array();
@@ -71,6 +77,11 @@ 
 /*
  * Packs the time (hour and minute) into a single string.
  */
+/**
+ * @param string|null $hour
+ * @param string|null $min
+ * @param string|null $day
+ */
 function mm_pack_time($hour, $min, $day)
 {
     $returner = '';
@@ -95,6 +106,9 @@ 
 /*
  * Unpacks the time into an array of hour and minute.
  */
+/**
+ * @param string|null $day
+ */
 function mm_unpack_time($data_string, $day)
 {
     $returner = array();
@@ -118,6 +132,9 @@ 
 /*
  * Unpacks every unpackable item within a given entity.
  */
+/**
+ * @param ElggEntity $entity
+ */
 function mm_unpack_mission($entity)
 {
     $returner = array();
@@ -429,6 +446,10 @@ 
  * Notify user function which uses messages_send() to send on site notifications and mail() to send e-mail.
  * This is here because notify_user() is currently not working.
  */
+/**
+ * @param string $title_en
+ * @param string $title_fr
+ */
 function mm_notify_user($recipient, $sender, $subject, $title_en,$title_fr,$body_en, $body_fr) {
 	//notify_user($recipient, $sender, $subject, $body, array(), 'email');
 
@@ -622,6 +643,9 @@ 
 /*
  * Returns an accept button to a user who has received an offer if the mission is not full.
  */
+/**
+ * @param ElggUser|null $applicant
+ */
 function mm_finalize_button($mission, $applicant) {
 	$relationship_count = elgg_get_entities_from_relationship(array(
 			'relationship' => 'mission_accepted',
@@ -787,6 +811,9 @@ 
 /*
  * Check if the user is opted in to any of the opt-in options.
  */
+/**
+ * @param ElggEntity|null $current_user
+ */
 function check_if_opted_in($current_user) {
     //Nick - adding additional checks for other opportunity types
 	if($current_user->opt_in_missions == 'gcconnex_profile:opt:yes') {
@@ -864,6 +891,9 @@ 
 	return false;
 }
 
+/**
+ * @param ElggEntity $mission
+ */
 function mm_complete_mission_inprogress_reports($mission, $if_no_applicants = false) {
 		if ($if_no_applicants) {
 				// Find out how many accepted applicants are on this mission.

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/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