chamilo / chamilo-lms

main/inc/lib/zombie/zombie_report.class.php

Doc Comments +3 added lines

@@ -121,6 +121,9 @@
         return $form->isSubmitted() == false || $form->validate();
     }
 
+    /**
+     * @param string $format
+     */
     function get_ceiling($format = null)
     {
         $result = Request::get('ceiling');

main/permissions/permissions_functions.inc.php

Doc Comments +2 added lines, -2 removed lines

@@ -118,7 +118,7 @@ 
 
 /**
 * This function retrieves the existing permissions of a user, group or role.
-* @param $content are we retrieving the rights of a user, a group or a role (the database depends on it)
+* @param string $content are we retrieving the rights of a user, a group or a role (the database depends on it)
 * @param $id the id of the user, group or role
 * @author Patrick Cool <patrick.cool@ugent.be>, Ghent University
 * @version 1.0
@@ -526,7 +526,7 @@ 
 
 /**
 * This function gets all the roles that are defined
-* @param $content are we finding the roles for a user or a group (the database depends on it)
+* @param string $content are we finding the roles for a user or a group (the database depends on it)
 * @param $id the id of the user or group
 * @param string	Deprecated parameter allowing use of 'platform' scope - the corresponding tables don't exist anymore so the scope is always set to 'course'
 * @return array that contains the name of the roles the user has

Braces +10 added lines, -17 removed lines

@@ -206,8 +206,7 @@ 
 function display_checkbox_matrix($permission_array, $tool, $permission, $inherited_permissions = array())
 {
     $checked = "";
-    if (is_array($permission_array[$tool]) AND in_array($permission, $permission_array[$tool]))
-    {
+    if (is_array($permission_array[$tool]) AND in_array($permission, $permission_array[$tool])) {
         $checked = "checked";
     }
     echo "\t\t\t<input type=\"checkbox\" name=\"permission*$tool*$permission\" $checked>\n";
@@ -254,8 +253,7 @@ 
                     echo "</a>";
                 }
             } else {
-                if ($editable)
-                {
+                if ($editable) {
                     $url = api_get_self();
                     $urlparameters = '';
                     foreach ($_GET as $key => $value) {
@@ -273,8 +271,7 @@ 
                     echo "\t\t\t <a href=\"".$url."\">";
                 }
                 echo "<img src=\"../img/wrong.gif\" border=\"0\"/>";
-                if ($editable)
-                {
+                if ($editable) {
                     echo "</a>";
                 }
             }
@@ -306,8 +303,7 @@ 
                 if ($editable) {
                     $url = api_get_self();
                     $urlparameters = '';
-                    foreach ($_GET as $key => $value)
-                    {
+                    foreach ($_GET as $key => $value) {
                         $parameter[$key] = $value;
                     }
                     $parameter['action'] = 'manage_rights';
@@ -315,8 +311,7 @@ 
                     $parameter['permission'] = $permission;
                     $parameter['tool'] = $tool;
                     $parameter['user_id'] = $user_id;
-                    foreach ($parameter as $key=>$value)
-                    {
+                    foreach ($parameter as $key=>$value) {
                         $urlparameters .= $key.'='.$value.'&amp;';
                     }
                     $url = $url.'?'.$urlparameters;
@@ -433,16 +428,15 @@ 
 * @author Patrick Cool <patrick.cool@ugent.be>, Ghent University
 * @version 1.0
 */
-function get_all_roles($content = 'course') {
+function get_all_roles($content = 'course')
+{
     $course_id = api_get_course_int_id();
     $course_id_condition = " WHERE c_id = $course_id ";
 
-    if ($content == 'course')
-    {
+    if ($content == 'course') {
         $table_role = Database::get_course_table(TABLE_ROLE);
     }
-    if ($content == 'platform')
-    {
+    if ($content == 'platform') {
         $table_role = Database::get_main_table(TABLE_ROLE);
         $course_id_condition = '';
     }
@@ -450,8 +444,7 @@ 
     $current_roles = array();
     $sql = "SELECT * FROM $table_role $course_id_condition ";
     $result = Database::query($sql);
-    while ($row = Database::fetch_array($result))
-    {
+    while ($row = Database::fetch_array($result)) {
         $roles[] = $row;
     }
 

Upper-Lower-Casing +4 added lines, -4 removed lines

@@ -175,7 +175,7 @@ 
                 if ($value == 'View') {
                     unset($current_permissions[$tool][$key]);
                 }
-                if ($value == 'Visibility' OR $value == 'Move') {
+                if ($value == 'Visibility' or $value == 'Move') {
                     if (!in_array('Edit', $current_permissions[$tool])) {
                         $current_permissions[$tool][] = 'Edit';
                     }
@@ -206,7 +206,7 @@ 
 function display_checkbox_matrix($permission_array, $tool, $permission, $inherited_permissions = array())
 {
     $checked = "";
-    if (is_array($permission_array[$tool]) AND in_array($permission, $permission_array[$tool]))
+    if (is_array($permission_array[$tool]) and in_array($permission, $permission_array[$tool]))
     {
         $checked = "checked";
     }
@@ -232,7 +232,7 @@ 
         if (in_array($permission, $inherited_permissions[$tool])) {
             echo "\t\t\t<img src=\"../img/checkbox_on3.gif\" border=\"0\"/ title=\"".get_lang('PermissionGrantedByGroupOrRole')."\">";
         } else {
-            if (is_array($permission_array[$tool]) AND in_array($permission, $permission_array[$tool])) {
+            if (is_array($permission_array[$tool]) and in_array($permission, $permission_array[$tool])) {
                 if ($editable) {
                     $url = api_get_self();
                     $urlparameters = '';
@@ -302,7 +302,7 @@ 
         if (!empty($inherited_permissions) and in_array($permission, $inherited_permissions[$tool])) {
             echo "\t\t\t<img src=\"../img/checkbox_on3.gif\" border=\"0\"/ title=\"".get_lang('PermissionGrantedByGroupOrRole')."\">";
         } else {
-            if (is_array($permission_array[$tool]) AND in_array($permission, $permission_array[$tool])) {
+            if (is_array($permission_array[$tool]) and in_array($permission, $permission_array[$tool])) {
                 if ($editable) {
                     $url = api_get_self();
                     $urlparameters = '';

main/webservices/additional_webservices.php

Doc Comments +1 added lines, -1 removed lines

@@ -84,7 +84,7 @@
 }
 
 /**
- * @param $directoryPath
+ * @param string $directoryPath
  * @return bool
  */
 function deleteDirectory($directoryPath)

Braces +2 added lines, -1 removed lines

@@ -132,7 +132,8 @@
  */
 function pptConverterGetCommandBaseParams()
 {
-    if (IS_WINDOWS_OS) { // IS_WINDOWS_OS has been defined in main_api.lib.php
+    if (IS_WINDOWS_OS) {
+// IS_WINDOWS_OS has been defined in main_api.lib.php
         $converterPath = str_replace('/', '\\', api_get_path(SYS_PATH).'main/inc/lib/ppt2png');
         $classPath = $converterPath.';'.$converterPath.'/jodconverter-2.2.2.jar;'.$converterPath.'/jodconverter-cli-2.2.2.jar';
         $cmd = 'java -Dfile.encoding=UTF-8 -cp "'.$classPath.'" DokeosConverter';

Upper-Lower-Casing +1 added lines, -1 removed lines

@@ -154,6 +154,6 @@
     'location' => $webCodePath.'webservices/additional_webservices.php'
 );
 
-$soapServer = new SoapServer(NULL, $options);
+$soapServer = new SoapServer(null, $options);
 $soapServer->addFunction('wsConvertPpt');
 $soapServer->handle();

main/webservices/cm_webservice_user.php

Doc Comments +1 added lines, -1 removed lines

@@ -137,7 +137,7 @@
     /**
     * Get a list of users of which the given conditions match with a LIKE '%cond%'
     * @param array $conditions a list of condition (exemple : status=>STUDENT)
-    * @param array $order_by a list of fields on which sort
+    * @param string[] $order_by a list of fields on which sort
     * @return array An array with all users of the platform.
     * @todo optional course code parameter, optional sorting parameters...
      *@todo Use the UserManager class

Indentation +7 added lines, -7 removed lines

@@ -102,7 +102,7 @@ 
     {
         global $charset;
         if ($this->verifyUserPass($username, $password) == "valid") {
-		    $user_id = UserManager::get_user_id_from_username($username);
+            $user_id = UserManager::get_user_id_from_username($username);
             $message_title = get_lang('Invitation');
             $count_is_true = SocialManager::send_invitation_friend($user_id, $userfriend_id, $message_title, $content_message);
 
@@ -158,14 +158,14 @@ 
 
 
     /**
-    * Get a list of users of which the given conditions match with a LIKE '%cond%'
-    * @param array $conditions a list of condition (exemple : status=>STUDENT)
-    * @param array $order_by a list of fields on which sort
-    * @return array An array with all users of the platform.
-    * @todo optional course code parameter, optional sorting parameters...
+     * Get a list of users of which the given conditions match with a LIKE '%cond%'
+     * @param array $conditions a list of condition (exemple : status=>STUDENT)
+     * @param array $order_by a list of fields on which sort
+     * @return array An array with all users of the platform.
+     * @todo optional course code parameter, optional sorting parameters...
      *@todo Use the UserManager class
      * @todo security filter order by
-    */
+     */
     private static function get_user_list_like_start($conditions = [], $order_by = [])
     {
         $user_table = Database::get_main_table(TABLE_MAIN_USER);

plugin/advanced_subscription/src/AdvancedSubscriptionPlugin.php

Doc Comments +7 added lines, -7 removed lines

@@ -370,7 +370,7 @@ 
      * Register a user into a queue for a session
      * @param $userId
      * @param $sessionId
-     * @return bool|int
+     * @return false|string
      */
     public function addToQueue($userId, $sessionId)
     {
@@ -396,7 +396,7 @@ 
      * Register message with type and status
      * @param $mailId
      * @param $userId
-     * @param $sessionId
+     * @param integer $sessionId
      * @return bool|int
      */
     public function saveLastMessage($mailId, $userId, $sessionId)
@@ -509,7 +509,7 @@ 
 
     /**
      * Check if session is open for subscription
-     * @param $sessionId
+     * @param integer $sessionId
      * @param string $fieldVariable
      * @return bool
      */
@@ -531,8 +531,8 @@ 
 
     /**
      * Check if user is in the session's target group based on its area
-     * @param $userId
-     * @param $sessionId
+     * @param integer $userId
+     * @param integer $sessionId
      * @param string $userFieldVariable
      * @param string $sessionFieldVariable
      * @return bool
@@ -1002,7 +1002,7 @@ 
     /**
      * Return the session details data from a session ID (including the extra
      * fields used for the advanced subscription mechanism)
-     * @param $sessionId
+     * @param integer $sessionId
      * @return bool|mixed
      */
     public function getSessionDetails($sessionId)
@@ -1102,7 +1102,7 @@ 
 
     /**
      * Return the url to go to session
-     * @param $sessionId
+     * @param integer $sessionId
      *
      * @return string
      */

plugin/openmeetings/lib/openmeetings.class.php

Doc Comments +2 added lines, -1 removed lines

@@ -213,7 +213,8 @@
     /**
      * Returns a meeting "join" URL
      * @param string The name of the meeting (usually the course code)
-     * @return mixed The URL to join the meeting, or false on error
+     * @param false|string $meetingId
+     * @return false|null The URL to join the meeting, or false on error
      * @todo implement moderator pass
      * @assert ('') === false
      * @assert ('abcdefghijklmnopqrstuvwxyzabcdefghijklmno') === false

Indentation +6 added lines, -6 removed lines

@@ -126,7 +126,7 @@ 
             return false;
         }
     }
-    */
+     */
 
     /*
      * Creating a Room for the meeting
@@ -256,10 +256,10 @@ 
         return true;
     }
 
-     /**
-     * Gets the password for a specific meeting for the current user
-     * @return string A moderator password if user is teacher, or the course code otherwise
-     */
+        /**
+         * Gets the password for a specific meeting for the current user
+         * @return string A moderator password if user is teacher, or the course code otherwise
+         */
     public function getMeetingUserPassword()
     {
         if ($this->isTeacher()) {
@@ -538,7 +538,7 @@ 
     //
     //            }
     //
-                 //$item['created_at'] = api_convert_and_format_date($meetingDb['created_at']);
+                    //$item['created_at'] = api_convert_and_format_date($meetingDb['created_at']);
     //            //created_at
     //
     //            $item['publish_url'] = api_get_self().'?action=publish&id='.$meetingDb['id'];

plugin/openmeetings/lib/openmeetings_gateway.php

Doc Comments +5 added lines

@@ -36,6 +36,11 @@
     private $_pass;
     private $_url;
 
+    /**
+     * @param string $host
+     * @param string $user
+     * @param string $pass
+     */
     public function __construct($host, $user, $pass)
     {
         $this->_user = urlencode($user);

Indentation +3 added lines, -3 removed lines

@@ -351,9 +351,9 @@
                 . '&externalRoomType='.$room->externalRoomType;
         if ($room->allowRecording) {
             $url .= '&allowUserQuestions='.$this->var_to_str($room->allowUserQuestions)
-                 . '&isAudioOnly='.$this->var_to_str($room->isAudioOnly)
-                 . '&waitForRecording='.$this->var_to_str($room->waitForRecording)
-                 . '&allowRecording='.$this->var_to_str($room->allowRecording);
+                    . '&isAudioOnly='.$this->var_to_str($room->isAudioOnly)
+                    . '&waitForRecording='.$this->var_to_str($room->waitForRecording)
+                    . '&allowRecording='.$this->var_to_str($room->allowRecording);
         } elseif ($room->isAudioOnly) {
             $url .= '&isAudioOnly='.$this->var_to_str($room->isAudioOnly);
         }

plugin/openmeetings/lib/openmeetings_rest_service.php

Doc Comments +6 added lines

@@ -27,6 +27,9 @@ 
  */
 class OpenMeetingsRestService
 {
+    /**
+     * @param string $request
+     */
     function call($request, $returnAttribute = "return")
     {
         // This will allow you to view errors in the browser
@@ -121,6 +124,9 @@ 
             
     }
 
+    /**
+     * @param DOMDocument $node
+     */
     function getArray($node)
     {
         if (is_null($node) || !is_object($node)) {

plugin/openmeetings/lib/room.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -99,7 +99,7 @@
     /**
      * Gets a string from a boolean attribute
      * @param string $attribute Name of the attribute
-     * @param mixed  $voidReturn What to return if the value is not defined
+     * @param string  $voidReturn What to return if the value is not defined
      * @return string The boolean value expressed as string ('true' or 'false')
      */
     public function getString($attribute, $voidReturn = false)