github-api/src/Github/exceptions.php at master · milo/github-api · GitHub

History

164 lines (120 loc) · 2.99 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

<?php

declare(strict_types=1);

/**

* All Milo\Github exceptions at one place. Whole library does not throw anything else.

* @author Miloslav Hůla (https://github.com/milo)

namespace Milo\Github {

/**

* Marker interface.

interface IException

{}

/**

* Wrong algorithm. API is used in wrong way. Application code should be changed.

class LogicException extends \LogicException implements IException

{}

/**

* Substitution is used in URL path but corresponding parameter is missing.

class MissingParameterException extends LogicException

{}

/**

* Unpredictable situation occurred.

abstract class RuntimeException extends \RuntimeException implements IException

{}

/**

* Github API returned a non-success HTTP code or data are somehow wrong. See all following descendants.

* @see Api::decode()

* @see https://developer.github.com/v3/#client-errors

abstract class ApiException extends RuntimeException

{

private ?Http\Response $response;

public function __construct(string $message = '', int $code = 0, ?\Exception $previous = null, ?Http\Response $response = null)

{

parent::__construct($message, $code, $previous);

$this->response = clone $response;

}

final public function getResponse(): ?Http\Response

{

return $this->response;

}

/**

* Invalid credentials (e.g. revoked token).

class UnauthorizedException extends ApiException

{}

/**

* Invalid JSON sent to Github API.

class BadRequestException extends ApiException

{}

/**

* Invalid structure sent to Github API (e.g. some required fields are missing).

class UnprocessableEntityException extends ApiException

{}

/**

* Access denied.

* @see https://developer.github.com/v3/#authentication

class ForbiddenException extends ApiException

{}

/**

* Rate limit exceed.

* @see https://developer.github.com/v3/#rate-limiting

class RateLimitExceedException extends ForbiddenException

{}

/**

* Resource not found.

* @see https://developer.github.com/v3/#authentication

class NotFoundException extends ApiException

{}

/**

* Response cannot be classified.

class UnexpectedResponseException extends ApiException

{}

/**

* Response from Github is somehow wrong (e.g. invalid JSON decoding).

class InvalidResponseException extends ApiException

{}

/**

* JSON cannot be decoded, or value cannot be encoded to JSON.

class JsonException extends RuntimeException

{}

}

namespace Milo\Github\Http {

use Milo\Github;

/**

* HTTP response is somehow wrong and cannot be processed.

class BadResponseException extends Github\RuntimeException

{}

}

namespace Milo\Github\OAuth {

use Milo\Github;

/**

* Something fails during the token obtaining.

class LoginException extends Github\RuntimeException

{}

}

namespace Milo\Github\Storages {

use Milo\Github;

/**

* Directory is missing and/or cannot be created.

class MissingDirectoryException extends Github\RuntimeException

{}

}

github-api/src/Github/exceptions.php at master · milo/github-api · GitHub

Expand file tree

Breadcrumbs

exceptions.php

Latest commit

History

Breadcrumbs

exceptions.php

File metadata and controls