Author Topic: Error handling in the api: suggestion for improvment (Read 675 times)

xavier · August 27, 2010, 05:56:39 am

Right now, and error is raised by:

civicrm_create_error( ts( 'Input parameters is not an array' ))

1) There isn't any "error code" that can be properly parsed
2) And as the error msg is translated, it can't be used reliably either to know what error we encountered

I would like to add a new param to civicrm_create_error ("msg","error_code"), and return it to the caller (eg. rest or ajax)

What do you think ?

Donald Lobo · August 27, 2010, 07:27:41 am

To make this effective, we'll need to:

1. Have a list of error codes, names and descriptions
2. Update that list (and potentially use that same list to generate a wiki document)
3. I think most systems which use error codes, get the description from a centralized place (db?) to avoid inconsistency
4. change the code to follow the standards across the entire API

so the project is a bit larger than just adding the error_code variable. wanna take this on for 3.3? note that freeze is schedule for end sept / early oct

lobo

Erik Hommel · August 28, 2010, 02:08:28 am

Good idea Xavier! I agree with Lobo that it will require a bit of work. I think we need to create a table that holds the error codes, if necessary type of error (warning, fatal etc.) and an error message. Ideally this error message should be multi-lingual? But perhaps that part would be for a later point in time. Would it be a nice project for a sprint?
Erik

CiviCRM Community Forums (archive)

News:

Author Topic: Error handling in the api: suggestion for improvment (Read 675 times)

xavier

Error handling in the api: suggestion for improvment

Donald Lobo

Re: Error handling in the api: suggestion for improvment

Erik Hommel

Re: Error handling in the api: suggestion for improvment