← All changes | integrations/thrive-apprentice/includes/triggers/complete-course.php +146 -0 5.7.6 → 6.0.3 View file →

		@@ -1,0 +1,146 @@
	1	+<?php
	2	+/**
	3	+ * Complete Course
	4	+ *
	5	+ * @package AutomatorWP\Integrations\Thrive_Apprentice\Triggers\Complete_Course
	6	+ * @author AutomatorWP <[email protected]>, Ruben Garcia <[email protected]>
	7	+ * @since 1.0.0
	8	+ */
	9	+// Exit if accessed directly
	10	+if( !defined( 'ABSPATH' ) ) exit;
	11	+
	12	+class AutomatorWP_Thrive_Apprentice_Complete_Course extends AutomatorWP_Integration_Trigger {
	13	+
	14	+ public $integration = 'thrive_apprentice';
	15	+ public $trigger = 'thrive_apprentice_complete_course';
	16	+
	17	+ /**
	18	+ * Register the trigger
	19	+ *
	20	+ * @since 1.0.0
	21	+ */
	22	+ public function register() {
	23	+
	24	+ automatorwp_register_trigger( $this->trigger, array(
	25	+ 'integration' => $this->integration,
	26	+ 'label' => __( 'User completes a course', 'automatorwp' ),
	27	+ 'select_option' => __( 'User completes <strong>a course</strong>', 'automatorwp' ),
	28	+ /* translators: %1$s: Course title. %2$s: Number of times. */
	29	+ 'edit_label' => sprintf( __( 'User completes %1$s %2$s time(s)', 'automatorwp' ), '{term}', '{times}' ),
	30	+ /* translators: %1$s: Course title. */
	31	+ 'log_label' => sprintf( __( 'User completes %1$s', 'automatorwp' ), '{term}' ),
	32	+ 'action' => 'thrive_apprentice_course_finish',
	33	+ 'function' => array( $this, 'listener' ),
	34	+ 'priority' => 10,
	35	+ 'accepted_args' => 2,
	36	+ 'options' => array(
	37	+ 'term' => automatorwp_utilities_term_option( array(
	38	+ 'name' => __( 'Course:', 'automatorwp' ),
	39	+ 'option_none_label' => __( 'any course', 'automatorwp' ),
	40	+ 'taxonomy' => 'tva_courses'
	41	+ ) ),
	42	+ 'times' => automatorwp_utilities_times_option(),
	43	+ ),
	44	+ 'tags' => array_merge(
	45	+ automatorwp_thrive_apprentice_get_course_tags(),
	46	+ automatorwp_utilities_times_tag()
	47	+ )
	48	+ ) );
	49	+
	50	+ }
	51	+
	52	+ /**
	53	+ * Trigger listener
	54	+ *
	55	+ * @since 1.0.0
	56	+ *
	57	+ * @param array $course_details
	58	+ * @param array $user_details
	59	+ */
	60	+ public function listener( $course_details, $user_details ) {
	61	+
	62	+ automatorwp_trigger_event( array(
	63	+ 'trigger' => $this->trigger,
	64	+ 'user_id' => $user_details['user_id'],
	65	+ 'course_id' => $course_details['course_id'],
	66	+ 'course_title' => $course_details['course_title']
	67	+ ) );
	68	+
	69	+ }
	70	+
	71	+ /**
	72	+ * User deserves check
	73	+ *
	74	+ * @since 1.0.0
	75	+ *
	76	+ * @param bool $deserves_trigger True if user deserves trigger, false otherwise
	77	+ * @param stdClass $trigger The trigger object
	78	+ * @param int $user_id The user ID
	79	+ * @param array $event Event information
	80	+ * @param array $trigger_options The trigger's stored options
	81	+ * @param stdClass $automation The trigger's automation object
	82	+ *
	83	+ * @return bool True if user deserves trigger, false otherwise
	84	+ */
	85	+
	86	+
	87	+ public function user_deserves_trigger( $deserves_trigger, $trigger, $user_id, $event, $trigger_options, $automation ) {
	88	+
	89	+ // Don't deserve if post is not received
	90	+ if( ! isset( $event['course_id'] ) ) {
	91	+ return false;
	92	+ }
	93	+
	94	+ // Don't deserve if post doesn't match with the trigger option
	95	+ if( $trigger_options['term'] != 'any' && $trigger_options['term'] != $event['course_id'] ) {
	96	+ return false;
	97	+ }
	98	+
	99	+ return $deserves_trigger;
	100	+
	101	+ }
	102	+
	103	+ /**
	104	+ * Register the required hooks
	105	+ *
	106	+ * @since 1.0.0
	107	+ */
	108	+ public function hooks() {
	109	+
	110	+ // Log meta data
	111	+ add_filter( 'automatorwp_user_completed_trigger_log_meta', array( $this, 'log_meta' ), 10, 6 );
	112	+
	113	+ parent::hooks();
	114	+ }
	115	+
	116	+ /**
	117	+ * Trigger custom log meta
	118	+ *
	119	+ * @since 1.0.0
	120	+ *
	121	+ * @param array $log_meta Log meta data
	122	+ * @param stdClass $trigger The trigger object
	123	+ * @param int $user_id The user ID
	124	+ * @param array $event Event information
	125	+ * @param array $trigger_options The trigger's stored options
	126	+ * @param stdClass $automation The trigger's automation object
	127	+ *
	128	+ * @return array
	129	+ */
	130	+ function log_meta( $log_meta, $trigger, $user_id, $event, $trigger_options, $automation ) {
	131	+
	132	+ // Bail if action type don't match this action
	133	+ if( $trigger->type !== $this->trigger ) {
	134	+ return $log_meta;
	135	+ }
	136	+
	137	+ $log_meta['course_id'] = ( isset( $event['course_id'] ) ? $event['course_id'] : '' );
	138	+ $log_meta['course_title'] = ( isset( $event['course_title'] ) ? $event['course_title'] : '' );
	139	+
	140	+ return $log_meta;
	141	+
	142	+ }
	143	+
	144	+}
	145	+
	146	+new AutomatorWP_Thrive_Apprentice_Complete_Course();