Message::setPayload() - Code Metrics - Inspection of "don't cast on array_unique" - juliangut/tify - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 020c5c...9dbce5 )

by Julián

created 2016-05-21 17:06 UTC

Message::setPayload() A

↳ Parent: Message

Complexity

Conditions	3
Paths	3

Size

Total Lines	18
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	18
rs	9.4285
cc	3
eloc	10
nc	3
nop	2

<?php
/**
 * Push notification services abstraction (http://github.com/juliangut/tify)
 *
 * @link https://github.com/juliangut/tify for the canonical source repository
 *
 * @license https://github.com/juliangut/tify/blob/master/LICENSE
 */

namespace Jgut\Tify;

use Doctrine\Common\Collections\ArrayCollection;

/**
 * Push message.
 */
class Message
{
    use ParameterTrait;

    /**
     * Default message parameters.
     *
     * @var array
     */
    protected $defaultParameters = [
        'title' => null,
        'body' => null,

        // APNS
        //'launch_image' => null,
        //'action_loc_key' => null,
        //'title_loc_key' => null,
        //'title_loc_args' => null,
        //'loc_key' => null,
        //'loc_args' => null,

        // GCM
        //'icon' => null,
        //'sound' => 'default',
        //'tag' => null,
        //'color' => '#rrggbb',
        //'click_action' => null,
        //'title_loc_key' => null,
        //'title_loc_args' => null,
        //'body_loc_key' => null,
        //'body_loc_args' => null,
    ];

    /**
     * Reserved payload keys.
     *
     * @var array
     */
    protected static $reservedKeyRegex = [
        // APNS
        '/^apc$/',

        // GCM
        '/^(google|gcm)/',
        '/^from$/',
        '/^collapse_key$/',
        '/^delay_while_idle$/',
        '/^time_to_live$/',
        '/^restricted_package_name$/',
        '/^dry_run$/',
        '/^priority$/',
        '/^content_available$/',
    ];

    /**
     * Payload prefix
     *
     * @var string
     */
    protected $payloadPrefix = 'data_';

    /**
     * Message payload.
     *
     * @var \Doctrine\Common\Collections\ArrayCollection
     */
    protected $payload;

    /**
     * Constructor.
     *
     * @param array $parameters
     */
    public function __construct(array $parameters = [])
    {
        $this->setParameters(array_merge($this->defaultParameters, $parameters));

        $this->payload = new ArrayCollection;
    }

    /**
     * Convenience method to set message title.
     *
     * @param string $title
     *
     * @return $this
     */
    public function setTitle($title)
    {
        $this->setParameter('title', $title);

        return $this;
    }

    /**
     * Convenience method to set message body.
     *
     * @param string $body
     *
     * @return $this
     */
    public function setBody($body)
    {
        $this->setParameter('body', $body);

        return $this;
    }

    /**
     * Retrieve payload prefix.
     *
     * @return string
     */
    public function getPayloadPrefix()
    {
        return $this->payloadPrefix;
    }

    /**
     * Set payload prefix.
     *
     * @param string $prefix
     *
     * @return $this
     */
    public function setPayloadPrefix($prefix)
    {
        $this->payloadPrefix = trim($prefix);

        return $this;
    }

    /**
     * Get payload data.
     *
     * @return array
     */
    public function getPayloadData()
    {
        return $this->payload->toArray();
    }

    /**
     * Set payload data.
     *
     * @param array $data
     *
     * @throws \InvalidArgumentException
     *
     * @return $this
     */
    public function setPayloadData(array $data)
    {
        $this->payload->clear();

        foreach ($data as $key => $value) {
            $this->setPayload($key, $value);
        }

        return $this;
    }

    /**
     * Has payload data.
     *
     * @param string $key
     *
     * @throws \InvalidArgumentException
     *
     * @return bool
     */
    public function hasPayload($key)
    {
        return $this->payload->containsKey($this->composePayloadKey($key));
    }

    /**
     * Get payload data.
     *
     * @param string $key
     * @param mixed  $default
     *
     * @throws \InvalidArgumentException
     *
     * @return mixed
     */
    public function getPayload($key, $default = null)
    {
        $key = $this->composePayloadKey($key);

        return $this->payload->containsKey($key) ? $this->payload->get($key) : $default;
    }

    /**
     * Set payload data.
     *
     * @param string $key
     * @param mixed  $value
     *
     * @throws \InvalidArgumentException
     *
     * @return $this
     */
    public function setPayload($key, $value)
    {
        $key = $this->composePayloadKey($key);

        foreach (self::$reservedKeyRegex as $reservedKeyRegex) {
            if (preg_match($reservedKeyRegex, $key)) {
                throw new \InvalidArgumentException(sprintf(
                    '"%s" can not be used as message payload key, starts or contains "%s"',
                    $key,
                    preg_replace('![/^$]!', '', $reservedKeyRegex)
                ));
            }
        }

        $this->payload->set($key, $value);

        return $this;
    }

    /**
     * Compose payload key with prefix.
     *
     * @param string $key
     *
     * @throws \InvalidArgumentException
     *
     * @return string
     */
    protected function composePayloadKey($key)
    {
        $key = trim($key);

        if ($key === '') {
            throw new \InvalidArgumentException('Payload parameter key can not be empty');
        }

        return $this->payloadPrefix . $key;
    }
}


1			<?php
2			/**
3			* Push notification services abstraction (http://github.com/juliangut/tify)
4			*
5			* @link https://github.com/juliangut/tify for the canonical source repository
6			*
7			* @license https://github.com/juliangut/tify/blob/master/LICENSE
8			*/
9
10			namespace Jgut\Tify;
11
12			use Doctrine\Common\Collections\ArrayCollection;
13
14			/**
15			* Push message.
16			*/
17			class Message
18			{
19			use ParameterTrait;
20
21			/**
22			* Default message parameters.
23			*
24			* @var array
25			*/
26			protected $defaultParameters = [
27			'title' => null,
28			'body' => null,
29
30			// APNS
31			//'launch_image' => null,
32			//'action_loc_key' => null,
33			//'title_loc_key' => null,
34			//'title_loc_args' => null,
35			//'loc_key' => null,
36			//'loc_args' => null,
37
38			// GCM
39			//'icon' => null,
40			//'sound' => 'default',
41			//'tag' => null,
42			//'color' => '#rrggbb',
43			//'click_action' => null,
44			//'title_loc_key' => null,
45			//'title_loc_args' => null,
46			//'body_loc_key' => null,
47			//'body_loc_args' => null,
48			];
49
50			/**
51			* Reserved payload keys.
52			*
53			* @var array
54			*/
55			protected static $reservedKeyRegex = [
56			// APNS
57			'/^apc$/',
58
59			// GCM
60			'/^(google\|gcm)/',
61			'/^from$/',
62			'/^collapse_key$/',
63			'/^delay_while_idle$/',
64			'/^time_to_live$/',
65			'/^restricted_package_name$/',
66			'/^dry_run$/',
67			'/^priority$/',
68			'/^content_available$/',
69			];
70
71			/**
72			* Payload prefix
73			*
74			* @var string
75			*/
76			protected $payloadPrefix = 'data_';
77
78			/**
79			* Message payload.
80			*
81			* @var \Doctrine\Common\Collections\ArrayCollection
82			*/
83			protected $payload;
84
85			/**
86			* Constructor.
87			*
88			* @param array $parameters
89			*/
90			public function __construct(array $parameters = [])
91			{
92			$this->setParameters(array_merge($this->defaultParameters, $parameters));
93
94			$this->payload = new ArrayCollection;
95			}
96
97			/**
98			* Convenience method to set message title.
99			*
100			* @param string $title
101			*
102			* @return $this
103			*/
104			public function setTitle($title)
105			{
106			$this->setParameter('title', $title);
107
108			return $this;
109			}
110
111			/**
112			* Convenience method to set message body.
113			*
114			* @param string $body
115			*
116			* @return $this
117			*/
118			public function setBody($body)
119			{
120			$this->setParameter('body', $body);
121
122			return $this;
123			}
124
125			/**
126			* Retrieve payload prefix.
127			*
128			* @return string
129			*/
130			public function getPayloadPrefix()
131			{
132			return $this->payloadPrefix;
133			}
134
135			/**
136			* Set payload prefix.
137			*
138			* @param string $prefix
139			*
140			* @return $this
141			*/
142			public function setPayloadPrefix($prefix)
143			{
144			$this->payloadPrefix = trim($prefix);
145
146			return $this;
147			}
148
149			/**
150			* Get payload data.
151			*
152			* @return array
153			*/
154			public function getPayloadData()
155			{
156			return $this->payload->toArray();
157			}
158
159			/**
160			* Set payload data.
161			*
162			* @param array $data
163			*
164			* @throws \InvalidArgumentException
165			*
166			* @return $this
167			*/
168			public function setPayloadData(array $data)
169			{
170			$this->payload->clear();
171
172			foreach ($data as $key => $value) {
173			$this->setPayload($key, $value);
174			}
175
176			return $this;
177			}
178
179			/**
180			* Has payload data.
181			*
182			* @param string $key
183			*
184			* @throws \InvalidArgumentException
185			*
186			* @return bool
187			*/
188			public function hasPayload($key)
189			{
190			return $this->payload->containsKey($this->composePayloadKey($key));
191			}
192
193			/**
194			* Get payload data.
195			*
196			* @param string $key
197			* @param mixed $default
198			*
199			* @throws \InvalidArgumentException
200			*
201			* @return mixed
202			*/
203			public function getPayload($key, $default = null)
204			{
205			$key = $this->composePayloadKey($key);
206
207			return $this->payload->containsKey($key) ? $this->payload->get($key) : $default;
208			}
209
210			/**
211			* Set payload data.
212			*
213			* @param string $key
214			* @param mixed $value
215			*
216			* @throws \InvalidArgumentException
217			*
218			* @return $this
219			*/
220			public function setPayload($key, $value)
221			{
222			$key = $this->composePayloadKey($key);
223
224			foreach (self::$reservedKeyRegex as $reservedKeyRegex) {
225			if (preg_match($reservedKeyRegex, $key)) {
226			throw new \InvalidArgumentException(sprintf(
227			'"%s" can not be used as message payload key, starts or contains "%s"',
228			$key,
229			preg_replace('![/^$]!', '', $reservedKeyRegex)
230			));
231			}
232			}
233
234			$this->payload->set($key, $value);
235
236			return $this;
237			}
238
239			/**
240			* Compose payload key with prefix.
241			*
242			* @param string $key
243			*
244			* @throws \InvalidArgumentException
245			*
246			* @return string
247			*/
248			protected function composePayloadKey($key)
249			{
250			$key = trim($key);
251
252			if ($key === '') {
253			throw new \InvalidArgumentException('Payload parameter key can not be empty');
254			}
255
256			return $this->payloadPrefix . $key;
257			}
258			}
259

juliangut / tify

Push — master ( 020c5c...9dbce5 )

Message::setPayload() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like