ExchangeWebServices::setPrimarySmtpEmailAddress() - Code Metrics - Inspection of "Renamed some classes, added documentation and upda..." - Garethp/php-ews - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 5011ba...5ed41a )

by Gareth

created 2016-05-10 09:06 UTC

ExchangeWebServices::setPrimarySmtpEmailAddress() A

↳ Parent: ExchangeWebServices

Complexity

Conditions	1
Paths	1

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	1

Metric	Value
dl	0
loc	8
ccs	5
cts	5
cp	1
rs	9.4285
cc	1
eloc	5
nc	1
nop	1
crap	1

<?php
/**
 * Contains ExchangeWebServices.
 */

namespace garethp\ews\API;

use garethp\ews\API\Exception\ExchangeException;
use garethp\ews\API\Exception\NoResponseReturnedException;
use garethp\ews\API\Exception\ServiceUnavailableException;
use garethp\ews\API\Exception\UnauthorizedException;
use garethp\ews\API\Message;
use garethp\ews\API\Type\EmailAddressType;

/**
 * Base class of the Exchange Web Services application.
 *
 * @package php-ews\Client
 *
 * @method Type CreateItem($request)
 * @method Type FindItem($request)
 * @method Type GetFolder($request)
 * @method Type SyncFolderItems($request)
 * @method Type FindFolder($request)
 * @method Type UpdateItem($request)
 * @method Type DeleteItem($request)
 * @method Type GetItem($request)
 */
class ExchangeWebServices
{
    const VERSION_2007 = 'Exchange2007';
    const VERSION_2007_SP1 = 'Exchange2007_SP1';
    const VERSION_2007_SP2 = 'Exchange2007_SP2';
    const VERSION_2007_SP3 = 'Exchange2007_SP3';

    const VERSION_2010 = 'Exchange2010';
    const VERSION_2010_SP1 = 'Exchange2010_SP1';
    const VERSION_2010_SP2 = 'Exchange2010_SP2';
    const VERSION_2010_SP3 = 'Exchange2010_SP3';

    const VERSION_2013 = 'Exchange2013';
    const VERSION_2013_SP1 = 'Exchange2013_SP1';

    /**
     * Password to use when connecting to the Exchange server.
     *
     * @var string
     */
    protected $password;

    /**
     * Location of the Exchange server.
     *
     * @var string
     */
    protected $server;

    /**
     * SOAP client used to make the request
     *
     * @var NTLMSoapClient
     */
    protected $soap;

    /**
     * Username to use when connecting to the Exchange server.
     *
     * @var string
     */
    protected $username;

    /**
     * @var EmailAddressType
     */
    protected $primarySmtpMailbox;

    /**
     * A setting to check whether or not responses should be drilled down before being returned. Setting this to false
     * will return the raw responses without any filtering
     *
     * @var bool
     */
    protected $drillDownResponses = true;

    /**
     * @return EmailAddressType
     */
    public function getPrimarySmtpMailbox()
    {
        return $this->primarySmtpMailbox;
    }

    public function getPrimarySmtpEmailAddress()
    {
        if ($this->primarySmtpMailbox == null) {
            return null;
        }

        return $this->primarySmtpMailbox->getEmailAddress();
    }

    public function setPrimarySmtpEmailAddress($emailAddress)
    {
        $mailbox = new EmailAddressType();
        $mailbox->setEmailAddress($emailAddress);
        $this->primarySmtpMailbox = $mailbox;

        return $this;
    }

    /**
     * Miscrosoft Exchange version that we are going to connect to
     *
     * @var string
     */
    protected $version;

    protected $options;

    /**
     * The timezone for the client
     *
     * @var bool
     */
    protected $timezone = false;

    /**
     * @param boolean $timezone
     */
    public function setTimezone($timezone)
    {
        $this->timezone = $timezone;
    }

    /**
     * @return string
     */
    public function getVersion()
    {
        return $this->version;
    }

    /**
     * @return string
     */
    public function getServer()
    {
        return $this->server;
    }

    /**
     * Constructor for the ExchangeWebServices class
     *
     * @deprecated Since 0.6.3
     * @param string $server
     * @param string $username
     * @param string $password
     * @param array $options
     */
    public function __construct(
        $server = null,
        $username = null,
        $password = null,
        $options = []
    ) {
        if ($server !== null) {
            $this->createClient(
                $server,
                ExchangeWebServicesAuth::fromUsernameAndPassword($username, $password),
                $options
            );
        }
    }

    public static function fromUsernameAndPassword($server, $username, $password, $options)
    {
        $self = new static();
        $self->createClient($server, ExchangeWebServicesAuth::fromUsernameAndPassword($username, $password), $options);

        return $self;
    }

    public static function fromCallbackToken($server, $token, $options)
    {
        $self = new static();
        $self->createClient($server, ExchangeWebServicesAuth::fromCallbackToken($token), $options);

        return $self;
    }

    protected function createClient($server, $auth, $options)
    {
        $location = 'https://' . $this->cleanServerUrl($server) . '/EWS/Exchange.asmx';

        $options = array_replace_recursive([
            'version' => self::VERSION_2007,
            'trace' => 1,
            'exceptions' => true,
            'classmap' => ClassMap::getClassMap(),
            'drillDownResponses' => true
        ], $options);

        $this->server = $server;
        $this->version = $options['version'];

        $this->soap = new NTLMSoapClient(
            $location,
            $auth,
            dirname(__FILE__) . '/../../Resources/wsdl/services.wsdl',
            $options
        );

        if (isset($options['primarySmtpEmailAddress'])) {
            $this->setPrimarySmtpEmailAddress($options['primarySmtpEmailAddress']);
        }

        if (isset($options['impersonation'])) {
            $this->setPrimarySmtpEmailAddress($options['impersonation']);
        }

        $this->drillDownResponses = $options['drillDownResponses'];
    }

    /**
     * @codeCoverageIgnore
     *
     * @param $name
     * @param $arguments
     * @return Type
     * @throws \garethp\ews\API\Exception
     */
    public function __call($name, $arguments)
    {
        $response = $this->getClient()->__call($name, $arguments);

        return $this->processResponse($response);
    }

    /**
     * Returns the SOAP Client that may be used to make calls against the server
     *
     * @return NTLMSoapClient
     */
    public function getClient()
    {
        return $this->soap;
    }

    /**
     * Sets the client
     *
     * @param NTLMSoapClient $client
     * @return $this
     */
    public function setClient($client)
    {
        $this->soap = $client;

        return $this;
    }

    /**
     * Cleans the server URL for usage
     *
     * @param $server
     * @return string
     */
    public function cleanServerUrl($server)
    {
        $url = parse_url($server);
        if (!isset($url['host']) && isset($url['path'])) {
            $url['host'] = $url['path'];
            unset($url['path']);
        }

        $server = $url['host'];
        if (isset($url['port'])) {
            $server .= ':' . $url['port'];
        }

        if (isset($url['path'])) {
            $server .= $url['path'];
        }

        $server = rtrim($server, "/");

        return $server;
    }

    /**
     * Process a response to verify that it succeeded and take the appropriate
     * action
     *
     * @param \garethp\ews\API\Message\BaseResponseMessageType $response
     * @return \garethp\ews\API\Message\ArrayOfResponseMessageType|\garethp\ews\API\Message\ResponseMessageType
     * @throws \garethp\ews\API\Exception
     */
    protected function processResponse($response)
    {
        // If the soap call failed then we need to thow an exception.
        $code = $this->getClient()->getResponseCode();
        if ($code == 401) {
            throw new UnauthorizedException();
        }

        if ($code == 503) {
            throw new ServiceUnavailableException();
        }

        if ($code != 200) {
            throw new ExchangeException('SOAP client returned status of ' . $code, $code);
        }

        if (empty($response) ||
            empty($response->getNonNullResponseMessages())
        ) {
            throw new NoResponseReturnedException();
        }

        if (!$this->drillDownResponses) {
            return $response;
        }

        if (!$response->exists('responseMessages')) {
            return $response;
        }

        $response = $response->getResponseMessages();
        $response = $this->drillDownResponseLevels($response);

        return $response;
    }

    /**
     * @param $response
     * @return array
     * @throws \garethp\ews\API\Exception
     */
    public function drillDownResponseLevels($response)
    {
        $items = array();
        if ($response instanceof Type) {
            $items = $response->getNonNullItems();
        } elseif (is_array($response)) {
            $items = $response;
        }

        if ($response instanceof Message\ResponseMessageType) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
            if ($response->getResponseClass() !== "Success") {
                throw new ExchangeException($response->getMessageText());
            }

            unset($items['responseClass']);
            unset($items['responseCode']);
        }

        if (count($items) == 1) {
            reset($items);
            $key = key($items);
            $methodName = "get$key";
            $response = $response->$methodName();

            $response = $this->drillDownResponseLevels($response);
        } elseif (is_array($items) && isset($items[1]) && $items[1] instanceof Message\ResponseMessageType) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
            $response = array();
            foreach ($items as $responseItem) {
                $response[] = $this->drillDownResponseLevels($responseItem);
            }
        }

        return $response;
    }
}


Push — master ( 5011ba...5ed41a )

ExchangeWebServices::setPrimarySmtpEmailAddress() A

Complexity

Size

Duplication

Code Coverage

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1		<?php
2		/**
3		* Contains ExchangeWebServices.
4		*/
5
6		namespace garethp\ews\API;
7
8		use garethp\ews\API\Exception\ExchangeException;
9		use garethp\ews\API\Exception\NoResponseReturnedException;
10		use garethp\ews\API\Exception\ServiceUnavailableException;
11		use garethp\ews\API\Exception\UnauthorizedException;
12		use garethp\ews\API\Message;
13		use garethp\ews\API\Type\EmailAddressType;
14
15		/**
16		* Base class of the Exchange Web Services application.
17		*
18		* @package php-ews\Client
19		*
20		* @method Type CreateItem($request)
21		* @method Type FindItem($request)
22		* @method Type GetFolder($request)
23		* @method Type SyncFolderItems($request)
24		* @method Type FindFolder($request)
25		* @method Type UpdateItem($request)
26		* @method Type DeleteItem($request)
27		* @method Type GetItem($request)
28		*/
29		class ExchangeWebServices
30		{
31		const VERSION_2007 = 'Exchange2007';
32		const VERSION_2007_SP1 = 'Exchange2007_SP1';
33		const VERSION_2007_SP2 = 'Exchange2007_SP2';
34		const VERSION_2007_SP3 = 'Exchange2007_SP3';
35
36		const VERSION_2010 = 'Exchange2010';
37		const VERSION_2010_SP1 = 'Exchange2010_SP1';
38		const VERSION_2010_SP2 = 'Exchange2010_SP2';
39		const VERSION_2010_SP3 = 'Exchange2010_SP3';
40
41		const VERSION_2013 = 'Exchange2013';
42		const VERSION_2013_SP1 = 'Exchange2013_SP1';
43
44		/**
45		* Password to use when connecting to the Exchange server.
46		*
47		* @var string
48		*/
49		protected $password;
50
51		/**
52		* Location of the Exchange server.
53		*
54		* @var string
55		*/
56		protected $server;
57
58		/**
59		* SOAP client used to make the request
60		*
61		* @var NTLMSoapClient
62		*/
63		protected $soap;
64
65		/**
66		* Username to use when connecting to the Exchange server.
67		*
68		* @var string
69		*/
70		protected $username;
71
72		/**
73		* @var EmailAddressType
74		*/
75		protected $primarySmtpMailbox;
76
77		/**
78		* A setting to check whether or not responses should be drilled down before being returned. Setting this to false
79		* will return the raw responses without any filtering
80		*
81		* @var bool
82		*/
83		protected $drillDownResponses = true;
84
85		/**
86		* @return EmailAddressType
87		*/
88	20	public function getPrimarySmtpMailbox()
89		{
90	20	return $this->primarySmtpMailbox;
91		}
92
93	1	public function getPrimarySmtpEmailAddress()
94		{
95	1	if ($this->primarySmtpMailbox == null) {
96	1	return null;
97		}
98
99	1	return $this->primarySmtpMailbox->getEmailAddress();
100		}
101
102	2	public function setPrimarySmtpEmailAddress($emailAddress)
103		{
104	2	$mailbox = new EmailAddressType();
105	2	$mailbox->setEmailAddress($emailAddress);
106	2	$this->primarySmtpMailbox = $mailbox;
107
108	2	return $this;
109		}
110
111		/**
112		* Miscrosoft Exchange version that we are going to connect to
113		*
114		* @var string
115		*/
116		protected $version;
117
118		protected $options;
119
120		/**
121		* The timezone for the client
122		*
123		* @var bool
124		*/
125		protected $timezone = false;
126
127		/**
128		* @param boolean $timezone
129		*/
130		public function setTimezone($timezone)
131		{
132		$this->timezone = $timezone;
133		}
134
135		/**
136		* @return string
137		*/
138		public function getVersion()
139		{
140		return $this->version;
141		}
142
143		/**
144		* @return string
145		*/
146		public function getServer()
147		{
148		return $this->server;
149		}
150
151		/**
152		* Constructor for the ExchangeWebServices class
153		*
154		* @deprecated Since 0.6.3
155		* @param string $server
156		* @param string $username
157		* @param string $password
158		* @param array $options
159		*/
160	28	public function __construct(
161		$server = null,
162		$username = null,
163		$password = null,
164		$options = []
165		) {
166	28	if ($server !== null) {
167	1	$this->createClient(
168		$server,
169	1	ExchangeWebServicesAuth::fromUsernameAndPassword($username, $password),
170		$options
171		);
172		}
173		}
174
175	26	public static function fromUsernameAndPassword($server, $username, $password, $options)
176		{
177	26	$self = new static();
178	26	$self->createClient($server, ExchangeWebServicesAuth::fromUsernameAndPassword($username, $password), $options);
179
180	26	return $self;
181		}
182
183	1	public static function fromCallbackToken($server, $token, $options)
184		{
185	1	$self = new static();
186	1	$self->createClient($server, ExchangeWebServicesAuth::fromCallbackToken($token), $options);
187
188	1	return $self;
189		}
190
191	28	protected function createClient($server, $auth, $options)
192		{
193	28	$location = 'https://' . $this->cleanServerUrl($server) . '/EWS/Exchange.asmx';
194
195	28	$options = array_replace_recursive([
196	28	'version' => self::VERSION_2007,
197	28	'trace' => 1,
198		'exceptions' => true,
199	28	'classmap' => ClassMap::getClassMap(),
200		'drillDownResponses' => true
201		], $options);
202
203	28	$this->server = $server;
204	28	$this->version = $options['version'];
205
206	28	$this->soap = new NTLMSoapClient(
207		$location,
208		$auth,
209	28	dirname(__FILE__) . '/../../Resources/wsdl/services.wsdl',
210		$options
211		);
212
213	28	if (isset($options['primarySmtpEmailAddress'])) {
214	1	$this->setPrimarySmtpEmailAddress($options['primarySmtpEmailAddress']);
215		}
216
217	28	if (isset($options['impersonation'])) {
218	1	$this->setPrimarySmtpEmailAddress($options['impersonation']);
219		}
220
221	28	$this->drillDownResponses = $options['drillDownResponses'];
222		}
223
224		/**
225		* @codeCoverageIgnore
226		*
227		* @param $name
228		* @param $arguments
229		* @return Type
230		* @throws \garethp\ews\API\Exception
231		*/
232		public function __call($name, $arguments)
233		{
234		$response = $this->getClient()->__call($name, $arguments);
235
236		return $this->processResponse($response);
237		}
238
239		/**
240		* Returns the SOAP Client that may be used to make calls against the server
241		*
242		* @return NTLMSoapClient
243		*/
244	26	public function getClient()
245		{
246	26	return $this->soap;
247		}
248
249		/**
250		* Sets the client
251		*
252		* @param NTLMSoapClient $client
253		* @return $this
254		*/
255	2	public function setClient($client)
256		{
257	2	$this->soap = $client;
258
259	2	return $this;
260		}
261
262		/**
263		* Cleans the server URL for usage
264		*
265		* @param $server
266		* @return string
267		*/
268	35	public function cleanServerUrl($server)
269		{
270	35	$url = parse_url($server);
271	35	if (!isset($url['host']) && isset($url['path'])) {
272	30	$url['host'] = $url['path'];
273	30	unset($url['path']);
274		}
275
276	35	$server = $url['host'];
277	35	if (isset($url['port'])) {
278	2	$server .= ':' . $url['port'];
279		}
280
281	35	if (isset($url['path'])) {
282	4	$server .= $url['path'];
283		}
284
285	35	$server = rtrim($server, "/");
286
287	35	return $server;
288		}
289
290		/**
291		* Process a response to verify that it succeeded and take the appropriate
292		* action
293		*
294		* @param \garethp\ews\API\Message\BaseResponseMessageType $response
295		* @return \garethp\ews\API\Message\ArrayOfResponseMessageType\|\garethp\ews\API\Message\ResponseMessageType
296		* @throws \garethp\ews\API\Exception
297		*/
298	24	protected function processResponse($response)
299		{
300		// If the soap call failed then we need to thow an exception.
301	24	$code = $this->getClient()->getResponseCode();
302	24	if ($code == 401) {
303		throw new UnauthorizedException();
304		}
305
306	24	if ($code == 503) {
307		throw new ServiceUnavailableException();
308		}
309
310	24	if ($code != 200) {
311	2	throw new ExchangeException('SOAP client returned status of ' . $code, $code);
312		}
313
314	22	if (empty($response) \|\|
315	22	empty($response->getNonNullResponseMessages())
316		) {
317		throw new NoResponseReturnedException();
318		}
319
320	22	if (!$this->drillDownResponses) {
321		return $response;
322		}
323
324	22	if (!$response->exists('responseMessages')) {
325		return $response;
326		}
327
328	22	$response = $response->getResponseMessages();
329	22	$response = $this->drillDownResponseLevels($response);
330
331	22	return $response;
332		}
333
334		/**
335		* @param $response
336		* @return array
337		* @throws \garethp\ews\API\Exception
338		*/
339	22	public function drillDownResponseLevels($response)
340		{
341	22	$items = array();
342	22	if ($response instanceof Type) {
343	22	$items = $response->getNonNullItems();
344	1	} elseif (is_array($response)) {
345	1	$items = $response;
346		}
347
348	22	if ($response instanceof Message\ResponseMessageType) {
		0 ignored issues – show Bug introduced 2016-05-02 09:06 UTC by Report Bug Copy Issue Report The class `garethp\ews\API\Message\ResponseMessageType` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
349	22	if ($response->getResponseClass() !== "Success") {
350	1	throw new ExchangeException($response->getMessageText());
351		}
352
353	22	unset($items['responseClass']);
354	22	unset($items['responseCode']);
355		}
356
357	22	if (count($items) == 1) {
358	22	reset($items);
359	22	$key = key($items);
360	22	$methodName = "get$key";
361	22	$response = $response->$methodName();
362
363	22	$response = $this->drillDownResponseLevels($response);
364	22	} elseif (is_array($items) && isset($items[1]) && $items[1] instanceof Message\ResponseMessageType) {
		0 ignored issues – show Bug introduced 2016-05-02 09:06 UTC by Report Bug Copy Issue Report The class `garethp\ews\API\Message\ResponseMessageType` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
365	1	$response = array();
366	1	foreach ($items as $responseItem) {
367	1	$response[] = $this->drillDownResponseLevels($responseItem);
368		}
369		}
370
371	22	return $response;
372		}
373		}
374

Garethp / php-ews

Push — master ( 5011ba...5ed41a )

ExchangeWebServices::setPrimarySmtpEmailAddress() A

Complexity

Size

Duplication

Code Coverage

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like