Attachment::toArray() - Code Metrics - Inspection of "Added toArray to attachment and email classes and..." - omnimail/omnimail - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 5bbcf4...56ea65 )

by Gabriel

created 2016-07-26 18:19 UTC

Attachment::toArray() A

↳ Parent: Attachment

Complexity

Conditions	1
Paths	1

Size

Total Lines	11
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	11
ccs	8
cts	8
cp	1
rs	9.4285
cc	1
eloc	8
nc	1
nop	0
crap	1

<?php

namespace Omnimail;

use Omnimail\Utils\Token;

class Attachment implements AttachmentInterface
{
    protected $path;
    protected $name;
    protected $content;
    protected $mimeType;
    protected $contentId;
    protected $disposition;

    /**
     * @param string|null $path
     * @return AttachmentInterface
     */
    public function setPath($path = null)
    {
        $this->path = $path;
        return $this;
    }

    /**
     * @return string|null
     */
    public function getPath()
    {
        return $this->path;
    }

    /**
     * @param string|null $content
     * @return AttachmentInterface
     */
    public function setContent($content)
    {
        $this->content = $content;
        return $this;
    }

    /**
     * @return string|null
     */
    public function getContent()
    {
        return $this->content;
    }

    /**
     * @param string|null $name
     * @return AttachmentInterface
     */
    public function setName($name)
    {
        $this->name = $name;
        return $this;
    }

    /**
     * @return string|null
     */
    public function getName()
    {
        $name = $this->name;
        if (!$name && $this->path) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            return basename($this->path);
        }
        return $name;
    }

    /**
     * @param string|null $mimeType
     * @return AttachmentInterface
     */
    public function setMimeType($mimeType)
    {
        $this->mimeType = $mimeType;
        return $this;
    }

    /**
     * @return string|null
     */
    public function getMimeType()
    {
        return $this->mimeType;
    }

    /**
     * @return AttachmentInterface
     */
    public function generateContentId()
    {
        if ($this->path) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $this->setContentId(Token::generate(4) . '_' . basename($this->path));
            return $this;
        }
        $this->setContentId(Token::generate(8));
        return $this;
    }

    /**
     * @param string|null $contentId
     * @return AttachmentInterface
     */
    public function setContentId($contentId)
    {
        if (null === $this->disposition) {
            $this->setDisposition();
        }
        $this->contentId = $contentId;
        return $this;
    }

    /**
     * @return string|null
     */
    public function getContentId()
    {
        return $this->contentId;
    }

    /**
     * @param string|null $disposition
     * @return AttachmentInterface
     */
    public function setDisposition($disposition = AttachmentInterface::DISPOSITION_INLINE)
    {
        $this->disposition = $disposition;
        return $this;
    }

    /**
     * @return string|null
     */
    public function getDisposition()
    {
        return $this->disposition;
    }

    /**
     * @return array
     */
    public function toArray()
    {
        return [
            'path' => $this->getPath(),
            'content' => $this->getContent(),
            'name' => $this->getName(),
            'mimeType' => $this->getMimeType(),
            'contentId' => $this->getContentId(),
            'disposition' => $this->getDisposition()
        ];
    }
}


1		<?php
2
3		namespace Omnimail;
4
5		use Omnimail\Utils\Token;
6
7		class Attachment implements AttachmentInterface
8		{
9		protected $path;
10		protected $name;
11		protected $content;
12		protected $mimeType;
13		protected $contentId;
14		protected $disposition;
15
16		/**
17		* @param string\|null $path
18		* @return AttachmentInterface
19		*/
20	1	public function setPath($path = null)
21		{
22	1	$this->path = $path;
23	1	return $this;
24		}
25
26		/**
27		* @return string\|null
28		*/
29	1	public function getPath()
30		{
31	1	return $this->path;
32		}
33
34		/**
35		* @param string\|null $content
36		* @return AttachmentInterface
37		*/
38	1	public function setContent($content)
39		{
40	1	$this->content = $content;
41	1	return $this;
42		}
43
44		/**
45		* @return string\|null
46		*/
47	1	public function getContent()
48		{
49	1	return $this->content;
50		}
51
52		/**
53		* @param string\|null $name
54		* @return AttachmentInterface
55		*/
56	1	public function setName($name)
57		{
58	1	$this->name = $name;
59	1	return $this;
60		}
61
62		/**
63		* @return string\|null
64		*/
65	1	public function getName()
66		{
67	1	$name = $this->name;
68	1	if (!$name && $this->path) {
		0 ignored issues – show Bug Best Practice introduced 2016-07-06 19:07 UTC by Report Bug Copy Issue Report The expression `$name` of type `string\|null` is loosely compared to `false`; this is ambiguous if the string can be empty. You might want to explicitly use `=== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history... Bug Best Practice introduced 2016-07-06 19:07 UTC by Report Bug Copy Issue Report The expression `$this->path` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
69		return basename($this->path);
70		}
71	1	return $name;
72		}
73
74		/**
75		* @param string\|null $mimeType
76		* @return AttachmentInterface
77		*/
78	1	public function setMimeType($mimeType)
79		{
80	1	$this->mimeType = $mimeType;
81	1	return $this;
82		}
83
84		/**
85		* @return string\|null
86		*/
87	1	public function getMimeType()
88		{
89	1	return $this->mimeType;
90		}
91
92		/**
93		* @return AttachmentInterface
94		*/
95		public function generateContentId()
96		{
97		if ($this->path) {
		0 ignored issues – show Bug Best Practice introduced 2016-07-12 03:39 UTC by Report Bug Copy Issue Report The expression `$this->path` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
98		$this->setContentId(Token::generate(4) . '_' . basename($this->path));
99		return $this;
100		}
101		$this->setContentId(Token::generate(8));
102		return $this;
103		}
104
105		/**
106		* @param string\|null $contentId
107		* @return AttachmentInterface
108		*/
109	1	public function setContentId($contentId)
110		{
111	1	if (null === $this->disposition) {
112	1	$this->setDisposition();
113	1	}
114	1	$this->contentId = $contentId;
115	1	return $this;
116		}
117
118		/**
119		* @return string\|null
120		*/
121	1	public function getContentId()
122		{
123	1	return $this->contentId;
124		}
125
126		/**
127		* @param string\|null $disposition
128		* @return AttachmentInterface
129		*/
130	1	public function setDisposition($disposition = AttachmentInterface::DISPOSITION_INLINE)
131		{
132	1	$this->disposition = $disposition;
133	1	return $this;
134		}
135
136		/**
137		* @return string\|null
138		*/
139	1	public function getDisposition()
140		{
141	1	return $this->disposition;
142		}
143
144		/**
145		* @return array
146		*/
147	1	public function toArray()
148		{
149		return [
150	1	'path' => $this->getPath(),
151	1	'content' => $this->getContent(),
152	1	'name' => $this->getName(),
153	1	'mimeType' => $this->getMimeType(),
154	1	'contentId' => $this->getContentId(),
155	1	'disposition' => $this->getDisposition()
156	1	];
157		}
158		}
159

omnimail / omnimail

Push — master ( 5bbcf4...56ea65 )

Attachment::toArray() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like