← All changes | integrations/sensei/includes/triggers.php +247 -0 7.9.2 → 8.0.5 View file →

		@@ -1,0 +1,247 @@
	1	+<?php
	2	+/**
	3	+ * Triggers
	4	+ *
	5	+ * @package GamiPress\Sensei\Triggers
	6	+ * @since 1.0.0
	7	+ */
	8	+
	9	+// Exit if accessed directly
	10	+if( !defined( 'ABSPATH' ) ) exit;
	11	+
	12	+/**
	13	+ * Register Sensei specific triggers
	14	+ *
	15	+ * @since 1.0.0
	16	+ *
	17	+ * @param array $triggers
	18	+ * @return mixed
	19	+ */
	20	+function gamipress_sensei_activity_triggers( $triggers ) {
	21	+
	22	+ $triggers[__( 'Sensei', 'gamipress' )] = array(
	23	+
	24	+ 'gamipress_sensei_complete_quiz' => __( 'Complete a quiz', 'gamipress' ),
	25	+ 'gamipress_sensei_complete_specific_quiz' => __( 'Complete a specific quiz', 'gamipress' ),
	26	+
	27	+ 'gamipress_sensei_complete_quiz_grade' => __( 'Complete a quiz with a minimum percent grade', 'gamipress' ),
	28	+ 'gamipress_sensei_complete_specific_quiz_grade' => __( 'Complete a specific quiz with a minimum percent grade', 'gamipress' ),
	29	+
	30	+ 'gamipress_sensei_complete_quiz_max_grade' => __( 'Complete a quiz with a maximum percent grade', 'gamipress' ),
	31	+ 'gamipress_sensei_complete_specific_quiz_max_grade' => __( 'Complete a specific quiz with a maximum percent grade', 'gamipress' ),
	32	+
	33	+ 'gamipress_sensei_pass_quiz' => __( 'Successfully pass a quiz', 'gamipress' ),
	34	+ 'gamipress_sensei_pass_specific_quiz' => __( 'Successfully pass a specific quiz', 'gamipress' ),
	35	+
	36	+ 'gamipress_sensei_fail_quiz' => __( 'Fail a quiz', 'gamipress' ),
	37	+ 'gamipress_sensei_fail_specific_quiz' => __( 'Fail a specific quiz', 'gamipress' ),
	38	+
	39	+ 'gamipress_sensei_complete_lesson' => __( 'Complete a lesson', 'gamipress' ),
	40	+ 'gamipress_sensei_complete_specific_lesson' => __( 'Complete a specific lesson', 'gamipress' ),
	41	+
	42	+ 'gamipress_sensei_start_course' => __( 'Enroll in a course', 'gamipress' ),
	43	+ 'gamipress_sensei_complete_course' => __( 'Complete a course', 'gamipress' ),
	44	+ 'gamipress_sensei_complete_specific_course' => __( 'Complete a specific course', 'gamipress' ),
	45	+ );
	46	+
	47	+ return $triggers;
	48	+
	49	+}
	50	+add_filter( 'gamipress_activity_triggers', 'gamipress_sensei_activity_triggers' );
	51	+
	52	+/**
	53	+ * Register Sensei specific activity triggers
	54	+ *
	55	+ * @since 1.0.0
	56	+ *
	57	+ * @param array $specific_activity_triggers
	58	+ * @return array
	59	+ */
	60	+function gamipress_sensei_specific_activity_triggers( $specific_activity_triggers ) {
	61	+
	62	+ $specific_activity_triggers['gamipress_sensei_complete_specific_quiz'] = array( 'quiz' );
	63	+ $specific_activity_triggers['gamipress_sensei_complete_specific_quiz_grade'] = array( 'quiz' );
	64	+ $specific_activity_triggers['gamipress_sensei_complete_specific_quiz_max_grade'] = array( 'quiz' );
	65	+ $specific_activity_triggers['gamipress_sensei_pass_specific_quiz'] = array( 'quiz' );
	66	+ $specific_activity_triggers['gamipress_sensei_fail_specific_quiz'] = array( 'quiz' );
	67	+ $specific_activity_triggers['gamipress_sensei_complete_specific_lesson'] = array( 'lesson' );
	68	+ $specific_activity_triggers['gamipress_sensei_complete_specific_course'] = array( 'course' );
	69	+
	70	+ return $specific_activity_triggers;
	71	+}
	72	+add_filter( 'gamipress_specific_activity_triggers', 'gamipress_sensei_specific_activity_triggers' );
	73	+
	74	+/**
	75	+ * Build custom activity trigger label
	76	+ *
	77	+ * @since 1.0.0
	78	+ *
	79	+ * @param string $title
	80	+ * @param integer $requirement_id
	81	+ * @param array $requirement
	82	+ *
	83	+ * @return string
	84	+ */
	85	+function gamipress_sensei_activity_trigger_label( $title, $requirement_id, $requirement ) {
	86	+
	87	+ $minimum_score = ( isset( $requirement['sensei_score'] ) ) ? absint( $requirement['sensei_score'] ) : 0;
	88	+
	89	+ switch( $requirement['trigger_type'] ) {
	90	+ case 'gamipress_sensei_complete_quiz_grade':
	91	+ return sprintf( __( 'Completed a quiz with a score of %d or higher', 'gamipress' ), $minimum_score );
	92	+ break;
	93	+ case 'gamipress_sensei_complete_specific_quiz_grade':
	94	+ $achievement_post_id = absint( $requirement['achievement_post'] );
	95	+ return sprintf( __( 'Complete the quiz %s with a score of %d or higher', 'gamipress' ), get_the_title( $achievement_post_id ), $minimum_score );
	96	+ break;
	97	+ case 'gamipress_sensei_complete_quiz_max_grade':
	98	+ return sprintf( __( 'Completed a quiz with a maximum score of %d', 'gamipress' ), $minimum_score );
	99	+ break;
	100	+ case 'gamipress_sensei_complete_specific_quiz_max_grade':
	101	+ $achievement_post_id = absint( $requirement['achievement_post'] );
	102	+ return sprintf( __( 'Complete the quiz %s with a maximum score of %d', 'gamipress' ), get_the_title( $achievement_post_id ), $minimum_score );
	103	+ break;
	104	+ }
	105	+
	106	+ return $title;
	107	+}
	108	+add_filter( 'gamipress_activity_trigger_label', 'gamipress_sensei_activity_trigger_label', 10, 3 );
	109	+
	110	+/**
	111	+ * Register Sensei specific activity triggers labels
	112	+ *
	113	+ * @since 1.0.0
	114	+ *
	115	+ * @param array $specific_activity_trigger_labels
	116	+ * @return array
	117	+ */
	118	+function gamipress_sensei_specific_activity_trigger_label( $specific_activity_trigger_labels ) {
	119	+
	120	+ $specific_activity_trigger_labels['gamipress_sensei_complete_specific_quiz'] = __( 'Complete the quiz %s', 'gamipress' );
	121	+ $specific_activity_trigger_labels['gamipress_sensei_pass_specific_quiz'] = __( 'Pass the quiz %s', 'gamipress' );
	122	+ $specific_activity_trigger_labels['gamipress_sensei_fail_specific_quiz'] = __( 'Fail the quiz %s', 'gamipress' );
	123	+ $specific_activity_trigger_labels['gamipress_sensei_complete_specific_lesson'] = __( 'Complete the lesson %s', 'gamipress' );
	124	+ $specific_activity_trigger_labels['gamipress_sensei_complete_specific_course'] = __( 'Complete the course %s', 'gamipress' );
	125	+
	126	+ return $specific_activity_trigger_labels;
	127	+}
	128	+add_filter( 'gamipress_specific_activity_trigger_label', 'gamipress_sensei_specific_activity_trigger_label' );
	129	+
	130	+/**
	131	+ * Get user for a given trigger action.
	132	+ *
	133	+ * @since 1.0.0
	134	+ *
	135	+ * @param integer $user_id user ID to override.
	136	+ * @param string $trigger Trigger name.
	137	+ * @param array $args Passed trigger args.
	138	+ * @return integer User ID.
	139	+ */
	140	+function gamipress_sensei_trigger_get_user_id( $user_id, $trigger, $args ) {
	141	+
	142	+ switch ( $trigger ) {
	143	+ case 'gamipress_sensei_complete_quiz':
	144	+ case 'gamipress_sensei_complete_specific_quiz':
	145	+ case 'gamipress_sensei_complete_quiz_grade':
	146	+ case 'gamipress_sensei_complete_specific_quiz_grade':
	147	+ case 'gamipress_sensei_complete_quiz_max_grade':
	148	+ case 'gamipress_sensei_complete_specific_quiz_max_grade':
	149	+ case 'gamipress_sensei_pass_quiz':
	150	+ case 'gamipress_sensei_pass_specific_quiz':
	151	+ case 'gamipress_sensei_fail_quiz':
	152	+ case 'gamipress_sensei_fail_specific_quiz':
	153	+ case 'gamipress_sensei_complete_lesson':
	154	+ case 'gamipress_sensei_complete_specific_lesson':
	155	+ case 'gamipress_sensei_start_course':
	156	+ case 'gamipress_sensei_complete_course':
	157	+ case 'gamipress_sensei_complete_specific_course':
	158	+ $user_id = $args[1];
	159	+ break;
	160	+ }
	161	+
	162	+ return $user_id;
	163	+
	164	+}
	165	+add_filter( 'gamipress_trigger_get_user_id', 'gamipress_sensei_trigger_get_user_id', 10, 3 );
	166	+
	167	+/**
	168	+ * Get the id for a given specific trigger action.
	169	+ *
	170	+ * @since 1.0.0
	171	+ *
	172	+ * @param integer $specific_id Specific ID.
	173	+ * @param string $trigger Trigger name.
	174	+ * @param array $args Passed trigger args.
	175	+ *
	176	+ * @return integer Specific ID.
	177	+ */
	178	+function gamipress_sensei_specific_trigger_get_id( $specific_id, $trigger = '', $args = array() ) {
	179	+
	180	+ switch ( $trigger ) {
	181	+ case 'gamipress_sensei_complete_specific_quiz':
	182	+ case 'gamipress_sensei_complete_specific_quiz_grade':
	183	+ case 'gamipress_sensei_complete_specific_quiz_max_grade':
	184	+ case 'gamipress_sensei_pass_specific_quiz':
	185	+ case 'gamipress_sensei_fail_specific_quiz':
	186	+ case 'gamipress_sensei_complete_specific_lesson':
	187	+ case 'gamipress_sensei_complete_specific_course':
	188	+ $specific_id = $args[0];
	189	+ break;
	190	+ }
	191	+
	192	+ return $specific_id;
	193	+}
	194	+add_filter( 'gamipress_specific_trigger_get_id', 'gamipress_sensei_specific_trigger_get_id', 10, 3 );
	195	+
	196	+/**
	197	+ * Extended meta data for event trigger logging
	198	+ *
	199	+ * @since 1.0.0
	200	+ *
	201	+ * @param array $log_meta
	202	+ * @param integer $user_id
	203	+ * @param string $trigger
	204	+ * @param integer $site_id
	205	+ * @param array $args
	206	+ *
	207	+ * @return array
	208	+ */
	209	+function gamipress_sensei_log_event_trigger_meta_data( $log_meta, $user_id, $trigger, $site_id, $args ) {
	210	+
	211	+ switch ( $trigger ) {
	212	+ case 'gamipress_sensei_complete_quiz':
	213	+ case 'gamipress_sensei_complete_specific_quiz':
	214	+ case 'gamipress_sensei_pass_quiz':
	215	+ case 'gamipress_sensei_pass_specific_quiz':
	216	+ case 'gamipress_sensei_fail_quiz':
	217	+ case 'gamipress_sensei_fail_specific_quiz':
	218	+ // Add the quiz and course IDs
	219	+ $log_meta['quiz_id'] = $args[0];
	220	+ $log_meta['course_id'] = $args[2];
	221	+ break;
	222	+ case 'gamipress_sensei_complete_quiz_grade':
	223	+ case 'gamipress_sensei_complete_specific_quiz_grade':
	224	+ case 'gamipress_sensei_complete_quiz_max_grade':
	225	+ case 'gamipress_sensei_complete_specific_quiz_max_grade':
	226	+ // Add the quiz and course IDs
	227	+ $log_meta['quiz_id'] = $args[0];
	228	+ $log_meta['course_id'] = $args[2];
	229	+ $log_meta['score'] = $args[3];
	230	+ break;
	231	+ case 'gamipress_sensei_complete_lesson':
	232	+ case 'gamipress_sensei_complete_specific_lesson':
	233	+ // Add the lesson and course IDs
	234	+ $log_meta['lesson_id'] = $args[0];
	235	+ $log_meta['course_id'] = $args[2];
	236	+ break;
	237	+ case 'gamipress_sensei_start_course':
	238	+ case 'gamipress_sensei_complete_course':
	239	+ case 'gamipress_sensei_complete_specific_course':
	240	+ // Add the course ID
	241	+ $log_meta['course_id'] = $args[0];
	242	+ break;
	243	+ }
	244	+
	245	+ return $log_meta;
	246	+}
	247	+add_filter( 'gamipress_log_event_trigger_meta_data', 'gamipress_sensei_log_event_trigger_meta_data', 10, 5 );