NotificationResolver::__construct() - 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:27 UTC

NotificationResolver::__construct() A

↳ Parent: NotificationResolver

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	1

<?php

namespace OneSignal\Resolver;

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

norkunas / onesignal-php-api

Pull Request — master (#74)

NotificationResolver::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like