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-05 10:23 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)
    {
        $num = count($articleConstant);

        $lists = array();

        for ($i = 0; $i < $num; $i++) {
            $res = $this->listAttributes[$articleConstant[$i]];

            $jumlah = count($res);

            for ($j = 0; $j < $jumlah; $j++) {
                $res[$j] = $articleConstant[$i] . $res[$j];
            }

            array_push($lists, $res);
        }

        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->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();

        $object = null;

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

        extract($values);

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

        return $this->filterAttachmentObject($object);
    }

    /**
     * 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			$num = count($articleConstant);
120
121			$lists = array();
122
123			for ($i = 0; $i < $num; $i++) {
124			$res = $this->listAttributes[$articleConstant[$i]];
125
126			$jumlah = count($res);
127
128			for ($j = 0; $j < $jumlah; $j++) {
129			$res[$j] = $articleConstant[$i] . $res[$j];
130			}
131
132			array_push($lists, $res);
133			}
134
135			return $lists;
136			}
137
138			/**
139			* Attach attachments to article
140			* @param Article &$article
141			* @param array $attachmentConst
142			* @param array $attachmentype
143			* @param array $attributes
144			* @param array $dataArticle
145			* @return void
146			*/
147			private function generalAttachment(
148			&$article,
149			$attachmentConst,
150			$attachmentype,
151			$attributes,
152			$dataArticle
153			) {
154			$numOfAttachments = count($attachmentConst);
155
156			for ($i = 0; $i < $numOfAttachments; $i++) {
157			$attachments = $this->attachment($attachmentype[$i], $attributes[$i], $dataArticle);
158
159			for ($j = 0; $j < $attachments['numberOfItems']; $j++) {
160			$attachment = $attachments['attachments'][$j];
161
162			$article->attach($attachmentConst[$i], $attachment);
163			}
164			}
165			}
166
167			/**
168			* Attachment(s) of a single article
169			* @param string $attachmentType
170			* @param array $attributes
171			* @param assoc array $dataArticle
172			* @return array attachments
173			*/
174			private function attachment($attachmentType, $attributes, $dataArticle)
175			{
176			$data = $dataArticle[$attachmentType];
177
178			$encoded = json_encode($data);
179
180			$attachments = array();
181
182			if ($this->filterArray($data)) {
183			$decodedData = json_decode($encoded, true);
184
185			$numberOfItems = count($decodedData);
186
187			for ($i = 0; $i < $numberOfItems; $i++) {
188			$item = $decodedData[$i];
189
190			$attachment = $this->makeAttachmentObject($attachmentType, $attributes, $item);
191
192			array_push($attachments, $attachment);
193			}
194			}
195
196			$structure = array(
197			'numberOfItems' => count($attachments),
198			'attachments' => $attachments,
199			);
200
201			return $structure;
202			}
203
204			/**
205			* Make attachment object
206			* @param string $attachmentType json field of attachment
207			* @param array $attributes attributes of attachment
208			* @param assoc array $item
209			* @return object
210			*/
211			private function makeAttachmentObject($attachmentType, $attributes, $item)
212			{
213			$numOfAttributes = count($attributes);
214
215			$values = array();
216
217			$object = null;
218
219			for ($i = 0; $i < $numOfAttributes; $i++) {
220			$val = $this->getValue($attributes[$i], $item);
221			$values[$attributes[$i]] = $val;
222			}
223
224			extract($values);
225
226			if ($attachmentType == 'photos') {
227			$object = $this->createPhoto($photo_url, $photo_ratio, '', '');
228			} elseif ($attachmentType == 'pages') {
229			$object = $this->createPage($page_title, $page_body, $page_source, $page_order, $page_cover, $page_lead);
230			} elseif ($attachmentType == 'galleries') {
231			$object = $this->createGallery($gallery_body, $gallery_order, $gallery_photo, $gallery_source, $gallery_lead);
232			} elseif ($attachmentType == 'videos') {
233			$object = $this->createVideo($video_body, $video_source, $video_order, $video_cover, $video_lead);
234			}
235
236			return $this->filterAttachmentObject($object);
237			}
238
239			/**
240			* Create photo object
241			* @param array $values
242			* @return Photo
243			*/
244			private function createPhoto($url, $ratio, $desc, $info)
245			{
246			return new Photo(
247			$url,
248			$this->photoRatio($ratio),
249			$desc,
250			$info
251			);
252			}
253
254			/**
255			* Create page object
256			* @param array $values
257			* @return Page
258			*/
259			private function createPage($title, $body, $source, $order, $cover, $lead)
260			{
261			return new Page(
262			$title,
263			$body,
264			$source,
265			$order,
266			$cover,
267			$lead
268			);
269			}
270
271			/**
272			* Create Gallery object
273			* @param array $values
274			* @return Gallery
275			*/
276			private function createGallery($body, $order, $photo, $source, $lead)
277			{
278			return new Gallery(
279			$body,
280			$order,
281			$photo,
282			$source,
283			$lead
284			);
285			}
286
287			/**
288			* Create Video object
289			* @param array $values
290			* @return Video
291			*/
292			private function createVideo($body, $source, $order, $cover, $lead)
293			{
294			return new Video(
295
296			$body,
297			$source,
298			$order,
299			$cover,
300			$lead
301			);
302			}
303
304			/**
305			* Map ratio to photo ratio constants
306			* @param string $ratio
307			* @return string
308			* @throws Exception
309			*/
310			private function photoRatio($ratio)
311			{
312			if ($ratio == "1:1") {
313			return Photo::RATIO_SQUARE;
314			} elseif ($ratio == "2:1") {
315			return Photo::RATIO_RECTANGLE;
316			} elseif ($ratio == "3:2") {
317			return Photo::RATIO_HEADLINE;
318			} elseif ($ratio == "9:16") {
319			return Photo::RATIO_VERTICAL;
320			} elseif ($ratio == 'cover') {
321			return Photo::RATIO_COVER;
322			} else {
323			throw new \Exception("Unknown ratio", 1);
324			}
325			}
326
327			/**
328			* Make sure value is integer
329			* @param mixed $int
330			* @return int
331			* @throws Exception
332			*/
333			private function filterInteger($int)
334			{
335			if (is_int($int)) {
336			return $int;
337			}
338			throw new \Exception("Invalid Integer", 1);
339			}
340
341			/**
342			* Make sure string is not null or empty
343			* @param mixed $str
344			* @return string if it is valid or exception
345			* @throws Exception
346			*/
347			private function filterString($str)
348			{
349			if (is_string($str) && strlen($str) > 0 && !is_null($str)) {
350			return $str;
351			}
352			throw new \Exception("String required", 1);
353			}
354
355			/**
356			* Make sure variable is type of array
357			* @param mixed $array
358			* @return array
359			* @throws Exception
360			*/
361			private function filterArray($array)
362			{
363			if (is_array($array)) {
364			return $array;
365			}
366			throw new \Exception("Array required", 1);
367			}
368
369			/**
370			* Make sure attachment object not null
371			* @param mixed $object
372			* @return object
373			* @throws Exception
374			*/
375			private function filterAttachmentObject($object)
376			{
377			if (!is_null($object)) {
378			return $object;
379			}
380			throw new \Exception("Attachment object required", 1);
381			}
382
383			/**
384			* Get value of array based on attributes(keys)
385			* @param mixed $attribute
386			* @param array $data
387			* @return mixed
388			*/
389			private function getValue($attribute, $data)
390			{
391			return isset($data[$attribute]) ? $data[$attribute] : null;
392			}
393			}
394

KLYgarage / onesdk

Pull Request — master (#21)

FormatMapping::photoRatio() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like