Skip to content
Browse files

Document the 'submit' options in CHtml::clientChange() even better.

  • Loading branch information...
1 parent 6051be5 commit 5d30e121601c3a5968d0aa9ad07babfc7239fc48 @rawtaz rawtaz committed Oct 5, 2012
Showing with 4 additions and 3 deletions.
  1. +4 −3 framework/web/helpers/CHtml.php
View
7 framework/web/helpers/CHtml.php
@@ -2043,9 +2043,10 @@ public static function listOptions($selection,$listData,&$htmlOptions)
* specifying the client change behaviors:
* <ul>
* <li>submit: string, specifies the URL to submit to. If the current element has a parent form, that form will be
- * submitted, and if 'submit' contains an URL it will override the form's URL. If there is no parent form the data
- * listed in 'params' will be submitted instead (via POST method). Please note that if the 'csrf' setting is true,
- * the CSRF token will be included in the params too.</li>
+ * submitted, and if 'submit' is non-empty its value will replace the form's URL. If there is no parent form the
+ * data listed in 'params' will be submitted instead (via POST method), to the URL in 'submit' or the currently
+ * requested URL if 'submit' is empty. Please note that if the 'csrf' setting is true, the CSRF token will be
+ * included in the params too.</li>
* <li>params: array, name-value pairs that should be submitted together with the form. This is only used when 'submit' option is specified.</li>
* <li>csrf: boolean, whether a CSRF token should be automatically included in 'params' when {@link CHttpRequest::enableCsrfValidation} is true. Defaults to false.
* You may want to set this to be true if there is no enclosing form around this element.

0 comments on commit 5d30e12

Please sign in to comment.
Something went wrong with that request. Please try again.