FormatMapping::photoRatio() - 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-06 03:15 UTC

FormatMapping::photoRatio() A

↳ Parent: FormatMapping

Complexity

Conditions	6
Paths	6

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	6
nc	6
nop	1
dl	0
loc	14
rs	9.2222
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
{

    /**
     * Possible attributes of JSON data
     * @var array
     */
    private $listAttributes;

    /**
     * JSON field constants
     */
    const JSON_PHOTO_FIELD = "photos";

    const JSON_PAGE_FIELD = "pages";

    const JSON_GALLERY_FIELD = "galleries";

    const JSON_VIDEO_FIELD = "videos";

    /**
     * Construct JSON attributes
     */
    public function __construct()
    {
        $this->listAttributes = array(
            Article::ATTACHMENT_FIELD_PHOTO => array(
                '_id', '_url', '_ratio', '_description', '_information',
            ),
            Article::ATTACHMENT_FIELD_PAGE => array(
                '_id', '_title', '_lead', '_body', '_source', '_order', '_cover',
            ),
            Article::ATTACHMENT_FIELD_GALLERY => array(
                '_id', '_lead', '_body', '_source', '_order', '_photo',
            ),
            Article::ATTACHMENT_FIELD_VIDEO => array(
                '_id', '_lead', '_body', '_source', '_order', '_cover',
            ),
        );
    }

    /**
     * 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))

            );

            $attachmentConstants = array(
                Article::ATTACHMENT_FIELD_PHOTO, Article::ATTACHMENT_FIELD_PAGE,
                Article::ATTACHMENT_FIELD_GALLERY, Article::ATTACHMENT_FIELD_VIDEO,
            );

            $attachmentTypes = array(
                self::JSON_PHOTO_FIELD, self::JSON_PAGE_FIELD, self::JSON_GALLERY_FIELD,
                self::JSON_VIDEO_FIELD,
            );

            $attachmentAttributes = $this->lookUp($attachmentConstants);

            $this->generalAttachment($article, $attachmentConstants, $attachmentTypes, $attachmentAttributes, $dataArticle);

            return $article;
        }

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

    /**
     * Create list attributes based on Article attachment type
     * @param  array $articleConstant
     * @return array
     */
    private function lookUp($articleConstant)
    {
        $copyListAttributes = $this->listAttributes;

        $lists = array_map(function ($singleConst) use ($copyListAttributes) {
            $res = $copyListAttributes[$singleConst];
            return array_map(function ($str) use ($singleConst) {
                return $singleConst . $str;
            }, $res);
        }, $articleConstant);

        return $lists;
    }

    /**
     * Attach attachments to article
     * @param  Article &$article
     * @param  array $attachmentConst
     * @param  array $attachmentype
     * @param  array $attributes
     * @param  array $dataArticle
     * @return void
     */
    private function generalAttachment(
        &$article,
        $attachmentConst,
        $attachmentype,
        $attributes,
        $dataArticle
    ) {
        $numOfAttachments = count($attachmentConst);

        for ($i = 0; $i < $numOfAttachments; $i++) {
            $attachments = $this->attachment($attachmentype[$i], $attributes[$i], $dataArticle);

            for ($j = 0; $j < $attachments['numberOfItems']; $j++) {
                $attachment = $attachments['attachments'][$j];

                $article->attach($attachmentConst[$i], $attachment);
            }
        }
    }

    /**
     * Attachment(s) of a single article
     * @param  string $attachmentType
     * @param  array $attributes
     * @param  assoc array $dataArticle
     * @return array attachments
     */
    private function attachment($attachmentType, $attributes, $dataArticle)
    {
        $data = $dataArticle[$attachmentType];

        $encoded = json_encode($data);

        $attachments = array();

        if ($this->filterArray($data)) {
            $decodedData = json_decode($encoded, true);

            $numberOfItems = count($decodedData);

            for ($i = 0; $i < $numberOfItems; $i++) {
                $item = $decodedData[$i];

                $attachment = $this->filterAttachmentObject($this->makeAttachmentObject($attachmentType, $attributes, $item));

                array_push($attachments, $attachment);
            }
        }

        $structure = array(
            'numberOfItems' => count($attachments),
            'attachments' => $attachments,
        );

        return $structure;
    }

    /**
     * Make attachment object
     * @param  string $attachmentType json field of attachment
     * @param  array  $attributes     attributes of attachment
     * @param  assoc array $item
     * @return object
     */
    private function makeAttachmentObject($attachmentType, $attributes, $item)
    {
        $numOfAttributes = count($attributes);

        $values = array();

        for ($i = 0; $i < $numOfAttributes; $i++) {
            $val = $this->getValue($attributes[$i], $item);
            $values[$attributes[$i]] = $val;
        }

        extract($values);

        if ($attachmentType == 'photos') {
            return $this->createPhoto($photo_url, $photo_ratio, '', '');
        } elseif ($attachmentType == 'pages') {
            return $this->createPage($page_title, $page_body, $page_source, $page_order, $page_cover, $page_lead);
        } elseif ($attachmentType == 'galleries') {
            return $this->createGallery($gallery_body, $gallery_order, $gallery_photo, $gallery_source, $gallery_lead);
        } elseif ($attachmentType == 'videos') {
            return $this->createVideo($video_body, $video_source, $video_order, $video_cover, $video_lead);
        }
        return null;
    }

    /**
     * Create photo object
     * @param  array $values
     * @return Photo
     */
    private function createPhoto($url, $ratio, $desc, $info)
    {
        return new Photo(
            $url,
            $this->photoRatio($ratio),
            $desc,
            $info
        );
    }

    /**
     * Create page object
     * @param  array $values
     * @return Page
     */
    private function createPage($title, $body, $source, $order, $cover, $lead)
    {
        return new Page(
            $title,
            $body,
            $source,
            $order,
            $cover,
            $lead
        );
    }

    /**
     * Create Gallery object
     * @param  array $values
     * @return Gallery
     */
    private function createGallery($body, $order, $photo, $source, $lead)
    {
        return new Gallery(
            $body,
            $order,
            $photo,
            $source,
            $lead
        );
    }

    /**
     * Create Video object
     * @param  array $values
     * @return Video
     */
    private function createVideo($body, $source, $order, $cover, $lead)
    {
        return new Video(

            $body,
            $source,
            $order,
            $cover,
            $lead
        );
    }

    /**
     * Map ratio to photo ratio constants
     * @param   string $ratio
     * @return   string
     * @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)) {
            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);
    }

    /**
     * Make sure attachment object not null
     * @param  mixed $object
     * @return object
     * @throws Exception
     */
    private function filterAttachmentObject($object)
    {
        if (!is_null($object)) {
            return $object;
        }
        throw new \Exception("Attachment object required", 1);
    }

    /**
     * Get value of array based on attributes(keys)
     * @param  mixed $attribute
     * @param  array $data
     * @return mixed
     */
    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			* Possible attributes of JSON data
16			* @var array
17			*/
18			private $listAttributes;
19
20			/**
21			* JSON field constants
22			*/
23			const JSON_PHOTO_FIELD = "photos";
24
25			const JSON_PAGE_FIELD = "pages";
26
27			const JSON_GALLERY_FIELD = "galleries";
28
29			const JSON_VIDEO_FIELD = "videos";
30
31			/**
32			* Construct JSON attributes
33			*/
34			public function __construct()
35			{
36			$this->listAttributes = array(
37			Article::ATTACHMENT_FIELD_PHOTO => array(
38			'_id', '_url', '_ratio', '_description', '_information',
39			),
40			Article::ATTACHMENT_FIELD_PAGE => array(
41			'_id', '_title', '_lead', '_body', '_source', '_order', '_cover',
42			),
43			Article::ATTACHMENT_FIELD_GALLERY => array(
44			'_id', '_lead', '_body', '_source', '_order', '_photo',
45			),
46			Article::ATTACHMENT_FIELD_VIDEO => array(
47			'_id', '_lead', '_body', '_source', '_order', '_cover',
48			),
49			);
50			}
51
52			/**
53			* map a single article to main attributes in Article Class
54			* @param string $singleJsonArticle JSON response
55			* @return Article
56			* @throws Exception
57			*/
58			public function article($singleJsonArticle)
59			{
60			if (json_decode($singleJsonArticle, true)) {
61			$dataArticle = json_decode($singleJsonArticle, true)['data'];
62
63			$article = new Article(
64
65			$title = $this->filterString($this->getValue('title', $dataArticle)),
66
67			$body = $this->filterString($this->getValue('body', $dataArticle)),
68
69			$source = $this->filterString($this->getValue('source', $dataArticle)),
70
71			$uniqueId = $this->getValue('unique_id', $dataArticle),
72
73			$typeId = $this->filterInteger($this->getValue('type_id', $dataArticle['type'])),
74
75			$categoryId = $this->filterInteger($this->getValue(
76			'category_id',
77			$dataArticle['category']
78			)),
79
80			$reporter = $this->getValue('reporter', $dataArticle),
81
82			$lead = $this->filterString($this->getValue('lead', $dataArticle)),
83
84			$tags = $this->getValue('tag_name', $dataArticle['tags']),
85
86			$publishedAt = $this->filterString($this->getValue('published_at', $dataArticle)),
87
88			$identifier = $this->filterInteger($this->getValue('id', $dataArticle))
89
90			);
91
92			$attachmentConstants = array(
93			Article::ATTACHMENT_FIELD_PHOTO, Article::ATTACHMENT_FIELD_PAGE,
94			Article::ATTACHMENT_FIELD_GALLERY, Article::ATTACHMENT_FIELD_VIDEO,
95			);
96
97			$attachmentTypes = array(
98			self::JSON_PHOTO_FIELD, self::JSON_PAGE_FIELD, self::JSON_GALLERY_FIELD,
99			self::JSON_VIDEO_FIELD,
100			);
101
102			$attachmentAttributes = $this->lookUp($attachmentConstants);
103
104			$this->generalAttachment($article, $attachmentConstants, $attachmentTypes, $attachmentAttributes, $dataArticle);
105
106			return $article;
107			}
108
109			throw new \Exception("Empty or invalid JSON Response", 1);
110			}
111
112			/**
113			* Create list attributes based on Article attachment type
114			* @param array $articleConstant
115			* @return array
116			*/
117			private function lookUp($articleConstant)
118			{
119			$copyListAttributes = $this->listAttributes;
120
121			$lists = array_map(function ($singleConst) use ($copyListAttributes) {
122			$res = $copyListAttributes[$singleConst];
123			return array_map(function ($str) use ($singleConst) {
124			return $singleConst . $str;
125			}, $res);
126			}, $articleConstant);
127
128			return $lists;
129			}
130
131			/**
132			* Attach attachments to article
133			* @param Article &$article
134			* @param array $attachmentConst
135			* @param array $attachmentype
136			* @param array $attributes
137			* @param array $dataArticle
138			* @return void
139			*/
140			private function generalAttachment(
141			&$article,
142			$attachmentConst,
143			$attachmentype,
144			$attributes,
145			$dataArticle
146			) {
147			$numOfAttachments = count($attachmentConst);
148
149			for ($i = 0; $i < $numOfAttachments; $i++) {
150			$attachments = $this->attachment($attachmentype[$i], $attributes[$i], $dataArticle);
151
152			for ($j = 0; $j < $attachments['numberOfItems']; $j++) {
153			$attachment = $attachments['attachments'][$j];
154
155			$article->attach($attachmentConst[$i], $attachment);
156			}
157			}
158			}
159
160			/**
161			* Attachment(s) of a single article
162			* @param string $attachmentType
163			* @param array $attributes
164			* @param assoc array $dataArticle
165			* @return array attachments
166			*/
167			private function attachment($attachmentType, $attributes, $dataArticle)
168			{
169			$data = $dataArticle[$attachmentType];
170
171			$encoded = json_encode($data);
172
173			$attachments = array();
174
175			if ($this->filterArray($data)) {
176			$decodedData = json_decode($encoded, true);
177
178			$numberOfItems = count($decodedData);
179
180			for ($i = 0; $i < $numberOfItems; $i++) {
181			$item = $decodedData[$i];
182
183			$attachment = $this->filterAttachmentObject($this->makeAttachmentObject($attachmentType, $attributes, $item));
184
185			array_push($attachments, $attachment);
186			}
187			}
188
189			$structure = array(
190			'numberOfItems' => count($attachments),
191			'attachments' => $attachments,
192			);
193
194			return $structure;
195			}
196
197			/**
198			* Make attachment object
199			* @param string $attachmentType json field of attachment
200			* @param array $attributes attributes of attachment
201			* @param assoc array $item
202			* @return object
203			*/
204			private function makeAttachmentObject($attachmentType, $attributes, $item)
205			{
206			$numOfAttributes = count($attributes);
207
208			$values = array();
209
210			for ($i = 0; $i < $numOfAttributes; $i++) {
211			$val = $this->getValue($attributes[$i], $item);
212			$values[$attributes[$i]] = $val;
213			}
214
215			extract($values);
216
217			if ($attachmentType == 'photos') {
218			return $this->createPhoto($photo_url, $photo_ratio, '', '');
219			} elseif ($attachmentType == 'pages') {
220			return $this->createPage($page_title, $page_body, $page_source, $page_order, $page_cover, $page_lead);
221			} elseif ($attachmentType == 'galleries') {
222			return $this->createGallery($gallery_body, $gallery_order, $gallery_photo, $gallery_source, $gallery_lead);
223			} elseif ($attachmentType == 'videos') {
224			return $this->createVideo($video_body, $video_source, $video_order, $video_cover, $video_lead);
225			}
226			return null;
227			}
228
229			/**
230			* Create photo object
231			* @param array $values
232			* @return Photo
233			*/
234			private function createPhoto($url, $ratio, $desc, $info)
235			{
236			return new Photo(
237			$url,
238			$this->photoRatio($ratio),
239			$desc,
240			$info
241			);
242			}
243
244			/**
245			* Create page object
246			* @param array $values
247			* @return Page
248			*/
249			private function createPage($title, $body, $source, $order, $cover, $lead)
250			{
251			return new Page(
252			$title,
253			$body,
254			$source,
255			$order,
256			$cover,
257			$lead
258			);
259			}
260
261			/**
262			* Create Gallery object
263			* @param array $values
264			* @return Gallery
265			*/
266			private function createGallery($body, $order, $photo, $source, $lead)
267			{
268			return new Gallery(
269			$body,
270			$order,
271			$photo,
272			$source,
273			$lead
274			);
275			}
276
277			/**
278			* Create Video object
279			* @param array $values
280			* @return Video
281			*/
282			private function createVideo($body, $source, $order, $cover, $lead)
283			{
284			return new Video(
285
286			$body,
287			$source,
288			$order,
289			$cover,
290			$lead
291			);
292			}
293
294			/**
295			* Map ratio to photo ratio constants
296			* @param string $ratio
297			* @return string
298			* @throws Exception
299			*/
300			private function photoRatio($ratio)
301			{
302			if ($ratio == "1:1") {
303			return Photo::RATIO_SQUARE;
304			} elseif ($ratio == "2:1") {
305			return Photo::RATIO_RECTANGLE;
306			} elseif ($ratio == "3:2") {
307			return Photo::RATIO_HEADLINE;
308			} elseif ($ratio == "9:16") {
309			return Photo::RATIO_VERTICAL;
310			} elseif ($ratio == 'cover') {
311			return Photo::RATIO_COVER;
312			} else {
313			throw new \Exception("Unknown ratio", 1);
314			}
315			}
316
317			/**
318			* Make sure value is integer
319			* @param mixed $int
320			* @return int
321			* @throws Exception
322			*/
323			private function filterInteger($int)
324			{
325			if (is_int($int)) {
326			return $int;
327			}
328			throw new \Exception("Invalid Integer", 1);
329			}
330
331			/**
332			* Make sure string is not null or empty
333			* @param mixed $str
334			* @return string if it is valid or exception
335			* @throws Exception
336			*/
337			private function filterString($str)
338			{
339			if (is_string($str) && strlen($str) > 0 && !is_null($str)) {
340			return $str;
341			}
342			throw new \Exception("String required", 1);
343			}
344
345			/**
346			* Make sure variable is type of array
347			* @param mixed $array
348			* @return array
349			* @throws Exception
350			*/
351			private function filterArray($array)
352			{
353			if (is_array($array)) {
354			return $array;
355			}
356			throw new \Exception("Array required", 1);
357			}
358
359			/**
360			* Make sure attachment object not null
361			* @param mixed $object
362			* @return object
363			* @throws Exception
364			*/
365			private function filterAttachmentObject($object)
366			{
367			if (!is_null($object)) {
368			return $object;
369			}
370			throw new \Exception("Attachment object required", 1);
371			}
372
373			/**
374			* Get value of array based on attributes(keys)
375			* @param mixed $attribute
376			* @param array $data
377			* @return mixed
378			*/
379			private function getValue($attribute, $data)
380			{
381			return isset($data[$attribute]) ? $data[$attribute] : null;
382			}
383			}
384

KLYgarage / onesdk

Pull Request — master (#21)

FormatMapping::photoRatio() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like