CiviCRM Community Forums (archive)

Hi,

You mean on the wiki ? Create an account if you don't have one already and feel free to update.

X+

we've frozen the 3.1 docs and all changes are now happening in the 3.2 doc space (change CRMDOC to CRMUPCOMING)

this is primarily because confluence does not have a good version control system

lobo

Hi,

I'm wondering if the API functions should include something like an 'interrogate' function for each class. i.e. a function that would return an array of all the possible values. Some would be DB specific e.g.

$params['custom_23']

and others would have to be added as a form of documentation e.g.

$params['dedupe_check']


It's just a variant of documentation I suppose but it makes it easy when coding. The Get functions don't currently return empty values for all the possibilities do they?

I guess the question I have is:

How do you know what values can be passed to the api functions. You send in a $params array but ideally there would be an easy way to find out what values that array can / should hold. I don't think there is and I don't think there is much other then examples to go by.

Since documentation is hard to write & keep up-to-date it would be ideal if there was a way that was somewhat self-documenting

That's a bit of a hit or miss indeed.

Tip: Use the ajax interface, so you play directly with the url and that's easier to test/debug.

I can't see easily a way of generating all the possible param values (on the search for instance you have dozens). Something that would be a good first step is to be able to add a &debug=1 mode, that at least tell you when one of the params you have isn't recognized instead of silently being ignored.

Otherwise, the tests are a good source of examples, and if the specific ones you use is missing, that would be great that you add it, both as a way of expending the doc, and be sure it works the way you want on the next version.

How do you know what values can be passed to the api functions. You send in a $params array but ideally there would be an easy way to find out what values that array can / should hold. I don't think there is and I don't think there is much other then examples to go by.

Since documentation is hard to write & keep up-to-date it would be ideal if there was a way that was somewhat self-documenting