Révision 4444412d
Ajouté par Julien Enselme il y a presque 10 ans
drupal7/includes/form.inc | ||
---|---|---|
15 | 15 |
* reference the form builder function using \@see. For examples, of this see |
16 | 16 |
* system_modules_uninstall() or user_pass(), the latter of which has the |
17 | 17 |
* following in its doxygen documentation: |
18 |
* |
|
19 |
* \@ingroup forms |
|
20 |
* \@see user_pass_validate(). |
|
21 |
* \@see user_pass_submit(). |
|
18 |
* - \@ingroup forms |
|
19 |
* - \@see user_pass_validate() |
|
20 |
* - \@see user_pass_submit() |
|
22 | 21 |
* |
23 | 22 |
* @} |
24 | 23 |
*/ |
... | ... | |
3101 | 3100 |
* @param $variables |
3102 | 3101 |
* An associative array containing: |
3103 | 3102 |
* - element: An associative array containing the properties of the element. |
3104 |
* Properties used: #title, #value, #return_value, #description, #required, |
|
3105 |
* #attributes, #checked. |
|
3103 |
* Properties used: #id, #name, #attributes, #checked, #return_value. |
|
3106 | 3104 |
* |
3107 | 3105 |
* @ingroup themeable |
3108 | 3106 |
*/ |
... | ... | |
4294 | 4292 |
* returns any user input in the 'results' or 'message' keys of $context, |
4295 | 4293 |
* it must also sanitize them first. |
4296 | 4294 |
* |
4297 |
* Sample batch operations:
|
|
4295 |
* Sample callback_batch_operation():
|
|
4298 | 4296 |
* @code |
4299 | 4297 |
* // Simple and artificial: load a node of a given type for a given user |
4300 | 4298 |
* function my_function_1($uid, $type, &$context) { |
... | ... | |
4346 | 4344 |
* } |
4347 | 4345 |
* @endcode |
4348 | 4346 |
* |
4349 |
* Sample 'finished' callback:
|
|
4347 |
* Sample callback_batch_finished():
|
|
4350 | 4348 |
* @code |
4351 | 4349 |
* function batch_test_finished($success, $results, $operations) { |
4352 | 4350 |
* // The 'success' parameter means no fatal PHP errors were detected. All |
... | ... | |
4385 | 4383 |
* @param $batch_definition |
4386 | 4384 |
* An associative array defining the batch, with the following elements (all |
4387 | 4385 |
* are optional except as noted): |
4388 |
* - operations: (required) Array of function calls to be performed. |
|
4386 |
* - operations: (required) Array of operations to be performed, where each |
|
4387 |
* item is an array consisting of the name of an implementation of |
|
4388 |
* callback_batch_operation() and an array of parameter. |
|
4389 | 4389 |
* Example: |
4390 | 4390 |
* @code |
4391 | 4391 |
* array( |
4392 |
* array('my_function_1', array($arg1)),
|
|
4393 |
* array('my_function_2', array($arg2_1, $arg2_2)),
|
|
4392 |
* array('callback_batch_operation_1', array($arg1)),
|
|
4393 |
* array('callback_batch_operation_2', array($arg2_1, $arg2_2)),
|
|
4394 | 4394 |
* ) |
4395 | 4395 |
* @endcode |
4396 | 4396 |
* - title: A safe, translated string to use as the title for the progress |
... | ... | |
4402 | 4402 |
* @elapsed. Defaults to t('Completed @current of @total.'). |
4403 | 4403 |
* - error_message: Message displayed if an error occurred while processing |
4404 | 4404 |
* the batch. Defaults to t('An error has occurred.'). |
4405 |
* - finished: Name of a function to be executed after the batch has
|
|
4406 |
* completed. This should be used to perform any result massaging that may
|
|
4407 |
* be needed, and possibly save data in $_SESSION for display after final
|
|
4408 |
* page redirection. |
|
4405 |
* - finished: Name of an implementation of callback_batch_finished(). This is
|
|
4406 |
* executed after the batch has completed. This should be used to perform
|
|
4407 |
* any result massaging that may be needed, and possibly save data in
|
|
4408 |
* $_SESSION for display after final page redirection.
|
|
4409 | 4409 |
* - file: Path to the file containing the definitions of the 'operations' and |
4410 | 4410 |
* 'finished' functions, for instance if they don't reside in the main |
4411 | 4411 |
* .module file. The path should be relative to base_path(), and thus should |
Formats disponibles : Unified diff
Update drupal 7.27 -> 7.28