The OutOfRangeException class

(PHP 5 >= 5.1.0, PHP 7, PHP 8)


Exception thrown when an illegal index was requested. This represents errors that should be detected at compile time.

Sinopse da classe

class OutOfRangeException extends LogicException {
/* Propriedades herdadas */
protected string $message;
protected int $code;
protected string $file;
protected int $line;
/* Métodos herdados */
final public Exception::getMessage(): string
final public Exception::getCode(): mixed
final public Exception::getFile(): string
final public Exception::getLine(): string
final public Exception::getTrace(): array
final public Exception::getTraceAsString(): string
public Exception::__toString(): string
final private Exception::__clone(): string
add a note

User Contributed Notes 4 notes

2 years ago
I tried to write a snippet that would be detected at compile time, but was unable, apparently due to my PHP engine's interpreted nature. The creator(s) should have provided a usage example (for end-users) or pointed to PHP sources for an example of where/how it's used. None of the provided examples, to date, reflect an exception detected at compile time, as this class asserts.

IMO it's hopeful at best to expect a compiler to detect an illegal index in a dynamically-typed, typically JIT-executed, enviro. Since when is there a strict contract of what indexes should be considered "within range" and how would the compiler know about this contract? Also, how would we try/catch that in the compile phase?

SPL also provides the OutOfBounds exception. If this class, its parent, and OOB have little distinction, then does SPL need all 3?
5 years ago
I see this in this way:
By definiton, OutOfRangeException should be use to when potential problem is logical - occurs because of wrong code or definition. OutOfBoundsException is for runtime.

Example (see also note in "OutOfBoundsException class" article):
function prepareData(PDOStatement $s) {
$x = $s->fetch();
    if (!isset(
        throw new
OutOfRangeException ("Secret column doesn't exist! Verify table definition and query.");
evguenia dot chagnon at gmail dot com
5 years ago
Exemple :

$calendar = new Calendar();
anrdaemon at yandex dot ru
2 months ago
I would probably repeat @jacub's answer, but I see the distinction as following:

`OutOfBoundsException` you throw, when _you_ _set_ bounds and do not wish them to be crossed by an external entity, but they may be.
Example: you ask for a number in range [1, 6] and user input 0 or 7 or what else. You throw an exception indicating user error they could amend.

`OutOfRange` you throw, when you expect value within allowed boundary, but actual operation fails.
Example: You are trying to access external API call using information provided by the API itself, and it suddenly tell you that the reference key is not pointing to a valid object. You throw an exception indicating internal failure that the user is unable to correct.

In both cases, the key word is "you throw". Both exceptions are generated at runtime, but the latter describes a situation that should not happen, ever, if a system is configured correctly.
To Top