gamipress / integrations / forminator / includes / rules-engine.php

rules-engine.php in GamiPress – Gamification plugin to reward points, badges & ranks in WordPress, now with AI 8.0.2, at integrations/forminator/includes/rules-engine.php

119 lines 4.2 KB

Raw Download Zip

1	<?php
2	/**
3	* Rules Engine
4	*
5	* @package GamiPress\Forminator\Rules_Engine
6	* @since 1.0.0
7	*/
8	// Exit if accessed directly
9	if( !defined( 'ABSPATH' ) ) exit;
10
11	/**
12	* Checks if given requirement meets the requirements of triggered event
13	*
14	* @since 1.0.0
15	*
16	* @param int $requirement_id
17	* @param string $trigger
18	* @param array $args
19	*
20	* @return bool
21	*/
22	function gamipress_forminator_check_if_meets_requirements( $requirement_id, $trigger, $args ) {
23
24	// Initialize the return value
25	$return = true;
26
27	// If is between score trigger, rules engine needs to check if field name and values matches required ones
28	if( $return && ( $trigger === 'gamipress_forminator_form_field_value_submission'
29	\|\| $trigger === 'gamipress_forminator_specific_form_field_value_submission'
30	\|\| $trigger === 'gamipress_forminator_poll_field_value_submission'
31	\|\| $trigger === 'gamipress_forminator_specific_poll_field_value_submission'
32	\|\| $trigger === 'gamipress_forminator_quiz_field_value_submission'
33	\|\| $trigger === 'gamipress_forminator_specific_quiz_field_value_submission' ) ) {
34
35	$field_name = $args[2];
36	$field_value = $args[3];
37
38	$required_field_name = get_post_meta( $requirement_id, '_gamipress_forminator_field_name', true );
39	$required_field_value = get_post_meta( $requirement_id, '_gamipress_forminator_field_value', true );
40
41	// First, check if field name matches the required one
42	$return = (bool) ( $field_name === $required_field_name );
43
44	if( $return ) {
45	// Check if field value matches the required one (with support for arrays)
46	if( is_array( $field_value ) )
47	$return = (bool) ( in_array( $required_field_value, $field_value ) );
48	else
49	$return = (bool) ( $field_value === $required_field_value );
50	}
51	}
52
53	return $return;
54
55	}
56
57	/**
58	* Filter triggered requirements to reduce the number of requirements to check by the awards engine
59	*
60	* @since 1.0.0
61	*
62	* @param array $triggered_requirements
63	* @param integer $user_id
64	* @param string $trigger
65	* @param integer $site_id
66	* @param array $args
67	*
68	* @return array
69	*/
70	function gamipress_forminator_filter_triggered_requirements( $triggered_requirements, $user_id, $trigger, $site_id, $args ) {
71
72	$new_requirements = array();
73
74	foreach( $triggered_requirements as $i => $requirement ) {
75
76	// Skip item
77	if( ! gamipress_forminator_check_if_meets_requirements( $requirement->ID, $trigger, $args ) ) {
78	continue;
79	}
80
81	// Keep the requirement on the list of requirements to check by the awards engine
82	$new_requirements[] = $requirement;
83
84	}
85
86	return $new_requirements;
87
88	}
89	add_filter( 'gamipress_get_triggered_requirements', 'gamipress_forminator_filter_triggered_requirements', 20, 5 );
90
91	/**
92	* Checks if an user is allowed to work on a given requirement related to a minimum of score
93	*
94	* @since 1.0.0
95	*
96	* @param bool $return The default return value
97	* @param int $user_id The given user's ID
98	* @param int $requirement_id The given requirement's post ID
99	* @param string $trigger The trigger triggered
100	* @param int $site_id The site id
101	* @param array $args Arguments of this trigger
102	*
103	* @return bool True if user has access to the requirement, false otherwise
104	*/
105	function gamipress_forminator_user_has_access_to_achievement( $return = false, $user_id = 0, $requirement_id = 0, $trigger = '', $site_id = 0, $args = array() ) {
106
107	// If we're not working with a requirement, bail here
108	if ( ! in_array( get_post_type( $requirement_id ), gamipress_get_requirement_types_slugs() ) )
109	return $return;
110
111	// Check if user has access to the achievement ($return will be false if user has exceed the limit or achievement is not published yet)
112	if( ! $return )
113	return $return;
114
115	// Send back our eligibility
116	return gamipress_forminator_check_if_meets_requirements( $requirement_id, $trigger, $args );
117
118	}
119	add_filter( 'user_has_access_to_achievement', 'gamipress_forminator_user_has_access_to_achievement', 10, 6 );