NotificationChannels\Apn\ApnMessage

Complexity

Total Complexity

14

Size/Duplication

Total Lines	267
Duplicated Lines	0 %

Coupling/Cohesion

Components	10
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes	6
Bugs	1	Features	0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	create()	0	4	1
A	__construct()	0	7	1
A	title()	0	6	1
A	body()	0	6	1
A	badge()	0	6	1
A	sound()	0	6	1
A	category()	0	6	1
A	contentAvailable()	0	6	1
A	custom()	0	6	1
A	setCustom()	0	6	1
A	action()	0	7	1
A	environment()	0	5	1
A	certificate()	0	5	1
A	passphrase()	0	5	1

<?php

namespace NotificationChannels\Apn;

class ApnMessage
{
    /**
     * The title of the notification.
     *
     * @var string
     */
    public $title;

    /**
     * The body of the notification.
     *
     * @var string
     */
    public $body;

    /**
     * The badge of the notification.
     *
     * @var int
     */
    public $badge;

    /**
     * The sound for the notification.
     *
     * @var string|null
     */
    public $sound;

    /**
     * The category for action button.
     *
     * @var string|null
     * */
    public $category;

    /**
     * Value indicating incoming resource in the notification.
     *
     * @var int|null
     */
    public $contentAvailable = null;

    /**
     * Additional data of the notification.
     *
     * @var array
     */
    public $custom = [];
    
    /**
     * APN Environment
     * 
     * @var int 
     */
    public $environment = null;
    
    /**
     * APN Certificate path
     * 
     * @var string 
     */
    public $certificate = '';
    
    /**
     * APN Certificate Passphrase
     * 
     * @var string 
     */
    public $passphrase = '';

    /**
     * @param string|null $title
     * @param string|null $body
     * @param array $custom
     * @param null|int $badge
     *
     * @return static
     */
    public static function create($title = null, $body = null, $custom = [], $badge = null)
    {
        return new static($title, $body, $custom, $badge);
    }

    /**
     * @param string|null $title
     * @param string|null $body
     * @param array $custom
     * @param null|int $badge
     */
    public function __construct($title = null, $body = null, $custom = [], $badge = null)
    {
        $this->title = $title;
        $this->body = $body;
        $this->custom = $custom;
        $this->badge = $badge;
    }

    /**
     * Set the alert title of the notification.
     *
     * @param string $title
     *
     * @return $this
     */
    public function title($title)
    {
        $this->title = $title;

        return $this;
    }

    /**
     * Set the alert message of the notification.
     *
     * @param string $body
     *
     * @return $this
     */
    public function body($body)
    {
        $this->body = $body;

        return $this;
    }

    /**
     * Set the badge of the notification.
     *
     * @param int $badge
     *
     * @return $this
     */
    public function badge($badge)
    {
        $this->badge = $badge;

        return $this;
    }

    /**
     * Set the sound for the notification.
     *
     * @param string|null $sound
     *
     * @return $this
     */
    public function sound($sound = 'default')
    {
        $this->sound = $sound;

        return $this;
    }

    /**
     * Set category for this notification.
     *
     * @param string|null $category
     *
     * @return $this
     * */
    public function category($category)
    {
        $this->category = $category;

        return $this;
    }

    /**
     * Set content available value for this notification.
     *
     * @param int $value
     *
     * @return $this
     */
    public function contentAvailable($value = 1)
    {
        $this->contentAvailable = $value;

        return $this;
    }

    /**
     * Add custom data to the notification.
     *
     * @param string $key
     * @param mixed $value
     *
     * @return $this
     */
    public function custom($key, $value)
    {
        $this->custom[$key] = $value;

        return $this;
    }

    /**
     * Override the data of the notification.
     *
     * @param array $custom
     *
     * @return $this
     */
    public function setCustom($custom)
    {
        $this->custom = $custom;

        return $this;
    }

    /**
     * Add an action to the notification.
     *
     * @param string $action
     * @param mixed $params
     *
     * @return $this
     */
    public function action($action, $params = null)
    {
        return $this->custom('action', [
            'action' => $action,
            'params' => $params,
        ]);
    }
    
    /**
     * Set the APN Environment
     * 
     * @param int $environment
     *
     * @return $this
     */
    public function environment($environment) {
        $this->environment = $environment;
        
        return $this;
    }
    
    /** 
     * Set the APN Certificate path
     * 
     * @param string $certificate
     * 
     * @return $this
     */
    public function certificate($certificate) {
        $this->certificate = $certificate;
        
        return $this;
    }
    
    /**
     *  Set the APN Certificate passphrase
     * 
     * @param string $passphrase
     * 
     * @return $this
     */
    public function passphrase($passphrase) {
        $this->passphrase = $passphrase;
        
        return $this;
    }
}