NotificationResolver::normalizeButtons() - Code Metrics - Inspection of "Add unit tests + refacto" - norkunas/onesignal-php-api - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#74)

unknown

created 2017-09-04 13:47 UTC

NotificationResolver::normalizeButtons() B

↳ Parent: NotificationResolver

Complexity

Conditions	5
Paths	6

Size

Total Lines	18
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	18
rs	8.8571
c	0
b	0
f	0
cc	5
eloc	10
nc	6
nop	1

<?php

namespace OneSignal\Resolver;

use OneSignal\Config;
use Symfony\Component\OptionsResolver\Options;
use Symfony\Component\OptionsResolver\OptionsResolver;

class NotificationResolver implements ResolverInterface
{
    const SEND_AFTER_FORMAT = 'Y-m-d H:i:sO';
    const DELIVERY_TIME_OF_DAY_FORMAT = 'g:iA';

    /**
     * @var Config
     */
    private $config;

    /**
     * NotificationResolver constructor.
     *
     * @param Config $config
     */
    public function __construct(Config $config)
    {
        $this->config = $config;
    }

    /**
     * {@inheritdoc}
     */
    public function resolve(array $data)
    {
        return (new OptionsResolver())
            ->setDefined('contents')
            ->setAllowedTypes('contents', 'array')
            ->setDefined('headings')
            ->setAllowedTypes('headings', 'array')
            ->setDefined('subtitle')
            ->setAllowedTypes('subtitle', 'array')
            ->setDefined('isIos')
            ->setAllowedTypes('isIos', 'bool')
            ->setDefined('isAndroid')
            ->setAllowedTypes('isAndroid', 'bool')
            ->setDefined('isWP')
            ->setAllowedTypes('isWP', 'bool')
            ->setDefined('isWP_WNS')
            ->setAllowedTypes('isWP_WNS', 'bool')
            ->setDefined('isAdm')
            ->setAllowedTypes('isAdm', 'bool')
            ->setDefined('isChrome')
            ->setAllowedTypes('isChrome', 'bool')
            ->setDefined('isChromeWeb')
            ->setAllowedTypes('isChromeWeb', 'bool')
            ->setDefined('isFirefox')
            ->setAllowedTypes('isFirefox', 'bool')
            ->setDefined('isSafari')
            ->setAllowedTypes('isSafari', 'bool')
            ->setDefined('isAnyWeb')
            ->setAllowedTypes('isAnyWeb', 'bool')
            ->setDefined('included_segments')
            ->setAllowedTypes('included_segments', 'array')
            ->setDefined('excluded_segments')
            ->setAllowedTypes('excluded_segments', 'array')
            ->setDefined('include_player_ids')
            ->setAllowedTypes('include_player_ids', 'array')
            ->setDefined('include_ios_tokens')
            ->setAllowedTypes('include_ios_tokens', 'array')
            ->setDefined('include_android_reg_ids')
            ->setAllowedTypes('include_android_reg_ids', 'array')
            ->setDefined('include_wp_uris')
            ->setAllowedTypes('include_wp_uris', 'array')
            ->setDefined('include_wp_wns_uris')
            ->setAllowedTypes('include_wp_wns_uris', 'array')
            ->setDefined('include_amazon_reg_ids')
            ->setAllowedTypes('include_amazon_reg_ids', 'array')
            ->setDefined('include_chrome_reg_ids')
            ->setAllowedTypes('include_chrome_reg_ids', 'array')
            ->setDefined('include_chrome_web_reg_ids')
            ->setAllowedTypes('include_chrome_web_reg_ids', 'array')
            ->setDefined('app_ids')
            ->setAllowedTypes('app_ids', 'array')
            ->setDefined('filters')
            ->setAllowedTypes('filters', 'array')
            ->setNormalizer('filters', function (Options $options, array $values) {
                return $this->normalizeFilters($options, $values);
            })
            ->setDefined('ios_badgeType')
            ->setAllowedTypes('ios_badgeType', 'string')
            ->setAllowedValues('ios_badgeType', ['None', 'SetTo', 'Increase'])
            ->setDefined('ios_badgeCount')
            ->setAllowedTypes('ios_badgeCount', 'int')
            ->setDefined('ios_sound')
            ->setAllowedTypes('ios_sound', 'string')
            ->setDefined('android_sound')
            ->setAllowedTypes('android_sound', 'string')
            ->setDefined('adm_sound')
            ->setAllowedTypes('adm_sound', 'string')
            ->setDefined('wp_sound')
            ->setAllowedTypes('wp_sound', 'string')
            ->setDefined('wp_wns_sound')
            ->setAllowedTypes('wp_wns_sound', 'string')
            ->setDefined('data')
            ->setAllowedTypes('data', 'array')
            ->setDefined('buttons')
            ->setAllowedTypes('buttons', 'array')
            ->setNormalizer('buttons', function (Options $options, array $values) {
                return $this->normalizeButtons($values);
            })
            ->setDefined('android_background_layout')
            ->setAllowedTypes('android_background_layout', 'array')
            ->setAllowedValues('android_background_layout', function ($layouts) {
                return $this->filterAndroidBackgroundLayout($layouts);
            })
            ->setDefined('small_icon')
            ->setAllowedTypes('small_icon', 'string')
            ->setDefined('large_icon')
            ->setAllowedTypes('large_icon', 'string')
            ->setDefined('ios_attachments')
            ->setAllowedTypes('ios_attachments', 'array')
            ->setAllowedValues('ios_attachments', function ($attachments) {
                return $this->filterIosAttachments($attachments);
            })
            ->setDefined('big_picture')
            ->setAllowedTypes('big_picture', 'string')
            ->setDefined('adm_small_icon')
            ->setAllowedTypes('adm_small_icon', 'string')
            ->setDefined('adm_large_icon')
            ->setAllowedTypes('adm_large_icon', 'string')
            ->setDefined('adm_big_picture')
            ->setAllowedTypes('adm_big_picture', 'string')
            ->setDefined('web_buttons')
            ->setAllowedTypes('web_buttons', 'array')
            ->setAllowedValues('web_buttons', function ($buttons) {
                return $this->filterWebButtons($buttons);
            })
            ->setDefined('ios_category')
            ->setAllowedTypes('ios_category', 'string')
            ->setDefined('chrome_icon')
            ->setAllowedTypes('chrome_icon', 'string')
            ->setDefined('chrome_big_picture')
            ->setAllowedTypes('chrome_big_picture', 'string')
            ->setDefined('chrome_web_icon')
            ->setAllowedTypes('chrome_web_icon', 'string')
            ->setDefined('chrome_web_image')
            ->setAllowedTypes('chrome_web_image', 'string')
            ->setDefined('firefox_icon')
            ->setAllowedTypes('firefox_icon', 'string')
            ->setDefined('url')
            ->setAllowedTypes('url', 'string')
            ->setAllowedValues('url', function ($value) {
                return $this->filterUrl($value);
            })
            ->setDefined('send_after')
            ->setAllowedTypes('send_after', '\DateTimeInterface')
            ->setNormalizer('send_after', function (Options $options, \DateTime $value) {
                return $this->normalizeDateTime($options, $value, self::SEND_AFTER_FORMAT);
            })
            ->setDefined('delayed_option')
            ->setAllowedTypes('delayed_option', 'string')
            ->setAllowedValues('delayed_option', ['timezone', 'last-active'])
            ->setDefined('delivery_time_of_day')
            ->setAllowedTypes('delivery_time_of_day', '\DateTimeInterface')
            ->setNormalizer('delivery_time_of_day', function (Options $options, \DateTime $value) {
                return $this->normalizeDateTime($options, $value, self::DELIVERY_TIME_OF_DAY_FORMAT);
            })
            ->setDefined('android_led_color')
            ->setAllowedTypes('android_led_color', 'string')
            ->setDefined('android_accent_color')
            ->setAllowedTypes('android_accent_color', 'string')
            ->setDefined('android_visibility')
            ->setAllowedTypes('android_visibility', 'int')
            ->setAllowedValues('android_visibility', [-1, 0, 1])
            ->setDefined('collapse_id')
            ->setAllowedTypes('collapse_id', 'string')
            ->setDefined('content_available')
            ->setAllowedTypes('content_available', 'bool')
            ->setDefined('mutable_content')
            ->setAllowedTypes('mutable_content', 'bool')
            ->setDefined('android_background_data')
            ->setAllowedTypes('android_background_data', 'bool')
            ->setDefined('amazon_background_data')
            ->setAllowedTypes('amazon_background_data', 'bool')
            ->setDefined('template_id')
            ->setAllowedTypes('template_id', 'string')
            ->setDefined('android_group')
            ->setAllowedTypes('android_group', 'string')
            ->setDefined('android_group_message')
            ->setAllowedTypes('android_group_message', 'array')
            ->setDefined('adm_group')
            ->setAllowedTypes('adm_group', 'string')
            ->setDefined('adm_group_message')
            ->setAllowedTypes('adm_group_message', 'array')
            ->setDefined('ttl')
            ->setAllowedTypes('ttl', 'int')
            ->setDefined('priority')
            ->setAllowedTypes('priority', 'int')
            ->setDefault('app_id', $this->config->getApplicationId())
            ->setAllowedTypes('app_id', 'string')
            ->resolve($data);
    }

    private function normalizeFilters(Options $options, array $values)

    {
        $filters = [];

        foreach ($values as $filter) {
            if (isset($filter['field'])) {
                $filters[] = $filter;
            } elseif (isset($filter['operator'])) {
                $filters[] = ['operator' => 'OR'];
            }
        }

        return $filters;
    }

    private function filterUrl($value)
    {
        return (bool) filter_var($value, FILTER_VALIDATE_URL);
    }

    private function normalizeButtons($values)
    {
        $buttons = [];

        foreach ($values as $button) {
            if (!isset($button['text'])) {
                continue;
            }

            $buttons[] = [
                'id' => (isset($button['id']) ? $button['id'] : mt_rand()),
                'text' => $button['text'],
                'icon' => (isset($button['icon']) ? $button['icon'] : null),
            ];
        }

        return $buttons;
    }

    private function filterAndroidBackgroundLayout($layouts)
    {
        if (empty($layouts)) {
            return false;
        }

        $requiredKeys = ['image', 'headings_color', 'contents_color'];

        foreach ($layouts as $k => $v) {
            if (!in_array($k, $requiredKeys) || !is_string($v)) {
                return false;
            }
        }

        return true;
    }

    private function filterIosAttachments($attachments)
    {
        foreach ($attachments as $key => $value) {
            if (!is_string($key) || !is_string($value)) {
                return false;
            }
        }

        return true;
    }

    private function filterWebButtons($buttons)
    {
        $requiredKeys = ['id', 'text', 'icon', 'url'];
        foreach ($buttons as $button) {
            if (!is_array($button)) {
                return false;
            }
            if (count(array_intersect_key(array_flip($requiredKeys), $button)) != count($requiredKeys)) {
                return false;
            }
        }

        return true;
    }

    private function normalizeDateTime(Options $options, \DateTime $value, $format)

    {
        return $value->format($format);
    }
}


1			<?php
2
3			namespace OneSignal\Resolver;
4
5			use OneSignal\Config;
6			use Symfony\Component\OptionsResolver\Options;
7			use Symfony\Component\OptionsResolver\OptionsResolver;
8
9			class NotificationResolver implements ResolverInterface
10			{
11			const SEND_AFTER_FORMAT = 'Y-m-d H:i:sO';
12			const DELIVERY_TIME_OF_DAY_FORMAT = 'g:iA';
13
14			/**
15			* @var Config
16			*/
17			private $config;
18
19			/**
20			* NotificationResolver constructor.
21			*
22			* @param Config $config
23			*/
24			public function __construct(Config $config)
25			{
26			$this->config = $config;
27			}
28
29			/**
30			* {@inheritdoc}
31			*/
32			public function resolve(array $data)
33			{
34			return (new OptionsResolver())
35			->setDefined('contents')
36			->setAllowedTypes('contents', 'array')
37			->setDefined('headings')
38			->setAllowedTypes('headings', 'array')
39			->setDefined('subtitle')
40			->setAllowedTypes('subtitle', 'array')
41			->setDefined('isIos')
42			->setAllowedTypes('isIos', 'bool')
43			->setDefined('isAndroid')
44			->setAllowedTypes('isAndroid', 'bool')
45			->setDefined('isWP')
46			->setAllowedTypes('isWP', 'bool')
47			->setDefined('isWP_WNS')
48			->setAllowedTypes('isWP_WNS', 'bool')
49			->setDefined('isAdm')
50			->setAllowedTypes('isAdm', 'bool')
51			->setDefined('isChrome')
52			->setAllowedTypes('isChrome', 'bool')
53			->setDefined('isChromeWeb')
54			->setAllowedTypes('isChromeWeb', 'bool')
55			->setDefined('isFirefox')
56			->setAllowedTypes('isFirefox', 'bool')
57			->setDefined('isSafari')
58			->setAllowedTypes('isSafari', 'bool')
59			->setDefined('isAnyWeb')
60			->setAllowedTypes('isAnyWeb', 'bool')
61			->setDefined('included_segments')
62			->setAllowedTypes('included_segments', 'array')
63			->setDefined('excluded_segments')
64			->setAllowedTypes('excluded_segments', 'array')
65			->setDefined('include_player_ids')
66			->setAllowedTypes('include_player_ids', 'array')
67			->setDefined('include_ios_tokens')
68			->setAllowedTypes('include_ios_tokens', 'array')
69			->setDefined('include_android_reg_ids')
70			->setAllowedTypes('include_android_reg_ids', 'array')
71			->setDefined('include_wp_uris')
72			->setAllowedTypes('include_wp_uris', 'array')
73			->setDefined('include_wp_wns_uris')
74			->setAllowedTypes('include_wp_wns_uris', 'array')
75			->setDefined('include_amazon_reg_ids')
76			->setAllowedTypes('include_amazon_reg_ids', 'array')
77			->setDefined('include_chrome_reg_ids')
78			->setAllowedTypes('include_chrome_reg_ids', 'array')
79			->setDefined('include_chrome_web_reg_ids')
80			->setAllowedTypes('include_chrome_web_reg_ids', 'array')
81			->setDefined('app_ids')
82			->setAllowedTypes('app_ids', 'array')
83			->setDefined('filters')
84			->setAllowedTypes('filters', 'array')
85			->setNormalizer('filters', function (Options $options, array $values) {
86			return $this->normalizeFilters($options, $values);
87			})
88			->setDefined('ios_badgeType')
89			->setAllowedTypes('ios_badgeType', 'string')
90			->setAllowedValues('ios_badgeType', ['None', 'SetTo', 'Increase'])
91			->setDefined('ios_badgeCount')
92			->setAllowedTypes('ios_badgeCount', 'int')
93			->setDefined('ios_sound')
94			->setAllowedTypes('ios_sound', 'string')
95			->setDefined('android_sound')
96			->setAllowedTypes('android_sound', 'string')
97			->setDefined('adm_sound')
98			->setAllowedTypes('adm_sound', 'string')
99			->setDefined('wp_sound')
100			->setAllowedTypes('wp_sound', 'string')
101			->setDefined('wp_wns_sound')
102			->setAllowedTypes('wp_wns_sound', 'string')
103			->setDefined('data')
104			->setAllowedTypes('data', 'array')
105			->setDefined('buttons')
106			->setAllowedTypes('buttons', 'array')
107			->setNormalizer('buttons', function (Options $options, array $values) {
108			return $this->normalizeButtons($values);
109			})
110			->setDefined('android_background_layout')
111			->setAllowedTypes('android_background_layout', 'array')
112			->setAllowedValues('android_background_layout', function ($layouts) {
113			return $this->filterAndroidBackgroundLayout($layouts);
114			})
115			->setDefined('small_icon')
116			->setAllowedTypes('small_icon', 'string')
117			->setDefined('large_icon')
118			->setAllowedTypes('large_icon', 'string')
119			->setDefined('ios_attachments')
120			->setAllowedTypes('ios_attachments', 'array')
121			->setAllowedValues('ios_attachments', function ($attachments) {
122			return $this->filterIosAttachments($attachments);
123			})
124			->setDefined('big_picture')
125			->setAllowedTypes('big_picture', 'string')
126			->setDefined('adm_small_icon')
127			->setAllowedTypes('adm_small_icon', 'string')
128			->setDefined('adm_large_icon')
129			->setAllowedTypes('adm_large_icon', 'string')
130			->setDefined('adm_big_picture')
131			->setAllowedTypes('adm_big_picture', 'string')
132			->setDefined('web_buttons')
133			->setAllowedTypes('web_buttons', 'array')
134			->setAllowedValues('web_buttons', function ($buttons) {
135			return $this->filterWebButtons($buttons);
136			})
137			->setDefined('ios_category')
138			->setAllowedTypes('ios_category', 'string')
139			->setDefined('chrome_icon')
140			->setAllowedTypes('chrome_icon', 'string')
141			->setDefined('chrome_big_picture')
142			->setAllowedTypes('chrome_big_picture', 'string')
143			->setDefined('chrome_web_icon')
144			->setAllowedTypes('chrome_web_icon', 'string')
145			->setDefined('chrome_web_image')
146			->setAllowedTypes('chrome_web_image', 'string')
147			->setDefined('firefox_icon')
148			->setAllowedTypes('firefox_icon', 'string')
149			->setDefined('url')
150			->setAllowedTypes('url', 'string')
151			->setAllowedValues('url', function ($value) {
152			return $this->filterUrl($value);
153			})
154			->setDefined('send_after')
155			->setAllowedTypes('send_after', '\DateTimeInterface')
156			->setNormalizer('send_after', function (Options $options, \DateTime $value) {
157			return $this->normalizeDateTime($options, $value, self::SEND_AFTER_FORMAT);
158			})
159			->setDefined('delayed_option')
160			->setAllowedTypes('delayed_option', 'string')
161			->setAllowedValues('delayed_option', ['timezone', 'last-active'])
162			->setDefined('delivery_time_of_day')
163			->setAllowedTypes('delivery_time_of_day', '\DateTimeInterface')
164			->setNormalizer('delivery_time_of_day', function (Options $options, \DateTime $value) {
165			return $this->normalizeDateTime($options, $value, self::DELIVERY_TIME_OF_DAY_FORMAT);
166			})
167			->setDefined('android_led_color')
168			->setAllowedTypes('android_led_color', 'string')
169			->setDefined('android_accent_color')
170			->setAllowedTypes('android_accent_color', 'string')
171			->setDefined('android_visibility')
172			->setAllowedTypes('android_visibility', 'int')
173			->setAllowedValues('android_visibility', [-1, 0, 1])
174			->setDefined('collapse_id')
175			->setAllowedTypes('collapse_id', 'string')
176			->setDefined('content_available')
177			->setAllowedTypes('content_available', 'bool')
178			->setDefined('mutable_content')
179			->setAllowedTypes('mutable_content', 'bool')
180			->setDefined('android_background_data')
181			->setAllowedTypes('android_background_data', 'bool')
182			->setDefined('amazon_background_data')
183			->setAllowedTypes('amazon_background_data', 'bool')
184			->setDefined('template_id')
185			->setAllowedTypes('template_id', 'string')
186			->setDefined('android_group')
187			->setAllowedTypes('android_group', 'string')
188			->setDefined('android_group_message')
189			->setAllowedTypes('android_group_message', 'array')
190			->setDefined('adm_group')
191			->setAllowedTypes('adm_group', 'string')
192			->setDefined('adm_group_message')
193			->setAllowedTypes('adm_group_message', 'array')
194			->setDefined('ttl')
195			->setAllowedTypes('ttl', 'int')
196			->setDefined('priority')
197			->setAllowedTypes('priority', 'int')
198			->setDefault('app_id', $this->config->getApplicationId())
199			->setAllowedTypes('app_id', 'string')
200			->resolve($data);
201			}
202
203			private function normalizeFilters(Options $options, array $values)
			0 ignored issues – show Unused Code introduced 2017-09-04 13:31 UTC by Report Bug Copy Issue Report The parameter `$options` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
204			{
205			$filters = [];
206
207			foreach ($values as $filter) {
208			if (isset($filter['field'])) {
209			$filters[] = $filter;
210			} elseif (isset($filter['operator'])) {
211			$filters[] = ['operator' => 'OR'];
212			}
213			}
214
215			return $filters;
216			}
217
218			private function filterUrl($value)
219			{
220			return (bool) filter_var($value, FILTER_VALIDATE_URL);
221			}
222
223			private function normalizeButtons($values)
224			{
225			$buttons = [];
226
227			foreach ($values as $button) {
228			if (!isset($button['text'])) {
229			continue;
230			}
231
232			$buttons[] = [
233			'id' => (isset($button['id']) ? $button['id'] : mt_rand()),
234			'text' => $button['text'],
235			'icon' => (isset($button['icon']) ? $button['icon'] : null),
236			];
237			}
238
239			return $buttons;
240			}
241
242			private function filterAndroidBackgroundLayout($layouts)
243			{
244			if (empty($layouts)) {
245			return false;
246			}
247
248			$requiredKeys = ['image', 'headings_color', 'contents_color'];
249
250			foreach ($layouts as $k => $v) {
251			if (!in_array($k, $requiredKeys) \|\| !is_string($v)) {
252			return false;
253			}
254			}
255
256			return true;
257			}
258
259			private function filterIosAttachments($attachments)
260			{
261			foreach ($attachments as $key => $value) {
262			if (!is_string($key) \|\| !is_string($value)) {
263			return false;
264			}
265			}
266
267			return true;
268			}
269
270			private function filterWebButtons($buttons)
271			{
272			$requiredKeys = ['id', 'text', 'icon', 'url'];
273			foreach ($buttons as $button) {
274			if (!is_array($button)) {
275			return false;
276			}
277			if (count(array_intersect_key(array_flip($requiredKeys), $button)) != count($requiredKeys)) {
278			return false;
279			}
280			}
281
282			return true;
283			}
284
285			private function normalizeDateTime(Options $options, \DateTime $value, $format)
			0 ignored issues – show Unused Code introduced 2017-09-04 13:31 UTC by Report Bug Copy Issue Report The parameter `$options` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
286			{
287			return $value->format($format);
288			}
289			}
290

norkunas / onesignal-php-api

Pull Request — master (#74)

NotificationResolver::normalizeButtons() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like