gamipress / integrations / shortlinkspro / includes / triggers.php

triggers.php in GamiPress – Gamification plugin to reward points, badges & ranks in WordPress, now with AI 7.9.8, at integrations/shortlinkspro/includes/triggers.php

207 lines 6.2 KB

Raw Download Zip

1	<?php
2	/**
3	* Triggers
4	*
5	* @package GamiPress\ShortLinksPro\Triggers
6	* @since 1.0.0
7	*/
8
9	// Exit if accessed directly
10	if( !defined( 'ABSPATH' ) ) exit;
11
12	/**
13	* Register plugin specific triggers
14	*
15	* @since 1.0.0
16	*
17	* @param array $triggers
18	* @return mixed
19	*/
20	function gamipress_shortlinkspro_activity_triggers( $triggers ) {
21
22	$triggers[__( 'ShortLinks Pro', 'gamipress' )] = array(
23	'gamipress_shortlinkspro_click' => __( 'User clicks a link', 'gamipress' ),
24	'gamipress_shortlinkspro_specific_click' => __( 'User clicks a specific link', 'gamipress' ),
25	'gamipress_shortlinkspro_click_specific_category' => __( 'User clicks a link of a category', 'gamipress' ),
26	'gamipress_shortlinkspro_click_specific_tag' => __( 'User clicks a link of a tag', 'gamipress' ),
27	);
28
29	return $triggers;
30
31	}
32	add_filter( 'gamipress_activity_triggers', 'gamipress_shortlinkspro_activity_triggers' );
33
34	/**
35	* Register plugin specific activity triggers
36	*
37	* @since 1.0.0
38	*
39	* @param array $specific_activity_triggers
40	* @return array
41	*/
42	function gamipress_shortlinkspro_specific_activity_triggers( $specific_activity_triggers ) {
43
44	$specific_activity_triggers['gamipress_shortlinkspro_specific_click'] = array( 'slp_links' );
45
46	return $specific_activity_triggers;
47
48	}
49	add_filter( 'gamipress_specific_activity_triggers', 'gamipress_shortlinkspro_specific_activity_triggers' );
50
51	/**
52	* Build custom activity trigger label
53	*
54	* @since 1.0.0
55	*
56	* @param string $title
57	* @param integer $requirement_id
58	* @param array $requirement
59	*
60	* @return string
61	*/
62	function gamipress_shortlinkspro_activity_trigger_label( $title, $requirement_id, $requirement ) {
63
64	$category = ( isset( $requirement['shortlinkspro_category'] ) ) ? $requirement['shortlinkspro_category'] : '';
65	$category_name = shortlinkspro_get_link_category_name( $category );
66	$tag = ( isset( $requirement['shortlinkspro_tag'] ) ) ? $requirement['shortlinkspro_tag'] : '';
67	$tag_name = shortlinkspro_get_link_tag_name( $tag );
68
69	switch( $requirement['trigger_type'] ) {
70	// Category field value
71	case 'gamipress_shortlinkspro_click_specific_category':
72	return sprintf( __( 'User clicks a link of %s category', 'gamipress' ), $category_name );
73	break;
74	// Tag field value
75	case 'gamipress_shortlinkspro_click_specific_tag':
76	return sprintf( __( 'User clicks a link of %s tag', 'gamipress' ), $tag_name );
77	break;
78	}
79
80	return $title;
81	}
82	add_filter( 'gamipress_activity_trigger_label', 'gamipress_shortlinkspro_activity_trigger_label', 10, 3 );
83
84	/**
85	* Register plugin specific activity triggers labels
86	*
87	* @since 1.0.0
88	*
89	* @param array $specific_activity_trigger_labels
90	* @return array
91	*/
92	function gamipress_shortlinkspro_specific_activity_trigger_label( $specific_activity_trigger_labels ) {
93
94	$specific_activity_trigger_labels['gamipress_shortlinkspro_specific_click'] = __( 'User clicks %s', 'gamipress' );
95
96	return $specific_activity_trigger_labels;
97
98	}
99	add_filter( 'gamipress_specific_activity_trigger_label', 'gamipress_shortlinkspro_specific_activity_trigger_label' );
100
101	/**
102	* Get plugin specific activity trigger post title
103	*
104	* @since 1.0.0
105	*
106	* @param string $post_title
107	* @param integer $specific_id
108	* @param string $trigger_type
109	* @return string
110	*/
111	function gamipress_shortlinkspro_specific_activity_trigger_post_title( $post_title, $specific_id, $trigger_type ) {
112
113	global $wpdb;
114
115	switch ($trigger_type) {
116	case 'gamipress_shortlinkspro_specific_click':
117
118	if( absint( $specific_id ) !== 0 ) {
119
120	// Get the link title
121	$link_title = shortlinkspro_get_link_title( $specific_id );
122
123	$post_title = $link_title;
124	}
125	break;
126	}
127
128	return $post_title;
129
130	}
131	add_filter( 'gamipress_specific_activity_trigger_post_title', 'gamipress_shortlinkspro_specific_activity_trigger_post_title', 10, 3 );
132
133
134	/**
135	* Get user for a given trigger action.
136	*
137	* @since 1.0.0
138	*
139	* @param integer $user_id user ID to override.
140	* @param string $trigger Trigger name.
141	* @param array $args Passed trigger args.
142	* @return integer User ID.
143	*/
144	function gamipress_shortlinkspro_trigger_get_user_id( $user_id, $trigger, $args ) {
145
146	switch ( $trigger ) {
147	case 'gamipress_shortlinkspro_click':
148	case 'gamipress_shortlinkspro_specific_click':
149	case 'gamipress_shortlinkspro_click_specific_category':
150	case 'gamipress_shortlinkspro_click_specific_tag':
151	$user_id = $args[1];
152	break;
153	}
154
155	return $user_id;
156
157	}
158	add_filter( 'gamipress_trigger_get_user_id', 'gamipress_shortlinkspro_trigger_get_user_id', 10, 3 );
159
160	/**
161	* Get the id for a given specific trigger action.
162	*
163	* @since 1.0.0
164	*
165	* @param integer $specific_id Specific ID.
166	* @param string $trigger Trigger name.
167	* @param array $args Passed trigger args.
168	*
169	* @return integer Specific ID.
170	*/
171	function gamipress_shortlinkspro_specific_trigger_get_id( $specific_id, $trigger = '', $args = array() ) {
172
173	switch( $trigger ) {
174	case 'gamipress_shortlinkspro_specific_click':
175	$specific_id = $args[0];
176	}
177	return $specific_id;
178
179	}
180	add_filter( 'gamipress_specific_trigger_get_id', 'gamipress_shortlinkspro_specific_trigger_get_id', 10, 3 );
181
182	/**
183	* Extended meta data for event trigger logging
184	*
185	* @since 1.0.0
186	*
187	* @param array $log_meta
188	* @param integer $user_id
189	* @param string $trigger
190	* @param integer $site_id
191	* @param array $args
192	*
193	* @return array
194	*/
195	function gamipress_shortlinkspro_log_event_trigger_meta_data( $log_meta, $user_id, $trigger, $site_id, $args ) {
196
197	switch ($trigger) {
198	case 'gamipress_shortlinkspro_click':
199	case 'gamipress_shortlinkspro_specific_click':
200	// Add the link ID
201	$log_meta['link_id'] = $args[0];
202	break;
203	}
204
205	return $log_meta;
206	}
207	add_filter( 'gamipress_log_event_trigger_meta_data', 'gamipress_shortlinkspro_log_event_trigger_meta_data', 10, 5 );