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
      *

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 );