Viewing file:  ClickTracking.php (2.65 KB) -rw-rw-r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
/**
* This helper builds the ClickTracking object for a /mail/send API call
*/
namespace SendGrid\Mail;
use SendGrid\Helper\Assert;
/**
* This class is used to construct a ClickTracking object for the /mail/send API call
*
* @package SendGrid\Mail
*/
class ClickTracking implements \JsonSerializable
{
/** @var $enable bool Indicates if this setting is enabled */
private $enable;
/* @var $enable_text bool Indicates if this setting should be included in the text/plain portion of your email */
private $enable_text;
/**
* Optional constructor
*
* @param bool|null $enable Indicates if this setting is enabled
* @param bool|null $enable_text Indicates if this setting should be
* included in the text/plain portion of
* your email
* @throws \SendGrid\Mail\TypeException
*/
public function __construct($enable = null, $enable_text = null)
{
if (isset($enable)) {
$this->setEnable($enable);
}
if (isset($enable_text)) {
$this->setEnableText($enable_text);
}
}
/**
* Update the enable setting on a ClickTracking object
*
* @param bool $enable Indicates if this setting is enabled
*
* @throws \SendGrid\Mail\TypeException
*/
public function setEnable($enable)
{
Assert::boolean($enable, 'enable');
$this->enable = $enable;
}
/**
* Retrieve the enable setting on a ClickTracking object
*
* @return bool
*/
public function getEnable()
{
return $this->enable;
}
/**
* Update the enable text setting on a ClickTracking object
*
* @param bool $enable_text Indicates if this setting is enabled
*
* @throws \SendGrid\Mail\TypeException
*/
public function setEnableText($enable_text)
{
Assert::boolean($enable_text, 'enable_text');
$this->enable_text = $enable_text;
}
/**
* Retrieve the enable_text setting on a ClickTracking object
*
* @return bool
*/
public function getEnableText()
{
return $this->enable_text;
}
/**
* Return an array representing a ClickTracking object for the Twilio SendGrid API
*
* @return null|array
*/
#[\ReturnTypeWillChange]
public function jsonSerialize()
{
return array_filter(
[
'enable' => $this->getEnable(),
'enable_text' => $this->getEnableText()
],
function ($value) {
return $value !== null;
}
) ?: null;
}
}
|