gctools-outilsgc / gcconnex

mod/event_calendar/models/model.php

Doc Comments +61 added lines, -2 removed lines

@@ -276,6 +276,10 @@ 
 	return $event;
 }
 
+/**
+ * @param integer $start_date
+ * @param integer $end_date
+ */
 function event_calendar_get_events_between($start_date, $end_date, $is_count=false, $limit=10, $offset=0, $container_guid=0, $region='-') {
 	$polls_supported = elgg_is_active_plugin('event_poll');
 	if ($is_count) {
@@ -324,6 +328,10 @@ 
 	return $non_repeating_events;
 }
 
+/**
+ * @param integer $container_guid
+ * @param string $region
+ */
 function event_calendar_get_repeating_events_between($start_date, $end_date, $container_guid, $region) {
 	// game plan: get all repeating events with start date <= $end_date and then generate all possible events
 	// sanity check
@@ -428,6 +436,10 @@ 
 	return $repeating_events;
 }
 
+/**
+ * @param integer $start_date
+ * @param integer $end_date
+ */
 function event_calendar_get_open_events_between($start_date, $end_date, $is_count=false, $limit=10, $offset=0, $container_guid=0, $region='-', $meta_max = 'spots', $relationship_name = 'personal_event') {
 	if ($is_count) {
 		$count = event_calendar_get_entities_from_metadata_between('start_date', 'end_date', $start_date, $end_date, "object", "event_calendar", 0, $container_guid, $limit, $offset, "", 0, false, true, $region, $meta_max, $relationship_name);
@@ -441,6 +453,10 @@ 
 	}
 }
 
+/**
+ * @param integer $container_guid
+ * @param string $region
+ */
 function event_calendar_get_open_repeating_events_between($start_date, $end_date, $container_guid, $region) {
 	$db_prefix = elgg_get_config('dbprefix');
 	$meta_max = 'spots';
@@ -505,6 +521,9 @@ 
 
 
 //For list event
+/**
+ * @param boolean $is_count
+ */
 function event_calendar_get_events_for_user_between($start_date, $end_date, $is_count, $limit=10, $offset=0, $user_guid, $container_guid=0, $region='-') {
 	$options = array(
 		'type' => 'object',
@@ -549,6 +568,12 @@ 
 
 
 //For calendar event
+/**
+ * @param integer $start_date
+ * @param integer $end_date
+ * @param boolean $is_count
+ * @param integer $user_guid
+ */
 function event_calendar_get_events_for_user_between2($start_date, $end_date, $is_count, $limit=10, $offset=0, $user_guid, $container_guid=0, $region='-') {
 	$options = array(
 		'type' => 'object',
@@ -590,6 +615,10 @@ 
 	}
 }
 
+/**
+ * @param integer $container_guid
+ * @param string $region
+ */
 function event_calendar_get_repeating_events_for_user_between($user_guid, $start_date, $end_date, $container_guid, $region) {
 	$options = array(
 			'type' => 'object',
@@ -628,6 +657,9 @@ 
 	return event_calendar_get_repeating_event_structure($events, $start_date, $end_date);
 }
 
+/**
+ * @param string $friend_list
+ */
 function event_calendar_get_repeating_events_for_friends_between($user_guid, $friend_list, $start_date, $end_date, $container_guid=0, $region='-') {
 
 	$db_prefix = elgg_get_config('dbprefix');
@@ -664,6 +696,11 @@ 
 	return event_calendar_get_repeating_event_structure($events, $start_date, $end_date);
 }
 
+/**
+ * @param integer $start_date
+ * @param integer $end_date
+ * @param boolean $is_count
+ */
 function event_calendar_get_events_for_friends_between($start_date, $end_date, $is_count, $limit=10, $offset=0, $user_guid, $container_guid=0, $region='-') {
 	if ($user_guid) {
 		$user = get_user($user_guid);
@@ -792,14 +829,14 @@ 
  * @param mixed $meta_end_value - end of metadata range, must be numerical value
  * @param string $entity_type The type of entity to look for, eg 'site' or 'object'
  * @param string $entity_subtype The subtype of the entity.
- * @param mixed $owner_guid Either one integer user guid or an array of user guids
+ * @param integer $owner_guid Either one integer user guid or an array of user guids
  * @param int $container_guid If supplied, the result is restricted to events associated with a specific container
  * @param int $limit
  * @param int $offset
  * @param string $order_by Optional ordering.
  * @param int $site_guid The site to get entities for. Leave as 0 (default) for the current site; -1 for all sites.
  * @param boolean $filter Filter by events in personal calendar if true
- * @param true|false $count If set to true, returns the total number of entities rather than a list. (Default: false)
+ * @param boolean $count If set to true, returns the total number of entities rather than a list. (Default: false)
  * @param string $meta_max metadata name containing maximum relationship count
  * @param string $relationship_name relationship name to count
  *
@@ -979,6 +1016,9 @@ 
 	return false;
 }
 
+/**
+ * @param integer $event_guid
+ */
 function event_calendar_add_personal_events_from_group($event_guid, $group_guid) {
 	$group = get_entity($group_guid);
 
@@ -993,6 +1033,9 @@ 
 	remove_entity_relationship($user_guid, 'personal_event', $event_guid);
 }
 
+/**
+ * @param integer $limit
+ */
 function event_calendar_get_personal_events_for_user($user_guid, $limit) {
 	$events = elgg_get_entities_from_relationship(array(
 		'type' => 'object',
@@ -1018,6 +1061,9 @@ 
 	return array_slice($sorted, 0, $limit);
 }
 
+/**
+ * @param integer $limit
+ */
 function event_calendar_get_users_for_event($event_guid, $limit, $offset=0, $is_count=false) {
 	$options = array(
 		'type' => 'user',
@@ -1355,6 +1401,9 @@ 
 }
 
 // returns open, closed or private for the given event and user
+/**
+ * @param integer $user_id
+ */
 function event_calendar_personal_can_manage($event, $user_id) {
 	$status = 'private';
 	$event_calendar_personal_manage = elgg_get_plugin_setting('personal_manage', 'event_calendar');
@@ -2285,6 +2334,10 @@ 
 	}
 }
 
+/**
+ * @param string $month
+ * @param string $year
+ */
 function getLastDayOfMonth($month, $year) {
 	return idate('d', mktime(0, 0, 0, ($month + 1), 0, $year));
 }
@@ -2493,6 +2546,9 @@ 
 }
 
 // utility function for BBB api calls
+/**
+ * @param string $api_function
+ */
 function event_calendar_bbb_api($api_function, $params=null) {
 
 	$bbb_security_salt = elgg_get_plugin_setting('bbb_security_salt', 'event_calendar');
@@ -2533,6 +2589,9 @@ 
 	}
 }
 
+/**
+ * @param ElggEntity $event
+ */
 function event_calendar_create_bbb_conf($event) {
 	$day_in_minutes = 60*24;
 	$now = time();

mod/event_calendar/start.php

Doc Comments +1 added lines, -1 removed lines

@@ -178,7 +178,7 @@
  * Title is ignored
  *
  * @param array $page
- * @return null
+ * @return boolean
  */
 function event_calendar_page_handler($page) {
 

mod/file/start.php

Doc Comments +3 added lines

@@ -298,6 +298,9 @@
 	return elgg_view('file/typecloud', $params);
 }
 
+/**
+ * @param boolean $friends
+ */
 function file_type_cloud_get_url($type, $friends) {
 	$url = elgg_get_site_url() . 'file/search?subtype=file';
 

mod/file_tools/lib/page_handlers.php

Doc Comments +1 added lines, -1 removed lines

@@ -8,7 +8,7 @@
  *
  * @param array $page page elements
  *
- * @return bool
+ * @return null|boolean
  */
 function file_tools_page_handler($page) {
 	$include_file = false;

mod/gc_onboard_collab/lib/functions.php

Doc Comments +4 added lines

@@ -68,6 +68,10 @@
  * @return [ARRAY] [<ARRAY of user entities>]
  *
  */
+/**
+ * @param string $query_operand
+ * @param integer $limit
+ */
 function skill_search($query_array, $query_operand, $limit)
 {
     $options = array();

mod/gcRegistration/actions/registerAJAX.php

Doc Comments +2 added lines, -2 removed lines

@@ -141,7 +141,7 @@ 
  * Checks for invalid / external domains
  * 
  * @param  $domain <string> domain part of the user's email address
- * @return true if domain is invalid, false otherwise
+ * @return boolean if domain is invalid, false otherwise
  * 
  **/
 function checkInvalidDomain($dom) 
@@ -195,7 +195,7 @@ 
  * Array key is the character to remove and the associated item is what will replace it.
  *
  * @param  $emailInput <string> users email address
- * @return always returns "" because we use the response text directly
+ * @return string returns "" because we use the response text directly
  * @author Matthew April <Matthew.April@tbs-sct.gc.ca>
  */
 

mod/gcRegistration_collab/actions/registerAJAX.php

Doc Comments +2 added lines, -2 removed lines

@@ -194,7 +194,7 @@ 
  * 
  * @param  $domain <string> domain part of the user's email address
  * @param  $email <string> the user's full email address
- * @return true if domain is invalid, false otherwise
+ * @return boolean if domain is invalid, false otherwise
  * 
  **/
 function checkInvalidDomain($dom, $email){
@@ -251,7 +251,7 @@ 
  * Array key is the character to remove and the associated item is what will replace it.
  *
  * @param  $emailInput <string> users email address
- * @return always returns "" because we use the response text directly
+ * @return string returns "" because we use the response text directly
  * @author Matthew April <Matthew.April@tbs-sct.gc.ca>
  */
 

mod/group_tools/lib/functions.php

Doc Comments +1 added lines, -1 removed lines

@@ -446,7 +446,7 @@
  * @param int    $group_guid the group GUID
  * @param string $email      the email address
  *
- * @return boolean|string the invite code, or false on failure
+ * @return string|false the invite code, or false on failure
  */
 function group_tools_generate_email_invite_code($group_guid, $email) {
 	$result = false;

mod/group_tools/lib/hooks.php

Doc Comments +1 added lines, -1 removed lines

@@ -685,7 +685,7 @@
  * @param bool   $return_value true, return false to stop the action
  * @param null   $params       passed on params
  *
- * @return bool
+ * @return boolean|null
  */
 function group_tools_join_group_action_handler($hook, $type, $return_value, $params) {
 	// hacky way around a short comming of Elgg core to allow users to join a group