-
Notifications
You must be signed in to change notification settings - Fork 2k
Expand file tree
/
Copy pathApiException.php
More file actions
63 lines (54 loc) · 1.66 KB
/
ApiException.php
File metadata and controls
63 lines (54 loc) · 1.66 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
<?php
declare(strict_types=1);
/**
* This file is part of CodeIgniter 4 framework.
*
* (c) CodeIgniter Foundation <admin@codeigniter.com>
*
* For the full copyright and license information, please view
* the LICENSE file that was distributed with this source code.
*/
namespace CodeIgniter\API;
use CodeIgniter\Exceptions\FrameworkException;
/**
* Custom exception for API-related errors.
*/
final class ApiException extends FrameworkException
{
/**
* Thrown when the fields requested in a URL are not valid.
*/
public static function forInvalidFields(string $field): self
{
return new self(lang('Api.invalidFields', [$field]));
}
/**
* Thrown when the includes requested in a URL are not valid.
*/
public static function forInvalidIncludes(string $include): self
{
return new self(lang('Api.invalidIncludes', [$include]));
}
/**
* Thrown when an include is requested, but the method to handle it
* does not exist on the model.
*/
public static function forMissingInclude(string $include): self
{
return new self(lang('Api.missingInclude', [$include]));
}
/**
* Thrown when a transformer class cannot be found.
*/
public static function forTransformerNotFound(string $transformerClass): self
{
return new self(lang('Api.transformerNotFound', [$transformerClass]));
}
/**
* Thrown when a transformer class does not implement TransformerInterface.
*/
public static function forInvalidTransformer(string $transformerClass): self
{
return new self(lang('Api.invalidTransformer', [$transformerClass]));
}
}