MASTERSTUDY_COURSEDONE

Class MASTERSTUDY_COURSEDONE

Contents

  • Methods

  • Source Source

    File: src/integrations/masterstudy-lms/triggers/masterstudy-coursedone.php

    class MASTERSTUDY_COURSEDONE {
    
    	/**
    	 * Integration code
    	 * @var string
    	 */
    	public static $integration = 'MSLMS';
    
    	private $trigger_code;
    	private $trigger_meta;
    
    	/**
    	 * Set up Automator trigger constructor.
    	 */
    	public function __construct() {
    		$this->trigger_code = 'MSLMSCOURSEDONE';
    		$this->trigger_meta = 'MSLMSCOURSE';
    		$this->define_trigger();
    	}
    
    	/**
    	 * Define and register the trigger by pushing it into the Automator object
    	 */
    	public function define_trigger() {
    
    
    
    		$args = [
    			'post_type'      => 'stm-courses',
    			'posts_per_page' => 999,
    			'orderby'        => 'title',
    			'order'          => 'ASC',
    			'post_status'    => 'publish',
    		];
    
    		$options = Automator()->helpers->recipe->options->wp_query( $args, true, __( 'Any course', 'uncanny-automator' ) );
    
    		$trigger = array(
    			'author'              => Automator()->get_author_name(),
    			'support_link'        => Automator()->get_author_support_link( $this->trigger_code, 'integration/masterstudy-lms/' ),
    			'integration'         => self::$integration,
    			'code'                => $this->trigger_code,
    			/* translators: Logged-in trigger - MasterStudy LMS */
    			'sentence'            => sprintf( esc_attr__( 'A user completes {{a course:%1$s}}', 'uncanny-automator' ), $this->trigger_meta ),
    			/* translators: Logged-in trigger - MasterStudy LMS */
    			'select_option_name'  => esc_attr__( 'A user completes {{a course}}', 'uncanny-automator' ),
    			'action'              => 'stm_lms_progress_updated',
    			'priority'            => 20,
    			'accepted_args'       => 3,
    			'validation_function' => array( $this, 'course_done' ),
    			'options'             => [
    				[
    					'option_code'              => $this->trigger_meta,
    					'label'                    => esc_attr_x( 'Course', 'MasterStudy LMS', 'uncanny-automator' ),
    					'input_type'               => 'select',
    					'required'                 => true,
    					'options'                  => $options,
    					'relevant_tokens'          => [
    						'MSLMSCOURSE'     => esc_attr__( 'Course title', 'uncanny-automator' ),
    						'MSLMSCOURSE_ID'  => esc_attr__( 'Course ID', 'uncanny-automator' ),
    						'MSLMSCOURSE_URL' => esc_attr__( 'Course URL', 'uncanny-automator' ),
    					],
    					'custom_value_description' => _x( 'Course ID', 'MasterStudy', 'uncanny-automator' ),
    				],
    			],
    		);
    
    		Automator()->register->trigger( $trigger );
    
    		return;
    	}
    
    	/**
    	 * Validation function when the trigger action is hit
    	 *
    	 * @param $data
    	 */
    	public function course_done( $course_id, $user_id, $progress ) {
    
    
    
    		if ( empty( $progress ) ) {
    			return;
    		}
    
    		if ( 100 >= absint( $progress ) ) {
    
    			$args = [
    				'code'    => $this->trigger_code,
    				'meta'    => $this->trigger_meta,
    				'post_id' => $course_id,
    				'user_id' => $user_id,
    			];
    
    			$args = Automator()->maybe_add_trigger_entry( $args, false );
    			if ( $args ) {
    				foreach ( $args as $result ) {
    					if ( true === $result['result'] ) {
    						Automator()->insert_trigger_meta(
    							[
    								'user_id'        => $user_id,
    								'trigger_id'     => $result['args']['trigger_id'],
    								'meta_key'       => $this->trigger_meta,
    								'meta_value'     => $course_id,
    								'trigger_log_id' => $result['args']['get_trigger_id'],
    								'run_number'     => $result['args']['run_number'],
    							]
    						);
    						Automator()->maybe_trigger_complete( $result['args'] );
    					}
    				}
    			}
    		}
    	}
    }
    

    Methods Methods

    • __construct — Set up Automator trigger constructor.
    • course_done — Validation function when the trigger action is hit
    • define_trigger — Define and register the trigger by pushing it into the Automator object