chamilo / chamilo-lms

main/inc/lib/internationalization.lib.php

Doc Comments +20 added lines, -14 removed lines

@@ -437,6 +437,7 @@ 
  * If null, the timezone will be determined based on user preference,
  * or timezone chosen by the admin for the platform.
  * @param string The timezone to be converted from. If null, UTC will be assumed.
+ * @param string $to_timezone
  * @return string The converted time formatted as Y-m-d H:i:s
  *
  * @author Guillaume Viguier <guillaume.viguier@beeznest.com>
@@ -793,6 +794,7 @@ 
  * @param mixed The time to be converted
  * @param mixed Format to be used (TIME_NO_SEC_FORMAT, DATE_FORMAT_SHORT, DATE_FORMAT_LONG, DATE_TIME_FORMAT_LONG)
  * @param string Timezone to be converted from. If null, UTC will be assumed.
+ * @param string $from_timezone
  * @return string Converted and localized date
  *
  * @author Guillaume Viguier <guillaume.viguier@beeznest.com>
@@ -862,7 +864,7 @@ 
  * @param int/string $format (optional)	The person name format. It may be a pattern-string (for example '%t %l, %f' or '%T %F %L', ...) or some of the constants PERSON_NAME_COMMON_CONVENTION (default), PERSON_NAME_WESTERN_ORDER, PERSON_NAME_EASTERN_ORDER, PERSON_NAME_LIBRARY_ORDER.
  * @param string $language (optional)	The language id. If it is omitted, the current interface language is assumed. This parameter has meaning with the format PERSON_NAME_COMMON_CONVENTION only.
  * @param string $encoding (optional)	The used internally by this function character encoding. If it is omitted, the platform character set will be used by default.
- * @return bool							The result is sort of full name of the person.
+ * @return string							The result is sort of full name of the person.
  * Sample results:
  * Peter Ustinoff or Dr. Peter Ustinoff     - the Western order
  * Ustinoff Peter or Dr. Ustinoff Peter     - the Eastern order
@@ -956,7 +958,7 @@ 
 
 /**
  * Checks whether a given format represents person name in Western order (for which first name is first).
- * @param int/string $format (optional)	The person name format. It may be a pattern-string (for example '%t. %l, %f') or some of the constants PERSON_NAME_COMMON_CONVENTION (default), PERSON_NAME_WESTERN_ORDER, PERSON_NAME_EASTERN_ORDER, PERSON_NAME_LIBRARY_ORDER.
+ * @param integer $format (optional)	The person name format. It may be a pattern-string (for example '%t. %l, %f') or some of the constants PERSON_NAME_COMMON_CONVENTION (default), PERSON_NAME_WESTERN_ORDER, PERSON_NAME_EASTERN_ORDER, PERSON_NAME_LIBRARY_ORDER.
  * @param string $language (optional)	The language id. If it is omitted, the current interface language is assumed. This parameter has meaning with the format PERSON_NAME_COMMON_CONVENTION only.
  * @return bool							The result TRUE means that the order is first_name last_name, FALSE means last_name first_name.
  * Note: You may use this function for determing the order of the fields or columns "First name" and "Last name" in forms, tables and reports.
@@ -1184,8 +1186,8 @@ 
 
 /**
  * This function returns a string or an array with all occurrences of search in subject (ignoring case) replaced with the given replace value.
- * @param mixed $search					String or array of strings to be found.
- * @param mixed $replace				String or array of strings used for replacement.
+ * @param string $search					String or array of strings to be found.
+ * @param string $replace				String or array of strings used for replacement.
  * @param mixed $subject				String or array of strings being searched.
  * @param int $count (optional)			The number of matched and replaced needles will be returned in count, which is passed by reference.
  * @param string $encoding (optional)	The used internally by this function character encoding.
@@ -1248,10 +1250,10 @@ 
 /**
  * Finds first occurrence of a string within another, case insensitive.
  * @param string $haystack					The string from which to get the first occurrence.
- * @param mixed $needle						The string to be found.
+ * @param string $needle						The string to be found.
  * @param bool $before_needle (optional)	Determines which portion of $haystack this function returns. The default value is FALSE.
  * @param string $encoding (optional)		The used internally by this function character encoding. If it is omitted, the platform character set will be used by default.
- * @return mixed							Returns the portion of $haystack, or FALSE if $needle is not found.
+ * @return false|string							Returns the portion of $haystack, or FALSE if $needle is not found.
  * Notes:
  * If $needle is not a string, it is converted to an integer and applied as the ordinal value (codepoint if the encoding is UTF-8) of a character.
  * If $before_needle is set to TRUE, the function returns all of $haystack from the beginning to the first occurrence of $needle.
@@ -1307,7 +1309,7 @@ 
  * @param mixed $needle						The string which first character is to be found.
  * @param bool $before_needle (optional)	Determines which portion of $haystack this function returns. The default value is FALSE.
  * @param string $encoding (optional)		The used internally by this function character encoding. If it is omitted, the platform character set will be used by default.
- * @return mixed							Returns the portion of $haystack, or FALSE if the first character from $needle is not found.
+ * @return false|string							Returns the portion of $haystack, or FALSE if the first character from $needle is not found.
  * Notes:
  * If $needle is not a string, it is converted to an integer and applied as the ordinal value (codepoint if the encoding is UTF-8) of a character.
  * If $before_needle is set to TRUE, the function returns all of $haystack from the beginning to the first occurrence.
@@ -1357,7 +1359,7 @@ 
  * @param string $needle				The string to be found.
  * @param int $offset (optional)		$offset may be specified to begin searching an arbitrary position. Negative values will stop searching at an arbitrary point prior to the end of the string.
  * @param string $encoding (optional)	The used internally by this function character encoding. If it is omitted, the platform character set will be used by default.
- * @return mixed						Returns the numeric position of the first occurrence of $needle in the $haystack, or FALSE if $needle is not found.
+ * @return integer|null						Returns the numeric position of the first occurrence of $needle in the $haystack, or FALSE if $needle is not found.
  * Note: The first character's position is 0, the second character position is 1, and so on.
  * This function is aimed at replacing the functions strrpos() and mb_strrpos() for human-language strings.
  * @link http://php.net/manual/en/function.strrpos
@@ -1374,7 +1376,7 @@ 
  * @param mixed $needle						The string to be found.
  * @param bool $before_needle (optional)	Determines which portion of $haystack this function returns. The default value is FALSE.
  * @param string $encoding (optional)		The used internally by this function character encoding. If it is omitted, the platform character set will be used by default.
- * @return mixed							Returns the portion of $haystack, or FALSE if $needle is not found.
+ * @return false|string							Returns the portion of $haystack, or FALSE if $needle is not found.
  * Notes:
  * If $needle is not a string, it is converted to an integer and applied as the ordinal value (codepoint if the encoding is UTF-8) of a character.
  * If $before_needle is set to TRUE, the function returns all of $haystack from the beginning to the first occurrence of $needle.
@@ -1517,7 +1519,7 @@ 
  * 										Note that this changes the return value in an array where every element is an array consisting of the matched string at index 0 and its string offset into subject at index 1.
  * @param int $offset (optional)		Normally, the search starts from the beginning of the subject string. The optional parameter offset can be used to specify the alternate place from which to start the search.
  * @param string $encoding (optional)	The used internally by this function character encoding. If it is omitted, the platform character set will be used by default.
- * @return int|boolean					Returns the number of times pattern matches or FALSE if an error occurred.
+ * @return integer					Returns the number of times pattern matches or FALSE if an error occurred.
  * @link http://php.net/preg_match
  */
 function api_preg_match($pattern, $subject, &$matches = null, $flags = 0, $offset = 0, $encoding = null) {
@@ -1540,7 +1542,7 @@ 
  * If no order flag is given, PREG_PATTERN_ORDER is assumed.
  * @param int $offset (optional)		Normally, the search starts from the beginning of the subject string. The optional parameter offset can be used to specify the alternate place from which to start the search.
  * @param string $encoding (optional)	The used internally by this function character encoding. If it is omitted, the platform character set will be used by default.
- * @return int|boolean					Returns the number of full pattern matches (which might be zero), or FALSE if an error occurred.
+ * @return integer					Returns the number of full pattern matches (which might be zero), or FALSE if an error occurred.
  * @link http://php.net/preg_match_all
  */
 function api_preg_match_all($pattern, $subject, &$matches, $flags = PREG_PATTERN_ORDER, $offset = 0, $encoding = null) {
@@ -1555,8 +1557,8 @@ 
 
 /**
  * Performs a regular expression search and replace, UTF-8 aware when it is applicable.
- * @param string|array $pattern			The pattern to search for. It can be either a string or an array with strings.
- * @param string|array $replacement		The string or an array with strings to replace.
+ * @param string $pattern			The pattern to search for. It can be either a string or an array with strings.
+ * @param string $replacement		The string or an array with strings to replace.
  * @param string|array $subject			The string or an array with strings to search and replace.
  * @param int $limit					The maximum possible replacements for each pattern in each subject string. Defaults to -1 (no limit).
  * @param int &$count					If specified, this variable will be filled with the number of replacements done.
@@ -1808,6 +1810,7 @@ 
 /**
  * Checks a string for UTF-8 validity.
  *
+ * @param string $string
  */
 function api_is_valid_utf8(&$string)
 {
@@ -1950,7 +1953,7 @@ 
 /**
  * Replaces non-valid formats for person names with the default (English) format.
  * @param string $format	The input format to be verified.
- * @return bool				Returns the same format if is is valid, otherwise returns a valid English format.
+ * @return string				Returns the same format if is is valid, otherwise returns a valid English format.
  */
 function _api_validate_person_name_format($format) {
     if (empty($format) || stripos($format, '%f') === false || stripos($format, '%l') === false) {
@@ -2077,6 +2080,9 @@ 
 
 // This function checks whether the function _api_convert_encoding() (the php-
 // implementation) is able to convert from/to a given encoding.
+/**
+ * @param string $encoding
+ */
 function _api_convert_encoding_supports($encoding) {
     static $supports = array();
     if (!isset($supports[$encoding])) {

plugin/bbb/lib/bbb.lib.php

Spacing +35 added lines, -35 removed lines

@@ -166,13 +166,13 @@ 
         }
 
         $params['attendee_pw'] = isset($params['moderator_pw']) ? $params['moderator_pw'] : $courseCode;
-        $attendeePassword =  $params['attendee_pw'];
+        $attendeePassword = $params['attendee_pw'];
         $params['moderator_pw'] = isset($params['moderator_pw']) ? $params['moderator_pw'] : $this->getModMeetingPassword();
         $moderatorPassword = $params['moderator_pw'];
 
         $params['record'] = api_get_course_setting('big_blue_button_record_and_store', $courseCode) == 1 ? true : false;
         $max = api_get_course_setting('big_blue_button_max_students_allowed', $courseCode);
-        $max =  isset($max) ? $max : -1;
+        $max = isset($max) ? $max : -1;
 
         $params['status'] = 1;
         // Generate a pseudo-global-unique-id to avoid clash of conferences on
@@ -203,23 +203,23 @@ 
             $duration = 300;
 
             $bbbParams = array(
-                'meetingId' => $params['remote_id'], 					// REQUIRED
-                'meetingName' => $meetingName, 	// REQUIRED
-                'attendeePw' => $attendeePassword, 					// Match this value in getJoinMeetingURL() to join as attendee.
-                'moderatorPw' => $moderatorPassword, 					// Match this value in getJoinMeetingURL() to join as moderator.
-                'welcomeMsg' => $welcomeMessage, 					// ''= use default. Change to customize.
-                'dialNumber' => '', 					// The main number to call into. Optional.
-                'voiceBridge' => $params['voice_bridge'], 					// PIN to join voice. Required.
-                'webVoice' => '', 						// Alphanumeric to join voice. Optional.
+                'meetingId' => $params['remote_id'], // REQUIRED
+                'meetingName' => $meetingName, // REQUIRED
+                'attendeePw' => $attendeePassword, // Match this value in getJoinMeetingURL() to join as attendee.
+                'moderatorPw' => $moderatorPassword, // Match this value in getJoinMeetingURL() to join as moderator.
+                'welcomeMsg' => $welcomeMessage, // ''= use default. Change to customize.
+                'dialNumber' => '', // The main number to call into. Optional.
+                'voiceBridge' => $params['voice_bridge'], // PIN to join voice. Required.
+                'webVoice' => '', // Alphanumeric to join voice. Optional.
                 'logoutUrl' =>  $this->logoutUrl,
-                'maxParticipants' => $max, 				// Optional. -1 = unlimitted. Not supported in BBB. [number]
-                'record' => $record, 					// New. 'true' will tell BBB to record the meeting.
-                'duration' => $duration, 				// Default = 0 which means no set duration in minutes. [number]
+                'maxParticipants' => $max, // Optional. -1 = unlimitted. Not supported in BBB. [number]
+                'record' => $record, // New. 'true' will tell BBB to record the meeting.
+                'duration' => $duration, // Default = 0 which means no set duration in minutes. [number]
                 //'meta_category' => '', 				// Use to pass additional info to BBB server. See API docs.
             );
 
             if ($this->debug) {
-                error_log("create_meeting params: ".print_r($bbbParams,1));
+                error_log("create_meeting params: ".print_r($bbbParams, 1));
             }
 
             $status = false;
@@ -232,7 +232,7 @@ 
                 if (isset($result) && strval($result['returncode']) == 'SUCCESS') {
                     if ($this->debug) {
                         error_log(
-                            "create_meeting result: " . print_r($result, 1)
+                            "create_meeting result: ".print_r($result, 1)
                         );
                     }
                     $meeting = $this->joinMeeting($meetingName, true);
@@ -263,7 +263,7 @@ 
 
         $courseId = api_get_course_int_id();
         $sessionId = api_get_session_id();
-        $conditions =  array(
+        $conditions = array(
             'where' => array(
                 'c_id = ? AND session_id = ? AND meeting_name = ? AND status = 1 ' =>
                     array($courseId, $sessionId, $meetingName)
@@ -272,7 +272,7 @@ 
 
         if ($this->hasGroupSupport()) {
             $groupId = api_get_group_id();
-            $conditions =  array(
+            $conditions = array(
                 'where' => array(
                     'c_id = ? AND session_id = ? AND meeting_name = ? AND group_id = ? AND status = 1 ' =>
                         array($courseId, $sessionId, $meetingName, $groupId)
@@ -369,7 +369,7 @@ 
 
             if ($this->debug) {
                 error_log(
-                    "meeting is running: " . intval($meetingInfoExists)
+                    "meeting is running: ".intval($meetingInfoExists)
                 );
             }
 
@@ -386,11 +386,11 @@ 
 
         if ($meetingInfoExists) {
             $joinParams = array(
-                'meetingId' => $meetingData['remote_id'],	//	-- REQUIRED - A unique id for the meeting
-                'username' => $this->userCompleteName,	//-- REQUIRED - The name that will display for the user in the meeting
-                'password' => $pass,			//-- REQUIRED - The attendee or moderator password, depending on what's passed here
+                'meetingId' => $meetingData['remote_id'], //	-- REQUIRED - A unique id for the meeting
+                'username' => $this->userCompleteName, //-- REQUIRED - The name that will display for the user in the meeting
+                'password' => $pass, //-- REQUIRED - The attendee or moderator password, depending on what's passed here
                 //'createTime' => api_get_utc_datetime(),			//-- OPTIONAL - string. Leave blank ('') unless you set this correctly.
-                'userID' => api_get_user_id(),				//-- OPTIONAL - string
+                'userID' => api_get_user_id(), //-- OPTIONAL - string
                 'webVoiceConf' => ''	//	-- OPTIONAL - string
             );
             $url = $this->api->getJoinMeetingURL($joinParams);
@@ -399,7 +399,7 @@ 
             $url = $this->logoutUrl;
         }
         if ($this->debug) {
-            error_log("return url :" . $url);
+            error_log("return url :".$url);
         }
 
         return $url;
@@ -441,7 +441,7 @@ 
         $courseId = api_get_course_int_id();
         $sessionId = api_get_session_id();
 
-        $conditions =  array(
+        $conditions = array(
             'where' => array(
                 'c_id = ? AND session_id = ? ' => array(
                     $courseId,
@@ -452,7 +452,7 @@ 
 
         if ($this->hasGroupSupport()) {
             $groupId = api_get_group_id();
-            $conditions =  array(
+            $conditions = array(
                 'where' => array(
                     'c_id = ? AND session_id = ? AND group_id = ? ' =>
                         array($courseId, $sessionId, $groupId)
@@ -487,7 +487,7 @@ 
             }
             $meetingBBB['end_url'] = $this->endUrl($meetingDB);
 
-            if ((string)$meetingBBB['returncode'] == 'FAILED') {
+            if ((string) $meetingBBB['returncode'] == 'FAILED') {
                 if ($meetingDB['status'] == 1 && $this->isConferenceManager()) {
                     $this->endMeeting($meetingDB['id']);
                 }
@@ -657,7 +657,7 @@ 
                     $item['action_links'] = implode('<br />', $actionLinksArray);
                 }
                 //var_dump($recordArray);
-                $item['show_links']  = implode('<br />', $recordArray);
+                $item['show_links'] = implode('<br />', $recordArray);
                 $item['action_links'] = implode('<br />', $actionLinksArray);
             }
 
@@ -670,11 +670,11 @@ 
 
             if ($meetingDB['status'] == 1) {
                 $joinParams = array(
-                    'meetingId' => $meetingDB['remote_id'],		//-- REQUIRED - A unique id for the meeting
-                    'username' => $this->userCompleteName,	//-- REQUIRED - The name that will display for the user in the meeting
-                    'password' => $pass,			//-- REQUIRED - The attendee or moderator password, depending on what's passed here
-                    'createTime' => '',			//-- OPTIONAL - string. Leave blank ('') unless you set this correctly.
-                    'userID' => '',			//	-- OPTIONAL - string
+                    'meetingId' => $meetingDB['remote_id'], //-- REQUIRED - A unique id for the meeting
+                    'username' => $this->userCompleteName, //-- REQUIRED - The name that will display for the user in the meeting
+                    'password' => $pass, //-- REQUIRED - The attendee or moderator password, depending on what's passed here
+                    'createTime' => '', //-- OPTIONAL - string. Leave blank ('') unless you set this correctly.
+                    'userID' => '', //	-- OPTIONAL - string
                     'webVoiceConf' => ''	//	-- OPTIONAL - string
                 );
                 $item['go_url'] = $this->protocol.$this->api->getJoinMeetingURL($joinParams);
@@ -735,8 +735,8 @@ 
         $pass = $this->getUserMeetingPassword();
 
         $endParams = array(
-            'meetingId' => $meetingData['remote_id'],   // REQUIRED - We have to know which meeting to end.
-            'password' => $pass,        // REQUIRED - Must match moderator pass for meeting.
+            'meetingId' => $meetingData['remote_id'], // REQUIRED - We have to know which meeting to end.
+            'password' => $pass, // REQUIRED - Must match moderator pass for meeting.
         );
         $this->api->endMeetingWithXmlResponseArray($endParams);
         Database::update(
@@ -961,7 +961,7 @@ 
      */
     public function redirectToBBB($url)
     {
-        if (file_exists(__DIR__ . '/../config.vm.php')) {
+        if (file_exists(__DIR__.'/../config.vm.php')) {
             // Using VM
             echo Display::url(get_lang('ClickToContinue'), $url);
             exit;