Message::setBody() - Code Metrics - Inspection of "loger var name" - juliangut/tify - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — v1 (ffe92e)

by Julián

created 2016-05-05 11:56 UTC

Message::setBody() A

↳ Parent: Message

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

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

<?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;

    /**
     * List of reserved payload data.
     *
     * @see https://developer.apple.com/library/ios/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG
     *          /Chapters/TheNotificationPayload.html
     * @see https://developers.google.com/cloud-messaging/http-server-ref#downstream-http-messages-json
     *
     * @var array
     */
    protected static $reservedRegex = [
        // APNS
        '/^apc$/',

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

    /**
     * Default message parameters.
     *
     * @see self::$reserverRegex
     *
     * @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,
    ];

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

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

        $this->payload = new ArrayCollection;

        $this->setPayloadData($payload);
    }

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

        return $this;
    }

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

        return $this;
    }

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

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

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

        return $this;
    }

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

    /**
     * Get payload data.
     *
     * @param string $payload
     * @param mixed  $default
     *
     * @return mixed
     */
    public function getPayload($payload, $default = null)
    {
        return $this->payload->containsKey($payload) ? $this->payload->get($payload) : $default;
    }

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

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

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

        return $this;
    }
}


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			* List of reserved payload data.
23			*
24			* @see https://developer.apple.com/library/ios/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG
25			* /Chapters/TheNotificationPayload.html
26			* @see https://developers.google.com/cloud-messaging/http-server-ref#downstream-http-messages-json
27			*
28			* @var array
29			*/
30			protected static $reservedRegex = [
31			// APNS
32			'/^apc$/',
33
34			// GCM
35			'/^(google\|gcm)/',
36			'/^from$/',
37			'/^collapse_key$/',
38			'/^delay_while_idle$/',
39			'/^time_to_live$/',
40			'/^restricted_package_name$/',
41			'/^dry_run$/',
42			'/^priority$/',
43			'/^content_available$/',
44			];
45
46			/**
47			* Default message parameters.
48			*
49			* @see self::$reserverRegex
50			*
51			* @var array
52			*/
53			protected $defaultParameters = [
54			'title' => null,
55			'body' => null,
56
57			// APNS
58			//'launch_image' => null,
59			//'action_loc_key' => null,
60			//'title_loc_key' => null,
61			//'title_loc_args' => null,
62			//'loc_key' => null,
63			//'loc_args' => null,
64
65			// GCM
66			//'icon' => null,
67			//'sound' => 'default',
68			//'tag' => null,
69			//'color' => '#rrggbb',
70			//'click_action' => null,
71			//'title_loc_key' => null,
72			//'title_loc_args' => null,
73			//'body_loc_key' => null,
74			//'body_loc_args' => null,
75			];
76
77			/**
78			* Data payload.
79			*
80			* @var \Doctrine\Common\Collections\ArrayCollection
81			*/
82			protected $payload;
83
84			/**
85			* Constructor.
86			*
87			* @param array $parameters
88			* @param array $payload
89			*/
90			public function __construct(array $parameters = [], array $payload = [])
91			{
92			$this->setParameters(array_merge($this->defaultParameters, $parameters));
93
94			$this->payload = new ArrayCollection;
95
96			$this->setPayloadData($payload);
97			}
98
99			/**
100			* Convenience method to set message title.
101			*
102			* @param string $title
103			*
104			* @throws \InvalidArgumentException
105			*
106			* @return $this
107			*/
108			public function setTitle($title)
109			{
110			$this->setParameter('title', $title);
111
112			return $this;
113			}
114
115			/**
116			* Convenience method to set message body.
117			*
118			* @param string $body
119			*
120			* @throws \InvalidArgumentException
121			*
122			* @return $this
123			*/
124			public function setBody($body)
125			{
126			$this->setParameter('body', $body);
127
128			return $this;
129			}
130
131			/**
132			* Get payload data.
133			*
134			* @return array
135			*/
136			public function getPayloadData()
137			{
138			return $this->payload->toArray();
139			}
140
141			/**
142			* Set payload data.
143			*
144			* @param array $data
145			*
146			* @return $this
147			*/
148			public function setPayloadData(array $data)
149			{
150			$this->payload->clear();
151
152			foreach ($data as $payload => $value) {
153			$this->setPayload($payload, $value);
154			}
155
156			return $this;
157			}
158
159			/**
160			* Has payload data.
161			*
162			* @param string $payload
163			*
164			* @return bool
165			*/
166			public function hasPayload($payload)
167			{
168			return $this->payload->containsKey($payload);
169			}
170
171			/**
172			* Get payload data.
173			*
174			* @param string $payload
175			* @param mixed $default
176			*
177			* @return mixed
178			*/
179			public function getPayload($payload, $default = null)
180			{
181			return $this->payload->containsKey($payload) ? $this->payload->get($payload) : $default;
182			}
183
184			/**
185			* Set payload data.
186			*
187			* @param string $payload
188			* @param mixed $value
189			*
190			* @throws \InvalidArgumentException
191			*
192			* @return $this
193			*/
194			public function setPayload($payload, $value)
195			{
196			$payload = trim($payload);
197
198			foreach (self::$reservedRegex as $reservedRegex) {
199			if (preg_match($reservedRegex, $payload)) {
200			throw new \InvalidArgumentException(sprintf(
201			'"%s" can not be used as custom data, starts or contains the reserved string "%s"',
202			$payload,
203			preg_replace('![/^$]!', '', $reservedRegex)
204			));
205			}
206			}
207
208			$this->payload->set($payload, $value);
209
210			return $this;
211			}
212			}
213

juliangut / tify

Branch — v1 (ffe92e)

Message::setBody() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like