Correct exception type for adding to an array when it isn't allowed?

Question

Let's say I have a class that implements ArrayAccess but doesn't allow the addition of new data. You can set already existing values, but you can't add to the size.

$arrayAccessible[1] = new StdClass(); //okay
$arrayAccessible[] = new StdClass(); //should throw an exception

What exception type should I throw? I do have SPL exception types available and should use them if it makes sense. The best I can think of is perhaps BadFunctionCallException or BadMethodCallException.

If there isn't a good one to throw, perhaps I'll make UnsupportedOperationException or the like. However, that is definitely not something I'd like to do. That would be incredibly hard to add in this project.

Community · Accepted Answer · 2023-11-17 20:42:18Z

6

Honestly, I would throw an OverflowException. Since the array is fixed, it is by definition full as well...

edited Nov 17, 2023 at 20:42

CommunityBot

11 silver badge

answered Nov 21, 2011 at 23:51

ircmaxell

166k36 gold badges269 silver badges316 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Ondrej Slinták · Accepted Answer · 2011-11-21 22:36:05Z

1

I'd say UnsupportedOperationException is good enough - it describes the problem that occurred well and fellow developer should be able to figure out what happened easily. If you aren't sure or want to be more specific, create your own exception.

Also, I wouldn't probably use ArrayAccess (unless you are working with legacy code) if I wanted to have fields read only. Getters should do the trick. If you want to iterate over object's properties, implement also Iterator interface.

answered Nov 21, 2011 at 22:36

Ondrej Slinták

32.1k21 gold badges97 silver badges127 bronze badges

4 Comments

Levi Morrison Over a year ago

You misunderstood: you can modifiy it, you just cannot increase the size of the array. Also, creating a new exception is my last option to take. I'd MUCH rather throw an existing one. I don't think you quite understand how much, but it's a big deal to make a new one.

Ondrej Slinták Over a year ago

It doesn't change anything. UnsupportedOperationException still sounds good to me - just perhaps specify what went wrong in its message. Just as a backup to my statement, check comment from baldurien at bbnwn dot on php.net/manual/en/language.oop5.iterations.php. He uses the same exception in similar situation to yours.

Levi Morrison Over a year ago

Note that he's quoting a Java exception, not a PHP one. Java is where I got the name UnsupportedOperationException from. It does not exist in PHP, and baldurien did NOT throw it in PHP.

Ondrej Slinták Over a year ago

Ah crap, I should learn to read. I'm not familiar with SPL exceptions and missed that "make" in your question. Anyway, I'd use LogicException for sure:

Exception that represents error in the program logic. This kind of exceptions should directly lead to a fix in your code.

BadFunctionCallException wouldn't be a good choice as it is Exception thrown if a callback refers to an undefined function or if some arguments are missing. which isn't correct in your case.

Collectives™ on Stack Overflow

Correct exception type for adding to an array when it isn't allowed?

2 Answers 2

Comments

4 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

4 Comments

Your Answer

Sign up or log in

Post as a guest

Related