woothemes / sensei

includes/class-sensei-course.php

Doc Comments -2 removed lines

@@ -848,7 +848,6 @@ 
 	 * course_count function.
 	 *
 	 * @access public
-	 * @param array $exclude (default: array())
 	 * @param string $post_status (default: 'publish')
 	 * @return int
 	 */
@@ -1159,7 +1158,6 @@ 
      *
 	 * @since  1.4.0
 	 * @param  object  $user   Queried user object
-	 * @param  boolean $manage Whether the user has permission to manage the courses
 	 * @return string          HTML displayng course data
 	 */
 	public function load_user_courses_content( $user = false ) {

includes/class-sensei-lesson.php

Doc Comments +3 added lines, -3 removed lines

@@ -239,7 +239,7 @@ 
 	 *
 	 * @access public
 	 * @param int $post_id
-	 * @return void
+	 * @return integer|null
 	 */
 	public function meta_box_save ( $post_id ) {
 
@@ -2418,7 +2418,7 @@ 
 	 *
 	 * @access private
 	 * @param array $data (default: array())
-	 * @return void
+	 * @return boolean
 	 */
 	private function lesson_delete_question( $data = array() ) {
 
@@ -2884,7 +2884,7 @@ 
      * @access public
      *
      * @param int $lesson_id
-     * @return int|bool $course_id or bool when nothing is found.
+     * @return integer $course_id or bool when nothing is found.
      */
      public function get_course_id( $lesson_id ){
 

includes/class-sensei-utils.php

Doc Comments +21 added lines, -18 removed lines

@@ -345,7 +345,7 @@ 
      * @param  string $customer_email
      * @param  int $user_id
      * @param  int $product_id
-     * @return bool
+     * @return boolean|null
      */
     public static function sensei_customer_bought_product ( $customer_email, $user_id, $product_id ) {
 
@@ -464,6 +464,9 @@ 
 
 	} // End sensei_save_quiz_answers()
 
+	/**
+	 * @return string
+	 */
 	public static function upload_file( $file = array() ) {
 
 		require_once( ABSPATH . 'wp-admin/includes/admin.php' );
@@ -636,7 +639,7 @@ 
      * @param integer $lesson_id
      * @param bool $complete
      *
-     * @return mixed boolean or comment_ID
+     * @return boolean|string boolean or comment_ID
      */
     public static function user_start_lesson(  $user_id = 0, $lesson_id = 0, $complete = false ) {
 
@@ -655,7 +658,7 @@ 
 	 * @param int| string $user_id default 0
      * @param bool $complete default false
      *
-     * @return mixed boolean or comment_ID
+     * @return boolean|string boolean or comment_ID
 	 */
 	public static function sensei_start_lesson( $lesson_id = 0, $user_id = 0, $complete = false ) {
 
@@ -834,7 +837,7 @@ 
 	/**
 	 * Returns the user_grade for a specific question and user, or sensei_user_answer entry
 	 *
-	 * @param mixed $question
+	 * @param integer $question
 	 * @param int $user_id
 	 * @return string
 	 */
@@ -862,7 +865,7 @@ 
 	 * Returns the answer_notes for a specific question and user, or sensei_user_answer entry
 	 *
      * @deprecated since 1.7.5 use Sensei()->quiz->get_user_question_feedback instead
-	 * @param mixed $question
+	 * @param integer $question
 	 * @param int $user_id
 	 * @return string
 	 */
@@ -975,7 +978,7 @@ 
 	 * sort_array_by_key sorts array by key
 	 * @since  1.3.0
 	 * @param  array $array by ref
-	 * @param  $key string column name in array
+	 * @param  string $key string column name in array
 	 * @return void
 	 */
 	public static function sort_array_by_key( $array, $key ) {
@@ -1022,7 +1025,7 @@ 
 	/**
 	 * Get pass mark for course
 	 * @param  integer $course_id ID of course
-	 * @return integer            Pass mark for course
+	 * @return double            Pass mark for course
 	 */
 	public static function sensei_course_pass_grade( $course_id = 0 ) {
 
@@ -1063,7 +1066,7 @@ 
 	 * Get user total grade for course
 	 * @param  integer $course_id ID of course
 	 * @param  integer $user_id   ID of user
-	 * @return integer            User's total grade
+	 * @return double            User's total grade
 	 */
 	public static function sensei_course_user_grade( $course_id = 0, $user_id = 0 ) {
 
@@ -1323,7 +1326,7 @@ 
 	 * @since  1.4.8
 	 * @param  integer $user_id   User ID
 	 * @param  integer $course_id Course ID
-	 * @return mixed boolean or comment_ID
+	 * @return string|boolean boolean or comment_ID
 	 */
 	public static function user_start_course( $user_id = 0, $course_id = 0 ) {
 
@@ -1359,7 +1362,7 @@ 
 	 * @since  1.7.0
 	 * @param int $course_id
 	 * @param int $user_id
-	 * @return mixed false or comment_ID
+	 * @return false|string false or comment_ID
 	 */
 	public static function user_started_course( $course_id = 0, $user_id = 0 ) {
 
@@ -1386,7 +1389,7 @@ 
 	 * @since  1.7.0
 	 * @param  integer $course_id Course ID
 	 * @param  integer $user_id   User ID
-	 * @return int
+	 * @return boolean
 	 */
 	public static function user_complete_course( $course_id = 0, $user_id = 0 ) {
 		global  $wp_version;
@@ -1535,7 +1538,7 @@ 
 	 * @since  1.7.0
 	 * @param int $lesson_id
 	 * @param int $user_id
-	 * @return mixed false or comment_ID
+	 * @return string|false false or comment_ID
 	 */
 	public static function user_started_lesson( $lesson_id = 0, $user_id = 0 ) {
 
@@ -1562,7 +1565,7 @@ 
 	 * Check if a user has completed a lesson or not
 	 *
      * @uses  Sensei()
-	 * @param mixed $lesson lesson_id or sensei_lesson_status entry
+	 * @param integer $lesson lesson_id or sensei_lesson_status entry
 	 * @param int $user_id
 	 * @return boolean
 	 */
@@ -1660,7 +1663,7 @@ 
 	 * @since 1.7.0
 	 * @param int $lesson_id
 	 * @param int $user_id
-	 * @return object | bool
+	 * @return integer | bool
 	 */
 	public static function user_lesson_status( $lesson_id = 0, $user_id = 0 ) {
 
@@ -1719,11 +1722,11 @@ 
 	 * @since  1.7.0
      *
 	 * @param int|string $user_id
-	 * @param int|string $lesson_id
+	 * @param integer $lesson_id
 	 * @param string $status
 	 * @param array $metadata
      *
-	 * @return mixed false or comment_ID
+	 * @return boolean false or comment_ID
 	 */
 	public static function update_lesson_status( $user_id, $lesson_id, $status = 'in-progress', $metadata = array() ) {
 		$comment_id = false;
@@ -1761,7 +1764,7 @@ 
 	 * @param int $course_id
 	 * @param string $status
 	 * @param array $metadata
-	 * @return mixed false or comment_ID
+	 * @return boolean false or comment_ID
 	 */
 	public static function update_course_status( $user_id, $course_id, $status = 'in-progress', $metadata = array() ) {
 		$comment_id = false;
@@ -1951,7 +1954,7 @@ 
      *
      * @since 1.7.4
      *
-     * @param $data_key
+     * @param string $data_key
      * @param $post_id
      * @param int $user_id
      *

includes/template-functions.php

Doc Comments +1 added lines, -1 removed lines

@@ -143,7 +143,7 @@
 	 * sensei_check_if_product_is_in_cart function.
 	 *
 	 * @deprecated since 1.9.0
-	 * @param int $wc_post_id (default: 0)
+	 * @param int $wc_product_id (default: 0)
 	 * @return bool
 	 */
 	function sensei_check_if_product_is_in_cart( $wc_product_id = 0 ) {

includes/class-sensei-frontend.php

Braces +30 added lines, -12 removed lines

@@ -1,5 +1,8 @@ 
 <?php
-if ( ! defined( 'ABSPATH' ) ) exit; // Exit if accessed directly
+if ( ! defined( 'ABSPATH' ) ) {
+	exit;
+}
+// Exit if accessed directly
 
 /**
  * Sensei Frontend Class
@@ -668,7 +671,9 @@ 
 	public function sensei_breadcrumb( $id = 0 ) {
 
 		// Only output on lesson, quiz and taxonomy (module) pages
-		if( ! ( is_tax( 'module' ) || is_singular( 'lesson' ) || is_singular( 'quiz' ) ) ) return;
+		if( ! ( is_tax( 'module' ) || is_singular( 'lesson' ) || is_singular( 'quiz' ) ) ) {
+			return;
+		}
 
 		if( empty( $id )  ){
 
@@ -1094,17 +1099,26 @@ 
 
 						<p class="form-row form-row-wide">
 							<label for="sensei_reg_username"><?php _e( 'Username', 'woothemes-sensei' ); ?> <span class="required">*</span></label>
-							<input type="text" class="input-text" name="sensei_reg_username" id="sensei_reg_username" value="<?php if ( ! empty( $_POST['sensei_reg_username'] ) ) esc_attr_e( $_POST['sensei_reg_username'] ); ?>" />
+							<input type="text" class="input-text" name="sensei_reg_username" id="sensei_reg_username" value="<?php if ( ! empty( $_POST['sensei_reg_username'] ) ) {
+	esc_attr_e( $_POST['sensei_reg_username'] );
+}
+?>" />
 						</p>
 
 						<p class="form-row form-row-wide">
 							<label for="sensei_reg_email"><?php _e( 'Email address', 'woothemes-sensei' ); ?> <span class="required">*</span></label>
-							<input type="email" class="input-text" name="sensei_reg_email" id="sensei_reg_email" value="<?php if ( ! empty( $_POST['sensei_reg_email'] ) ) esc_attr_e( $_POST['sensei_reg_email'] ); ?>" />
+							<input type="email" class="input-text" name="sensei_reg_email" id="sensei_reg_email" value="<?php if ( ! empty( $_POST['sensei_reg_email'] ) ) {
+	esc_attr_e( $_POST['sensei_reg_email'] );
+}
+?>" />
 						</p>
 
 						<p class="form-row form-row-wide">
 							<label for="sensei_reg_password"><?php _e( 'Password', 'woothemes-sensei' ); ?> <span class="required">*</span></label>
-							<input type="password" class="input-text" name="sensei_reg_password" id="sensei_reg_password" value="<?php if ( ! empty( $_POST['sensei_reg_password'] ) ) esc_attr_e( $_POST['sensei_reg_password'] ); ?>" />
+							<input type="password" class="input-text" name="sensei_reg_password" id="sensei_reg_password" value="<?php if ( ! empty( $_POST['sensei_reg_password'] ) ) {
+	esc_attr_e( $_POST['sensei_reg_password'] );
+}
+?>" />
 						</p>
 
 						<!-- Spam Trap -->
@@ -1437,8 +1451,12 @@ 
 
 		if( Sensei_WC::is_woocommerce_active() ) {
 
-			if( ! is_user_logged_in() ) return;
-			if( ! isset( $post->ID ) ) return;
+			if( ! is_user_logged_in() ) {
+				return;
+			}
+			if( ! isset( $post->ID ) ) {
+				return;
+			}
 
 			$user_id = $current_user->ID;
 			$course_id = $post->ID;
@@ -1599,7 +1617,7 @@ 
 		    		//assigne the username to the creds array for further processing
 		    		$creds['user_login'] =  $user->user_login ;
 
-		    	}else{
+		    	} else{
 
 		    		// process this as a default username login
 		    		$creds['user_login'] = sanitize_text_field( $_REQUEST['log'] ) ;
@@ -1616,7 +1634,7 @@ 
 				if ( is_wp_error($user) ){ // on login failure
                     wp_redirect( esc_url_raw( add_query_arg('login', 'failed', $referrer) ) );
                     exit;
-				}else{ // on login success
+				} else{ // on login success
 
 					/**
 					* change the redirect url programatically
@@ -1633,14 +1651,14 @@ 
 
 				}	// end is_wp_error($user)
 
-		    }else{ // if username or password is empty
+		    } else{ // if username or password is empty
 
                 wp_redirect( esc_url_raw( add_query_arg('login', 'emptyfields', $referrer) ) );
 		        exit;
 
 		    } // end if username $_REQUEST['log']  and password $_REQUEST['pwd'] is empty
 
-	    }elseif( ( isset( $_GET['login'] ) ) ) {
+	    } elseif( ( isset( $_GET['login'] ) ) ) {
 	    	// else if this request is a redircect from a previously faile login request
 	    	$this->login_message_process();
 
@@ -1762,7 +1780,7 @@ 
 
 				$message = __('Incorrect login details', 'woothemes-sensei' );
 
-			}elseif( $_GET['login'] == 'emptyfields'  ){
+			} elseif( $_GET['login'] == 'emptyfields'  ){
 
 				$message= __('Please enter your username and password', 'woothemes-sensei' );
 			}