woothemes / sensei

includes/class-sensei-emails.php

Doc Comments +5 added lines, -1 removed lines

@@ -40,6 +40,7 @@ 
 	 * Constructor for the email class hooks in all emails that can be sent.
 	 *
 	 * @access public
+	 * @param string $file
 	 * @return void
 	 */
 	function __construct( $file ) {
@@ -140,7 +141,7 @@ 
 	 * Wraps a message in the sensei mail template.
 	 *
 	 * @access public
-	 * @param mixed $content
+	 * @param null|string $content
 	 * @return string
 	 */
 	function wrap_message( $content ) {
@@ -198,6 +199,9 @@ 
 		remove_filter( 'wp_mail_content_type', array( $this, 'get_content_type' ) );
 	}
 
+	/**
+	 * @param string $email_template
+	 */
 	function get_content( $email_template ) {
 
 		$message = $this->load_template( $email_template );

Braces +3 added lines, -1 removed lines

@@ -210,7 +210,9 @@
 	function load_template( $template = '' ) {
 		global  $email_template;
 
-		if( ! $template ) return;
+		if( ! $template ) {
+			return;
+		}
 
 		$email_template = $template . '.php';
 		$template = Sensei_Templates::template_loader( '' );

includes/class-sensei-grading.php

Doc Comments +5 added lines, -4 removed lines

@@ -22,7 +22,7 @@ 
 	 * Constructor
 	 * @since  1.3.0
      *
-     * @param $file
+     * @param string $file
 	 */
 	public function __construct ( $file ) {
 		$this->name = __( 'Grading', 'woothemes-sensei' );
@@ -330,6 +330,7 @@ 
 	/**
 	 * Return array of valid statuses for either Course or Lesson
 	 * @since  1.7.0
+	 * @param string $type
 	 * @return array
 	 */
 	public function get_stati( $type ) {
@@ -529,7 +530,7 @@ 
      * the grades as the Grader selected theme and saves the total grade and
      * individual question grades.
      *
-     * @return bool
+     * @return false|null
      */
     public function admin_process_grading_submission() {
 
@@ -906,8 +907,8 @@ 
      * Grading logic specifically for the gap fill questions
      *
      * @since 1.9.0
-     * @param $question_id
-     * @param $user_answer
+     * @param integer $question_id
+     * @param string $user_answer
      *
      * @return bool | int false or the grade given to the user answer
      */

Braces +20 added lines, -28 removed lines

@@ -1,5 +1,8 @@ 
 <?php
-if ( ! defined( 'ABSPATH' ) ) exit; // Exit if accessed directly
+if ( ! defined( 'ABSPATH' ) ) {
+	exit;
+}
+// Exit if accessed directly
 
 /**
  * Sensei Grading Class
@@ -130,8 +133,7 @@ 
 		$object_name = 'WooThemes_Sensei_Grading_' . $name;
 		if ( is_null($optional_data) ) {
 			$sensei_grading_object = new $object_name( $data );
-		}
-		else {
+		} else {
 			$sensei_grading_object = new $object_name( $data, $optional_data );
 		} // End If Statement
 		if ( 'Main' == $name ) {
@@ -150,8 +152,7 @@ 
 
 		if ( isset( $_GET['quiz_id'] ) && 0 < intval( $_GET['quiz_id'] ) && isset( $_GET['user'] ) && 0 < intval( $_GET['user'] ) ) {
 			$this->grading_user_quiz_view();
-		}
-		else {
+		} else {
 			$this->grading_default_view();
 		} // End If Statement
 	} // End grading_page()
@@ -273,8 +274,7 @@ 
 			if ( version_compare($wp_version, '4.1', '>=') ) {
 				$url = add_query_arg( array( 'page' => $this->page_slug, 'course_id' => $course_id ), admin_url( 'admin.php' ) );
 				$title .= sprintf( '&nbsp;&nbsp;<span class="course-title">&gt;&nbsp;&nbsp;<a href="%s">%s</a></span>', esc_url( $url ), get_the_title( $course_id ) );
-			}
-			else {
+			} else {
 				$title .= sprintf( '&nbsp;&nbsp;<span class="course-title">&gt;&nbsp;&nbsp;%s</span>', get_the_title( $course_id ) ); 
 			}
 		}
@@ -309,8 +309,7 @@ 
 			if ( version_compare($wp_version, '4.1', '>=') ) {
 				$url = add_query_arg( array( 'page' => $this->page_slug, 'course_id' => $course_id ), admin_url( 'admin.php' ) );
 				$title .= sprintf( '&nbsp;&nbsp;<span class="course-title">&gt;&nbsp;&nbsp;<a href="%s">%s</a></span>', esc_url( $url ), get_the_title( $course_id ) );
-			}
-			else {
+			} else {
 				$title .= sprintf( '&nbsp;&nbsp;<span class="course-title">&gt;&nbsp;&nbsp;%s</span>', get_the_title( $course_id ) ); 
 			}
 			$url = add_query_arg( array( 'page' => $this->page_slug, 'lesson_id' => $lesson_id ), admin_url( 'admin.php' ) );
@@ -379,8 +378,7 @@ 
 
 		if ( 'course' == $args['type'] ) {
 			$type = 'sensei_course_status';
-		}
-		else {
+		} else {
 			$type = 'sensei_lesson_status';
 		}
 		$cache_key = 'sensei-' . $args['type'] . '-statuses';
@@ -390,15 +388,13 @@ 
         // Restrict to specific posts
 		if ( isset( $args['post__in'] ) && !empty( $args['post__in'] ) && is_array( $args['post__in'] ) ) {
 			$query .= ' AND comment_post_ID IN (' . implode( ',', array_map( 'absint', $args['post__in'] ) ) . ')';
-		}
-		elseif ( !empty( $args['post_id'] ) ) {
+		} elseif ( !empty( $args['post_id'] ) ) {
 			$query .= $wpdb->prepare( ' AND comment_post_ID = %d', $args['post_id'] );
 		}
 		// Restrict to specific users
 		if ( isset( $args['user_id'] ) && is_array( $args['user_id'] ) ) {
 			$query .= ' AND user_id IN (' . implode( ',', array_map( 'absint', $args['user_id'] ) ) . ')';
-		}
-		elseif ( !empty( $args['user_id'] ) ) {
+		} elseif ( !empty( $args['user_id'] ) ) {
 			$query .= $wpdb->prepare( ' AND user_id = %d', $args['user_id'] );
 		}
 		$query .= ' GROUP BY comment_approved';
@@ -601,8 +597,7 @@ 
             // set the users total quiz grade
 			if ( 0 < intval( $quiz_grade_total ) ) {
             $grade = abs( round( ( doubleval( $quiz_grade ) * 100 ) / ( $quiz_grade_total ), 2 ) );
-			}
-			else {
+			} else {
 				$grade = 0;
 			}
             WooThemes_Sensei_Utils::sensei_grade_quiz( $quiz_id, $grade, $user_id );
@@ -615,8 +610,7 @@ 
                 // Student has reached the pass mark and lesson is complete
                 if ( $quiz_passmark <= $grade ) {
                     $lesson_status = 'passed';
-                }
-                else {
+                } else {
                     $lesson_status = 'failed';
                 } // End If Statement
             }
@@ -761,8 +755,7 @@ 
 			// Question has a zero grade, so skip grading
 			if ( 0 == $achievable_grade ) {
 				$all_question_grades[ $question_id ] = $achievable_grade;
-			}
-            elseif ( in_array( $question_type, $autogradable_question_types ) ) {
+			} elseif ( in_array( $question_type, $autogradable_question_types ) ) {
                 // Get user question grade
                 $question_grade = WooThemes_Sensei_Utils::sensei_grade_question_auto( $question_id, $question_type, $answer, $user_id );
                 $all_question_grades[ $question_id ] = $question_grade;
@@ -784,8 +777,7 @@ 
 			// Check for zero total from grades
 			if ( 0 < $quiz_total ) {
             $grade = abs( round( ( doubleval( $grade_total ) * 100 ) / ( $quiz_total ), 2 ) );
-			}
-			else {
+			} else {
 				$grade = 0;
 			}
             WooThemes_Sensei_Utils::sensei_grade_quiz( $quiz_id, $grade, $user_id, $quiz_grade_type );
@@ -945,19 +937,19 @@ 
 
                     return Sensei()->question->get_question_grade($question_id);
 
-                }else{
+                } else{
 
                     return false;
 
                 }
 
-            }else{
+            } else{
 
                 return false;
 
             }
 
-        }else{
+        } else{
 
             // Case Sensitive Check that the 'gap' is "exactly" equal to the given answer
             if ( trim(strtolower($gapfill_array[1])) == trim(strtolower( $user_answer )) ) {
@@ -970,13 +962,13 @@ 
 
                     return  Sensei()->question->get_question_grade( $question_id );
 
-                }else{
+                } else{
 
                     return false;
 
                 }
 
-            }else{
+            } else{
 
                 return false;
 

includes/class-sensei-list-table.php

Doc Comments +1 added lines

@@ -44,6 +44,7 @@
 	/**
 	 * Constructor
 	 * @since  1.2.0
+	 * @param string $token
 	 * @return  void
 	 */
 	public function __construct ( $token ) {

Braces +16 added lines, -9 removed lines

@@ -1,5 +1,8 @@ 
 <?php
-if ( ! defined( 'ABSPATH' ) ) exit; // Exit if accessed directly
+if ( ! defined( 'ABSPATH' ) ) {
+	exit;
+}
+// Exit if accessed directly
 
 /**
  * Sensei Generic List Table Class
@@ -131,8 +134,9 @@ 
 	 * @return array
 	 */
 	function get_column_info() {
-		if ( isset( $this->_column_headers ) )
-			return $this->_column_headers;
+		if ( isset( $this->_column_headers ) ) {
+					return $this->_column_headers;
+		}
 
 		$columns = $this->get_columns();
 		$hidden = get_hidden_columns( $this->screen );
@@ -152,12 +156,14 @@ 
 
 		$sortable = array();
 		foreach ( $_sortable as $id => $data ) {
-			if ( empty( $data ) )
-				continue;
+			if ( empty( $data ) ) {
+							continue;
+			}
 
 			$data = (array) $data;
-			if ( !isset( $data[1] ) )
-				$data[1] = false;
+			if ( !isset( $data[1] ) ) {
+							$data[1] = false;
+			}
 
 			$sortable[$id] = $data;
 		}
@@ -188,8 +194,9 @@ 
 			$class = "class='$column_name column-$column_name'";
 
 			$style = '';
-			if ( in_array( $column_name, $hidden ) )
-				$style = ' style="display:none;"';
+			if ( in_array( $column_name, $hidden ) ) {
+							$style = ' style="display:none;"';
+			}
 
 			$attributes = "$class$style";
 

includes/class-sensei-messages.php

Doc Comments +1 added lines, -1 removed lines

@@ -299,7 +299,7 @@
      * @param  integer $sender_id   ID of sender
      * @param  integer $receiver_id ID of receiver
      * @param  string  $message     Message content
-     * @param  string  $post_id     ID of post related to message
+     * @param  integer  $post_id     ID of post related to message
      * @return mixed                Message ID on success, boolean false on failure
      */
     private function save_new_message_post( $sender_id = 0, $receiver_id = 0, $message = '', $post_id = 0 ) {

Braces +39 added lines, -16 removed lines

@@ -1,5 +1,8 @@ 
 <?php
-if ( ! defined( 'ABSPATH' ) ) exit; // Exit if accessed directly
+if ( ! defined( 'ABSPATH' ) ) {
+	exit;
+}
+// Exit if accessed directly
 
 /**
  * Sensei Messages Class
@@ -73,7 +76,9 @@ 
 
 	public function add_meta_box( $post_type, $post ) {
 
-		if( ! $post_type == $this->post_type ) return;
+		if( ! $post_type == $this->post_type ) {
+			return;
+		}
 
 		add_meta_box( $this->post_type . '-data', __( 'Message Information', 'woothemes-sensei' ), array( $this, 'meta_box_content' ), $this->post_type, 'normal', 'default' );
 
@@ -138,7 +143,9 @@ 
 	public function save_message( $post_id = 0 ) {
 		global $post;
 
-		if( $this->post_type != get_post_type() ) return;
+		if( $this->post_type != get_post_type() ) {
+			return;
+		}
 
 		if( isset( $_POST['sender'] ) && $_POST['sender'] ) {
 			update_post_meta( $post_id, '_sender', $_POST['sender'] );
@@ -174,7 +181,9 @@ 
 
 		if( ! isset( Sensei()->settings->settings['messages_disable'] ) || ! Sensei()->settings->settings['messages_disable'] ) {
 
-			if( ! is_user_logged_in() ) return;
+			if( ! is_user_logged_in() ) {
+				return;
+			}
 
 			if( isset( $_GET['contact'] ) ) {
 				$html .= $this->teacher_contact_form( $post );
@@ -185,7 +194,7 @@ 
 					$contact_button_text = __( 'Contact Lesson Teacher', 'woothemes-sensei' );
 				} elseif( 'course' == $post->post_type ) {
 					$contact_button_text = __( 'Contact Course Teacher', 'woothemes-sensei' );
-				}else{
+				} else{
                     $contact_button_text = __( 'Contact Teacher', 'woothemes-sensei' );
                 }
 
@@ -203,14 +212,18 @@ 
 
 	public function teacher_contact_form( $post ) {
 
-		if( ! is_user_logged_in() ) return;
+		if( ! is_user_logged_in() ) {
+			return;
+		}
 
 		global $current_user;
 		wp_get_current_user();
 
 		$html = '';
 
-		if( ! isset( $post->ID ) ) return $html;
+		if( ! isset( $post->ID ) ) {
+			return $html;
+		}
 
         //confirm private message
         $confirmation = '';
@@ -244,9 +257,13 @@ 
 
 	public function save_new_message() {
 
-		if( ! isset( $_POST['sensei_message_teacher_nonce'] ) ) return;
+		if( ! isset( $_POST['sensei_message_teacher_nonce'] ) ) {
+			return;
+		}
 
-		if( ! wp_verify_nonce( $_POST['sensei_message_teacher_nonce'], 'message_teacher' ) ) return;
+		if( ! wp_verify_nonce( $_POST['sensei_message_teacher_nonce'], 'message_teacher' ) ) {
+			return;
+		}
 
 		$message_id = $this->save_new_message_post( $_POST['sender_id'], $_POST['receiver_id'], $_POST['contact_message'], $_POST['post_id'] );
 
@@ -257,12 +274,16 @@ 
 		// Get comment object
     	$comment = get_comment( $comment_id );
 
-		if( is_null( $comment ) ) return;
+		if( is_null( $comment ) ) {
+			return;
+		}
 
 		// Get message post object
 		$message = get_post( $comment->comment_post_ID );
 
-		if( $message->post_type != $this->post_type ) return;
+		if( $message->post_type != $this->post_type ) {
+			return;
+		}
 
 		// Force comment to be approved
 		wp_set_comment_status( $comment_id, 'approve' );
@@ -360,7 +381,9 @@ 
 	 */
 	private function view_message( $message_id, $user_id = 0) {
 
-		if( ! is_user_logged_in() ) return false;
+		if( ! is_user_logged_in() ) {
+			return false;
+		}
 
 		if( $user_id == 0 ) {
 			global $current_user;
@@ -424,9 +447,7 @@ 
 
                 wp_redirect($my_courses_url, 303);
                 exit;
-            }
-
-            else {
+            } else {
 
                 wp_redirect(home_url('/wp-login.php'), 303);
                 exit;
@@ -442,7 +463,9 @@ 
 	public function message_list( $query ) {
 		global $current_user;
 
-		if( is_admin() ) return;
+		if( is_admin() ) {
+			return;
+		}
 
 		if( is_post_type_archive( $this->post_type ) && $query->is_main_query() ) {
 			wp_get_current_user();

includes/class-sensei-question.php

Doc Comments +2 added lines, -2 removed lines

@@ -402,7 +402,7 @@ 
      * This function simply loads the question type template
      *
      * @since 1.9.0
-     * @param $question_type
+     * @param string $question_type
      */
     public static function load_question_template( $question_type ){
 
@@ -487,7 +487,7 @@ 
      * Get the questions media markup
      *
      * @since 1.9.0
-     * @param $question_id
+     * @param string $question_id
      * @return string
      */
     public static function get_the_question_media( $question_id ){

Braces +15 added lines, -10 removed lines

@@ -1,5 +1,8 @@ 
 <?php
-if ( ! defined( 'ABSPATH' ) ) exit; // Exit if accessed directly
+if ( ! defined( 'ABSPATH' ) ) {
+	exit;
+}
+// Exit if accessed directly
 
 /**
  * Sensei Question Class
@@ -211,7 +214,9 @@ 
 
 			$lesson_id = get_post_meta( $quiz, '_quiz_lesson', true );
 
-			if( ! $lesson_id ) continue;
+			if( ! $lesson_id ) {
+				continue;
+			}
 
 			$lessons[ $lesson_id ]['title'] = get_the_title( $lesson_id );
 			$lessons[ $lesson_id ]['link'] = admin_url( 'post.php?post=' . $lesson_id . '&action=edit' );
@@ -880,7 +885,7 @@ 
 
                 $merged_options = array_merge( $question_data[ 'question_wrong_answers' ], $question_data[ 'question_right_answer' ] );
 
-            }  else {
+            } else {
 
                 array_push( $question_data[ 'question_wrong_answers' ], $question_data[ 'question_right_answer' ] );
                 $merged_options = $question_data[ 'question_wrong_answers' ];
@@ -908,7 +913,7 @@ 
 
                         $user_correct = true;
 
-                    }  else if( $question_data[ 'user_question_grade' ] > 0 ) {
+                    } else if( $question_data[ 'user_question_grade' ] > 0 ) {
 
                         $user_correct = true;
 
@@ -923,7 +928,7 @@ 
 
                         $answer_class .= ' right_answer';
 
-                    }  elseif( !is_array($question_data['question_right_answer']) && $question_data['question_right_answer'] == $answer ) {
+                    } elseif( !is_array($question_data['question_right_answer']) && $question_data['question_right_answer'] == $answer ) {
 
                         $answer_class .= ' right_answer';
 
@@ -1006,13 +1011,13 @@ 
                             }
                         }
 
-                    }else{
+                    } else{
 
                         $answer_options_sorted = $question_answers_options;
 
                     }
 
-                }else{
+                } else{
 
                     $answer_options_sorted = $question_answers_options;
 
@@ -1075,12 +1080,12 @@ 
 
             $right_answer = ucfirst($right_answer);
 
-        }elseif( 'multiple-choice' == $type ) {
+        } elseif( 'multiple-choice' == $type ) {
 
             $right_answer = (array) $right_answer;
             $right_answer = implode( ', ', $right_answer );
 
-        }elseif( 'gap-fill' == $type ) {
+        } elseif( 'gap-fill' == $type ) {
 
             $right_answer_array = explode( '||', $right_answer );
             if ( isset( $right_answer_array[0] ) ) { $gapfill_pre = $right_answer_array[0]; } else { $gapfill_pre = ''; }
@@ -1089,7 +1094,7 @@ 
 
             $right_answer = $gapfill_pre . ' <span class="highlight">' . $gapfill_gap . '</span> ' . $gapfill_post;
 
-        }else{
+        } else{
 
             // for non auto gradable question types no answer should be returned.
             $right_answer = '';

includes/class-sensei-quiz.php

Doc Comments +4 added lines, -5 removed lines

@@ -123,7 +123,7 @@ 
      *
      * This function hooks into the quiz page and accepts the answer form save post.
      * @since 1.7.3
-     * @return bool $saved;
+     * @return boolean|null $saved;
      */
     public function user_save_quiz_answers_listener(){
 
@@ -214,7 +214,7 @@ 
 	 * @param int $lesson_id
 	 * @param int $user_id
 	 *
-	 * @return array $answers or false
+	 * @return boolean $answers or false
 	 */
 	public function get_user_answers( $lesson_id, $user_id ){
 
@@ -707,7 +707,7 @@ 
       *      @type int $question_id
       *      @type int $question_grade
       * }
-      * @param $lesson_id
+      * @param integer $lesson_id
       * @param $user_id (Optional) will use the current user if not supplied
       *
       * @return bool
@@ -754,7 +754,7 @@ 
       *
       * @since 1.7.4
       *
-      * @param $lesson_id
+      * @param integer $lesson_id
       * @param $user_id (Optional) will use the current user if not supplied
       *
       * @return array $user_quiz_grades or false if none exists for this users
@@ -1090,7 +1090,6 @@ 
       * Filter the single title and add the Quiz to it.
       *
       * @param string $title
-      * @param int $id title post id
       * @return string $quiz_title
       */
      public static function single_quiz_title( $title, $post_id ){

Braces +7 added lines, -4 removed lines

@@ -1,5 +1,8 @@ 
 <?php
-if ( ! defined( 'ABSPATH' ) ) exit; // Exit if accessed directly
+if ( ! defined( 'ABSPATH' ) ) {
+	exit;
+}
+// Exit if accessed directly
 
 /**
  * Sensei Quiz Class
@@ -104,7 +107,7 @@ 
 			global $post;
 			if( 'quiz' == get_post_type( $post ) ){
 				$quiz_id = $post->ID;
-			}else{
+			} else{
 				return false;
 			}
 
@@ -234,7 +237,7 @@ 
 
             $encoded_user_answers = $transient_cached_answers;
 
-        }else{
+        } else{
 
             $encoded_user_answers = WooThemes_Sensei_Utils::get_user_data( 'quiz_answers', $lesson_id  , $user_id );
 
@@ -424,7 +427,7 @@ 
             // compress the answer for saving
 			if( 'multi-line' == $question_type ) {
                 $answer = esc_html( $answer );
-            }elseif( 'file-upload' == $question_type  ){
+            } elseif( 'file-upload' == $question_type  ){
                 $file_key = 'file_upload_' . $question_id;
                 if( isset( $files[ $file_key ] ) ) {
                         $attachment_id = WooThemes_Sensei_Utils::upload_file(  $files[ $file_key ] );

includes/sensei-functions.php

Doc Comments +2 added lines, -2 removed lines

@@ -178,8 +178,8 @@
  *
  * @since 1.9.0
  *
- * @param $hook_tag
- * @param $version
+ * @param string $hook_tag
+ * @param string $version
  * @param $alternative
  * @param array $args
  */

Braces +4 added lines, -1 removed lines

@@ -1,5 +1,8 @@
 <?php
-if ( ! defined( 'ABSPATH' ) ) exit; // Exit if accessed directly
+if ( ! defined( 'ABSPATH' ) ) {
+	exit;
+}
+// Exit if accessed directly
 
 /**
  * Sensei Analysis User Profile List Table Class

includes/shortcodes/class-sensei-legacy-shortcodes.php

Doc Comments +2 added lines, -2 removed lines

@@ -103,8 +103,8 @@
      *
      * @since 1.9.0
      *
-     * @param $title
-     * @param $shortcode_specific_override
+     * @param string $title
+     * @param string $shortcode_specific_override
      * @return string
      */
     public static function generate_shortcode_courses( $title , $shortcode_specific_override  ){

Braces +1 added lines, -1 removed lines

@@ -166,7 +166,7 @@
 
             Sensei_Templates::get_template( 'user/my-courses.php' );
 
-        }else{
+        } else{
 
             Sensei()->frontend->sensei_login_form();
 

includes/shortcodes/class-sensei-shortcode-course-categories.php

Doc Comments +1 added lines, -1 removed lines

@@ -114,7 +114,7 @@
      *
      * @since 1.9.0
      *
-     * @param array $category_ids
+     * @param array $categories
      * @return array
      */
     public function generate_term_ids( $categories = array() ){

Braces +4 added lines, -1 removed lines

@@ -1,5 +1,8 @@
 <?php
-if ( ! defined( 'ABSPATH' ) ) exit; // Exit if accessed directly
+if ( ! defined( 'ABSPATH' ) ) {
+	exit;
+}
+// Exit if accessed directly
 
 /**
  * Sensei Analysis User Profile List Table Class