appertly / minotaur

src/Net/Exception/Unreachable.php

<?php
declare(strict_types=1);
/**
 * Minotaur
 *
 * 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.
 *
 * @copyright 2015-2017 Appertly
 * @license   Apache-2.0
 */
namespace Minotaur\Net\Exception;

/**
 * An exception for connection errors.
 */
class Unreachable extends \RuntimeException implements \Minotaur\Net\Exception
{
    private const ERRORS = [
        CURLE_OPERATION_TIMEOUTED, CURLE_COULDNT_RESOLVE_HOST,
        CURLE_COULDNT_RESOLVE_PROXY, CURLE_COULDNT_CONNECT, CURLE_SSL_CONNECT_ERROR,
        CURLE_SSL_PEER_CERTIFICATE, CURLE_SSL_CACERT, CURLE_SEND_ERROR,
        CURLE_RECV_ERROR, CURLE_GOT_NOTHING
    ];

    /**
     * @var array<string,mixed> The cURL handle info
     */
    private $info;

    /**
     * @param iterable<string,mixed> $info The cURL handle info

The doc-type iterable<string,mixed> could not be parsed: Expected "|" or "end of type", but got "<" at position 8. (view supported doc-types)

     * @param $msg - The message
     * @param $code - The code
     * @param $previous - Any nested exception
     */
    public function __construct(iterable $info, string $msg, int $code = 0, \Exception $previous = null)
    {
        $this->info = is_array($info) ? $info : iterator_to_array($info, true);
        parent::__construct($msg, $code, $previous);
    }

    /**
     * Gets the cURL handle info.
     *
     * @return array<string,mixed> the handle info
     */
    public function getInfo(): array
    {
        return $this->info;
    }

    /**
     * Determines whether the code returned from cURL is one this class supports.
     *
     * @param int $code The code
     * @return bool whether this class should be used
     */
    public static function isUsable(int $code) : bool
    {
        return in_array($code, self::ERRORS, true);
    }
}