Contents

Code Reference Classes Sync

Sync

Class for all syncing related functions

Description

Source

File: bp-integrations/learndash/learndash/Sync.php

22
23
24
25
26
27
28
29
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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
class Sync
{
    // temporarily hold the synced learndash group id just before delete
    protected $deletingSyncedBpGroupId;
 
    /**
     * Constructor
     *
     * @since BuddyBoss 1.0.0
     */
    public function __construct()
    {
        add_action('bp_ld_sync/init', [$this, 'init']);
    }
 
    /**
     * Add actions once integration is ready
     *
     * @since BuddyBoss 1.0.0
     */
    public function init()
    {
        add_action('bp_ld_sync/learndash_group_updated', [$this, 'onGroupUpdated']);
        add_action('bp_ld_sync/learndash_group_deleting', [$this, 'onGroupDeleting']);
        add_action('bp_ld_sync/learndash_group_deleted', [$this, 'onGroupDeleted']);
 
        add_action('bp_ld_sync/learndash_group_admin_added', [$this, 'onAdminAdded'], 10, 2);
        add_action('bp_ld_sync/learndash_group_user_added', [$this, 'onUserAdded'], 10, 2);
 
        add_action('bp_ld_sync/learndash_group_admin_removed', [$this, 'onAdminRemoved'], 10, 2);
        add_action('bp_ld_sync/learndash_group_user_removed', [$this, 'onUserRemoved'], 10, 2);
    }
 
    /**
     * Get Sync generator object
     *
     * @since BuddyBoss 1.0.0
     */
    public function generator($bpGroupId = null, $ldGroupId = null)
    {
        return new SyncGenerator($bpGroupId, $ldGroupId);
    }
 
    /**
     * Run the sync when new group is created / updated
     *
     * @since BuddyBoss 1.0.0
     */
    public function onGroupUpdated( $groupId ) {
        if ( ! $this->preCheck() ) {
            return false;
        }
 
        // created from backend
        if ( bp_ld_sync()->isRequestExists( 'bp-ld-sync-enable' ) && ! bp_ld_sync()->getRequest( 'bp-ld-sync-enable' ) ) {
            $group_id = get_post_meta( $groupId, '_sync_group_id', true );
            if ( ! empty( $group_id ) ) {
                bp_ld_sync( 'buddypress' )->sync->generator( $group_id )->desyncFromLearndash();
            }
 
            return false;
        }
 
        // created programmatically
        //if ( ! bp_ld_sync( 'settings' )->get( 'learndash.default_auto_sync' ) ) {
            //return false;
        //}
 
        $newGroup  = bp_ld_sync()->getRequest( 'bp-ld-sync-id', null );
        $generator = $this->generator( null, $groupId );
 
        if ( $generator->hasBpGroup() && $generator->getBpGroupId() == $newGroup ) {
            $generator->fullSyncToBuddypress();
 
            return false;
        }
 
        $generator->associateToBuddypress( $newGroup )->syncLdAdmins()->syncLdUsers();
    }
 
    /**
     * Set the deleted gropu in temporarly variable for later use
     *
     * @since BuddyBoss 1.0.0
     */
    public function onGroupDeleting($groupId)
    {
        if (! $this->preCheck()) {
            return false;
        }
 
        $this->deletingSyncedBpGroupId = $this->generator(null, $groupId)->getBpGroupId();
    }
 
    /**
     * Desync when group is deleted
     *
     * @since BuddyBoss 1.0.0
     */
    public function onGroupDeleted($groupId)
    {
        if (! $bpGroupId = $this->deletingSyncedBpGroupId) {
            return;
        }
 
        $this->deletingSyncedBpGroupId = null;
 
        if (! bp_ld_sync('settings')->get('learndash.delete_bp_on_delete')) {
            $this->generator($bpGroupId)->desyncFromLearndash();
            return;
        }
 
        $this->generator()->deleteBpGroup($bpGroupId);
    }
 
    /**
     * Sync when a admin is added to the group
     *
     * @since BuddyBoss 1.0.0
     */
    public function onAdminAdded($groupId, $userId)
    {
        if (! $generator = $this->groupUserEditCheck('admin', $groupId)) {
            return false;
        }
 
        $generator->syncLdAdmin($userId);
    }
 
    /**
     * Sync when a user is added to the group
     *
     * @since BuddyBoss 1.0.0
     */
    public function onUserAdded($groupId, $userId)
    {
        if (! $generator = $this->groupUserEditCheck('user', $groupId)) {
            return false;
        }
 
        $generator->syncLdUser($userId);
    }
 
    /**
     * Sync when a admin is removed from the group
     *
     * @since BuddyBoss 1.0.0
     */
    public function onAdminRemoved($groupId, $userId)
    {
        if (! $generator = $this->groupUserEditCheck('admin', $groupId)) {
            return false;
        }
 
        $generator->syncLdAdmin($userId, true);
    }
 
    /**
     * Sync when a user is removed from the group
     *
     * @since BuddyBoss 1.0.0
     */
    public function onUserRemoved($groupId, $userId)
    {
        if (! $generator = $this->groupUserEditCheck('user', $groupId)) {
            return false;
        }
 
        $generator->syncLdUser($userId, true);
    }
 
    /**
     * Check if the user type need to be synced
     *
     * @since BuddyBoss 1.0.0
     */
    protected function groupUserEditCheck($role, $groupId)
    {
        if (! $this->preCheck()) {
            return false;
        }
 
        if ('none' == bp_ld_sync('settings')->get("learndash.default_{$role}_sync_to")) {
            return false;
        }
 
        $generator = $this->generator(null, $groupId);
 
        if (! $generator->hasBpGroup()) {
            return false;
        }
 
        return $generator;
    }
 
    /**
     * Standard pre check bore all sync happens
     *
     * @since BuddyBoss 1.0.0
     */
    protected function preCheck()
    {
        global $bp_ld_sync__syncing_to_learndash;
 
        // if it's group is created from buddypress sync, don't need to sync back
        if ($bp_ld_sync__syncing_to_learndash) {
            return false;
        }
 
        return bp_ld_sync('settings')->get('learndash.enabled');
    }
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
BuddyBoss 1.0.0 Introduced.

Methods

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.