gctools-outilsgc / gcconnex

mod/pleio/classes/ModPleio/Helpers.php

Doc Comments +4 added lines

@@ -2,6 +2,10 @@
 namespace ModPleio;
 
 class Helpers {
+
+    /**
+     * @return string
+     */
     public static function generateUsername($username) {
         $hidden = access_show_hidden_entities(true);
 

mod/gc_mobile_api/models/wire.php

Doc Comments +3 added lines

@@ -109,6 +109,9 @@
 	false
 );
 
+/**
+ * @param ElggUser $user_entity
+ */
 function wires_foreach($wire_posts, $user_entity)
 {
 	foreach ($wire_posts as $wire_post) {

engine/lib/input.php

Doc Comments +1 added lines, -1 removed lines

@@ -48,7 +48,7 @@
  * @param mixed $var Anything that does not include an object (strings, ints, arrays)
  *					 This includes multi-dimensional arrays.
  *
- * @return mixed The filtered result - everything will be strings
+ * @return string The filtered result - everything will be strings
  */
 function filter_tags($var) {
 	return elgg_trigger_plugin_hook('validate', 'input', null, $var);

mod/thewire/start.php

Doc Comments +2 added lines, -2 removed lines

@@ -258,7 +258,7 @@ 
  * @param int    $access_id   Public/private etc
  * @param int    $parent_guid Parent post guid (if any)
  * @param string $method      The method (default: 'site')
- * @return guid or false if failure
+ * @return integer or false if failure
  */
 function thewire_save_post($text, $userid, $access_id, $parent_guid = 0, $method = "site") {
 	$post = new ElggObject();
@@ -473,7 +473,7 @@ 
 /**
  * Runs unit tests for the wire
  *
- * @return array
+ * @return string[]
  */
 function thewire_test($hook, $type, $value, $params) {
 	global $CONFIG;

mod/phpmailer/start.php

Doc Comments +6 added lines, -4 removed lines

@@ -29,7 +29,7 @@ 
  * @param string $subject The subject of the message.
  * @param string $message The message body
  * @param array $params Optional parameters (not used)
- * @return bool
+ * @return null|boolean
  */
 function phpmailer_notify_handler(ElggEntity $from, ElggUser $to, $subject, $message, array $params = NULL) {
 
@@ -72,6 +72,7 @@ 
  * This is a stupid function pulled from original Elgg code
  *
  * @param  ElggEntity The entity sending the message
+ * @param ElggEntity $from
  * @return string with email address
  */
 function phpmailer_extract_from_email($from) {
@@ -98,8 +99,6 @@ 
 /**
  * Send an email using phpmailer
  *
- * @param string $from       From address
- * @param string $from_name  From name
  * @param string $to         To address
  * @param string $to_name    To name
  * @param string $subject    The subject of the message.
@@ -110,7 +109,7 @@ 
  * @param array  $files      Array of file descriptor arrays, each file array
  *                           consists of full path and name
  * @param array  $params     Additional parameters
- * @return bool
+ * @return null|boolean
  */
 function phpmailer_send($to, $to_name, $subject, $body, array $bcc = NULL, $html = true, array $files = NULL, array $params = NULL, $image = NULL) {
 
@@ -255,6 +254,9 @@ 
 
 
 
+/**
+ * @param string $type
+ */
 function phpmailer_logging($errMess, $errStack, $type, $errType) {
 	// logging mechanism
 	if (elgg_is_active_plugin('wet4')) {

mod/gc_mobile_api/models/blog.php

Doc Comments +3 added lines

@@ -85,6 +85,9 @@
  false
 );
 
+/**
+ * @param ElggUser $user_entity
+ */
 function foreach_blogs($blogs, $user_entity, $lang)
 {
 	foreach ($blogs as $blog_post) {

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