diff options
Diffstat (limited to 'modules/contact/contact.admin.inc')
-rw-r--r-- | modules/contact/contact.admin.inc | 38 |
1 files changed, 30 insertions, 8 deletions
diff --git a/modules/contact/contact.admin.inc b/modules/contact/contact.admin.inc index 9fde037d3..4648fd3d7 100644 --- a/modules/contact/contact.admin.inc +++ b/modules/contact/contact.admin.inc @@ -2,7 +2,7 @@ /** * @file - * Admin page callbacks for the contact module. + * Admin page callbacks for the Contact module. */ /** @@ -53,7 +53,22 @@ function contact_category_list() { } /** - * Category edit page. + * Form constructor for the category edit form. + * + * @param $category + * An array describing the category to be edited. May be empty for new + * categories. Recognized array keys are: + * - category: The name of the category. + * - recipients: A comma-separated list of recipients. + * - reply: (optional) The body of the auto-reply message. + * - weight: The weight of the category. + * - selected: Boolean indicating whether the category should be selected by + * default. + * - cid: The category ID for which the form is to be displayed. + * + * @see contact_category_edit_form_validate() + * @see contact_category_edit_form_submit() + * @ingroup forms */ function contact_category_edit_form($form, &$form_state, array $category = array()) { // If this is a new category, add the default values. @@ -117,7 +132,9 @@ function contact_category_edit_form($form, &$form_state, array $category = array } /** - * Validate the contact category edit page form submission. + * Form validation handler for contact_category_edit_form(). + * + * @see contact_category_edit_form_submit() */ function contact_category_edit_form_validate($form, &$form_state) { // Validate and each e-mail recipient. @@ -144,7 +161,9 @@ function contact_category_edit_form_validate($form, &$form_state) { } /** - * Process the contact category edit page form submission. + * Form submission handler for contact_category_edit_form(). + * + * @see contact_category_edit_form_validate() */ function contact_category_edit_form_submit($form, &$form_state) { if ($form_state['values']['selected']) { @@ -167,8 +186,13 @@ function contact_category_edit_form_submit($form, &$form_state) { } /** - * Form builder for deleting a contact category. + * Form constructor for the contact category deletion form. + * + * @param $contact + * Array describing the contact category to be deleted. See the documentation + * of contact_category_edit_form() for the recognized keys. * + * @see contact_menu() * @see contact_category_delete_form_submit() */ function contact_category_delete_form($form, &$form_state, array $contact) { @@ -188,9 +212,7 @@ function contact_category_delete_form($form, &$form_state, array $contact) { } /** - * Submit handler for the confirm delete category form. - * - * @see contact_category_delete_form() + * Form submission handler for contact_category_delete_form(). */ function contact_category_delete_form_submit($form, &$form_state) { $contact = $form['contact']['#value']; |