woothemes / sensei

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/admin/class-sensei-learner-management.php

Doc Comments +1 added lines

@@ -21,6 +21,7 @@
 	/**
 	 * Constructor
 	 * @since  1.6.0
+	 * @param string $file
 	 * @return  void
 	 */
 	public function __construct ( $file ) {

includes/class-sensei-modules.php

Doc Comments +4 added lines

@@ -21,6 +21,9 @@ 
     private $order_page_slug;
     public $taxonomy;
 
+    /**
+     * @param string $file
+     */
     public function __construct( $file )
     {
         $this->file = $file;
@@ -1942,6 +1945,7 @@ 
      * Hooked into 'get_terms'
      *
      * @since 1.8.0
+     * @param string[] $taxonomies
      */
     public function append_teacher_name_to_module( $terms, $taxonomies, $args )
     {

includes/class-sensei-notices.php

Doc Comments -8 removed lines

@@ -33,10 +33,6 @@ 
 	* 
 	*
 	* 
-	* @param string $message 
-	* @param string $type defaults to alert options( alert, tick , download , info   )
-	*
-	* @return void
 	*/
 
 	public function add_notice( $content ,  $type = 'alert'   ){
@@ -47,10 +43,6 @@ 
 	/**
 	*  Output all notices added 
 	* 
-	* @param string $message 
-	* @param string $type
-	*
-	* @return void
 	*/
 
 	public function print_notices(){

includes/class-sensei-settings-api.php

Doc Comments +1 added lines, -1 removed lines

@@ -796,7 +796,7 @@
 	 * Return an array of field types expecting an array value returned.
 	 * @access protected
 	 * @since  1.0.0
-	 * @return array
+	 * @return string[]
 	 */
 	protected function get_array_field_types () {
 		return array( 'multicheck' );

includes/class-sensei-teacher.php

Doc Comments +2 added lines, -3 removed lines

@@ -452,7 +452,7 @@ 
      * @since 1.8.0
      * @access public
      * @parameters
-     * @return array $users user id array
+     * @return boolean $users user id array
      */
     public function update_course_lessons_author ( $course_id, $new_author  ){
 
@@ -841,8 +841,7 @@ 
      * This function hooks into wp_insert_post
      *
      * @since 1.8.0
-     * @param int $course_id
-     * @return bool
+     * @return false|null
      */
     public function notify_admin_teacher_course_creation( $new_status, $old_status, $post ){
 

includes/class-sensei-updates.php

Doc Comments +4 added lines, -4 removed lines

@@ -1424,8 +1424,8 @@ 
 	 *
 	 * @global type $woothemes_sensei
 	 * @global type $wpdb
-	 * @param type $n
-	 * @param type $offset
+	 * @param integer $n
+	 * @param integer $offset
 	 * @return boolean
 	 */
 	function status_changes_repair_course_statuses( $n = 50, $offset = 0 ) {
@@ -1669,8 +1669,8 @@ 
 	 * Update the comment counts for all Courses and Lessons now that sensei comments will no longer be counted.
 	 *
 	 * @global type $wpdb
-	 * @param type $n
-	 * @param type $offset
+	 * @param integer $n
+	 * @param integer $offset
 	 * @return boolean
 	 */
 	public function update_comment_course_lesson_comment_counts( $n = 50, $offset = 0 ) {

includes/class-sensei-course.php

Doc Comments +1 added lines, -3 removed lines

@@ -850,7 +850,6 @@ 
 	 * course_count function.
 	 *
 	 * @access public
-	 * @param array $exclude (default: array())
 	 * @param string $post_status (default: 'publish')
 	 * @return int
 	 */
@@ -1152,7 +1151,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 ) {
@@ -1879,7 +1877,7 @@ 
      *
      * @since 1.9
      *
-     * @param WP_Post $post
+     * @param WP_Post $post_id
      */
     public function content_before_backwards_compatibility_hooks( $post_id ){