? 902644.patch
Index: forms_api_reference.html
===================================================================
RCS file: /cvs/drupal-contrib/contributions/docs/developer/topics/forms_api_reference.html,v
retrieving revision 1.137
diff -u -r1.137 forms_api_reference.html
--- forms_api_reference.html 22 Jul 2010 23:41:35 -0000 1.137
+++ forms_api_reference.html 13 Oct 2010 22:42:33 -0000
@@ -61,6 +61,7 @@
| date |
fieldset |
file |
+ machine_name |
managed_file |
password |
password_confirm |
@@ -81,6 +82,7 @@
X |
X |
X |
+ X |
X |
X |
X |
@@ -100,6 +102,7 @@
X |
X |
X |
+ X |
X |
X |
X |
@@ -119,6 +122,7 @@
- |
- |
- |
+ - |
- |
- |
X |
@@ -139,6 +143,7 @@
X |
X |
X |
+ X |
X |
X |
X |
@@ -160,6 +165,7 @@
X |
X |
X |
+ X |
X |
X |
X |
@@ -179,7 +185,8 @@
X |
X |
X |
- X |
+ - |
+ X |
X |
- |
X |
@@ -199,6 +206,7 @@
- |
- |
- |
+ - |
- |
- |
- |
@@ -218,6 +226,7 @@
X |
- |
- |
+ - |
- |
- |
- |
@@ -237,6 +246,7 @@
X |
- |
- |
+ - |
- |
- |
- |
@@ -256,6 +266,7 @@
- |
- |
- |
+ - |
- |
- |
- |
@@ -275,6 +286,7 @@
- |
- |
- |
+ - |
- |
- |
- |
@@ -294,6 +306,7 @@
- |
- |
- |
+ - |
- |
- |
X |
@@ -313,6 +326,7 @@
- |
- |
- |
+ - |
- |
- |
- |
@@ -332,6 +346,7 @@
X |
X |
X |
+ X |
X |
X |
X |
@@ -351,6 +366,7 @@
- |
X |
X |
+ X |
X |
X |
X |
@@ -370,6 +386,7 @@
X |
X |
X |
+ X |
X |
X |
X |
@@ -389,6 +406,7 @@
- |
- |
- |
+ - |
- |
- |
- |
@@ -408,6 +426,7 @@
- |
- |
- |
+ - |
- |
- |
- |
@@ -427,6 +446,7 @@
- |
- |
- |
+ - |
- |
- |
- |
@@ -446,6 +466,7 @@
X |
- |
- |
+ - |
- |
- |
- |
@@ -465,6 +486,7 @@
- |
- |
- |
+ - |
- |
- |
- |
@@ -484,6 +506,7 @@
- |
- |
- |
+ - |
- |
- |
- |
@@ -503,6 +526,7 @@
- |
- |
- |
+ - |
X |
- |
- |
@@ -522,6 +546,7 @@
- |
- |
- |
+ - |
- |
- |
- |
@@ -541,6 +566,7 @@
- |
- |
- |
+ - |
- |
- |
- |
@@ -560,6 +586,7 @@
X |
X |
X |
+ X |
X |
X |
X |
@@ -579,6 +606,7 @@
X |
X |
X |
+ X |
X |
X |
X |
@@ -598,6 +626,7 @@
X |
X |
X |
+ X |
X |
X |
X |
@@ -617,6 +646,7 @@
X |
X |
X |
+ X |
X |
X |
X |
@@ -636,6 +666,7 @@
X |
X |
X |
+ X |
X |
X |
X |
@@ -654,7 +685,8 @@
X |
- |
- |
- - |
+ X |
+ - |
X |
X |
X |
@@ -674,6 +706,7 @@
- |
- |
- |
+ - |
- |
- |
- |
@@ -693,6 +726,7 @@
- |
- |
- |
+ - |
- |
- |
X |
@@ -712,6 +746,7 @@
- |
- |
- |
+ - |
- |
- |
- |
@@ -731,6 +766,7 @@
- |
- |
- |
+ - |
X |
X |
- |
@@ -750,6 +786,7 @@
X |
X |
X |
+ X |
X |
X |
X |
@@ -769,6 +806,7 @@
X |
X |
X |
+ X |
X |
X |
X |
@@ -788,6 +826,7 @@
- |
- |
- |
+ - |
- |
- |
- |
@@ -807,6 +846,7 @@
X |
X |
X |
+ X |
X |
X |
X |
@@ -826,6 +866,7 @@
X |
X |
X |
+ X |
X |
X |
X |
@@ -845,6 +886,7 @@
X |
X |
X |
+ X |
X |
X |
X |
@@ -864,6 +906,7 @@
X |
X |
X |
+ X |
X |
X |
X |
@@ -883,6 +926,7 @@
X |
X |
X |
+ X |
X |
X |
X |
@@ -1710,6 +1754,63 @@
?>
+
+
+Description: Provides a unique machine-readable name.
+
+By default provides a machine name that is validated such that it contains only alphanumeric and '_'. All characters not meeting this criteria are replaced with '_'. The validation routines also fail if the element value is comprised solely of '_'.
+
+Non-standard form element properties:
+
+- #machine_name: (array)
+
+ - exists: A function name to invoke for checking whether a submitted machine name value already exists. The submitted value is passed as argument. In most cases, an existing API or menu argument function can be re-used. The callback is only invoked, if the submitted value differs from the element's #default_value
+ - source: (optional) The #array_parents of the form element containing the human-readable name (i.e., as contained in the $form structure) to use as source for the machine name. Defaults to array('name').
+ - label: (optional) A text to display as label for the machine name value after the human-readable name form element. Defaults to "Machine name".
+ - replace_pattern: (optional) A regular expression (without delimiters) matching disallowed characters in the machine name. Defaults to '[^a-z0-9_]+'.
+ - replace: (optional) A character to replace disallowed characters in the machine name via JavaScript. Defaults to '_' (underscore). When using a different character, 'replace_pattern' needs to be set accordingly.
+
+
+
+
+Properties: #access, #after_build, #array_parents, #attached, #description, #disabled,
+#element_validate, #parents,
+#post_render, #prefix,
+#pre_render, #process,
+#required, #states,
+#suffix, #theme, #theme_wrappers,
+#title, #tree,
+#type
+#weight
+
+
+Usage example (menu.admin.inc):
+
+
+ <?php
+ $form['menu_name'] = array(
+ '#type' => 'machine_name',
+ '#title' => t('Menu name'),
+ '#default_value' => $menu['menu_name'],
+ '#maxlength' => MENU_MAX_MENU_NAME_LENGTH_UI,
+ '#description' => t('A unique name to construct the URL for the menu. It must only contain lowercase letters, numbers and hyphens.'),
+ '#machine_name' => array(
+ 'exists' => 'menu_edit_menu_name_exists',
+ 'source' => array('title'),
+ 'label' => t('URL path'),
+ 'replace_pattern' => '[^a-z0-9-]+',
+ 'replace' => '-',
+ ),
+ // A menu's machine name cannot be changed.
+ '#disabled' => !empty($menu['old_name']) || isset($system_menus[$menu['menu_name']]),
+ );
+ ?>
+
+
+
+
+
+
Description: Provides a complete ajax/progress aware widget for uploading a file and saving it to the {files} table.
@@ -3524,7 +3625,7 @@
element.
Values: button, checkbox, checkboxes, date, fieldset, file, form, hidden,
-image_button, item, markup, password, password_confirm, radio,
+image_button, item, machine_name, markup, password, password_confirm, radio,
radios, select, submit, tableselect, textarea, textfield, token, value, vertical_tabs, weight
Usage example (locale.module):