How should my PHP function handle invalid parameters?

Question

I'm creating some re-usable functions, and right now I have error handling setup like this:

<?php
...
public function insertAfter( $index, $objects )
{
    if ( ! is_int( $index ) ) {
        trigger_error( 'Cursor::insertAfter() expects parameter 1 to be integer, ' . gettype( $index ) . ' given', E_USER_WARNING );
    } else {
        // Do my regular code
    }

    return $this;
}
...

I tried setting it up to work just like PHP would handle an error. Is this an appropriate way to do things?

Community · Accepted Answer · 2017-05-23 12:11:59Z

4

You may throws an exception. Take a look at Exception in PHP manual.

EDIT: Here are some useful SO threads.

edited May 23, 2017 at 12:11

CommunityBot

11 silver badge

answered Dec 9, 2011 at 3:48

KV Prajapati

94.8k20 gold badges151 silver badges188 bronze badges

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

4 Comments

Brandon - Free Palestine Over a year ago

I had that originally, but I prefer not to litter my code with try catch statements

deceze Over a year ago

An InvalidArgumentException would be most appropriate.

deceze Over a year ago

@Rogue You don't have to catch exceptions like this, that's the point. Passing an invalid argument type is not something that should be caught, it's an exceptional mistake that should stop your program and lead you to fix your code.

Brandon - Free Palestine Over a year ago

@deceze Thanks for point out InvalidArgumentException, this is exactly what I was looking for. Also, thank you for clarifying exceptions.

Community · Accepted Answer · 2017-05-23 11:55:31Z

0

Check out the Altumo package. It has quite a few handy validators that do what you are looking to do.

For example,

$index = \Altumo\Validation\Numerics::assertInteger( 
    $index, 
    'Cursor::insertAfter() expects parameter 1 to be integer, ' . gettype( $index ) . ' given'
);

There are validators for Object types, strings, boolean, etc.

P.S. Exceptions are more flexible than trigger_error() because you can control them more granularly. Here's a good thread on that topic.

edited May 23, 2017 at 11:55

CommunityBot

11 silver badge

answered Dec 9, 2011 at 3:56

0x6A75616E

4,7142 gold badges35 silver badges58 bronze badges

Collectives™ on Stack Overflow

How should my PHP function handle invalid parameters?

2 Answers 2

4 Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

4 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related