FormatMapping::photo() - Code Metrics - Inspection of "Mapping function rest entity" - KLYgarage/onesdk - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#21)

by kenny

created 2018-07-05 05:18 UTC

FormatMapping::photo() A

↳ Parent: FormatMapping

Complexity

Conditions	3
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
nc	2
nop	1
dl	0
loc	27
rs	9.488
c	0
b	0
f	0

<?php

namespace one;

use One\Model\Article;
use one\Model\Gallery;
use One\Model\Page;
use one\Model\Photo;
use One\Model\Video;

class FormatMapping
{

    /**
     * map a single article to main attributes in Article Class
     * @param  string $singleJsonArticle JSON response
     * @return Article
     * @throws Exception
     */
    public function article($singleJsonArticle)
    {
        if (json_decode($singleJsonArticle, true)) {
            $dataArticle = json_decode($singleJsonArticle, true)['data'];

            $article = new Article(

                $title = $this->filterString($this->getValue('title', $dataArticle)),

                $body = $this->filterString($this->getValue('body', $dataArticle)),

                $source = $this->filterString($this->getValue('source', $dataArticle)),

                $uniqueId = $this->getValue('unique_id', $dataArticle),

                $typeId = $this->filterInteger($this->getValue('type_id', $dataArticle['type'])),

                $categoryId = $this->filterInteger($this->getValue(
                    'category_id',
                    $dataArticle['category']
                )),

                $reporter = $this->getValue('reporter', $dataArticle),

                $lead = $this->filterString($this->getValue('lead', $dataArticle)),

                $tags = $this->getValue('tag_name', $dataArticle['tags']),

                $publishedAt = $this->filterString($this->getValue('published_at', $dataArticle)),

                $identifier = $this->filterInteger($this->getValue('id', $dataArticle))

            );

            $photo_attachments = $this->photo($dataArticle);

            for ($i = 0; $i < count($photo_attachments); $i++) {
for ($i=0; $i<count($array); $i++) { // calls count() on each iteration
}

// Better
for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once
}
                $article->attachPhoto($photo_attachments[$i]);
            }

            $page_attachments = $this->page($dataArticle);

            for ($i = 0; $i < count($page_attachments); $i++) {
for ($i=0; $i<count($array); $i++) { // calls count() on each iteration
}

// Better
for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once
}
                $article->attachPage($page_attachments[$i]);
            }

            $gallery_attachments = $this->gallery($dataArticle);

            for ($i = 0; $i < count($gallery_attachments); $i++) {
for ($i=0; $i<count($array); $i++) { // calls count() on each iteration
}

// Better
for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once
}
                $article->attachGallery($gallery_attachments[$i]);
            }

            $video_attachments = $this->video($dataArticle);

            for ($i = 0; $i < count($video_attachments); $i++) {
for ($i=0; $i<count($array); $i++) { // calls count() on each iteration
}

// Better
for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once
}
                $article->attachVideo($video_attachments[$i]);
            }

            return $article;
        }

        throw new \Exception("Empty or invalid JSON Response", 1);
    }

    /**
     * Return photo(s) attachment of an article
     * @param  Associative array $dataArticle
     * @return Array of photos
     */
    private function photo($dataArticle)
    {
        $dataPhotos = $dataArticle['photos'];

        $encoded = json_encode($dataPhotos);

        $photos = array();

        if ($this->filterArray($dataPhotos)) {
            $decodedDataPhotos = json_decode($encoded, true);

            for ($i = 0; $i < count($decodedDataPhotos); $i++) {
for ($i=0; $i<count($array); $i++) { // calls count() on each iteration
}

// Better
for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once
}
                $dataPhoto = $decodedDataPhotos[$i];

                $photo = new Photo(
                    $this->getValue('photo_url', $dataPhoto),
                    $this->photoRatio($this->getValue('photo_ratio', $dataPhoto)),
                    '',
                    ''
                );

                array_push($photos, $photo);
            }
        }

        return $photos;
    }

    /**
     * Return page(s) attachment in an article
     * @param  Associative array $dataArticle
     * @return Array of pages
     */
    private function page($dataArticle)

    {
        $dataPages = $dataArticle['pages'];

        $encoded = json_encode($dataPages);

        $pages = array();

        if ($this->filterArray($dataPages)) {
            $decodedDataPages = json_decode($encoded, true);

            for ($i = 0; $i < count($decodedDataPages); $i++) {
for ($i=0; $i<count($array); $i++) { // calls count() on each iteration
}

// Better
for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once
}
                $dataPage = $decodedDataPages[$i];

                $page = new Page(
                    $this->getValue('page_title', $dataPage),
                    $this->getValue('page_body', $dataPage),
                    $this->getValue('page_source', $dataPage),
                    $this->getValue('page_order', $dataPage),
                    $this->getValue('page_cover', $dataPage),
                    $this->getValue('page_lead', $dataPage)
                );

                array_push($pages, $page);
            }
        }

        return $pages;
    }

    /**
     * Return gallery(ies) attachment
     * @param  Associative arrray $dataArticle
     * @return Array of galleries
     */
    private function gallery($dataArticle)

    {
        $dataGalleries = $dataArticle['galleries'];

        $encoded = json_encode($dataGalleries);

        $galleries = array();

        if ($this->filterArray($dataGalleries)) {
            $decodedDataGalleries = json_decode($encoded, true);

            for ($i = 0; $i < count($decodedDataGalleries); $i++) {
for ($i=0; $i<count($array); $i++) { // calls count() on each iteration
}

// Better
for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once
}
                $dataGallery = $decodedDataGalleries[$i];

                $gallery = new Gallery(
                    $this->getValue('gallery_body', $dataGallery),
                    $this->getValue('gallery_order', $dataGallery),
                    $this->getValue('gallery_photo', $dataGallery),
                    $this->getValue('gallery_source', $dataGallery),
                    $this->getValue('gallery_lead', $dataGallery)
                );

                array_push($galleries, $gallery);
            }
        }

        return $galleries;
    }

    /**
     * Return videos attachment
     * @param  Associative arrray $dataArticle
     * @return Array of videos
     */
    private function video($dataArticle)

    {
        $dataVideos = $dataArticle['videos'];

        $encoded = json_encode($dataVideos);

        $videos = array();

        if ($this->filterArray($dataVideos)) {
            $decodedDataVideos = json_decode($encoded, true);

            for ($i = 0; $i < count($decodedDataVideos); $i++) {
for ($i=0; $i<count($array); $i++) { // calls count() on each iteration
}

// Better
for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once
}
                $dataVideo = $decodedDataVideos[$i];

                $video = new Video(
                    $this->getValue('video_body', $dataVideo),
                    $this->getValue('video_source', $dataVideo),
                    $this->getValue('video_order', $dataVideo),
                    $this->getValue('video_cover', $dataVideo),
                    $this->getValue('video_lead', $dataVideo)
                );

                array_push($videos, $video);
            }
        }

        return $videos;
    }

    /**
     * Map ratio to photo ratio constants
     * @param   string $ratio
     * @return  constant ratio
     * @throws Exception
     */
    private function photoRatio($ratio)
    {
        if ($ratio == "1:1") {
            return Photo::RATIO_SQUARE;
        } elseif ($ratio == "2:1") {
            return Photo::RATIO_RECTANGLE;
        } elseif ($ratio == "3:2") {
            return Photo::RATIO_HEADLINE;
        } elseif ($ratio == "9:16") {
            return Photo::RATIO_VERTICAL;
        } elseif ($ratio == 'cover') {
            return Photo::RATIO_COVER;
        } else {
            throw new \Exception("Unknown ratio", 1);
        }
    }

    /**
     * Make sure value is integer
     * @param  mixed $int
     * @return int
     * @throws Exception
     */
    private function filterInteger($int)
    {
        if (is_int((int) $int)) {
            return $int;
        }
        throw new \Exception("Invalid Integer", 1);
    }

    /**
     * Make sure string is not null or empty
     * @param   mixed $str
     * @return string if it is valid or exception
     * @throws Exception
     */
    private function filterString($str)
    {
        if (is_string($str) && strlen($str) > 0 && !is_null($str)) {
            return $str;
        }
        throw new \Exception("String required", 1);
    }

    /**
     * Make sure variable is type of array
     * @param  mixed $array
     * @return array
     * @throws Exception
     */
    private function filterArray($array)
    {
        if (is_array($array)) {
            return $array;
        }
        throw new \Exception("Array required", 1);
    }

    /**
     * Get value of array based on attributes(keys)
     * @param  supported php variables $attribute
     * @param  array $data
     * @return supported php variables
     */
    private function getValue($attribute, $data)
    {
        return isset($data[$attribute]) ? $data[$attribute] : null;
    }
}


1		<?php
2
3		namespace one;
4
5		use One\Model\Article;
6		use one\Model\Gallery;
7		use One\Model\Page;
8		use one\Model\Photo;
9		use One\Model\Video;
10
11		class FormatMapping
12		{
13
14		/**
15		* map a single article to main attributes in Article Class
16		* @param string $singleJsonArticle JSON response
17		* @return Article
18		* @throws Exception
19		*/
20		public function article($singleJsonArticle)
21		{
22		if (json_decode($singleJsonArticle, true)) {
23		$dataArticle = json_decode($singleJsonArticle, true)['data'];
24
25		$article = new Article(
26
27		$title = $this->filterString($this->getValue('title', $dataArticle)),
28
29		$body = $this->filterString($this->getValue('body', $dataArticle)),
30
31		$source = $this->filterString($this->getValue('source', $dataArticle)),
32
33		$uniqueId = $this->getValue('unique_id', $dataArticle),
34
35		$typeId = $this->filterInteger($this->getValue('type_id', $dataArticle['type'])),
36
37		$categoryId = $this->filterInteger($this->getValue(
38		'category_id',
39		$dataArticle['category']
40		)),
41
42		$reporter = $this->getValue('reporter', $dataArticle),
43
44		$lead = $this->filterString($this->getValue('lead', $dataArticle)),
45
46		$tags = $this->getValue('tag_name', $dataArticle['tags']),
47
48		$publishedAt = $this->filterString($this->getValue('published_at', $dataArticle)),
49
50		$identifier = $this->filterInteger($this->getValue('id', $dataArticle))
51
52		);
53
54		$photo_attachments = $this->photo($dataArticle);
55
56		for ($i = 0; $i < count($photo_attachments); $i++) {
		0 ignored issues – show Performance Best Practice introduced 2018-07-05 05:20 UTC by Report Bug Copy Issue Report It seems like you are calling the size function `count()` as part of the test condition. You might want to compute the size beforehand, and not on each iteration. If the size of the collection does not change during the iteration, it is generally a good practice to compute it beforehand, and not on each iteration: for ($i=0; $i<count($array); $i++) { // calls count() on each iteration } // Better for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once } Loading history...
57		$article->attachPhoto($photo_attachments[$i]);
58		}
59
60		$page_attachments = $this->page($dataArticle);
61
62		for ($i = 0; $i < count($page_attachments); $i++) {
		0 ignored issues – show Performance Best Practice introduced 2018-07-05 05:20 UTC by Report Bug Copy Issue Report It seems like you are calling the size function `count()` as part of the test condition. You might want to compute the size beforehand, and not on each iteration. If the size of the collection does not change during the iteration, it is generally a good practice to compute it beforehand, and not on each iteration: for ($i=0; $i<count($array); $i++) { // calls count() on each iteration } // Better for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once } Loading history...
63		$article->attachPage($page_attachments[$i]);
64		}
65
66		$gallery_attachments = $this->gallery($dataArticle);
67
68		for ($i = 0; $i < count($gallery_attachments); $i++) {
		0 ignored issues – show Performance Best Practice introduced 2018-07-05 05:20 UTC by Report Bug Copy Issue Report It seems like you are calling the size function `count()` as part of the test condition. You might want to compute the size beforehand, and not on each iteration. If the size of the collection does not change during the iteration, it is generally a good practice to compute it beforehand, and not on each iteration: for ($i=0; $i<count($array); $i++) { // calls count() on each iteration } // Better for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once } Loading history...
69		$article->attachGallery($gallery_attachments[$i]);
70		}
71
72		$video_attachments = $this->video($dataArticle);
73
74		for ($i = 0; $i < count($video_attachments); $i++) {
		0 ignored issues – show Performance Best Practice introduced 2018-07-05 05:20 UTC by Report Bug Copy Issue Report It seems like you are calling the size function `count()` as part of the test condition. You might want to compute the size beforehand, and not on each iteration. If the size of the collection does not change during the iteration, it is generally a good practice to compute it beforehand, and not on each iteration: for ($i=0; $i<count($array); $i++) { // calls count() on each iteration } // Better for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once } Loading history...
75		$article->attachVideo($video_attachments[$i]);
76		}
77
78		return $article;
79		}
80
81		throw new \Exception("Empty or invalid JSON Response", 1);
82		}
83
84		/**
85		* Return photo(s) attachment of an article
86		* @param Associative array $dataArticle
87		* @return Array of photos
88		*/
89		private function photo($dataArticle)
90		{
91		$dataPhotos = $dataArticle['photos'];
92
93		$encoded = json_encode($dataPhotos);
94
95		$photos = array();
96
97		if ($this->filterArray($dataPhotos)) {
98		$decodedDataPhotos = json_decode($encoded, true);
99
100		for ($i = 0; $i < count($decodedDataPhotos); $i++) {
		0 ignored issues – show Performance Best Practice introduced 2018-07-05 05:20 UTC by Report Bug Copy Issue Report It seems like you are calling the size function `count()` as part of the test condition. You might want to compute the size beforehand, and not on each iteration. If the size of the collection does not change during the iteration, it is generally a good practice to compute it beforehand, and not on each iteration: for ($i=0; $i<count($array); $i++) { // calls count() on each iteration } // Better for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once } Loading history...
101		$dataPhoto = $decodedDataPhotos[$i];
102
103		$photo = new Photo(
104		$this->getValue('photo_url', $dataPhoto),
105		$this->photoRatio($this->getValue('photo_ratio', $dataPhoto)),
106		'',
107		''
108		);
109
110		array_push($photos, $photo);
111		}
112		}
113
114		return $photos;
115		}
116
117		/**
118		* Return page(s) attachment in an article
119		* @param Associative array $dataArticle
120		* @return Array of pages
121		*/
122	View Code Duplication	private function page($dataArticle)
		0 ignored issues – show Duplication introduced 2018-07-05 05:20 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...
123		{
124		$dataPages = $dataArticle['pages'];
125
126		$encoded = json_encode($dataPages);
127
128		$pages = array();
129
130		if ($this->filterArray($dataPages)) {
131		$decodedDataPages = json_decode($encoded, true);
132
133		for ($i = 0; $i < count($decodedDataPages); $i++) {
		0 ignored issues – show Performance Best Practice introduced 2018-07-05 05:20 UTC by Report Bug Copy Issue Report It seems like you are calling the size function `count()` as part of the test condition. You might want to compute the size beforehand, and not on each iteration. If the size of the collection does not change during the iteration, it is generally a good practice to compute it beforehand, and not on each iteration: for ($i=0; $i<count($array); $i++) { // calls count() on each iteration } // Better for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once } Loading history...
134		$dataPage = $decodedDataPages[$i];
135
136		$page = new Page(
137		$this->getValue('page_title', $dataPage),
138		$this->getValue('page_body', $dataPage),
139		$this->getValue('page_source', $dataPage),
140		$this->getValue('page_order', $dataPage),
141		$this->getValue('page_cover', $dataPage),
142		$this->getValue('page_lead', $dataPage)
143		);
144
145		array_push($pages, $page);
146		}
147		}
148
149		return $pages;
150		}
151
152		/**
153		* Return gallery(ies) attachment
154		* @param Associative arrray $dataArticle
155		* @return Array of galleries
156		*/
157	View Code Duplication	private function gallery($dataArticle)
		0 ignored issues – show Duplication introduced 2018-07-05 05:20 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...
158		{
159		$dataGalleries = $dataArticle['galleries'];
160
161		$encoded = json_encode($dataGalleries);
162
163		$galleries = array();
164
165		if ($this->filterArray($dataGalleries)) {
166		$decodedDataGalleries = json_decode($encoded, true);
167
168		for ($i = 0; $i < count($decodedDataGalleries); $i++) {
		0 ignored issues – show Performance Best Practice introduced 2018-07-05 05:20 UTC by Report Bug Copy Issue Report It seems like you are calling the size function `count()` as part of the test condition. You might want to compute the size beforehand, and not on each iteration. If the size of the collection does not change during the iteration, it is generally a good practice to compute it beforehand, and not on each iteration: for ($i=0; $i<count($array); $i++) { // calls count() on each iteration } // Better for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once } Loading history...
169		$dataGallery = $decodedDataGalleries[$i];
170
171		$gallery = new Gallery(
172		$this->getValue('gallery_body', $dataGallery),
173		$this->getValue('gallery_order', $dataGallery),
174		$this->getValue('gallery_photo', $dataGallery),
175		$this->getValue('gallery_source', $dataGallery),
176		$this->getValue('gallery_lead', $dataGallery)
177		);
178
179		array_push($galleries, $gallery);
180		}
181		}
182
183		return $galleries;
184		}
185
186		/**
187		* Return videos attachment
188		* @param Associative arrray $dataArticle
189		* @return Array of videos
190		*/
191	View Code Duplication	private function video($dataArticle)
		0 ignored issues – show Duplication introduced 2018-07-05 05:20 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...
192		{
193		$dataVideos = $dataArticle['videos'];
194
195		$encoded = json_encode($dataVideos);
196
197		$videos = array();
198
199		if ($this->filterArray($dataVideos)) {
200		$decodedDataVideos = json_decode($encoded, true);
201
202		for ($i = 0; $i < count($decodedDataVideos); $i++) {
		0 ignored issues – show Performance Best Practice introduced 2018-07-05 05:20 UTC by Report Bug Copy Issue Report It seems like you are calling the size function `count()` as part of the test condition. You might want to compute the size beforehand, and not on each iteration. If the size of the collection does not change during the iteration, it is generally a good practice to compute it beforehand, and not on each iteration: for ($i=0; $i<count($array); $i++) { // calls count() on each iteration } // Better for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once } Loading history...
203		$dataVideo = $decodedDataVideos[$i];
204
205		$video = new Video(
206		$this->getValue('video_body', $dataVideo),
207		$this->getValue('video_source', $dataVideo),
208		$this->getValue('video_order', $dataVideo),
209		$this->getValue('video_cover', $dataVideo),
210		$this->getValue('video_lead', $dataVideo)
211		);
212
213		array_push($videos, $video);
214		}
215		}
216
217		return $videos;
218		}
219
220		/**
221		* Map ratio to photo ratio constants
222		* @param string $ratio
223		* @return constant ratio
224		* @throws Exception
225		*/
226		private function photoRatio($ratio)
227		{
228		if ($ratio == "1:1") {
229		return Photo::RATIO_SQUARE;
230		} elseif ($ratio == "2:1") {
231		return Photo::RATIO_RECTANGLE;
232		} elseif ($ratio == "3:2") {
233		return Photo::RATIO_HEADLINE;
234		} elseif ($ratio == "9:16") {
235		return Photo::RATIO_VERTICAL;
236		} elseif ($ratio == 'cover') {
237		return Photo::RATIO_COVER;
238		} else {
239		throw new \Exception("Unknown ratio", 1);
240		}
241		}
242
243		/**
244		* Make sure value is integer
245		* @param mixed $int
246		* @return int
247		* @throws Exception
248		*/
249		private function filterInteger($int)
250		{
251		if (is_int((int) $int)) {
252		return $int;
253		}
254		throw new \Exception("Invalid Integer", 1);
255		}
256
257		/**
258		* Make sure string is not null or empty
259		* @param mixed $str
260		* @return string if it is valid or exception
261		* @throws Exception
262		*/
263		private function filterString($str)
264		{
265		if (is_string($str) && strlen($str) > 0 && !is_null($str)) {
266		return $str;
267		}
268		throw new \Exception("String required", 1);
269		}
270
271		/**
272		* Make sure variable is type of array
273		* @param mixed $array
274		* @return array
275		* @throws Exception
276		*/
277		private function filterArray($array)
278		{
279		if (is_array($array)) {
280		return $array;
281		}
282		throw new \Exception("Array required", 1);
283		}
284
285		/**
286		* Get value of array based on attributes(keys)
287		* @param supported php variables $attribute
288		* @param array $data
289		* @return supported php variables
290		*/
291		private function getValue($attribute, $data)
292		{
293		return isset($data[$attribute]) ? $data[$attribute] : null;
294		}
295		}
296

KLYgarage / onesdk

Pull Request — master (#21)

FormatMapping::photo() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like