woothemes / sensei

includes/class-sensei-utils.php

Doc Comments +32 added lines, -29 removed lines

@@ -29,7 +29,7 @@ 
 	 * @access public
 	 * @since  1.0.2
 	 * @static
-	 * @return void
+	 * @return boolean
 	 */
 	public static function sensei_is_woocommerce_present () {
 		if ( class_exists( 'Woocommerce' ) ) {
@@ -349,7 +349,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 ) {
 
@@ -404,7 +404,7 @@ 
 	/**
 	 * Save quiz answers submitted by users
 	 * @param  boolean $submitted User's quiz answers
-	 * @return boolean            Whether the answers were saved or not
+	 * @return null|false            Whether the answers were saved or not
 	 */
 	public static function sensei_save_quiz_answers( $submitted = false, $user_id = 0 ) {
 		if( intval( $user_id ) == 0 ) {
@@ -467,6 +467,9 @@ 
 
 	} // End sensei_save_quiz_answers()
 
+	/**
+	 * @return string
+	 */
 	public static function upload_file( $file = array() ) {
 
 		require_once( ABSPATH . 'wp-admin/includes/admin.php' );
@@ -731,8 +734,8 @@ 
 	/**
 	 * Remove user from lesson, deleting all data from the corresponding quiz
 	 *
-	 * @param type $lesson_id
-	 * @param type $user_id
+	 * @param integer $lesson_id
+	 * @param integer $user_id
 	 * @return boolean
 	 */
 	public static function sensei_remove_user_from_lesson( $lesson_id = 0, $user_id = 0, $from_course = false ) {
@@ -769,8 +772,8 @@ 
 	/**
 	 * Remove a user from a course, deleting all activities across all lessons
 	 *
-	 * @param type $course_id
-	 * @param type $user_id
+	 * @param integer $course_id
+	 * @param integer $user_id
 	 * @return boolean
 	 */
 	public static function sensei_remove_user_from_course( $course_id = 0, $user_id = 0 ) {
@@ -835,7 +838,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
 	 */
@@ -863,7 +866,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 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 ) {
 
@@ -1355,9 +1358,9 @@ 
 	 * Check if a user has started a course or not
 	 *
 	 * @since  1.7.0
-	 * @param type $course_id
-	 * @param type $user_id
-	 * @return mixed false or comment_ID
+	 * @param integer $course_id
+	 * @param integer $user_id
+	 * @return false|string false or comment_ID
 	 */
 	public static function user_started_course( $course_id = 0, $user_id = 0 ) {
 
@@ -1384,7 +1387,7 @@ 
 	 * @since  1.7.0
 	 * @param  integer $course_id Course ID
 	 * @param  integer $user_id   User ID
-	 * @return int
+	 * @return null|false
 	 */
 	public static function user_complete_course( $course_id = 0, $user_id = 0 ) {
 		global  $wp_version;
@@ -1491,7 +1494,7 @@ 
 	/**
 	 * Check if a user has completed a course or not
 	 *
-	 * @param mixed $course course_id or sensei_course_status entry
+	 * @param integer $course course_id or sensei_course_status entry
 	 * @param int $user_id
 	 * @return boolean
 	 */
@@ -1530,9 +1533,9 @@ 
 	 * Check if a user has started a lesson or not
 	 *
 	 * @since  1.7.0
-	 * @param type $lesson_id
-	 * @param type $user_id
-	 * @return mixed false or comment_ID
+	 * @param integer $lesson_id
+	 * @param integer $user_id
+	 * @return string|false false or comment_ID
 	 */
 	public static function user_started_lesson( $lesson_id = 0, $user_id = 0 ) {
 
@@ -1553,7 +1556,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
 	 */
@@ -1626,9 +1629,9 @@ 
 	 * Returns the requested course status
 	 *
 	 * @since 1.7.0
-	 * @param type $course_id
-	 * @param type $user_id
-	 * @return object
+	 * @param integer $course_id
+	 * @param integer $user_id
+	 * @return integer
 	 */
 	public static function user_course_status( $course_id = 0, $user_id = 0 ) {
 
@@ -1651,7 +1654,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 ) {
 
@@ -1710,11 +1713,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 null|false false or comment_ID
 	 */
 	public static function update_lesson_status( $user_id, $lesson_id, $status = 'in-progress', $metadata = array() ) {
 		$comment_id = false;
@@ -1752,7 +1755,7 @@ 
 	 * @param type $course_id
 	 * @param type $status
 	 * @param type $metadata
-	 * @return mixed false or comment_ID
+	 * @return null|false false or comment_ID
 	 */
 	public static function update_course_status( $user_id, $course_id, $status = 'in-progress', $metadata = array() ) {
 		$comment_id = false;
@@ -1941,7 +1944,7 @@ 
      *
      * @since 1.7.4
      *
-     * @param $data_key
+     * @param string $data_key
      * @param $post_id
      * @param int $user_id
      *

Braces +41 added lines, -35 removed lines

@@ -1,5 +1,8 @@ 
 <?php
-if ( ! defined( 'ABSPATH' ) ) exit; // Exit if accessed directly
+if ( ! defined( 'ABSPATH' ) ) {
+	exit;
+}
+// Exit if accessed directly
 
 /**
  * Sensei Utilities Class
@@ -181,8 +184,7 @@ 
 				// ...use a filter to switch the encoding back
 				add_filter( 'comments_clauses', array( __CLASS__, 'comment_multiple_status_filter' ) );
 			}
-		}
-		else {
+		} else {
 			$args['status'] = 'any'; // 'log' == 'sensei_user_answer'
 		}
 
@@ -307,8 +309,12 @@ 
 				}
 
 				foreach( $activities as $activity ) {
-					if( '' == $activity->comment_type ) continue;
-					if( strpos( 'sensei_', $activity->comment_type ) != 0 ) continue;
+					if( '' == $activity->comment_type ) {
+						continue;
+					}
+					if( strpos( 'sensei_', $activity->comment_type ) != 0 ) {
+						continue;
+					}
 					$dataset_changes = wp_delete_comment( intval( $activity->comment_ID ), true );
 					wp_cache_flush();
 				}
@@ -360,11 +366,13 @@ 
             $emails[] = $user->user_email;
         }
 
-        if ( is_email( $customer_email ) )
-            $emails[] = $customer_email;
+        if ( is_email( $customer_email ) ) {
+                    $emails[] = $customer_email;
+        }
 
-        if ( sizeof( $emails ) == 0 )
-            return false;
+        if ( sizeof( $emails ) == 0 ) {
+                    return false;
+        }
 
         return Sensei_WC::has_customer_bought_product( $user_id, $product_id );
 
@@ -379,7 +387,9 @@ 
 	 */
 	public static function sensei_text_editor( $content = '', $editor_id = 'senseitexteditor', $input_name = '' ) {
 
-		if( ! $input_name ) $input_name = $editor_id;
+		if( ! $input_name ) {
+			$input_name = $editor_id;
+		}
 
 		$buttons = 'bold,italic,underline,strikethrough,blockquote,bullist,numlist,justifyleft,justifycenter,justifyright,undo,redo,pastetext';
 
@@ -689,8 +699,7 @@ 
 				if ( $has_questions ) {
 					$status = 'passed'; // Force a pass
 					$metadata['grade'] = 0;
-				}
-				else {
+				} else {
 					$status = 'complete';
 				}
 			}
@@ -738,7 +747,9 @@ 
 	public static function sensei_remove_user_from_lesson( $lesson_id = 0, $user_id = 0, $from_course = false ) {
 
 
-		if( ! $lesson_id ) return false;
+		if( ! $lesson_id ) {
+			return false;
+		}
 
 		if( intval( $user_id ) == 0 ) {
 			$user_id = get_current_user_id();
@@ -776,7 +787,9 @@ 
 	public static function sensei_remove_user_from_course( $course_id = 0, $user_id = 0 ) {
 
 
-		if( ! $course_id ) return false;
+		if( ! $course_id ) {
+			return false;
+		}
 
 		if( intval( $user_id ) == 0 ) {
 			$user_id = get_current_user_id();
@@ -844,8 +857,7 @@ 
 		if( $question ) {
 			if ( is_object( $question ) ) {
 				$user_answer_id = $question->comment_ID;
-			}
-			else {
+			} else {
 				if( intval( $user_id ) == 0 ) {
 					$user_id = get_current_user_id();
 				}
@@ -872,8 +884,7 @@ 
 		if( $question ) {
 			if ( is_object( $question ) ) {
 				$user_answer_id = $question->comment_ID;
-			}
-			else {
+			} else {
 				if( intval( $user_id ) == 0 ) {
 					$user_id = get_current_user_id();
 				}
@@ -938,8 +949,7 @@ 
 			if ( !empty($notes) ) {
 				$user_lesson_id = WooThemes_Sensei_Utils::sensei_get_activity_value( array( 'post_id' => $question_id, 'user_id' => $user_id, 'type' => 'sensei_user_answer', 'field' => 'comment_ID' ) );
 				$activity_logged = update_comment_meta( $user_lesson_id, 'answer_note', $notes );
-			}
-			else {
+			} else {
 				$activity_logged = true;
 			}
 		}
@@ -1451,8 +1461,7 @@ 
 							$lessons_completed++;
 							break;
 					}
-				}
-				else {
+				} else {
 					switch ( $lesson_status->comment_approved ) {
 						case 'complete': // Lesson has no quiz/questions
 						case 'graded': // Lesson has quiz, but it's not important what the grade was
@@ -1500,11 +1509,9 @@ 
 		if( $course ) {
 			if ( is_object( $course ) && is_a( $course,'WP_Comment') ) {
 				$user_course_status = $course->comment_approved;
-			}
-			elseif ( !is_numeric( $course ) && ! is_a( $course,'WP_Post') ) {
+			} elseif ( !is_numeric( $course ) && ! is_a( $course,'WP_Post') ) {
 				$user_course_status = $course;
-			}
-			else {
+			} else {
 				if( ! $user_id ) {
 					$user_id = get_current_user_id();
 				}
@@ -1564,11 +1571,9 @@ 
 			if ( is_object( $lesson ) ) {
 				$user_lesson_status = $lesson->comment_approved;
 				$lesson_id = $lesson->comment_post_ID;
-			}
-			elseif ( ! is_numeric( $lesson ) ) {
+			} elseif ( ! is_numeric( $lesson ) ) {
 				$user_lesson_status = $lesson;
-			}
-			else {
+			} else {
 				if( ! $user_id ) {
 					$user_id = get_current_user_id();
 				}
@@ -1581,8 +1586,7 @@ 
 
 				if ( $_user_lesson_status ) {
 					$user_lesson_status = $_user_lesson_status->comment_approved;
-				}
-				else {
+				} else {
 					return false; // No status means not complete
 				}
 				$lesson_id = $lesson;
@@ -1683,7 +1687,9 @@ 
 
 	public static function user_passed_quiz( $quiz_id = 0, $user_id = 0 ) {
 
-		if( ! $quiz_id  ) return false;
+		if( ! $quiz_id  ) {
+			return false;
+		}
 
 		if( ! $user_id ) {
 			$user_id = get_current_user_id();
@@ -1921,7 +1927,7 @@ 
             $start_function = 'user_start_'.$post_type;
             $sensei_user_activity_id = self::$start_function( $user_id, $post_id );
 
-        }else{
+        } else{
 
             $sensei_user_activity_id = $sensei_user_status->comment_ID;
 
@@ -2138,7 +2144,7 @@ 
 
             return round( $val, $precision, $mode );
 
-        }else{
+        } else{
 
             return round( $val, $precision );
 

includes/class-sensei-wc.php

Doc Comments +1 added lines, -1 removed lines

@@ -817,7 +817,7 @@
      * @param  int $user_id
      * @param  int $product_id
      *
-     * @return bool
+     * @return boolean|null
      */
     public static function has_customer_bought_product ( $user_id, $product_id ){
 

includes/template-functions.php

Doc Comments +2 added lines, -2 removed lines

@@ -143,8 +143,8 @@
 	 * sensei_check_if_product_is_in_cart function.
 	 *
 	 * @deprecated since 1.9.0
-	 * @param int $wc_post_id (default: 0)
-	 * @return void
+	 * @param int $wc_product_id (default: 0)
+	 * @return boolean
 	 */
 	function sensei_check_if_product_is_in_cart( $wc_product_id = 0 ) {
         return Sensei_WC::is_product_in_cart( $wc_product_id );

Braces +13 added lines, -8 removed lines

@@ -181,7 +181,9 @@ 
 	 * @return void
 	 */
 	function sensei_recent_comments_widget_filter( $widget_args = array() ) {
-		if ( ! isset( $widget_args['post_type'] ) ) $widget_args['post_type'] = array( 'post', 'page' );
+		if ( ! isset( $widget_args['post_type'] ) ) {
+			$widget_args['post_type'] = array( 'post', 'page' );
+		}
 		return $widget_args;
 	} // End sensei_recent_comments_widget_filter()
 	add_filter( 'widget_comments_args', 'sensei_recent_comments_widget_filter', 10, 1 );
@@ -196,8 +198,9 @@ 
 	function sensei_course_archive_filter( $query ) {
 
 
-		if ( ! $query->is_main_query() )
-        	return;
+		if ( ! $query->is_main_query() ) {
+		        	return;
+		}
 
 		// Apply Filter only if on frontend and when course archive is running
 		$course_page_id = intval( Sensei()->settings->settings[ 'course_page' ] );
@@ -412,7 +415,7 @@ 
 
 		return false;
 
-	}else{
+	} else{
 
 		return true;
 
@@ -446,7 +449,7 @@ 
 
 			$wp_query = $modules_query;
 
-		}else{
+		} else{
 
 			wp_reset_query();
 
@@ -478,7 +481,7 @@ 
 
 		return have_posts();
 
-	}else{
+	} else{
 
         // if the loop has not been initiated check the first module has lessons
         if( -1 == $sensei_modules_loop[ 'current' ]  ){
@@ -622,7 +625,7 @@ 
 
         return true;
 
-    }else{
+    } else{
 
         return false;
 
@@ -865,7 +868,9 @@ 
  */
 function get_sensei_header(){
 
-    if ( ! defined( 'ABSPATH' ) ) exit;
+    if ( ! defined( 'ABSPATH' ) ) {
+    	exit;
+    }
 
     get_header();