LLMS_Achievements

Main Achievements singleton

Contents

Description Description

See also See also

Top ↑

Source Source

File: includes/class.llms.achievements.php

30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
class LLMS_Achievements {
 
    use LLMS_Trait_Singleton,
        LLMS_Trait_Award_Default_Images;
 
    /**
     * List of available achievement types.
     *
     * @var array
     */
    public $achievements = array();
 
    /**
     * The ID for the award type.
     *
     * Used by {@see LLMS_Trait_Award_Default_Images}.
     *
     * @var string
     */
    protected $award_type = 'achievement';
 
    /**
     * Deprecated.
     *
     * @deprecated 6.0.0 Unused public class property `LLMS_Achievements::$content` is deprecated with no replacement.
     *
     * @var null
     */
    public $content;
 
    /**
     * Constructor.
     *
     * @since 1.0.0
     * @since 3.24.0 Unknown.
     *
     * @return void
     */
    private function __construct() {
        $this->init();
    }
 
    /**
     * Includes achievement class.
     *
     * @since 1.0.0
     * @since 6.0.0 Removed loading of class files that don't instantiate their class in favor of autoloading.
     *
     * @return void
     */
    public function init() {
 
        $this->achievements['LLMS_Achievement_User'] = include_once 'achievements/class.llms.achievement.user.php';
    }
 
    /**
     * Get a list of achievement Achievement Template IDs for a given post.
     *
     * @since 3.24.0
     * @since 5.3.3 Set the query limit to 500.
     *
     * @param array|int $post_ids         Post IDs or single post ID to look for achievements by.
     * @param bool      $include_children If true, will include course children (sections, lessons, and quizzes).
     * @return array
     */
    public function get_achievements_by_post( $post_ids, $include_children = true ) {
 
        if ( ! is_array( $post_ids ) ) {
            $post_ids = array( $post_ids );
        }
 
        $original_post_ids = $post_ids;
 
        if ( $include_children ) {
 
            foreach ( $post_ids as $post_id ) {
                if ( 'course' === get_post_type( $post_id ) ) {
                    $course   = llms_get_post( $post_id );
                    $post_ids = array_merge(
                        $post_ids,
                        $course->get_sections( 'ids' ),
                        $course->get_lessons( 'ids' ),
                        $course->get_quizzes()
                    );
                }
            }
        }
 
        /**
         * Filters the query args to retrieve the achievements by post.
         *
         * @since 5.3.3
         *
         * @param array     $args              The query args to retrieve the achievements by post.
         * @param array|int $post_ids          Post IDs or single post ID to look for achievements by.
         * @param bool      $include_children  If true, will include course children (sections, lessons, and quizzes).
         */
        $query_args = apply_filters(
            'llms_achievements_by_post_query_args',
            array(
                'post_type'      => 'llms_engagement',
                'meta_query'     => array(
                    array(
                        'key'   => '_llms_engagement_type',
                        'value' => 'achievement',
                    ),
                    array(
                        'compare' => 'IN',
                        'key'     => '_llms_engagement_trigger_post',
                        'value'   => $post_ids,
                    ),
                ),
                'posts_per_page' => 500,
            ),
            $original_post_ids,
            $include_children
        );
 
        $query = new WP_Query( $query_args );
 
        $achievements = array();
 
        foreach ( $query->posts as $engagement ) {
            $achievements[] = get_post_meta( $engagement->ID, '_llms_engagement', true );
        }
 
        return $achievements;
 
    }
 
    /**
     * Award an achievement to a user
     *
     * Calls trigger method passing arguments.
     *
     * @since 1.0.0
     * @deprecated 6.0.0 `LLMS_Achievements::trigger_engagement()` is deprecated in favor of `LLMS_Engagement_Handler::handle_achievement()`.
     *
     * @param int $person_id       WP_User ID.
     * @param int $achievement_id  WP_Post ID of the achievement template.
     * @param int $related_post_id WP_Post ID of the related post, for example a lesson id.
     * @return void
     */
    public function trigger_engagement( $person_id, $achievement_id, $related_post_id ) {
        _deprecated_function( 'LLMS_Achievements::trigger_engagement()', '6.0.0', 'LLMS_Engagement_Handler::handle_achievements()' );
        LLMS_Engagement_Handler::handle_achievement( array( $person_id, $achievement_id, $related_post_id, null ) );
    }
 
}

Expand full source code Collapse full source code View on GitHub

Top ↑

Methods Methods

Top ↑

Changelog Changelog

Changelog
Version Description
6.0.0 Changes:
  • Deprecated the unused public class property LLMS_Achievements::$content with no replacement.
  • Deprecated the LLMS_Achievements::trigger_engagement() method. Use the LLMS_Engagement_Handler::handle_achievement() method instead.
  • Removed the unused private LLMS_Achievements::$_from_address property.
  • Removed the unused private LLMS_Achievements::$_from_name property.
  • Removed the unused private LLMS_Achievements::$_content_type property.
  • Removed the deprecated LLMS_Achievements::$_instance property.
5.3.0 Replace singleton code with LLMS_Trait_Singleton.
3.24.0 Unknown.
1.0.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.