NotificationChannels\AllMySms\AllMySmsMessage

Complexity

Total Complexity

8

Size/Duplication

Total Lines	141
Duplicated Lines	0 %

Test Coverage

Coverage

96.15%

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	parameters()	0	5	1
A	sendAt()	0	9	2
A	sender()	0	5	1
A	campaign()	0	5	1
A	__construct()	0	3	1
A	toArray()	0	8	1
A	content()	0	5	1

<?php

namespace NotificationChannels\AllMySms;

use DateTime;
use DateTimeInterface;

class AllMySmsMessage
{
    const DATE_FORMAT = 'Y-m-d H:i:s';

    /**
     * The message content.
     *
     * @var string
     */
    public $content;

    /**
     * The sender name the message should sent from.
     *
     * @var string|null
     */
    public $sender;

    /**
     * The (optional) campaign name.
     *
     * @var string|null
     */
    public $campaign;

    /**
     * The (optional) date the message should sent at.
     *
     * @var string|null
     */
    public $sendAt;

    /**
     * The content parameters values.
     *
     * If you want to use parameters in your message you should add the following placeholder in your content:
     * "#param_x#" where x is the 1-based index of parameters array.
     *
     * <code>
     * $message->content("Hello #param_1# #param_2#")
     *     ->parameters([$user->first_name, $user->last_name]);
     * </code>
     *
     * @var array|null
     */
    public $parameters;

    /**
     * Create a new message instance.
     *
     * @param  string  $content
     * @return void
     */
    public function __construct(string $content = '')
    {
        $this->content = $content;
    }

    /**
     * Set message content.
     *
     * @param  string  $content
     * @return $this
     */
    public function content(string $content)
    {
        $this->content = $content;

        return $this;
    }

    /**
     * Set the sender name the message should sent from.
     *
     * @param  string  $sender
     * @return $this
     */
    public function sender(string $sender)
    {
        $this->sender = $sender;

        return $this;
    }

    /**
     * Set the campaign name.
     *
     * @param  string  $campaign
     * @return $this
     */
    public function campaign(string $campaign)
    {
        $this->campaign = $campaign;

        return $this;
    }

    /**
     * Set the date the message should sent at.
     *
     * @param  \DateTimeInterface|string  $sendAt
     * @return $this
     * @throws \Exception
     */
    public function sendAt($sendAt)
    {
        if (! $sendAt instanceof DateTimeInterface) {
            $sendAt = new DateTime($sendAt);
        }

        $this->sendAt = $sendAt->format(static::DATE_FORMAT);

        return $this;
    }

    /**
     * Set the message parameters.
     *
     * @param  array  $parameters
     * @return $this
     */
    public function parameters(array $parameters)
    {
        $this->parameters = $parameters;

        return $this;
    }

    /**
     * Get array representation of the message.
     *
     * @return array
     */
    public function toArray(): array
    {
        return [
            'message' => $this->content,
            'sender' => $this->sender,
            'campaign' => $this->campaign,
            'date' => $this->sendAt,
            'parameters' => $this->parameters,
        ];
    }
}