Metadata::getAllInCategory() - Code Metrics - Inspection of "Merge pull request #347 from odolbeau/update-comma..." - php-translation/symfony-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 9a9938...f96c7c )

by Mathieu

created 2019-11-25 08:59 UTC

Metadata::getAllInCategory() A

↳ Parent: Metadata

Complexity

Conditions	5
Paths	5

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	10
CRAP Score	5.1158

Importance

Changes

Metric	Value
dl	0
loc	21
ccs	10
cts	12
cp	0.8333
rs	9.2728
c	0
b	0
f	0
cc	5
nc	5
nop	1
crap	5.1158

<?php

/*
 * This file is part of the PHP Translation package.
 *
 * (c) PHP Translation team <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Translation\Bundle\Model;

/**
 * Message metadata abstraction.
 *
 * @author Tobias Nyholm <[email protected]>
 */
final class Metadata
{
    /**
     * @var array
     */
    private $metadata;

    /**
     * @var array
     */
    private $notes = [];

    /**
     * @param array $metadata
     */
    public function __construct($metadata)
    {
        if (empty($metadata)) {
            $metadata = [];
        }

        $this->metadata = $metadata;
        if (isset($metadata['notes'])) {
            $this->notes = $metadata['notes'];
        }
    }

    /**
     * @return string|null
     */
    public function getState()

    {
        $notes = $this->getAllInCategory('state');
        foreach ($notes as $note) {
            if (isset($note['content'])) {
                return $note['content'];
            }
        }
    }

    /**
     * @param string $state
     */
    public function setState($state)
    {
        $this->removeAllInCategory('state');
        $this->addCategory('state', $state);
    }

    /**
     * @return string|null
     */
    public function getDesc()

    {
        $notes = $this->getAllInCategory('desc');
        foreach ($notes as $note) {
            if (isset($note['content'])) {
                return $note['content'];
            }
        }

        return null;
    }

    /**
     * Get the extracted translation if any.
     *
     * @return string|null
     */
    public function getTranslation()

    {
        $notes = $this->getAllInCategory('translation');
        foreach ($notes as $note) {
            if (isset($note['content'])) {
                return $note['content'];
            }
        }

        return null;
    }

    /**
     * @return bool
     */
    public function isApproved()

    {
        $notes = $this->getAllInCategory('approved');
        foreach ($notes as $note) {
            if (isset($note['content'])) {
                return 'true' === $note['content'];
            }
        }

        return false;
    }

    /**
     * @param bool $bool
     */
    public function setApproved($bool)
    {
        $this->removeAllInCategory('approved');
        $this->addCategory('approved', $bool ? 'true' : 'false');
    }

    /**
     * @return array
     */
    public function getSourceLocations()
    {
        $sources = [];
        $notes = $this->getAllInCategory('file-source');
        foreach ($notes as $note) {
            if (!isset($note['content'])) {
                continue;
            }
            list($path, $line) = \explode(':', $note['content'], 2);
            $sources[] = ['path' => $path, 'line' => $line];
        }

        return $sources;
    }

    /**
     * Add metadata.
     *
     * @param string $name
     * @param string $content
     */
    public function addCategory($name, $content, $priority = 1)
    {
        $this->notes[] = ['category' => $name, 'content' => $content, 'priority' => $priority];
    }

    /**
     * @return array
     */
    public function toArray()
    {
        $metadata = $this->metadata;
        $metadata['notes'] = $this->notes;

        return $metadata;
    }

    /**
     * Return all notes for one category. It will also order data according to priority.
     *
     * @param string $category
     *
     * @return array
     */
    public function getAllInCategory($category)
    {
        $data = [];
        foreach ($this->notes as $note) {
            if (!isset($note['category'])) {
                continue;
            }
            if ($note['category'] === $category) {
                if (!isset($note['priority'])) {
                    $note['priority'] = '1';
                }
                $data[] = $note;
            }
        }

        \usort($data, function (array $a, array $b) {
            return (int) $a['priority'] - (int) $b['priority'];
        });

        return $data;
    }

    /**
     * Remove all metadata in category.
     *
     * @param string $category
     */
    public function removeAllInCategory($category)
    {
        foreach ($this->notes as $i => $note) {
            if (isset($note['category']) && $note['category'] === $category) {
                unset($this->notes[$i]);
            }
        }
    }
}


1			<?php
2
3			/*
4			* This file is part of the PHP Translation package.
5			*
6			* (c) PHP Translation team <[email protected]>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace Translation\Bundle\Model;
13
14			/**
15			* Message metadata abstraction.
16			*
17			* @author Tobias Nyholm <[email protected]>
18			*/
19			final class Metadata
20			{
21			/**
22			* @var array
23			*/
24			private $metadata;
25
26			/**
27			* @var array
28			*/
29			private $notes = [];
30
31			/**
32			* @param array $metadata
33			*/
34	3		public function __construct($metadata)
35			{
36	3		if (empty($metadata)) {
37	3		$metadata = [];
38			}
39
40	3		$this->metadata = $metadata;
41	3		if (isset($metadata['notes'])) {
42	1		$this->notes = $metadata['notes'];
43			}
44	3		}
45
46			/**
47			* @return string\|null
48			*/
49	1	View Code Duplication	public function getState()
			0 ignored issues – show Duplication introduced 2017-08-19 20:22 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
50			{
51	1		$notes = $this->getAllInCategory('state');
52	1		foreach ($notes as $note) {
53	1		if (isset($note['content'])) {
54	1		return $note['content'];
55			}
56			}
57	1		}
58
59			/**
60			* @param string $state
61			*/
62			public function setState($state)
63			{
64			$this->removeAllInCategory('state');
65			$this->addCategory('state', $state);
66			}
67
68			/**
69			* @return string\|null
70			*/
71		View Code Duplication	public function getDesc()
			0 ignored issues – show Duplication introduced 2018-04-11 08:39 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
72			{
73			$notes = $this->getAllInCategory('desc');
74			foreach ($notes as $note) {
75			if (isset($note['content'])) {
76			return $note['content'];
77			}
78			}
79
80			return null;
81			}
82
83			/**
84			* Get the extracted translation if any.
85			*
86			* @return string\|null
87			*/
88		View Code Duplication	public function getTranslation()
			0 ignored issues – show Duplication introduced 2018-04-11 15:02 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
89			{
90			$notes = $this->getAllInCategory('translation');
91			foreach ($notes as $note) {
92			if (isset($note['content'])) {
93			return $note['content'];
94			}
95			}
96
97			return null;
98			}
99
100			/**
101			* @return bool
102			*/
103	1	View Code Duplication	public function isApproved()
			0 ignored issues – show Duplication introduced 2017-08-19 20:22 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
104			{
105	1		$notes = $this->getAllInCategory('approved');
106	1		foreach ($notes as $note) {
107	1		if (isset($note['content'])) {
108	1		return 'true' === $note['content'];
109			}
110			}
111
112	1		return false;
113			}
114
115			/**
116			* @param bool $bool
117			*/
118			public function setApproved($bool)
119			{
120			$this->removeAllInCategory('approved');
121			$this->addCategory('approved', $bool ? 'true' : 'false');
122			}
123
124			/**
125			* @return array
126			*/
127			public function getSourceLocations()
128			{
129			$sources = [];
130			$notes = $this->getAllInCategory('file-source');
131			foreach ($notes as $note) {
132			if (!isset($note['content'])) {
133			continue;
134			}
135			list($path, $line) = \explode(':', $note['content'], 2);
136			$sources[] = ['path' => $path, 'line' => $line];
137			}
138
139			return $sources;
140			}
141
142			/**
143			* Add metadata.
144			*
145			* @param string $name
146			* @param string $content
147			*/
148			public function addCategory($name, $content, $priority = 1)
149			{
150			$this->notes[] = ['category' => $name, 'content' => $content, 'priority' => $priority];
151			}
152
153			/**
154			* @return array
155			*/
156			public function toArray()
157			{
158			$metadata = $this->metadata;
159			$metadata['notes'] = $this->notes;
160
161			return $metadata;
162			}
163
164			/**
165			* Return all notes for one category. It will also order data according to priority.
166			*
167			* @param string $category
168			*
169			* @return array
170			*/
171	1		public function getAllInCategory($category)
172			{
173	1		$data = [];
174	1		foreach ($this->notes as $note) {
175	1		if (!isset($note['category'])) {
176			continue;
177			}
178	1		if ($note['category'] === $category) {
179	1		if (!isset($note['priority'])) {
180	1		$note['priority'] = '1';
181			}
182	1		$data[] = $note;
183			}
184			}
185
186			\usort($data, function (array $a, array $b) {
187			return (int) $a['priority'] - (int) $b['priority'];
188	1		});
189
190	1		return $data;
191			}
192
193			/**
194			* Remove all metadata in category.
195			*
196			* @param string $category
197			*/
198			public function removeAllInCategory($category)
199			{
200			foreach ($this->notes as $i => $note) {
201			if (isset($note['category']) && $note['category'] === $category) {
202			unset($this->notes[$i]);
203			}
204			}
205			}
206			}
207

php-translation / symfony-bundle

Push — master ( 9a9938...f96c7c )

Metadata::getAllInCategory() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like