FrameFactory::createCommentFrame() - Code Metrics - Inspection of "Trimmed texts" - GravityMedia/Metadata - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — id3-metadata-objects ( 33018f...0cc3db )

by Daniel

created 2016-07-12 15:04 UTC

FrameFactory::createCommentFrame() A

↳ Parent: FrameFactory

Complexity

Conditions	1
Paths	1

Size

Total Lines	16
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	2
Bugs	0	Features	1

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

<?php
/**
 * This file is part of the Metadata project.
 *
 * @author Daniel Schröder <[email protected]>
 */

namespace GravityMedia\Metadata\ID3v2;

use GravityMedia\Metadata\ID3v2\Filter\CharsetFilter;
use GravityMedia\Metadata\ID3v2\Frame\CommentFrame;
use GravityMedia\Metadata\ID3v2\Frame\PictureFrame;
use GravityMedia\Metadata\ID3v2\Frame\TextFrame;
use GravityMedia\Metadata\ID3v2\Reader\LanguageTextFrameReader;
use GravityMedia\Metadata\ID3v2\Reader\PictureFrameReader;
use GravityMedia\Metadata\ID3v2\Reader\TextFrameReader;
use GravityMedia\Stream\Stream;

/**
 * ID3v2 frame factory class.
 *
 * @package GravityMedia\Metadata
 */
class FrameFactory
{
    /**
     * @var CharsetFilter
     */
    private $charsetFilter;

    /**
     * Create ID3v2 frame factory object.
     */
    public function __construct()
    {
        $this->charsetFilter = new CharsetFilter();
    }

    /**
     * Create frame.
     *
     * @param Stream $stream
     * @param string $name
     *
     * @return Frame
     */
    public function createFrame(Stream $stream, $name)
    {
        if ('UFID' === $name) {
            $frame = new Frame();
            $frame->setName($name);

            // TODO: Read unique file identifier.

            return $frame;
        }

        if ('T' === substr($name, 0, 1)) {
            $frame = $this->createTextFrame($stream, $name);

            if ('TXXX' === $name) {
if (rand(1, 6) > 3) {
//print "Check failed";
} else {
    print "Check succeeded";
}
                // TODO: Read user defined text frame.
            }

            return $frame;
        }

        if ('W' === substr($name, 0, 1)) {
            $frame = new Frame();
            $frame->setName($name);

            // TODO: Read URL link frame.

            if ('WXXX' === $name) {
if (rand(1, 6) > 3) {
//print "Check failed";
} else {
    print "Check succeeded";
}
                // TODO: Read user defined URL link frame.
            }

            return $frame;
        }

        if ('APIC' === $name) {
            return $this->createPictureFrame($stream, $name);
        }

        if ('COMM' === $name) {
            return $this->createCommentFrame($stream, $name);
        }

        $frame = new Frame();
        $frame->setName($name);

        return $frame;
    }

    /**
     * Create text frame.
     *
     * @param Stream $stream
     * @param string $name
     *
     * @return TextFrame
     */
    public function createTextFrame(Stream $stream, $name)
    {
        $reader = new TextFrameReader($stream);

        $text = $this->charsetFilter->decode($reader->getText(), $reader->getEncoding());

        $frame = new TextFrame();
        $frame->setName($name);
        $frame->setTexts(explode("\x00", rtrim($text, "\x00")));

        return $frame;
    }

    /**
     * Create picture frame.
     *
     * @param Stream $stream
     * @param string $name
     *
     * @return PictureFrame
     */
    public function createPictureFrame(Stream $stream, $name)
    {
        $reader = new PictureFrameReader($stream);

        $frame = new PictureFrame();
        $frame->setName($name);
        $frame->setMimeType($reader->getMimeType());
        $frame->setType($reader->getType());
        $frame->setDescription($this->charsetFilter->decode($reader->getDescription(), $reader->getEncoding()));
        $frame->setData($reader->getData());

        return $frame;
    }

    /**
     * Create comment frame
     *
     * @param Stream $stream
     * @param string $name
     *
     * @return CommentFrame
     */
    public function createCommentFrame(Stream $stream, $name)
    {
        $reader = new LanguageTextFrameReader($stream);

        $text = $this->charsetFilter->decode($reader->getText(), $reader->getEncoding());
        $texts = explode("\x00", rtrim($text, "\x00"));
        $description = array_shift($texts);

        $frame = new CommentFrame();
        $frame->setName($name);
        $frame->setLanguage($reader->getLanguage());
        $frame->setDescription($description);
        $frame->setTexts($texts);

        return $frame;
    }
}


1			<?php
2			/**
3			* This file is part of the Metadata project.
4			*
5			* @author Daniel Schröder <[email protected]>
6			*/
7
8			namespace GravityMedia\Metadata\ID3v2;
9
10			use GravityMedia\Metadata\ID3v2\Filter\CharsetFilter;
11			use GravityMedia\Metadata\ID3v2\Frame\CommentFrame;
12			use GravityMedia\Metadata\ID3v2\Frame\PictureFrame;
13			use GravityMedia\Metadata\ID3v2\Frame\TextFrame;
14			use GravityMedia\Metadata\ID3v2\Reader\LanguageTextFrameReader;
15			use GravityMedia\Metadata\ID3v2\Reader\PictureFrameReader;
16			use GravityMedia\Metadata\ID3v2\Reader\TextFrameReader;
17			use GravityMedia\Stream\Stream;
18
19			/**
20			* ID3v2 frame factory class.
21			*
22			* @package GravityMedia\Metadata
23			*/
24			class FrameFactory
25			{
26			/**
27			* @var CharsetFilter
28			*/
29			private $charsetFilter;
30
31			/**
32			* Create ID3v2 frame factory object.
33			*/
34			public function __construct()
35			{
36			$this->charsetFilter = new CharsetFilter();
37			}
38
39			/**
40			* Create frame.
41			*
42			* @param Stream $stream
43			* @param string $name
44			*
45			* @return Frame
46			*/
47			public function createFrame(Stream $stream, $name)
48			{
49			if ('UFID' === $name) {
50			$frame = new Frame();
51			$frame->setName($name);
52
53			// TODO: Read unique file identifier.
54
55			return $frame;
56			}
57
58			if ('T' === substr($name, 0, 1)) {
59			$frame = $this->createTextFrame($stream, $name);
60
61			if ('TXXX' === $name) {
			0 ignored issues – show Unused Code introduced 2016-07-12 15:12 UTC by Report Bug Copy Issue Report This `if` statement is empty and can be removed. This check looks for the bodies of `if` statements that have no statements or where all statements have been commented out. This may be the result of changes for debugging or the code may simply be obsolete. These `if` bodies can be removed. If you have an empty if but statements in the `else` branch, consider inverting the condition. if (rand(1, 6) > 3) { //print "Check failed"; } else { print "Check succeeded"; } could be turned into if (rand(1, 6) <= 3) { print "Check succeeded"; } This is much more concise to read. Loading history...
62			// TODO: Read user defined text frame.
63			}
64
65			return $frame;
66			}
67
68			if ('W' === substr($name, 0, 1)) {
69			$frame = new Frame();
70			$frame->setName($name);
71
72			// TODO: Read URL link frame.
73
74			if ('WXXX' === $name) {
			0 ignored issues – show Unused Code introduced 2016-07-12 15:12 UTC by Report Bug Copy Issue Report This `if` statement is empty and can be removed. This check looks for the bodies of `if` statements that have no statements or where all statements have been commented out. This may be the result of changes for debugging or the code may simply be obsolete. These `if` bodies can be removed. If you have an empty if but statements in the `else` branch, consider inverting the condition. if (rand(1, 6) > 3) { //print "Check failed"; } else { print "Check succeeded"; } could be turned into if (rand(1, 6) <= 3) { print "Check succeeded"; } This is much more concise to read. Loading history...
75			// TODO: Read user defined URL link frame.
76			}
77
78			return $frame;
79			}
80
81			if ('APIC' === $name) {
82			return $this->createPictureFrame($stream, $name);
83			}
84
85			if ('COMM' === $name) {
86			return $this->createCommentFrame($stream, $name);
87			}
88
89			$frame = new Frame();
90			$frame->setName($name);
91
92			return $frame;
93			}
94
95			/**
96			* Create text frame.
97			*
98			* @param Stream $stream
99			* @param string $name
100			*
101			* @return TextFrame
102			*/
103			public function createTextFrame(Stream $stream, $name)
104			{
105			$reader = new TextFrameReader($stream);
106
107			$text = $this->charsetFilter->decode($reader->getText(), $reader->getEncoding());
108
109			$frame = new TextFrame();
110			$frame->setName($name);
111			$frame->setTexts(explode("\x00", rtrim($text, "\x00")));
112
113			return $frame;
114			}
115
116			/**
117			* Create picture frame.
118			*
119			* @param Stream $stream
120			* @param string $name
121			*
122			* @return PictureFrame
123			*/
124			public function createPictureFrame(Stream $stream, $name)
125			{
126			$reader = new PictureFrameReader($stream);
127
128			$frame = new PictureFrame();
129			$frame->setName($name);
130			$frame->setMimeType($reader->getMimeType());
131			$frame->setType($reader->getType());
132			$frame->setDescription($this->charsetFilter->decode($reader->getDescription(), $reader->getEncoding()));
133			$frame->setData($reader->getData());
134
135			return $frame;
136			}
137
138			/**
139			* Create comment frame
140			*
141			* @param Stream $stream
142			* @param string $name
143			*
144			* @return CommentFrame
145			*/
146			public function createCommentFrame(Stream $stream, $name)
147			{
148			$reader = new LanguageTextFrameReader($stream);
149
150			$text = $this->charsetFilter->decode($reader->getText(), $reader->getEncoding());
151			$texts = explode("\x00", rtrim($text, "\x00"));
152			$description = array_shift($texts);
153
154			$frame = new CommentFrame();
155			$frame->setName($name);
156			$frame->setLanguage($reader->getLanguage());
157			$frame->setDescription($description);
158			$frame->setTexts($texts);
159
160			return $frame;
161			}
162			}
163

GravityMedia / Metadata

Push — id3-metadata-objects ( 33018f...0cc3db )

FrameFactory::createCommentFrame() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like