blob: 92d2f4b9701926ec1725d51bd847ee5b2838b788 (
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
|
<?php
/**
* This helper builds the Footer 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 Footer object for the /mail/send API call
*
* @package SendGrid\Mail
*/
class Footer implements \JsonSerializable
{
/** @var $enable bool Indicates if this setting is enabled */
private $enable;
/** @var $text string The plain text content of your footer */
private $text;
/** @var $html string The HTML content of your footer */
private $html;
/**
* Optional constructor
*
* @param bool|null $enable Indicates if this setting is enabled
* @param string|null $text The plain text content of your footer
* @param string|null $html The HTML content of your footer
*/
public function __construct($enable = null, $text = null, $html = null)
{
if (isset($enable)) {
$this->setEnable($enable);
}
if (isset($text)) {
$this->setText($text);
}
if (isset($html)) {
$this->setHtml($html);
}
}
/**
* Update the enable setting on a Footer object
*
* @param bool $enable Indicates if this setting is enabled
*
* @throws TypeException
*/
public function setEnable($enable)
{
if (!is_bool($enable)) {
throw new TypeException('$enable must be of type bool');
}
$this->enable = $enable;
}
/**
* Retrieve the enable setting on a Footer object
*
* @return bool
*/
public function getEnable()
{
return $this->enable;
}
/**
* Add text to a Footer object
*
* @param string $text The plain text content of your footer
*
* @throws TypeException
*/
public function setText($text)
{
if (!is_string($text)) {
throw new TypeException('$text must be of type string.');
}
$this->text = $text;
}
/**
* Retrieve text to a Footer object
*
* @return string
*/
public function getText()
{
return $this->text;
}
/**
* Add html to a Footer object
*
* @param string $html The HTML content of your footer
*
* @throws TypeException
*/
public function setHtml($html)
{
if (!is_string($html)) {
throw new TypeException('$html must be of type string.');
}
$this->html = $html;
}
/**
* Retrieve html from a Footer object
*
* @return string
*/
public function getHtml()
{
return $this->html;
}
/**
* Return an array representing a Footer object for the Twilio SendGrid API
*
* @return null|array
*/
public function jsonSerialize()
{
return array_filter(
[
'enable' => $this->getEnable(),
'text' => $this->getText(),
'html' => $this->getHtml()
],
function ($value) {
return $value !== null;
}
) ?: null;
}
}
|
