Message::sanitizeubstitutionData() - Code Metrics - Inspection of "Update scrutinizer configuration" - f500/swiftmailer-sparkpost - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( bc6f06...6b0db3 )

by Jasper

created 2017-01-24 20:38 UTC

Message::sanitizeubstitutionData() A

↳ Parent: Message

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	10
c	0
b	0
f	0
ccs	6
cts	6
cp	1
rs	9.4285
cc	2
eloc	5
nc	2
nop	1
crap	2

<?php

/**
 * @license https://github.com/f500/swiftmailer-sparkpost/blob/master/LICENSE Proprietary
 */

namespace SwiftSparkPost;

use Swift_Message;

/**
 * @copyright Future500 B.V.
 * @author    Jasper N. Brouwer <[email protected]>
 */
final class Message extends Swift_Message
{
    /**
     * @var string
     */
    private $campaignId;

    /**
     * @var array
     */
    private $perRecipientTags;

    /**
     * @var array
     */
    private $metadata;

    /**
     * @var array
     */
    private $perRecipientMetadata;

    /**
     * @var array
     */
    private $substitutionData;

    /**
     * @var array
     */
    private $perRecipientSubstitutionData;

    /**
     * @var array
     */
    private $options;

    /**
     * Create a new Message.
     *
     * @param string $subject
     * @param string $body
     * @param string $contentType
     * @param string $charset
     *
     * @return $this
     */
    public static function newInstance($subject = null, $body = null, $contentType = null, $charset = null)
    {
        return new self($subject, $body, $contentType, $charset);
    }

    /**
     * {@inheritdoc}
     */
    public function __construct($subject = null, $body = null, $contentType = null, $charset = null)
    {
        parent::__construct($subject, $body, $contentType, $charset);

        $this->campaignId                   = '';
        $this->perRecipientTags             = [];
        $this->metadata                     = [];
        $this->perRecipientMetadata         = [];
        $this->substitutionData             = [];
        $this->perRecipientSubstitutionData = [];

        $this->options = [
            'transactional' => true,
            'inline_css'    => true,
        ];
    }

    /**
     * @return string
     */
    public function getCampaignId()
    {
        return $this->campaignId;
    }

    /**
     * @param string $campaignId
     *
     * @return Message
     */
    public function setCampaignId($campaignId)
    {
        $this->campaignId = $campaignId;

        return $this;
    }

    /**
     * @return array
     */
    public function getPerRecipientTags()
    {
        return $this->perRecipientTags;
    }

    /**
     * @param string $recipient
     * @param array  $tags
     *
     * @return Message
     */
    public function setPerRecipientTags($recipient, array $tags)
    {
        $this->perRecipientTags[(string) $recipient] = $this->sanitizeTags($tags);

        return $this;
    }

    /**
     * @return array
     */
    public function getMetadata()
    {
        return $this->metadata;
    }

    /**
     * @param array $metadata
     *
     * @return Message
     */
    public function setMetadata(array $metadata)
    {
        $this->metadata = $this->sanitizeMetadata($metadata);

        return $this;
    }

    /**
     * @return array
     */
    public function getPerRecipientMetadata()
    {
        return $this->perRecipientMetadata;
    }

    /**
     * @param string $recipient
     * @param array  $metadata
     *
     * @return Message
     */
    public function setPerRecipientMetadata($recipient, array $metadata)
    {
        $this->perRecipientMetadata[(string) $recipient] = $this->sanitizeMetadata($metadata);

        return $this;
    }

    /**
     * @return array
     */
    public function getSubstitutionData()
    {
        return $this->substitutionData;
    }

    /**
     * @param array $substitutionData
     *
     * @return Message
     */
    public function setSubstitutionData(array $substitutionData)
    {
        $this->substitutionData = $this->sanitizeubstitutionData($substitutionData);

        return $this;
    }

    /**
     * @return array
     */
    public function getPerRecipientSubstitutionData()
    {
        return $this->perRecipientSubstitutionData;
    }

    /**
     * @param string $recipient
     * @param array  $substitutionData
     *
     * @return Message
     */
    public function setPerRecipientSubstitutionData($recipient, array $substitutionData)
    {
        $this->perRecipientSubstitutionData[(string) $recipient] = $this->sanitizeubstitutionData($substitutionData);

        return $this;
    }

    /**
     * @return array
     */
    public function getOptions()
    {
        return $this->options;
    }

    /**
     * @param array $options
     *
     * @return Message
     */
    public function setOptions(array $options)
    {
        $this->options = $this->sanitizeOptions($options);

        return $this;
    }

    /**
     * @param array $tags
     *
     * @return array
     */
    private function sanitizeTags(array $tags)
    {
        $sanitized = [];

        foreach ($tags as $tag) {
            $sanitized[] = (string) $tag;
        }

        return $sanitized;
    }

    /**
     * @param array $metadata
     *
     * @return array
     */
    private function sanitizeMetadata(array $metadata)
    {
        array_walk_recursive(
            $metadata,
            function ($value) {
                if (is_object($value) or is_resource($value)) {
// Logical operators have lower precedence:
$f = false or true;

// is executed like this:
($f = false) or true;


// Boolean operators have higher precedence:
$f = false || true;

// is executed like this:
$f = (false || true);
                    throw new Exception('Metadata cannot contain objects or resources');
                }
            }
        );

        return $metadata;
    }

    /**
     * @param array $substitutionData
     *
     * @return array
     */
    private function sanitizeubstitutionData(array $substitutionData)
    {
        $sanitized = [];

        foreach ($substitutionData as $key => $value) {
            $sanitized[(string) $key] = (string) $value;
        }

        return $sanitized;
    }

    /**
     * @param array $options
     *
     * @return array
     * @throws Exception
     */
    private function sanitizeOptions(array $options)
    {
        $sanitized = [];

        foreach ($options as $key => $value) {
            switch ($key) {
                case 'open_tracking':
                case 'click_tracking':
                case 'transactional':
                case 'sandbox':
                case 'skip_suppression':
                case 'inline_css':
                    $sanitized[$key] = (bool) $value;
                    break;
                case 'ip_pool':
                    $sanitized[$key] = (string) $value;
                    break;
                default:
                    throw new Exception(sprintf('Unknown SparkPost option "%s"', $key));
            }
        }

        return $sanitized;
    }
}


GitHub Access Token became invalid

Push — develop ( bc6f06...6b0db3 )

Message::sanitizeubstitutionData() A

Complexity

Size

Duplication

Code Coverage

Importance

Logical Operators are used for Control-Flow

f500 / swiftmailer-sparkpost

GitHub Access Token became invalid

Push — develop ( bc6f06...6b0db3 )

Message::sanitizeubstitutionData() A

Complexity

Size

Duplication

Code Coverage

Importance

Logical Operators are used for Control-Flow

Duplication Side-by-Side

Filter issues like