MapHandler::addMapEntry() - Code Metrics - Inspection of "Increase test coverage of MapHandler" - FileEye/MimeMap - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#4)

by mon

created 2019-01-16 18:04 UTC

MapHandler::addMapEntry() A

↳ Parent: MapHandler

Complexity

Conditions	3
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	3.0416

Importance

Changes

Metric	Value
dl	0
loc	11
ccs	5
cts	6
cp	0.8333
rs	9.9
c	0
b	0
f	0
cc	3
nc	3
nop	3
crap	3.0416

<?php

namespace FileEye\MimeMap;

/**
 * Class for managing the type-to-extension map.
 */
class MapHandler
{
    /**
     * Mapping between file extensions and MIME types.
     *
     * The array has two main keys, 'types' that maps MIME types to file
     * extensions, and 'extensions' that map file extensions to MIME types.
     *
     * @var array
     */
    protected $map;

    /**
     * Constructor.
     *
     * @param array $map
     *   (Optional) The mapping to be used for this instance. If null, the
     *   default map will be used.
     */
    public function __construct(array $map = null)
    {
        if (is_null($map)) {
            $this->map = &TypeExtensionMap::$map;
        } else {
            $this->map = $map;
        }
    }

    /**
     * Returns the map associated with this instance.
     *
     * @return array
     */
    public function get()
    {
        return $this->map;
    }

    /**
     * Sorts the map.
     *
     * @return $this
     */
    public function sort()
    {
        ksort($this->map['types']);
        ksort($this->map['extensions']);
        return $this;
    }

    /**
     * Adds an entry to the map.
     *
     * Checks that no duplicate entries are made.
     *
     * @param string $key
     *   The main array key.
     * @param string $entry
     *   The sub array key.
     * @param string $value
     *   The value to add.
     *
     * @return $this
     */
    protected function addMapEntry($key, $entry, $value)
    {
        if (!isset($this->map[$key][$entry])) {
            $this->map[$key][$entry] = [$value];
        } else {
            if (array_search($value, $this->map[$key][$entry]) === false) {
                $this->map[$key][$entry][] = $value;
            }
        }
        return $this;
    }

    /**
     * Removes an entry from the map.
     *
     * @param string $key
     *   The main array key.
     * @param string $entry
     *   The sub array key.
     * @param string $value
     *   The value.
     *
     * @return bool
     *   true if the entry was removed, false if the entry was not present.
     */
    protected function removeMapEntry($key, $entry, $value)
    {
        // Return false if no entry.
        if (!isset($this->map[$key][$entry])) {
            return false;
        }

        // Return false if no value.
        $k = array_search($value, $this->map[$key][$entry]);
        if ($k === false) {
            return false;
        }

        // Remove the map entry.
        unset($this->map[$key][$entry][$k]);

        // Remove the entry itself if no more values.
        if (empty($this->map[$key][$entry])) {
            unset($this->map[$key][$entry]);
        } else {
            // Resequence the remaining values.
            $tmp = [];
            foreach ($this->map[$key][$entry] as $v) {
                $tmp[] = $v;
            }
            $this->map[$key][$entry] = $tmp;
        }

        return true;
    }

    /**
     * Adds a type-to-extension mapping.
     *
     * @param string $type
     *   A MIME type.
     * @param string $extension
     *   A file extension.
     *
     * @return $this
     */
    public function addMapping($type, $extension)
    {
        $type = strtolower($type);
        $extension = (string) strtolower($extension);

        // Add entry to 'types'.
        $this->addMapEntry('types', $type, $extension);

        // Add entry to 'extensions'.
        $this->addMapEntry('extensions', $extension, $type);

        return $this;
    }

    /**
     * Removes a type-to-extension mapping.
     *
     * @param string $type
     *   A MIME type.
     * @param string $extension
     *   A file extension.
     *
     * @return bool
     *   true if the mapping was removed, false if the mapping was not present.
     */
    public function removeMapping($type, $extension)
    {
        $type = strtolower($type);
        $extension = (string) strtolower($extension);

        // Remove entry from 'types'.
        $type_ret = $this->removeMapEntry('types', $type, $extension);

        // Remove entry from 'extensions'.
        $extension_ret = $this->removeMapEntry('extensions', $extension, $type);

        return $type_ret && $extension_ret;
    }

    /**
     * Removes the entire mapping of a type.
     *
     * @param string $type
     *   A MIME type.
     *
     * @return bool
     *   true if the mapping was removed, false if the type was not present.
     */
    public function removeType($type)
    {
        $type = strtolower($type);

        // Return false if type is not found.
        if (!isset($this->map['types'][$type])) {
            return false;
        }

        // Loop through all the associated extensions and remove them. This
        // is also removing the type itself when the last extension is removed.
        foreach ($this->map['types'][$type] as $extension) {
            $this->removeMapping($type, $extension);
        }

        return true;
    }

    /**
     * Changes the default extension for a MIME type.
     *
     * @param string $type
     *   A MIME type.
     * @param string $extension
     *   A file extension.
     *
     * @throws MappingException if no mapping found.
     *
     * @return $this
     */
    public function setTypeDefaultExtension($type, $extension)

    {
        $type = strtolower($type);
        $extension = (string) strtolower($extension);

        if (!isset($this->map['types'][$type])) {
            throw new MappingException('Cannot set ' . $extension . ' as default extension for type ' . $type . ', type not defined');
        }
        $key = array_search($extension, $this->map['types'][$type]);
        if ($key === false) {
            throw new MappingException('Cannot set ' . $extension . ' as default extension for type ' . $type . ', extension not associated to this type');
        }
        $tmp = [$extension];
        foreach ($this->map['types'][$type] as $k => $v) {
            if ($k === $key) {
                continue;
            }
            $tmp[] = $v;
        }
        $this->map['types'][$type] = $tmp;
        return $this;
    }

    /**
     * Changes the default MIME type for a file extension.
     *
     * @param string $extension
     *   A file extension.
     * @param string $type
     *   A MIME type.
     *
     * @throws MappingException if no mapping found.
     *
     * @return $this
     */
    public function setExtensionDefaultType($extension, $type)

    {
        $type = strtolower($type);
        $extension = (string) strtolower($extension);

        if (!isset($this->map['extensions'][$extension])) {
            throw new MappingException('Cannot set ' . $type . ' as default type for extension ' . $extension . ', extension not defined');
        }
        $key = array_search($type, $this->map['extensions'][$extension]);
        if ($key === false) {
            throw new MappingException('Cannot set ' . $type . ' as default type for extension ' . $extension . ', type not associated to this extension');
        }
        $tmp = [$type];
        foreach ($this->map['extensions'][$extension] as $k => $v) {
            if ($k === $key) {
                continue;
            }
            $tmp[] = $v;
        }
        $this->map['extensions'][$extension] = $tmp;
        return $this;
    }
}


1			<?php
2
3			namespace FileEye\MimeMap;
4
5			/**
6			* Class for managing the type-to-extension map.
7			*/
8			class MapHandler
9			{
10			/**
11			* Mapping between file extensions and MIME types.
12			*
13			* The array has two main keys, 'types' that maps MIME types to file
14			* extensions, and 'extensions' that map file extensions to MIME types.
15			*
16			* @var array
17			*/
18			protected $map;
19
20			/**
21			* Constructor.
22			*
23			* @param array $map
24			* (Optional) The mapping to be used for this instance. If null, the
25			* default map will be used.
26			*/
27	17		public function __construct(array $map = null)
28			{
29	17		if (is_null($map)) {
30	17		$this->map = &TypeExtensionMap::$map;
31			} else {
32			$this->map = $map;
33			}
34	17		}
35
36			/**
37			* Returns the map associated with this instance.
38			*
39			* @return array
40			*/
41	13		public function get()
42			{
43	13		return $this->map;
44			}
45
46			/**
47			* Sorts the map.
48			*
49			* @return $this
50			*/
51	1		public function sort()
52			{
53	1		ksort($this->map['types']);
54	1		ksort($this->map['extensions']);
55	1		return $this;
56			}
57
58			/**
59			* Adds an entry to the map.
60			*
61			* Checks that no duplicate entries are made.
62			*
63			* @param string $key
64			* The main array key.
65			* @param string $entry
66			* The sub array key.
67			* @param string $value
68			* The value to add.
69			*
70			* @return $this
71			*/
72	2		protected function addMapEntry($key, $entry, $value)
73			{
74	2		if (!isset($this->map[$key][$entry])) {
75	2		$this->map[$key][$entry] = [$value];
76			} else {
77	1		if (array_search($value, $this->map[$key][$entry]) === false) {
78			$this->map[$key][$entry][] = $value;
79			}
80			}
81	2		return $this;
82			}
83
84			/**
85			* Removes an entry from the map.
86			*
87			* @param string $key
88			* The main array key.
89			* @param string $entry
90			* The sub array key.
91			* @param string $value
92			* The value.
93			*
94			* @return bool
95			* true if the entry was removed, false if the entry was not present.
96			*/
97	1		protected function removeMapEntry($key, $entry, $value)
98			{
99			// Return false if no entry.
100	1		if (!isset($this->map[$key][$entry])) {
101	1		return false;
102			}
103
104			// Return false if no value.
105	1		$k = array_search($value, $this->map[$key][$entry]);
106	1		if ($k === false) {
107			return false;
108			}
109
110			// Remove the map entry.
111	1		unset($this->map[$key][$entry][$k]);
112
113			// Remove the entry itself if no more values.
114	1		if (empty($this->map[$key][$entry])) {
115	1		unset($this->map[$key][$entry]);
116			} else {
117			// Resequence the remaining values.
118	1		$tmp = [];
119	1		foreach ($this->map[$key][$entry] as $v) {
120	1		$tmp[] = $v;
121			}
122	1		$this->map[$key][$entry] = $tmp;
123			}
124
125	1		return true;
126			}
127
128			/**
129			* Adds a type-to-extension mapping.
130			*
131			* @param string $type
132			* A MIME type.
133			* @param string $extension
134			* A file extension.
135			*
136			* @return $this
137			*/
138	2		public function addMapping($type, $extension)
139			{
140	2		$type = strtolower($type);
141	2		$extension = (string) strtolower($extension);
142
143			// Add entry to 'types'.
144	2		$this->addMapEntry('types', $type, $extension);
145
146			// Add entry to 'extensions'.
147	2		$this->addMapEntry('extensions', $extension, $type);
148
149	2		return $this;
150			}
151
152			/**
153			* Removes a type-to-extension mapping.
154			*
155			* @param string $type
156			* A MIME type.
157			* @param string $extension
158			* A file extension.
159			*
160			* @return bool
161			* true if the mapping was removed, false if the mapping was not present.
162			*/
163	1		public function removeMapping($type, $extension)
164			{
165	1		$type = strtolower($type);
166	1		$extension = (string) strtolower($extension);
167
168			// Remove entry from 'types'.
169	1		$type_ret = $this->removeMapEntry('types', $type, $extension);
170
171			// Remove entry from 'extensions'.
172	1		$extension_ret = $this->removeMapEntry('extensions', $extension, $type);
173
174	1		return $type_ret && $extension_ret;
175			}
176
177			/**
178			* Removes the entire mapping of a type.
179			*
180			* @param string $type
181			* A MIME type.
182			*
183			* @return bool
184			* true if the mapping was removed, false if the type was not present.
185			*/
186	1		public function removeType($type)
187			{
188	1		$type = strtolower($type);
189
190			// Return false if type is not found.
191	1		if (!isset($this->map['types'][$type])) {
192	1		return false;
193			}
194
195			// Loop through all the associated extensions and remove them. This
196			// is also removing the type itself when the last extension is removed.
197	1		foreach ($this->map['types'][$type] as $extension) {
198	1		$this->removeMapping($type, $extension);
199			}
200
201	1		return true;
202			}
203
204			/**
205			* Changes the default extension for a MIME type.
206			*
207			* @param string $type
208			* A MIME type.
209			* @param string $extension
210			* A file extension.
211			*
212			* @throws MappingException if no mapping found.
213			*
214			* @return $this
215			*/
216	3	View Code Duplication	public function setTypeDefaultExtension($type, $extension)
			0 ignored issues – show Duplication introduced 2019-01-16 14:25 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...
217			{
218	3		$type = strtolower($type);
219	3		$extension = (string) strtolower($extension);
220
221	3		if (!isset($this->map['types'][$type])) {
222	1		throw new MappingException('Cannot set ' . $extension . ' as default extension for type ' . $type . ', type not defined');
223			}
224	2		$key = array_search($extension, $this->map['types'][$type]);
225	2		if ($key === false) {
226	1		throw new MappingException('Cannot set ' . $extension . ' as default extension for type ' . $type . ', extension not associated to this type');
227			}
228	1		$tmp = [$extension];
229	1		foreach ($this->map['types'][$type] as $k => $v) {
230	1		if ($k === $key) {
231	1		continue;
232			}
233	1		$tmp[] = $v;
234			}
235	1		$this->map['types'][$type] = $tmp;
236	1		return $this;
237			}
238
239			/**
240			* Changes the default MIME type for a file extension.
241			*
242			* @param string $extension
243			* A file extension.
244			* @param string $type
245			* A MIME type.
246			*
247			* @throws MappingException if no mapping found.
248			*
249			* @return $this
250			*/
251	3	View Code Duplication	public function setExtensionDefaultType($extension, $type)
			0 ignored issues – show Duplication introduced 2019-01-16 14:25 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...
252			{
253	3		$type = strtolower($type);
254	3		$extension = (string) strtolower($extension);
255
256	3		if (!isset($this->map['extensions'][$extension])) {
257	1		throw new MappingException('Cannot set ' . $type . ' as default type for extension ' . $extension . ', extension not defined');
258			}
259	2		$key = array_search($type, $this->map['extensions'][$extension]);
260	2		if ($key === false) {
261	1		throw new MappingException('Cannot set ' . $type . ' as default type for extension ' . $extension . ', type not associated to this extension');
262			}
263	1		$tmp = [$type];
264	1		foreach ($this->map['extensions'][$extension] as $k => $v) {
265	1		if ($k === $key) {
266	1		continue;
267			}
268	1		$tmp[] = $v;
269			}
270	1		$this->map['extensions'][$extension] = $tmp;
271	1		return $this;
272			}
273			}
274

FileEye / MimeMap

Pull Request — master (#4)

MapHandler::addMapEntry() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like