woothemes / sensei

includes/class-sensei-grading.php

Doc Comments +9 added lines, -8 removed lines

@@ -21,7 +21,7 @@ 
 	 * Constructor
 	 * @since  1.3.0
      *
-     * @param $file
+     * @param string $file
 	 */
 	public function __construct ( $file ) {
 		$this->name = __( 'Grading', 'woothemes-sensei' );
@@ -328,6 +328,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 ) {
@@ -527,7 +528,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() {
 
@@ -904,8 +905,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
      */
@@ -1009,7 +1010,7 @@ 
      * Add together all the graded lesson grades
      *
      * @since 1.9.0
-     * @return double $sum_of_all_grades
+     * @return integer $sum_of_all_grades
      */
     public static function get_graded_lessons_sum(){
 
@@ -1032,7 +1033,7 @@ 
      *
      * @since 1.9.0
      * @param $user_id
-     * @return double
+     * @return integer
      */
     public static function get_user_graded_lessons_sum( $user_id ){
         global $wpdb;
@@ -1055,7 +1056,7 @@ 
      * @since 1.9.0
      *
      * @param int lesson_id
-     * @return double
+     * @return integer
      */
     public static function get_lessons_users_grades_sum( $lesson_id ){
 
@@ -1080,7 +1081,7 @@ 
      * @since 1.9.0
      *
      * @param int $course_id
-     * @return double
+     * @return integer
      */
     public static function get_course_users_grades_sum( $course_id ){
 

includes/class-sensei-utils.php

Doc Comments +20 added lines, -17 removed lines

@@ -463,6 +463,9 @@ 
 
 	} // End sensei_save_quiz_answers()
 
+	/**
+	 * @return string
+	 */
 	public static function upload_file( $file = array() ) {
 
 		require_once( ABSPATH . 'wp-admin/includes/admin.php' );
@@ -635,7 +638,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 ) {
 
@@ -654,7 +657,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 ) {
 
@@ -833,7 +836,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
 	 */
@@ -861,7 +864,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
 	 */
@@ -974,7 +977,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 ) {
@@ -1021,7 +1024,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 ) {
 
@@ -1062,7 +1065,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 ) {
 
@@ -1322,7 +1325,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 ) {
 
@@ -1358,7 +1361,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 ) {
 
@@ -1385,7 +1388,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;
@@ -1534,7 +1537,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 ) {
 
@@ -1561,7 +1564,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
 	 */
@@ -1659,7 +1662,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 ) {
 
@@ -1718,11 +1721,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;
@@ -1760,7 +1763,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;
@@ -1950,7 +1953,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 +8 added lines, -7 removed lines

@@ -973,7 +973,7 @@ 
      * @since   1.2.0
      * @since  1.9.0 move to class Sensei_WC
      *
-     * @param   WC_Order $order
+     * @param   integer $order
      *
      * @return  void
      */
@@ -1191,6 +1191,7 @@ 
      * @since   1.2.0
      * @since   1.9.0 Move function to the Sensei_WC class
      * @param   integer| WC_Order $order_id order ID
+     * @param integer $order_id
      * @return  void
      */
     public static function cancel_order ( $order_id ) {
@@ -1309,7 +1310,7 @@ 
      * @param  int 			$course_id  (default: 0)
      * @param  array/Object $order_user (default: array()) Specific user's data.
      *
-     * @return bool|int
+     * @return boolean|string
      */
     public static function course_update ( $course_id = 0, $order_user = array()  ) {
 
@@ -1381,7 +1382,7 @@ 
      *
      * @param  boolean $guest_checkout Current guest checkout setting
      *
-     * @return boolean                 Modified guest checkout setting
+     * @return string|boolean                 Modified guest checkout setting
      */
     public static function disable_guest_checkout( $guest_checkout ) {
 
@@ -1555,7 +1556,7 @@ 
      * Get all the valid subscription types.
      *
      * @since 1.9.0
-     * @return array
+     * @return string[]
      */
     public static function get_subscription_types(){
 
@@ -1573,8 +1574,8 @@ 
      *
      * @since 1.9.0
      *
-     * @param $user_id
-     * @param $product_id
+     * @param integer $user_id
+     * @param string $product_id
      * @param $course_id
      *
      * @return bool
@@ -1638,7 +1639,7 @@ 
 	 * Get all the orders for a specific user and product combination
 	 *
 	 * @param int $user_id
-	 * @param $product_id
+	 * @param integer $product_id
 	 *
 	 * @return array $orders
 	 */

includes/class-sensei.php

Doc Comments +4 added lines, -4 removed lines

@@ -825,7 +825,7 @@ 
      *
      * @since 1.4.5
      * @access public
-     * @param mixed $image_size
+     * @param string $image_size
      * @return string
      */
     public function get_image_size( $image_size ) {
@@ -1051,7 +1051,7 @@ 
      * @since  1.0.0
      * @param  int 			$course_id  (default: 0)
      * @param  array/Object $order_user (default: array()) Specific user's data.
-     * @return bool|int
+     * @return boolean|string
      */
     public function woocommerce_course_update ( $course_id = 0, $order_user = array()  ) {
 
@@ -1070,7 +1070,7 @@ 
      * @param   integer $wc_product_id Product ID or Variation ID
      * @param   string  $product_type  '' or 'variation'
      *
-     * @return   WC_Product $wc_product_object
+     * @return   integer $wc_product_object
      */
     public function sensei_get_woocommerce_product_object ( $wc_product_id = 0, $product_type = '' ) {
 
@@ -1094,7 +1094,7 @@ 
      * Disable guest checkout if a course product is in the cart
      * @deprecated since 1.9.0
      * @param  boolean $guest_checkout Current guest checkout setting
-     * @return boolean                 Modified guest checkout setting
+     * @return string|boolean                 Modified guest checkout setting
      */
     public function disable_guest_checkout( $guest_checkout ) {