Author Topic: Documentation for Form and related objects? (Read 1271 times)

surgeonbor · May 28, 2010, 11:00:42 am

I need to implement hook_civicrm_buildForm() on my Drupal site. The documentation in the "CiviCRM hook specification" page describes the $form parameter as "object $form - reference to the form object," but it doesn't refer to any documentation of the form object and its available methods (e.g. setDefaults(), assign(), freeze(), etc.). I looked at the sample hooks in civitest.module.sample, and those are somewhat useful, but it would be nice to see a full listing of the available methods and their parameters. In other words, is there documentation for the form object and its related objects?

Donald Lobo · May 28, 2010, 12:27:19 pm

all the form classes inherit from HTML_Quickform. docs here:

http://pear.php.net/manual/en/package.html.html-quickform.php

we need to do a better job documenting and generating docs for the classes that are our basis. maybe a class doc sprint? want to help coordinate and arrange one?

lobo

xavier · June 01, 2010, 06:47:26 am

Yeap, the quickForm package isn't the most documented piece of code. This article from 2004 is an attempt to provide some info about it:

http://www.devarticles.com/c/a/Web-Graphic-Design/Using-HTML-Quickform-for-Form-Processing/

X+

CiviCRM Community Forums (archive)

News:

Author Topic: Documentation for Form and related objects? (Read 1271 times)

surgeonbor

Documentation for Form and related objects?

Donald Lobo

Re: Documentation for Form and related objects?

xavier

Re: Documentation for Form and related objects?