Tutorlms_Helpers

Class Tutorlms_Helpers

Contents

  • Methods

  • Source Source

    File: src/integrations/tutorlms/helpers/tutorlms-helpers.php

    class Tutorlms_Helpers {
    	/**
    	 * @var Tutorlms_Helpers
    	 */
    	public $options;
    
    	/**
    	 * @var Tutorlms_Pro_Helpers
    	 */
    	public $pro;
    
    	/**
    	 * @var bool
    	 */
    	public $load_options;
    
    	/**
    	 * Tutorlms_Helpers constructor.
    	 */
    	public function __construct() {
    
    		$this->load_options = Automator()->helpers->recipe->maybe_load_trigger_options( __CLASS__ );
    	}
    
    	/**
    	 * @param Tutorlms_Helpers $options
    	 */
    	public function setOptions( Tutorlms_Helpers $options ) {
    		$this->options = $options;
    	}
    
    	/**
    	 * @param Tutorlms_Pro_Helpers $pro
    	 */
    	public function setPro( Tutorlms_Pro_Helpers $pro ) {
    		$this->pro = $pro;
    	}
    
    	/**
    	 * Creates options for trigger.
    	 *
    	 * @since 2.4.0
    	 */
    	public function all_tutorlms_lessons( $label = null, $option_code = 'TUTORLMSLESSON', $any_option = false ) {
    		if ( ! $this->load_options ) {
    
    
    			return Automator()->helpers->recipe->build_default_options_array( $label, $option_code );
    		}
    
    
    		if ( ! $label ) {
    			$label = esc_attr__( 'Lesson', 'uncanny-automator' );
    		}
    
    		// post query arguments.
    		$args = [
    			'post_type'      => tutor()->lesson_post_type,
    			'posts_per_page' => 999,
    			'orderby'        => 'title',
    			'order'          => 'ASC',
    			'post_status'    => 'publish',
    
    		];
    
    
    		$options = Automator()->helpers->recipe->options->wp_query( $args, $any_option, esc_attr__( 'Any lesson', 'uncanny-automator' ) );
    
    		$option = [
    			'option_code'     => $option_code,
    			'label'           => $label,
    			'input_type'      => 'select',
    			'required'        => true,
    			// to setup example, lets define the value the child will be based on
    			'current_value'   => false,
    			'validation_type' => 'text',
    			'options'         => $options,
    			'relevant_tokens' => [
    				$option_code          => esc_attr__( 'Lesson title', 'uncanny-automator' ),
    				$option_code . '_ID'  => esc_attr__( 'Lesson ID', 'uncanny-automator' ),
    				$option_code . '_URL' => esc_attr__( 'Lesson URL', 'uncanny-automator' ),
    			],
    		];
    
    		return apply_filters( 'uap_option_all_tutorlms_lessons', $option );
    
    	}
    
    	/**
    	 * Creates options for trigger.
    	 *
    	 * @since 2.4.0
    	 */
    	public function all_tutorlms_courses( $label = null, $option_code = 'TUTORLMSCOURSE', $all_label = false, $any_option = false ) {
    		if ( ! $this->load_options ) {
    
    
    			return Automator()->helpers->recipe->build_default_options_array( $label, $option_code );
    		}
    
    		if ( ! $label ) {
    			$label = esc_attr__( 'Course', 'uncanny-automator' );
    		}
    
    		// post query arguments.
    		$args = [
    			'post_type'      => tutor()->course_post_type,
    			'posts_per_page' => 999,
    			'orderby'        => 'title',
    			'order'          => 'ASC',
    			'post_status'    => 'publish',
    
    		];
    
    
    		$options = Automator()->helpers->recipe->options->wp_query( $args, $any_option, __( 'Any course', 'uncanny-automator' ), $all_label );
    
    		$option = [
    			'option_code'     => $option_code,
    			'label'           => $label,
    			'input_type'      => 'select',
    			'required'        => true,
    			// to setup example, lets define the value the child will be based on
    			'current_value'   => false,
    			'validation_type' => 'text',
    			'options'         => $options,
    			'relevant_tokens' => [
    				$option_code          => esc_attr__( 'Course title', 'uncanny-automator' ),
    				$option_code . '_ID'  => esc_attr__( 'Course ID', 'uncanny-automator' ),
    				$option_code . '_URL' => esc_attr__( 'Course URL', 'uncanny-automator' ),
    			],
    		];
    
    		return apply_filters( 'uap_option_all_tutorlms_courses', $option );
    
    	}
    
    	/**
    	 * Creates options for trigger.
    	 *
    	 * @since 2.4.0
    	 */
    	public function all_tutorlms_quizzes( $label = null, $option_code = 'TUTORLMSQUIZ', $any_option = false ) {
    		if ( ! $this->load_options ) {
    
    
    			return Automator()->helpers->recipe->build_default_options_array( $label, $option_code );
    		}
    
    
    		if ( ! $label ) {
    			$label = esc_attr__( 'Quiz', 'uncanny-automator' );
    		}
    
    		// post query arguments.
    		$args = [
    			'post_type'      => 'tutor_quiz',
    			'posts_per_page' => 999,
    			'orderby'        => 'title',
    			'order'          => 'ASC',
    			'post_status'    => 'publish',
    
    		];
    
    
    		$options = Automator()->helpers->recipe->options->wp_query( $args, $any_option, esc_attr__( 'Any quiz', 'uncanny-automator' ) );
    
    		$option = [
    			'option_code'     => $option_code,
    			'label'           => $label,
    			'input_type'      => 'select',
    			'required'        => true,
    			// to setup example, lets define the value the child will be based on
    			'current_value'   => false,
    			'validation_type' => 'text',
    			'options'         => $options,
    			'relevant_tokens' => [
    				$option_code          => esc_attr__( 'Quiz title', 'uncanny-automator' ),
    				$option_code . '_ID'  => esc_attr__( 'Quiz ID', 'uncanny-automator' ),
    				$option_code . '_URL' => esc_attr__( 'Quiz URL', 'uncanny-automator' ),
    			],
    		];
    
    		return apply_filters( 'uap_option_all_tutorlms_quizzes', $option );
    
    	}
    
    	/**
    	 * Checks if a quiz attempt was successful.
    	 *
    	 * @param $attempt object.
    	 *
    	 * @since 2.4.0
    	 */
    	public function was_quiz_attempt_successful( $attempt ) {
    
    		// if the earned grade is less than or equal to zero, they failed.
    		if ( $attempt->earned_marks <= 0 ) {
    			return false;
    		}
    
    		// return pass or fail based on whether the required score was met.
    		return ( $this->get_percentage_scored( $attempt ) >= $this->get_percentage_required( $attempt ) );
    	}
    
    	/**
    	 * Calculates percentage scored.
    	 *
    	 * @param object $attempt The quiz attempt object.
    	 *
    	 * @return int
    	 * @since 2.4.0
    	 */
    	public function get_percentage_scored( $attempt ) {
    		return number_format( ( $attempt->earned_marks * 100 ) / $attempt->total_marks );
    	}
    
    	/**
    	 * Retrieves required percentage.
    	 *
    	 * @param object $attempt The quiz attempt object.
    	 *
    	 * @return int
    	 * @since 2.4.0
    	 */
    	public function get_percentage_required( $attempt ) {
    		return (int) tutor_utils()->get_quiz_option( $attempt->quiz_id, 'passing_grade', 0 );
    	}
    }
    

    Methods Methods