Permalink
Browse files

Fixing + updating doc blocks

  • Loading branch information...
1 parent 72e1c73 commit 12cc01eff52ca19e58ab0efb2120a6b718adc7cd @markstory markstory committed Mar 14, 2009
Showing with 18 additions and 4 deletions.
  1. +1 −1 cake/libs/view/helpers/jquery_engine.php
  2. +17 −3 cake/libs/view/helpers/js.php
@@ -26,7 +26,7 @@
*/
App::import('Helper', 'Js');
-class jqueryEngineHelper extends JsBaseEngineHelper {
+class JqueryEngineHelper extends JsBaseEngineHelper {
/**
* Create javascript selector for a CSS rule
*
@@ -520,7 +520,7 @@ function each($callback) {
/**
* Trigger an Effect.
*
- * #### Supported Effects
+ * ### Supported Effects
*
* The following effects are supported by all JsEngines
*
@@ -532,7 +532,7 @@ function each($callback) {
* - 'slideIn' - Slide an element in.
* - 'slideOut' - Slide an element out.
*
- * #### Options
+ * ### Options
*
* - 'speed' - Speed at which the animation should occur. Accepted values are 'slow', 'fast'. Not all effects use
* the speed option.
@@ -547,9 +547,23 @@ function effect($name, $options) {
/**
* Make an XHR request
*
+ * ### Options
+ *
+ * - 'method' - The method to make the request with defaults to GET in more libraries
+ * - 'complete' - Callback to fire on complete.
+ * - 'request' - Callback to fire on request initialization.
+ * - 'error' - Callback to fire on request failure.
+ * - 'async' - Whether or not you want an asynchronous request.
+ * - 'data' - Additional data to send.
+ * - 'update' - Dom selector to update with the content of the request.
+ * - 'type' - Data type for response. 'json' and 'html' are supported. Default is html for most libraries.
+ * - 'evalScripts' - Whether or not <script> tags should be evaled.
+ *
+ * @param mixed $url Array or String URL to target with the request.
+ * @param array $options Array of options. See above for cross library supported options
* @return string XHR request.
**/
- function request() {
+ function request($url, $options = array()) {
trigger_error(sprintf(__('%s does not have request() implemented', true), get_class($this)), E_USER_WARNING);
}
/**

0 comments on commit 12cc01e

Please sign in to comment.