|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
namespace TestMonitor\ActiveCampaign\Actions; |
|
4
|
|
|
|
|
5
|
|
|
use TestMonitor\ActiveCampaign\Resources\Tag; |
|
6
|
|
|
use TestMonitor\ActiveCampaign\Resources\Contact; |
|
7
|
|
|
use TestMonitor\ActiveCampaign\Resources\Automation; |
|
8
|
|
|
use TestMonitor\ActiveCampaign\Resources\ContactTag; |
|
9
|
|
|
use TestMonitor\ActiveCampaign\Resources\ContactAutomation; |
|
10
|
|
|
|
|
11
|
|
|
trait ManagesContacts |
|
12
|
|
|
{ |
|
13
|
|
|
/** |
|
14
|
|
|
* Get all contacts. |
|
15
|
|
|
* |
|
16
|
|
|
* @return array |
|
17
|
|
|
*/ |
|
18
|
|
|
public function contacts() |
|
19
|
|
|
{ |
|
20
|
|
|
return $this->transformCollection( |
|
|
|
|
|
|
21
|
|
|
$this->get('contacts'), |
|
|
|
|
|
|
22
|
|
|
Contact::class, |
|
23
|
|
|
'contacts' |
|
24
|
|
|
); |
|
25
|
|
|
} |
|
26
|
|
|
|
|
27
|
|
|
/** |
|
28
|
|
|
* Find contact by email. |
|
29
|
|
|
* |
|
30
|
|
|
* @param string $email |
|
31
|
|
|
* |
|
32
|
|
|
* @return Contact|null |
|
33
|
|
|
*/ |
|
34
|
|
|
public function findContact($email) |
|
35
|
|
|
{ |
|
36
|
|
|
$contacts = $this->transformCollection( |
|
|
|
|
|
|
37
|
|
|
$this->get('contacts', ['query' => ['email' => $email]]), |
|
|
|
|
|
|
38
|
|
|
Contact::class, |
|
39
|
|
|
'contacts' |
|
40
|
|
|
); |
|
41
|
|
|
|
|
42
|
|
|
return array_shift($contacts); |
|
43
|
|
|
} |
|
44
|
|
|
|
|
45
|
|
|
/** |
|
46
|
|
|
* Find contact by ID. |
|
47
|
|
|
* |
|
48
|
|
|
* @param int $id |
|
49
|
|
|
* |
|
50
|
|
|
* @return Contact|null |
|
51
|
|
|
*/ |
|
52
|
|
|
public function findContactById($id) |
|
53
|
|
|
{ |
|
54
|
|
|
$contacts = $this->transformCollection( |
|
|
|
|
|
|
55
|
|
|
$this->get('contacts', ['query' => ['id' => $id]]), |
|
|
|
|
|
|
56
|
|
|
Contact::class, |
|
57
|
|
|
'contacts' |
|
58
|
|
|
); |
|
59
|
|
|
|
|
60
|
|
|
return array_shift($contacts); |
|
61
|
|
|
} |
|
62
|
|
|
|
|
63
|
|
|
/** |
|
64
|
|
|
* Create new contact. |
|
65
|
|
|
* |
|
66
|
|
|
* @param string $email |
|
67
|
|
|
* @param string $firstName |
|
68
|
|
|
* @param string $lastName |
|
69
|
|
|
* @param int|null $orgid |
|
70
|
|
|
* |
|
71
|
|
|
* @return Contact|null |
|
72
|
|
|
*/ |
|
73
|
|
|
public function createContact($email, $firstName, $lastName, $orgid = null) |
|
74
|
|
|
{ |
|
75
|
|
|
$contacts = $this->transformCollection( |
|
|
|
|
|
|
76
|
|
|
$this->post('contacts', ['json' => ['contact' => compact('email', 'firstName', 'lastName', 'orgid')]]), |
|
|
|
|
|
|
77
|
|
|
Contact::class |
|
78
|
|
|
); |
|
79
|
|
|
|
|
80
|
|
|
return array_shift($contacts); |
|
81
|
|
|
} |
|
82
|
|
|
|
|
83
|
|
|
/** |
|
84
|
|
|
* Find or create a contact. |
|
85
|
|
|
* |
|
86
|
|
|
* @param string $email |
|
87
|
|
|
* @param string $firstName |
|
88
|
|
|
* @param string $lastName |
|
89
|
|
|
* @param int|null $orgid |
|
90
|
|
|
* |
|
91
|
|
|
* @return Contact |
|
92
|
|
|
*/ |
|
93
|
|
|
public function findOrCreateContact($email, $firstName, $lastName, $orgid = null) |
|
94
|
|
|
{ |
|
95
|
|
|
$contact = $this->findContact($email); |
|
96
|
|
|
|
|
97
|
|
|
if ($contact instanceof Contact) { |
|
98
|
|
|
return $contact; |
|
99
|
|
|
} |
|
100
|
|
|
|
|
101
|
|
|
return $this->createContact($email, $firstName, $lastName, $orgid); |
|
102
|
|
|
} |
|
103
|
|
|
|
|
104
|
|
|
/** |
|
105
|
|
|
* Updates a contact. |
|
106
|
|
|
* |
|
107
|
|
|
* @param Contact|int|string $id |
|
108
|
|
|
* @param string|null $email |
|
109
|
|
|
* @param string|null $firstName |
|
110
|
|
|
* @param string|null $lastName |
|
111
|
|
|
* @param null $orgid |
|
112
|
|
|
* |
|
113
|
|
|
* @return Contact|null |
|
114
|
|
|
*/ |
|
115
|
|
|
public function updateContact($id, $email, $firstName, $lastName, $orgid = null) |
|
116
|
|
|
{ |
|
117
|
|
|
$id = $this->getContactId($id); |
|
118
|
|
|
|
|
119
|
|
|
$this->put('contacts/'.$id, ['json' => ['contact' => compact('email', 'firstName', 'lastName', 'orgid')]]); |
|
|
|
|
|
|
120
|
|
|
|
|
121
|
|
|
return $this->findContactById($id); |
|
122
|
|
|
} |
|
123
|
|
|
|
|
124
|
|
|
/** |
|
125
|
|
|
* Deletes a contact. |
|
126
|
|
|
* |
|
127
|
|
|
* @param Contact|int|string $contact |
|
128
|
|
|
*/ |
|
129
|
|
|
public function deleteContact($contact) |
|
130
|
|
|
{ |
|
131
|
|
|
$this->delete('contacts/'.$this->getContactId($contact)); |
|
|
|
|
|
|
132
|
|
|
} |
|
133
|
|
|
|
|
134
|
|
|
/** |
|
135
|
|
|
* Get all automations of a contact. |
|
136
|
|
|
* |
|
137
|
|
|
* @param \TestMonitor\ActiveCampaign\Resources\Contact $contact |
|
138
|
|
|
* |
|
139
|
|
|
* @return array |
|
140
|
|
|
*/ |
|
141
|
|
|
public function contactAutomations(Contact $contact) |
|
142
|
|
|
{ |
|
143
|
|
|
return $this->transformCollection( |
|
|
|
|
|
|
144
|
|
|
$this->get("contacts/{$contact->id}/contactAutomations"), |
|
|
|
|
|
|
145
|
|
|
ContactAutomation::class, |
|
146
|
|
|
'contactAutomations' |
|
147
|
|
|
); |
|
148
|
|
|
} |
|
149
|
|
|
|
|
150
|
|
|
/** |
|
151
|
|
|
* Get all tags of a contact. |
|
152
|
|
|
* |
|
153
|
|
|
* @param \TestMonitor\ActiveCampaign\Resources\Contact $contact |
|
154
|
|
|
* |
|
155
|
|
|
* @return array |
|
156
|
|
|
*/ |
|
157
|
|
|
public function contactTags(Contact $contact) |
|
158
|
|
|
{ |
|
159
|
|
|
return $this->transformCollection( |
|
|
|
|
|
|
160
|
|
|
$this->get("contacts/{$contact->id}/contactTags"), |
|
|
|
|
|
|
161
|
|
|
ContactTag::class, |
|
162
|
|
|
'contactTags' |
|
163
|
|
|
); |
|
164
|
|
|
} |
|
165
|
|
|
|
|
166
|
|
|
/** |
|
167
|
|
|
* Removing a automation from a contact. |
|
168
|
|
|
* |
|
169
|
|
|
* @param \TestMonitor\ActiveCampaign\Resources\Contact $contact |
|
170
|
|
|
* @param \TestMonitor\ActiveCampaign\Resources\Automation $automation |
|
171
|
|
|
*/ |
|
172
|
|
View Code Duplication |
public function removeAutomationFromContact(Contact $contact, Automation $automation) |
|
|
|
|
|
|
173
|
|
|
{ |
|
174
|
|
|
$contactAutomations = $this->contactAutomations($contact); |
|
175
|
|
|
|
|
176
|
|
|
$contactAutomation = current(array_filter($contactAutomations, function ($contactAutomation) use ($automation) { |
|
177
|
|
|
return $contactAutomation->automation == $automation->id; |
|
178
|
|
|
})); |
|
179
|
|
|
|
|
180
|
|
|
if (empty($contactAutomation)) { |
|
181
|
|
|
return; |
|
182
|
|
|
} |
|
183
|
|
|
|
|
184
|
|
|
$this->delete("contactAutomations/{$contactAutomation->id}"); |
|
|
|
|
|
|
185
|
|
|
} |
|
186
|
|
|
|
|
187
|
|
|
/** |
|
188
|
|
|
* Removing all automations from a contact. |
|
189
|
|
|
* |
|
190
|
|
|
* @param \TestMonitor\ActiveCampaign\Resources\Contact $contact |
|
191
|
|
|
*/ |
|
192
|
|
|
public function removeAllAutomationsFromContact(Contact $contact) |
|
193
|
|
|
{ |
|
194
|
|
|
$contactAutomations = $this->contactAutomations($contact); |
|
195
|
|
|
|
|
196
|
|
|
foreach ($contactAutomations as $contactAutomation) { |
|
197
|
|
|
$this->delete("contactAutomations/{$contactAutomation->id}"); |
|
|
|
|
|
|
198
|
|
|
} |
|
199
|
|
|
} |
|
200
|
|
|
|
|
201
|
|
|
/** |
|
202
|
|
|
* Removing a tag from a contact. |
|
203
|
|
|
* |
|
204
|
|
|
* @param \TestMonitor\ActiveCampaign\Resources\Contact $contact |
|
205
|
|
|
* @param \TestMonitor\ActiveCampaign\Resources\Tag $tag |
|
206
|
|
|
*/ |
|
207
|
|
View Code Duplication |
public function removeTagFromContact(Contact $contact, Tag $tag) |
|
|
|
|
|
|
208
|
|
|
{ |
|
209
|
|
|
$contactTags = $this->contactTags($contact); |
|
210
|
|
|
|
|
211
|
|
|
$contactTag = current(array_filter($contactTags, function ($contactTag) use ($tag) { |
|
212
|
|
|
return $contactTag->tag == $tag->id; |
|
213
|
|
|
})); |
|
214
|
|
|
|
|
215
|
|
|
if (empty($contactTag)) { |
|
216
|
|
|
return; |
|
217
|
|
|
} |
|
218
|
|
|
|
|
219
|
|
|
$this->delete("contactTags/{$contactTag->id}"); |
|
|
|
|
|
|
220
|
|
|
} |
|
221
|
|
|
|
|
222
|
|
|
/** |
|
223
|
|
|
* Determines the contact ID. |
|
224
|
|
|
* |
|
225
|
|
|
* @param Contact|int|string $contact |
|
226
|
|
|
*/ |
|
227
|
|
|
protected function getContactId($contact) |
|
228
|
|
|
{ |
|
229
|
|
|
if ($contact instanceof Contact) { |
|
230
|
|
|
return $contact->id; |
|
231
|
|
|
} elseif (is_numeric($contact)) { |
|
232
|
|
|
return (int) $contact; |
|
233
|
|
|
} else { |
|
234
|
|
|
$contact = $this->findContact($contact); |
|
235
|
|
|
return $contact->id; |
|
236
|
|
|
} |
|
237
|
|
|
} |
|
238
|
|
|
} |
|
239
|
|
|
|
This check looks for methods that are used by a trait but not required by it.
To illustrate, let’s look at the following code example
The trait
Idableprovides a methodequalsIdthat in turn relies on the methodgetId(). If this method does not exist on a class mixing in this trait, the method will fail.Adding the
getId()as an abstract method to the trait will make sure it is available.