automatorwp / integrations / h5p / includes / triggers / complete-content.php

complete-content.php in AutomatorWP – No-Code Workflow Automation, Integration & Webhooks Plugin, now with AI 5.8.6, at integrations/h5p/includes/triggers/complete-content.php

116 lines 4.3 KB

Raw Download Zip

1	<?php
2	/**
3	* Complete Content
4	*
5	* @package AutomatorWP\Integrations\H5P\Triggers\Complete_Content
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_H5P_Complete_Content extends AutomatorWP_Integration_Trigger {
13
14	public $integration = 'h5p';
15	public $trigger = 'h5p_complete_content';
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 content', 'automatorwp' ),
27	'select_option' => __( 'User completes <strong>a content</strong>', 'automatorwp' ),
28	/* translators: %1$s: Content title. %2$s: Number of times. */
29	'edit_label' => sprintf( __( 'User completes %1$s %2$s time(s)', 'automatorwp' ), '{content}', '{times}' ),
30	/* translators: %1$s: Content title. */
31	'log_label' => sprintf( __( 'User completes %1$s', 'automatorwp' ), '{content}' ),
32	'action' => 'h5p_alter_user_result',
33	'function' => array( $this, 'listener' ),
34	'priority' => 10,
35	'accepted_args' => 4,
36	'options' => array(
37	'content' => automatorwp_utilities_ajax_selector_option( array(
38	'field' => 'content',
39	'name' => __( 'Content:', 'automatorwp' ),
40	'option_none_value' => 'any',
41	'option_none_label' => __( 'any content', 'automatorwp' ),
42	'action_cb' => 'automatorwp_h5p_get_contents',
43	'options_cb' => 'automatorwp_h5p_options_cb_content',
44	'default' => 'any'
45	) ),
46	'times' => automatorwp_utilities_times_option(),
47	),
48	'tags' => array_merge(
49	automatorwp_utilities_times_tag()
50	)
51	) );
52
53	}
54
55	/**
56	* Trigger listener
57	*
58	* @since 1.0.0
59	*
60	* @param object $data Has the following properties score,max_score,opened,finished,time
61	* @param int $result_id Only set if updating result
62	* @param int $content_id Identifier of the H5P Content
63	* @param int $user_id Identifier of the User
64	*/
65	public function listener( $data, $result_id, $content_id, $user_id ) {
66
67	automatorwp_trigger_event( array(
68	'trigger' => $this->trigger,
69	'user_id' => $user_id,
70	'content_id' => $content_id,
71	) );
72
73	}
74
75	/**
76	* User deserves check
77	*
78	* @since 1.0.0
79	*
80	* @param bool $deserves_trigger True if user deserves trigger, false otherwise
81	* @param stdClass $trigger The trigger object
82	* @param int $user_id The user ID
83	* @param array $event Event information
84	* @param array $trigger_options The trigger's stored options
85	* @param stdClass $automation The trigger's automation object
86	*
87	* @return bool True if user deserves trigger, false otherwise
88	*/
89	public function user_deserves_trigger( $deserves_trigger, $trigger, $user_id, $event, $trigger_options, $automation ) {
90
91	// Don't deserve if content is not received
92	if( ! isset( $event['content_id'] ) ) {
93	return false;
94	}
95
96	$content_id = absint( $event['content_id'] );
97
98	// Don't deserve if content doesn't exists
99	if( $content_id === 0 ) {
100	return false;
101	}
102
103	$required_content_id = absint( $trigger_options['content'] );
104
105	// Don't deserve if content doesn't match with the trigger option
106	if( $required_content_id !== 0 && $content_id !== $required_content_id ) {
107	return false;
108	}
109
110	return $deserves_trigger;
111
112	}
113
114	}
115
116	new AutomatorWP_H5P_Complete_Content();