blob: c5f36435c9b7a01579e733c8896aecfceeace2bb (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
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
|
<?php
/**
* This helper builds the Asm object for a /mail/send API call
*
* PHP Version - 5.6, 7.0, 7.1, 7.2
*
* @package SendGrid\Mail
* @author Elmer Thomas <dx@sendgrid.com>
* @copyright 2018-19 Twilio SendGrid
* @license https://opensource.org/licenses/MIT The MIT License
* @version GIT: <git_id>
* @link http://packagist.org/packages/sendgrid/sendgrid
*/
namespace SendGrid\Mail;
/**
* This class is used to construct a Asm object for the /mail/send API call
*
* @package SendGrid\Mail
*/
class Asm implements \JsonSerializable
{
/** @var $group_id int The unsubscribe group to associate with this email */
private $group_id;
/**
* @var $groups_to_display int[] An array containing the unsubscribe groups that you
* would like to be displayed on the unsubscribe preferences page.
*/
private $groups_to_display;
/**
* Optional constructor
*
* @param int|GroupId|null $group_id A GroupId object or the
* unsubscribe group to
* associate with this email
* @param int[]|GroupsToDisplay|null $groups_to_display A GroupsToDisplay
* object or an array
* containing the
* unsubscribe groups
* that you would like
* to be displayed
* on the unsubscribe
* preferences page.
*/
public function __construct(
$group_id = null,
$groups_to_display = null
) {
if (isset($group_id)) {
$this->setGroupId($group_id);
}
if (isset($groups_to_display)) {
$this->setGroupsToDisplay($groups_to_display);
}
}
/**
* Add the group id to a Asm object
*
* @param int|GroupId $group_id The unsubscribe group to associate with this
* email
*
* @throws TypeException
*/
public function setGroupId($group_id)
{
if ($group_id instanceof GroupId) {
$this->group_id = $group_id->getGroupId();
} else {
if (!is_int($group_id)) {
throw new TypeException(
'$group_id must be an instance of Twilio SendGrid\Mail\GroupId or of type int.'
);
}
$this->group_id = new GroupId($group_id);
}
return;
}
/**
* Retrieve the GroupId object from a Asm object
*
* The unsubscribe group to associate with this email
*
* @return int
*/
public function getGroupId()
{
return $this->group_id;
}
/**
* Add the groups to display id(s) to a Asm object
*
* @param int[]|GroupsToDisplay $groups_to_display A GroupsToDisplay
* object or an array
* containing the
* unsubscribe groups
* that you would like
* to be displayed
* on the unsubscribe
* preferences page.
*
* @throws TypeException
*/
public function setGroupsToDisplay($groups_to_display)
{
if ($groups_to_display instanceof GroupsToDisplay) {
$this->groups_to_display = $groups_to_display->getGroupsToDisplay();
} else {
if (!is_array($groups_to_display)) {
throw new TypeException(
'$groups_to_display must be an instance of Twilio SendGrid\Mail\GroupsToDisplay or of type array.'
);
}
$this->groups_to_display = new GroupsToDisplay($groups_to_display);
}
return;
}
/**
* Retrieve the groups to display id(s) from a Asm object
*
* @return int[]
*/
public function getGroupsToDisplay()
{
return $this->groups_to_display;
}
/**
* Return an array representing a Asm object for the Twilio SendGrid API
*
* @return null|array
*/
public function jsonSerialize()
{
return array_filter(
[
'group_id' => $this->getGroupId(),
'groups_to_display' => $this->getGroupsToDisplay()
],
function ($value) {
return $value !== null;
}
) ?: null;
}
}
|
