SiteSearchPinger::ping() - Code Metrics - nixsolutions/yandex-php-library - Measure and Improve Code Quality continuously with Scrutinizer

SiteSearchPinger::ping() C
last analyzed 2021-05-31 12:34 UTC

↳ Parent: SiteSearchPinger

Complexity

Conditions	13
Paths	9

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	25
CRAP Score	13

Importance

Changes

Metric	Value
dl	0
loc	46
ccs	25
cts	25
cp	1
rs	6.6166
c	0
b	0
f	0
cc	13
nc	9
nop	2
crap	13

How to fix Complexity

<?php
/**
 * Yandex PHP Library
 *
 * @copyright NIX Solutions Ltd.
 * @link https://github.com/nixsolutions/yandex-php-library
 */

/**
 * @namespace
 */
namespace Yandex\SiteSearchPinger;

use Yandex\Common\AbstractServiceClient;
use Yandex\Common\Exception\InvalidArgumentException;
use Yandex\SiteSearchPinger\Exception\InvalidUrlException;
use Yandex\SiteSearchPinger\Exception\SiteSearchPingerException;
use GuzzleHttp\Psr7\Response;
use GuzzleHttp\Exception\ClientException;

/**
 * SiteSearchPinger
 *
 * @category Yandex
 * @package  SiteSearchPinger
 *
 * @property string $key
 * @property string $login
 * @property string $searchId
 * @property array $invalidUrls
 *
 * @author   Anton Shevchuk
 * @created  06.08.13 17:30
 */
class SiteSearchPinger extends AbstractServiceClient
{
    const DECODE_TYPE_DEFAULT = self::DECODE_TYPE_XML;

    /**
     * @var string
     */
    protected $serviceScheme = self::HTTP_SCHEME;

    /**
     * @var string
     */
    protected $serviceProtocolVersion = '1.0';

    /**
     * @var string
     */
    protected $serviceDomain = "site.yandex.ru";

    /**
     * @var string
     */
    protected $path = "ping.xml";

    /**
     * @var string
     */
    protected $key;

    /**
     * @var string
     */
    protected $login;

    /**
     * @var string
     */
    protected $searchId;

    /**
     * Connection Errors
     */
    const ERROR_ILLEGAL_PARAM_VALUE = 'ILLEGAL_PARAM_VALUE';
    const ERROR_ILLEGAL_VALUE_TYPE = 'ILLEGAL_VALUE_TYPE';
    const ERROR_NO_SUCH_USER_IN_PASSPORT = 'NO_SUCH_USER_IN_PASSPORT';
    const ERROR_SEARCH_NOT_OWNED_BY_USER = 'SEARCH_NOT_OWNED_BY_USER';
    const ERROR_TOO_DELAYED_PUBLISH = 'TOO_DELAYED_PUBLISH';
    const ERROR_USER_NOT_PERMITTED = 'USER_NOT_PERMITTED';

    /**
     * URL Errors
     */
    const INVALID_MALFORMED_URLS = 'MALFORMED_URLS';
    const INVALID_NOT_CONFIRMED_IN_WMC = 'NOT_CONFIRMED_IN_WMC';
    const INVALID_OUT_OF_SEARCH_AREA = 'OUT_OF_SEARCH_AREA';

    /**
     * @var array
     */
    protected $invalid = [
        self::INVALID_MALFORMED_URLS => "Invalid URL format",
        self::INVALID_NOT_CONFIRMED_IN_WMC => "Invalid site URL. Site is not confirmed on http://webmaster.yandex.ru/",
        self::INVALID_OUT_OF_SEARCH_AREA => "Invalid site URL. Site is not under your search area",
    ];

    /**
     * @var array
     */
    protected $invalidUrls = [];

    /**
     * set search key
     *
     * @param $value
     * @return self
     */
    public function setKey($value)
    {
        $this->key = $value;
        return $this;
    }

    /**
     * set search login
     *
     * @param $value
     * @return self
     */
    public function setLogin($value)
    {
        $this->login = $value;
        return $this;
    }

    /**
     * set search id
     *
     * @param $value
     * @return self
     */
    public function setSearchId($value)
    {
        $this->searchId = $value;
        return $this;
    }

    /**
     * get invalid Urls from request
     *
     * @return array
     */
    public function getInvalidUrls()
    {
        return $this->invalidUrls;
    }

    /**
     * ping
     *
     * @param string|array $urls
     * @param integer $publishDate seconds from now to publish urls
     *
     * @throws Exception\SiteSearchPingerException
     * @throws Exception\InvalidUrlException
     * @throws \Yandex\Common\Exception\InvalidArgumentException
     * @return int
     */
    public function ping($urls, $publishDate = 0)
    {
        $this->checkSettings();

        $urls = (array)$urls;

        try {
            $response = $this->doRequest($urls, $publishDate);
        } catch (ClientException $e) {
            $xml = $this->getDecodedBody($e->getResponse()->getBody());

            if (isset($xml->error) && isset($xml->error->message)) {
                $errorMessage = (string) $xml->error->message;
                if (isset($xml->error->param) && isset($xml->error->value)) {
                    $errorMessage .= " (".$xml->error->param." is ".$xml->error->value.")";
                }
                throw new InvalidArgumentException($errorMessage);
            }
            return 0;
        }

        if (!$xml = $this->getDecodedBody($response->getBody())) {
            throw new SiteSearchPingerException("Wrong server response format");
        } elseif ($xml->getName() == 'empty-param') {
            // workaround for invalid request, with empty `urls`
            throw new InvalidUrlException("URL param is required");
        }

        // retrieve count of valid urls
        $addedCount = 0;
        if (isset($xml->added) && isset($xml->added['count'])) {
            $addedCount = (int)$xml->added['count'];
        }

        // check invalid urls and fill errors stack
        $this->invalidUrls = [];
        if (isset($xml->invalid)) {
            foreach ($xml->invalid as $invalid) {
                foreach ($invalid as $url) {
                    $this->invalidUrls[(string)$url] = $this->invalid[(string) $invalid['reason']];
                }
            }
        }

        return $addedCount;
    }

    /**
     * doCheckOptions
     *
     * @return boolean
     */
    protected function doCheckSettings()
    {
        return $this->key && $this->login && $this->searchId;
    }

    /**
     * @param array $urls
     * @param integer $publishDate
     *
     * @return Response;

     */
    protected function doRequest($urls, $publishDate)
    {
        $client = $this->getClient();

        return $client->request(
            'POST',
            '/' . $this->path,
            [
                'version' => $this->serviceProtocolVersion,
                'form_params' => [
                    'urls' => join("\n", $urls),
                    'publishdate' => $publishDate
                ],
                'query' => [
                    'key' => $this->key,
                    'login' => $this->login,
                    'search_id' => $this->searchId
                ],
                'headers' => [
                    'Y-SDK' => 'Pinger'
                ]
            ]
        );
    }
}


1		<?php
2		/**
3		* Yandex PHP Library
4		*
5		* @copyright NIX Solutions Ltd.
6		* @link https://github.com/nixsolutions/yandex-php-library
7		*/
8
9		/**
10		* @namespace
11		*/
12		namespace Yandex\SiteSearchPinger;
13
14		use Yandex\Common\AbstractServiceClient;
15		use Yandex\Common\Exception\InvalidArgumentException;
16		use Yandex\SiteSearchPinger\Exception\InvalidUrlException;
17		use Yandex\SiteSearchPinger\Exception\SiteSearchPingerException;
18		use GuzzleHttp\Psr7\Response;
19		use GuzzleHttp\Exception\ClientException;
20
21		/**
22		* SiteSearchPinger
23		*
24		* @category Yandex
25		* @package SiteSearchPinger
26		*
27		* @property string $key
28		* @property string $login
29		* @property string $searchId
30		* @property array $invalidUrls
31		*
32		* @author Anton Shevchuk
33		* @created 06.08.13 17:30
34		*/
35		class SiteSearchPinger extends AbstractServiceClient
36		{
37		const DECODE_TYPE_DEFAULT = self::DECODE_TYPE_XML;
38
39		/**
40		* @var string
41		*/
42		protected $serviceScheme = self::HTTP_SCHEME;
43
44		/**
45		* @var string
46		*/
47		protected $serviceProtocolVersion = '1.0';
48
49		/**
50		* @var string
51		*/
52		protected $serviceDomain = "site.yandex.ru";
53
54		/**
55		* @var string
56		*/
57		protected $path = "ping.xml";
58
59		/**
60		* @var string
61		*/
62		protected $key;
63
64		/**
65		* @var string
66		*/
67		protected $login;
68
69		/**
70		* @var string
71		*/
72		protected $searchId;
73
74		/**
75		* Connection Errors
76		*/
77		const ERROR_ILLEGAL_PARAM_VALUE = 'ILLEGAL_PARAM_VALUE';
78		const ERROR_ILLEGAL_VALUE_TYPE = 'ILLEGAL_VALUE_TYPE';
79		const ERROR_NO_SUCH_USER_IN_PASSPORT = 'NO_SUCH_USER_IN_PASSPORT';
80		const ERROR_SEARCH_NOT_OWNED_BY_USER = 'SEARCH_NOT_OWNED_BY_USER';
81		const ERROR_TOO_DELAYED_PUBLISH = 'TOO_DELAYED_PUBLISH';
82		const ERROR_USER_NOT_PERMITTED = 'USER_NOT_PERMITTED';
83
84		/**
85		* URL Errors
86		*/
87		const INVALID_MALFORMED_URLS = 'MALFORMED_URLS';
88		const INVALID_NOT_CONFIRMED_IN_WMC = 'NOT_CONFIRMED_IN_WMC';
89		const INVALID_OUT_OF_SEARCH_AREA = 'OUT_OF_SEARCH_AREA';
90
91		/**
92		* @var array
93		*/
94		protected $invalid = [
95		self::INVALID_MALFORMED_URLS => "Invalid URL format",
96		self::INVALID_NOT_CONFIRMED_IN_WMC => "Invalid site URL. Site is not confirmed on http://webmaster.yandex.ru/",
97		self::INVALID_OUT_OF_SEARCH_AREA => "Invalid site URL. Site is not under your search area",
98		];
99
100		/**
101		* @var array
102		*/
103		protected $invalidUrls = [];
104
105		/**
106		* set search key
107		*
108		* @param $value
109		* @return self
110		*/
111	6	public function setKey($value)
112		{
113	6	$this->key = $value;
114	6	return $this;
115		}
116
117		/**
118		* set search login
119		*
120		* @param $value
121		* @return self
122		*/
123	6	public function setLogin($value)
124		{
125	6	$this->login = $value;
126	6	return $this;
127		}
128
129		/**
130		* set search id
131		*
132		* @param $value
133		* @return self
134		*/
135	6	public function setSearchId($value)
136		{
137	6	$this->searchId = $value;
138	6	return $this;
139		}
140
141		/**
142		* get invalid Urls from request
143		*
144		* @return array
145		*/
146	1	public function getInvalidUrls()
147		{
148	1	return $this->invalidUrls;
149		}
150
151		/**
152		* ping
153		*
154		* @param string\|array $urls
155		* @param integer $publishDate seconds from now to publish urls
156		*
157		* @throws Exception\SiteSearchPingerException
158		* @throws Exception\InvalidUrlException
159		* @throws \Yandex\Common\Exception\InvalidArgumentException
160		* @return int
161		*/
162	7	public function ping($urls, $publishDate = 0)
163		{
164	7	$this->checkSettings();
165
166	6	$urls = (array)$urls;
167
168		try {
169	6	$response = $this->doRequest($urls, $publishDate);
170	3	} catch (ClientException $e) {
171	3	$xml = $this->getDecodedBody($e->getResponse()->getBody());
172
173	3	if (isset($xml->error) && isset($xml->error->message)) {
174	2	$errorMessage = (string) $xml->error->message;
175	2	if (isset($xml->error->param) && isset($xml->error->value)) {
176	1	$errorMessage .= " (".$xml->error->param." is ".$xml->error->value.")";
177		}
178	2	throw new InvalidArgumentException($errorMessage);
179		}
180	1	return 0;
181		}
182
183	3	if (!$xml = $this->getDecodedBody($response->getBody())) {
184	1	throw new SiteSearchPingerException("Wrong server response format");
185	2	} elseif ($xml->getName() == 'empty-param') {
186		// workaround for invalid request, with empty `urls`
187	1	throw new InvalidUrlException("URL param is required");
188		}
189
190		// retrieve count of valid urls
191	1	$addedCount = 0;
192	1	if (isset($xml->added) && isset($xml->added['count'])) {
193	1	$addedCount = (int)$xml->added['count'];
194		}
195
196		// check invalid urls and fill errors stack
197	1	$this->invalidUrls = [];
198	1	if (isset($xml->invalid)) {
199	1	foreach ($xml->invalid as $invalid) {
200	1	foreach ($invalid as $url) {
201	1	$this->invalidUrls[(string)$url] = $this->invalid[(string) $invalid['reason']];
202		}
203		}
204		}
205
206	1	return $addedCount;
207		}
208
209		/**
210		* doCheckOptions
211		*
212		* @return boolean
213		*/
214	7	protected function doCheckSettings()
215		{
216	7	return $this->key && $this->login && $this->searchId;
217		}
218
219		/**
220		* @param array $urls
221		* @param integer $publishDate
222		*
223		* @return Response;
		0 ignored issues – show Documentation introduced 2015-11-23 12:09 UTC by Report Bug Copy Issue Report The doc-type `Response;` could not be parsed: Expected "\|" or "end of type", but got ";" at position 8. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
224		*/
225	6	protected function doRequest($urls, $publishDate)
226		{
227	6	$client = $this->getClient();
228
229	6	return $client->request(
230	6	'POST',
231	6	'/' . $this->path,
232		[
233	6	'version' => $this->serviceProtocolVersion,
234		'form_params' => [
235	6	'urls' => join("\n", $urls),
236	6	'publishdate' => $publishDate
237		],
238		'query' => [
239	6	'key' => $this->key,
240	6	'login' => $this->login,
241	6	'search_id' => $this->searchId
242		],
243		'headers' => [
244		'Y-SDK' => 'Pinger'
245		]
246		]
247		);
248		}
249		}
250

nixsolutions / yandex-php-library

SiteSearchPinger::ping() C last analyzed 2021-05-31 12:34 UTC

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like

SiteSearchPinger::ping() C
last analyzed 2021-05-31 12:34 UTC