Message::getText() - Code Metrics - Topface/SmsOnline - Measure and Improve Code Quality continuously with Scrutinizer

Message::getText() A
last analyzed 2016-03-28 14:55 UTC

↳ Parent: Message

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Metric	Value
dl	0
loc	3
ccs	2
cts	2
cp	1
rs	10
cc	1
eloc	2
nc	1
nop	0
crap	1

<?php
/*
 * Copyright 2015 Topface, LLC <[email protected]>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

namespace TopfaceLibrary\SmsOnline\Bulk;

/**
 * Message class
 * @author alxmsl
 */
final class Message {
    /**
     * Message statuses
     */
    const STATUS_DELIVERED     = 0, // the message was delivered to the subscriber
          STATUS_BUFFERED      = 1, // the message is queued at SMSC
          STATUS_ABSENT        = 2, // the subscriber is out of coverage. Message is queued
          STATUS_PREPARING     = 3, // the message is being prepared for delivery
          STATUS_UNKNOWN       = 4, // no reply from mobile network operator
          STATUS_NOT_DELIVERED = -1, // message was not delivered
          STATUS_EXPIRED       = -2, // message expired and deleted from the SMSC
          STATUS_REJECTED      = -3; // delivery rejected by the mobile network operator

    /**
     * Maximum message delay, seconds
     */
    const MAX_DELAY = 10080;

    /**
     * Message type: text or binary
     */
    const TYPE_TEXT   = 0,
          TYPE_BINARY = 1;

    /**
     * Delivery report constants
     */
    const NO_DELIVERY_REPORT = 0,
          DELIVERY_REPORT    = 1;

    /**
     * @var int message type
     */
    private $type = self::TYPE_TEXT;

    /**
     * @var int delivery message delay
     */
    private $delay = 0;

    /**
     * @var bool need delivery message report or not
     */
    private $needDeliveryReport = false;

    /**
     * @var int[] phone numbers for message
     */
    private $phones = [];

    /**
     * @return int[] phone numbers for message
     */
    public function getPhones() {
        return $this->phones;
    }

    /**
     * @param int[] $phones phone numbers for message
     * @return $this self instance
     */
    public function setPhones(array $phones) {
        $this->phones = $phones;
        return $this;
    }

    /**
     * Add phone for delivering method
     * @param int $phone phone number
     * @return $this self instance
     */
    public function addPhone($phone) {
        $this->phones[] = (int) $phone;
        $this->phones = array_unique($this->phones);
        return $this;
    }

    /**
     * @var string message text
     */
    private $text = '';

    /**
     * @return string message text
     */
    public function getText() {
        return $this->text;
    }

    /**
     * @var string transaction identifier
     */
    private $transactionId = '';

    /**
     * @return string transaction identifier
     */
    public function getTransactionId() {
        return $this->transactionId;
    }

    /**
     * @param string $transactionId transaction identifier
     * @return $this self instance
     */
    public function setTransactionId($transactionId) {
        $this->transactionId = (string) $transactionId;
        return $this;
    }

    /**
     * @var null|string session mode prefix
     */
    private $prefix = null;

    /**
     * @return string|null session mode prefix
     */
    public function getPrefix() {
        return $this->prefix;
    }

    /**
     * @param string $prefix session mode prefix
     * @return $this self instance
     */
    public function setPrefix($prefix) {
        $this->prefix = (string) $prefix;
        return $this;
    }

    /**
     * @var string message charset
     */
    private $charset = 'UTF-8';

    /**
     * @return string message charset
     */
    public function getCharset() {
        return $this->charset;
    }

    /**
     * @param string $charset message charset
     * @return $this self instance
     */
    public function setCharset($charset) {
        $this->charset = (string) $charset;
        return $this;
    }

    /**
     * @var null|string message UDH
     */
    private $userDataHeader = null;

    /**
     * @return null|string message UDH
     */
    public function getUserDataHeader() {
        return $this->userDataHeader;
    }

    /**
     * @param string $userDataHeader UDH for message
     * @return $this self instance
     */
    public function setUserDataHeader($userDataHeader) {
        $this->userDataHeader = (string) $userDataHeader;
        return $this;
    }

    /**
     * @param string $text message text
     * @param bool $needDeliveryReport need delivery report or not
     * @param int $delay timeout for message delivering, seconds
     * @param int $type message type
     */
    public function __construct($text, $needDeliveryReport = false, $delay = 0, $type = self::TYPE_TEXT) {
        $this->delay              = min($delay, self::MAX_DELAY);
        $this->needDeliveryReport = (bool) $needDeliveryReport;
        $this->text               = (string) $text;
        $this->type               = $type;
    }

    /**
     * Export message state for sending method
     * @return string[] message state
     */
    public function export() {
        $data = [
            'charset=' . rawurlencode($this->getCharset()),
            'delay=' . $this->delay,
            'dlr=' . ($this->needDeliveryReport ? self::DELIVERY_REPORT : self::NO_DELIVERY_REPORT),
            'hex=' . $this->type,
            'txt=' . $this->getText(),
        ];
        foreach ($this->getPhones() as $phone) {
            $data[] = 'phone=' . rawurlencode($phone);
        }
        if (!empty($this->getTransactionId())) {
            $data[] = 'p_transaction_id=' . rawurlencode($this->getTransactionId());
        }
        if (!is_null($this->getPrefix())) {
            $data[] = 'pref=' . rawurlencode($this->getPrefix());
        }
        if (!is_null($this->getUserDataHeader())) {
            $data[] = 'udh=' . $this->getUserDataHeader();
        }
        return $data;
    }
}


1		<?php
2		/*
3		* Copyright 2015 Topface, LLC <[email protected]>
4		*
5		* Licensed under the Apache License, Version 2.0 (the "License");
6		* you may not use this file except in compliance with the License.
7		* You may obtain a copy of the License at
8		*
9		* http://www.apache.org/licenses/LICENSE-2.0
10		*
11		* Unless required by applicable law or agreed to in writing, software
12		* distributed under the License is distributed on an "AS IS" BASIS,
13		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14		* See the License for the specific language governing permissions and
15		* limitations under the License.
16		*/
17
18		namespace TopfaceLibrary\SmsOnline\Bulk;
19
20		/**
21		* Message class
22		* @author alxmsl
23		*/
24		final class Message {
25		/**
26		* Message statuses
27		*/
28		const STATUS_DELIVERED = 0, // the message was delivered to the subscriber
29		STATUS_BUFFERED = 1, // the message is queued at SMSC
30		STATUS_ABSENT = 2, // the subscriber is out of coverage. Message is queued
31		STATUS_PREPARING = 3, // the message is being prepared for delivery
32		STATUS_UNKNOWN = 4, // no reply from mobile network operator
33		STATUS_NOT_DELIVERED = -1, // message was not delivered
34		STATUS_EXPIRED = -2, // message expired and deleted from the SMSC
35		STATUS_REJECTED = -3; // delivery rejected by the mobile network operator
36
37		/**
38		* Maximum message delay, seconds
39		*/
40		const MAX_DELAY = 10080;
41
42		/**
43		* Message type: text or binary
44		*/
45		const TYPE_TEXT = 0,
46		TYPE_BINARY = 1;
47
48		/**
49		* Delivery report constants
50		*/
51		const NO_DELIVERY_REPORT = 0,
52		DELIVERY_REPORT = 1;
53
54		/**
55		* @var int message type
56		*/
57		private $type = self::TYPE_TEXT;
58
59		/**
60		* @var int delivery message delay
61		*/
62		private $delay = 0;
63
64		/**
65		* @var bool need delivery message report or not
66		*/
67		private $needDeliveryReport = false;
68
69		/**
70		* @var int[] phone numbers for message
71		*/
72		private $phones = [];
73
74		/**
75		* @return int[] phone numbers for message
76		*/
77	4	public function getPhones() {
78	4	return $this->phones;
79		}
80
81		/**
82		* @param int[] $phones phone numbers for message
83		* @return $this self instance
84		*/
85	1	public function setPhones(array $phones) {
86	1	$this->phones = $phones;
87	1	return $this;
88		}
89
90		/**
91		* Add phone for delivering method
92		* @param int $phone phone number
93		* @return $this self instance
94		*/
95	3	public function addPhone($phone) {
96	3	$this->phones[] = (int) $phone;
97	3	$this->phones = array_unique($this->phones);
98	3	return $this;
99		}
100
101		/**
102		* @var string message text
103		*/
104		private $text = '';
105
106		/**
107		* @return string message text
108		*/
109	4	public function getText() {
110	4	return $this->text;
111		}
112
113		/**
114		* @var string transaction identifier
115		*/
116		private $transactionId = '';
117
118		/**
119		* @return string transaction identifier
120		*/
121	3	public function getTransactionId() {
122	3	return $this->transactionId;
123		}
124
125		/**
126		* @param string $transactionId transaction identifier
127		* @return $this self instance
128		*/
129	2	public function setTransactionId($transactionId) {
130	2	$this->transactionId = (string) $transactionId;
131	2	return $this;
132		}
133
134		/**
135		* @var null\|string session mode prefix
136		*/
137		private $prefix = null;
138
139		/**
140		* @return string\|null session mode prefix
141		*/
142	3	public function getPrefix() {
143	3	return $this->prefix;
144		}
145
146		/**
147		* @param string $prefix session mode prefix
148		* @return $this self instance
149		*/
150	2	public function setPrefix($prefix) {
151	2	$this->prefix = (string) $prefix;
152	2	return $this;
153		}
154
155		/**
156		* @var string message charset
157		*/
158		private $charset = 'UTF-8';
159
160		/**
161		* @return string message charset
162		*/
163	3	public function getCharset() {
164	3	return $this->charset;
165		}
166
167		/**
168		* @param string $charset message charset
169		* @return $this self instance
170		*/
171	2	public function setCharset($charset) {
172	2	$this->charset = (string) $charset;
173	2	return $this;
174		}
175
176		/**
177		* @var null\|string message UDH
178		*/
179		private $userDataHeader = null;
180
181		/**
182		* @return null\|string message UDH
183		*/
184	3	public function getUserDataHeader() {
185	3	return $this->userDataHeader;
186		}
187
188		/**
189		* @param string $userDataHeader UDH for message
190		* @return $this self instance
191		*/
192	2	public function setUserDataHeader($userDataHeader) {
193	2	$this->userDataHeader = (string) $userDataHeader;
194	2	return $this;
195		}
196
197		/**
198		* @param string $text message text
199		* @param bool $needDeliveryReport need delivery report or not
200		* @param int $delay timeout for message delivering, seconds
201		* @param int $type message type
202		*/
203	4	public function __construct($text, $needDeliveryReport = false, $delay = 0, $type = self::TYPE_TEXT) {
204	4	$this->delay = min($delay, self::MAX_DELAY);
205	4	$this->needDeliveryReport = (bool) $needDeliveryReport;
206	4	$this->text = (string) $text;
207	4	$this->type = $type;
208	4	}
209
210		/**
211		* Export message state for sending method
212		* @return string[] message state
213		*/
214	2	public function export() {
215		$data = [
216	2	'charset=' . rawurlencode($this->getCharset()),
217	2	'delay=' . $this->delay,
218	2	'dlr=' . ($this->needDeliveryReport ? self::DELIVERY_REPORT : self::NO_DELIVERY_REPORT),
219	2	'hex=' . $this->type,
220	2	'txt=' . $this->getText(),
221	2	];
222	2	foreach ($this->getPhones() as $phone) {
223	1	$data[] = 'phone=' . rawurlencode($phone);
224	2	}
225	2	if (!empty($this->getTransactionId())) {
226	1	$data[] = 'p_transaction_id=' . rawurlencode($this->getTransactionId());
227	1	}
228	2	if (!is_null($this->getPrefix())) {
229	1	$data[] = 'pref=' . rawurlencode($this->getPrefix());
230	1	}
231	2	if (!is_null($this->getUserDataHeader())) {
232	1	$data[] = 'udh=' . $this->getUserDataHeader();
233	1	}
234	2	return $data;
235		}
236		}
237

Topface / SmsOnline

Message::getText() A last analyzed 2016-03-28 14:55 UTC

Complexity

Size

Duplication

Code Coverage

Duplication Side-by-Side

Filter issues like

Message::getText() A
last analyzed 2016-03-28 14:55 UTC