Updated JavaScript casing and JsHelper references in doc blocks

This commit is contained in:
Bryan Crowe 2013-09-25 22:46:38 -04:00
parent 1c148c28f0
commit 915b51b239
11 changed files with 25 additions and 25 deletions

View file

@ -97,7 +97,7 @@
* /app/webroot/.htaccess * /app/webroot/.htaccess
* *
* And uncomment the App.baseUrl below. But keep in mind * And uncomment the App.baseUrl below. But keep in mind
* that plugin assets such as images, CSS and Javascript files * that plugin assets such as images, CSS and JavaScript files
* will not work without url rewriting! * will not work without url rewriting!
* To work around this issue you should either symlink or copy * To work around this issue you should either symlink or copy
* the plugin assets into you app's webroot directory. This is * the plugin assets into you app's webroot directory. This is
@ -254,7 +254,7 @@
* Plug in your own custom JavaScript compressor by dropping a script in your webroot to handle the * Plug in your own custom JavaScript compressor by dropping a script in your webroot to handle the
* output, and setting the config below to the name of the script. * output, and setting the config below to the name of the script.
* *
* To use, prefix your JavaScript link URLs with '/cjs/' instead of '/js/' or use JavaScriptHelper::link(). * To use, prefix your JavaScript link URLs with '/cjs/' instead of '/js/' or use JsHelper::link().
*/ */
//Configure::write('Asset.filter.js', 'custom_javascript_output_filter.php'); //Configure::write('Asset.filter.js', 'custom_javascript_output_filter.php');

View file

@ -88,7 +88,7 @@
* /app/webroot/.htaccess * /app/webroot/.htaccess
* *
* And uncomment the App.baseUrl below. But keep in mind * And uncomment the App.baseUrl below. But keep in mind
* that plugin assets such as images, CSS and Javascript files * that plugin assets such as images, CSS and JavaScript files
* will not work without URL rewriting! * will not work without URL rewriting!
* To work around this issue you should either symlink or copy * To work around this issue you should either symlink or copy
* the plugin assets into you app's webroot directory. This is * the plugin assets into you app's webroot directory. This is
@ -245,7 +245,7 @@
* Plug in your own custom JavaScript compressor by dropping a script in your webroot to handle the * Plug in your own custom JavaScript compressor by dropping a script in your webroot to handle the
* output, and setting the config below to the name of the script. * output, and setting the config below to the name of the script.
* *
* To use, prefix your JavaScript link URLs with '/cjs/' instead of '/js/' or use JavaScriptHelper::link(). * To use, prefix your JavaScript link URLs with '/cjs/' instead of '/js/' or use JsHelper::link().
*/ */
//Configure::write('Asset.filter.js', 'custom_javascript_output_filter.php'); //Configure::write('Asset.filter.js', 'custom_javascript_output_filter.php');

View file

@ -112,7 +112,7 @@ class CookieComponent extends Component {
* HTTP only cookie * HTTP only cookie
* *
* Set to true to make HTTP only cookies. Cookies that are HTTP only * Set to true to make HTTP only cookies. Cookies that are HTTP only
* are not accessible in Javascript. * are not accessible in JavaScript.
* *
* @var boolean * @var boolean
*/ */

View file

@ -88,7 +88,7 @@ class Controller extends Object implements CakeEventListener {
* An array containing the names of helpers this controller uses. The array elements should * An array containing the names of helpers this controller uses. The array elements should
* not contain the "Helper" part of the classname. * not contain the "Helper" part of the classname.
* *
* Example: `public $helpers = array('Html', 'Javascript', 'Time', 'Ajax');` * Example: `public $helpers = array('Html', 'JavaScript', 'Time', 'Ajax');`
* *
* @var mixed A single name as a string or a list of names as an array. * @var mixed A single name as a string or a list of names as an array.
* @link http://book.cakephp.org/2.0/en/controllers.html#components-helpers-and-uses * @link http://book.cakephp.org/2.0/en/controllers.html#components-helpers-and-uses

View file

@ -94,7 +94,7 @@ class MergeVarPluginAppController extends MergeVarsAppController {
* *
* @var array * @var array
*/ */
public $helpers = array('Javascript'); public $helpers = array('JavaScript');
/** /**
* parent for mergeVars * parent for mergeVars
@ -205,7 +205,7 @@ class ControllerMergeVarsTest extends CakeTestCase {
$expected = array( $expected = array(
'MergeVar' => array('format' => 'html', 'terse'), 'MergeVar' => array('format' => 'html', 'terse'),
'Javascript' => null 'JavaScript' => null
); );
$this->assertEquals($expected, $Controller->helpers, 'Helpers are unexpected.'); $this->assertEquals($expected, $Controller->helpers, 'Helpers are unexpected.');

View file

@ -699,7 +699,7 @@ class JsHelperTest extends CakeTestCase {
} }
/** /**
* test set()'ing variables to the Javascript buffer and controlling the output var name. * test set()'ing variables to the JavaScript buffer and controlling the output var name.
* *
* @return void * @return void
*/ */

View file

@ -618,7 +618,7 @@ class HtmlHelper extends AppHelper {
} }
/** /**
* End a Buffered section of Javascript capturing. * End a Buffered section of JavaScript capturing.
* Generates a script tag inline or in `$scripts_for_layout` depending on the settings * Generates a script tag inline or in `$scripts_for_layout` depending on the settings
* used when the scriptBlock was started * used when the scriptBlock was started
* *

View file

@ -2,7 +2,7 @@
/** /**
* jQuery Engine Helper for JsHelper * jQuery Engine Helper for JsHelper
* *
* Provides jQuery specific Javascript for JsHelper. * Provides jQuery specific JavaScript for JsHelper.
* *
* Implements the JsHelper interface for jQuery. All $options arrays * Implements the JsHelper interface for jQuery. All $options arrays
* support all options found in the JsHelper, as well as those in the jQuery * support all options found in the JsHelper, as well as those in the jQuery
@ -30,7 +30,7 @@ App::uses('JsBaseEngineHelper', 'View/Helper');
/** /**
* jQuery Engine Helper for JsHelper * jQuery Engine Helper for JsHelper
* *
* Provides jQuery specific Javascript for JsHelper. * Provides jQuery specific JavaScript for JsHelper.
* *
* Implements the JsHelper interface for jQuery. All $options arrays * Implements the JsHelper interface for jQuery. All $options arrays
* support all options found in the JsHelper, as well as those in the jQuery * support all options found in the JsHelper, as well as those in the jQuery
@ -167,7 +167,7 @@ class JqueryEngineHelper extends JsBaseEngineHelper {
* - 'stop' - Whether you want the event to stopped. (defaults true) * - 'stop' - Whether you want the event to stopped. (defaults true)
* *
* @param string $type Type of event to bind to the current dom id * @param string $type Type of event to bind to the current dom id
* @param string $callback The Javascript function you wish to trigger or the function literal * @param string $callback The JavaScript function you wish to trigger or the function literal
* @param array $options Options for the event. * @param array $options Options for the event.
* @return string completed event handler * @return string completed event handler
*/ */
@ -340,7 +340,7 @@ class JqueryEngineHelper extends JsBaseEngineHelper {
/** /**
* Serialize a form attached to $selector. If the current selection is not an input or * Serialize a form attached to $selector. If the current selection is not an input or
* form, errors will be created in the Javascript. * form, errors will be created in the JavaScript.
* *
* @param array $options Options for the serialization * @param array $options Options for the serialization
* @return string completed form serialization script. * @return string completed form serialization script.

View file

@ -57,7 +57,7 @@ abstract class JsBaseEngineHelper extends AppHelper {
protected $_callbackArguments = array(); protected $_callbackArguments = array();
/** /**
* Create an `alert()` message in Javascript * Create an `alert()` message in JavaScript
* *
* @param string $message Message you want to alter. * @param string $message Message you want to alter.
* @return string completed alert() * @return string completed alert()
@ -68,7 +68,7 @@ abstract class JsBaseEngineHelper extends AppHelper {
/** /**
* Redirects to an URL. Creates a window.location modification snippet * Redirects to an URL. Creates a window.location modification snippet
* that can be used to trigger 'redirects' from Javascript. * that can be used to trigger 'redirects' from JavaScript.
* *
* @param string|array $url URL * @param string|array $url URL
* @return string completed redirect in javascript * @return string completed redirect in javascript
@ -101,7 +101,7 @@ abstract class JsBaseEngineHelper extends AppHelper {
} }
/** /**
* Create a `prompt()` Javascript function * Create a `prompt()` JavaScript function
* *
* @param string $message Message you want to prompt. * @param string $message Message you want to prompt.
* @param string $default Default message * @param string $default Default message
@ -297,7 +297,7 @@ abstract class JsBaseEngineHelper extends AppHelper {
* - `stop` - Whether you want the event to stopped. (defaults to true) * - `stop` - Whether you want the event to stopped. (defaults to true)
* *
* @param string $type Type of event to bind to the current dom id * @param string $type Type of event to bind to the current dom id
* @param string $callback The Javascript function you wish to trigger or the function literal * @param string $callback The JavaScript function you wish to trigger or the function literal
* @param array $options Options for the event. * @param array $options Options for the event.
* @return string completed event handler * @return string completed event handler
*/ */
@ -363,7 +363,7 @@ abstract class JsBaseEngineHelper extends AppHelper {
* - `type` - Data type for response. 'json' and 'html' are supported. Default is html for most libraries. * - `type` - Data type for response. 'json' and 'html' are supported. Default is html for most libraries.
* - `evalScripts` - Whether or not <script> tags should be eval'ed. * - `evalScripts` - Whether or not <script> tags should be eval'ed.
* - `dataExpression` - Should the `data` key be treated as a callback. Useful for supplying `$options['data']` as * - `dataExpression` - Should the `data` key be treated as a callback. Useful for supplying `$options['data']` as
* another Javascript expression. * another JavaScript expression.
* *
* @param string|array $url Array or String URL to target with the request. * @param string|array $url Array or String URL to target with the request.
* @param array $options Array of options. See above for cross library supported options * @param array $options Array of options. See above for cross library supported options
@ -475,7 +475,7 @@ abstract class JsBaseEngineHelper extends AppHelper {
abstract public function serializeForm($options = array()); abstract public function serializeForm($options = array());
/** /**
* Parse an options assoc array into an Javascript object literal. * Parse an options assoc array into an JavaScript object literal.
* Similar to object() but treats any non-integer value as a string, * Similar to object() but treats any non-integer value as a string,
* does not include `{ }` * does not include `{ }`
* *

View file

@ -19,7 +19,7 @@ App::uses('JsBaseEngineHelper', 'View/Helper');
/** /**
* MooTools Engine Helper for JsHelper * MooTools Engine Helper for JsHelper
* *
* Provides MooTools specific Javascript for JsHelper. * Provides MooTools specific JavaScript for JsHelper.
* Assumes that you have the following MooTools packages * Assumes that you have the following MooTools packages
* *
* - Remote, Remote.HTML, Remote.JSON * - Remote, Remote.HTML, Remote.JSON
@ -144,7 +144,7 @@ class MootoolsEngineHelper extends JsBaseEngineHelper {
* - 'stop' - Whether you want the event to stopped. (defaults true) * - 'stop' - Whether you want the event to stopped. (defaults true)
* *
* @param string $type Type of event to bind to the current dom id * @param string $type Type of event to bind to the current dom id
* @param string $callback The Javascript function you wish to trigger or the function literal * @param string $callback The JavaScript function you wish to trigger or the function literal
* @param array $options Options for the event. * @param array $options Options for the event.
* @return string completed event handler * @return string completed event handler
*/ */

View file

@ -2,7 +2,7 @@
/** /**
* Prototype Engine Helper for JsHelper * Prototype Engine Helper for JsHelper
* *
* Provides Prototype specific Javascript for JsHelper. Requires at least * Provides Prototype specific JavaScript for JsHelper. Requires at least
* Prototype 1.6 * Prototype 1.6
* *
* PHP 5 * PHP 5
@ -26,7 +26,7 @@ App::uses('JsBaseEngineHelper', 'View/Helper');
/** /**
* Prototype Engine Helper for JsHelper * Prototype Engine Helper for JsHelper
* *
* Provides Prototype specific Javascript for JsHelper. Requires at least * Provides Prototype specific JavaScript for JsHelper. Requires at least
* Prototype 1.6 * Prototype 1.6
* *
* @package Cake.View.Helper * @package Cake.View.Helper
@ -142,7 +142,7 @@ class PrototypeEngineHelper extends JsBaseEngineHelper {
* - `stop` - Whether you want the event to stopped. (defaults true) * - `stop` - Whether you want the event to stopped. (defaults true)
* *
* @param string $type Type of event to bind to the current 946 id * @param string $type Type of event to bind to the current 946 id
* @param string $callback The Javascript function you wish to trigger or the function literal * @param string $callback The JavaScript function you wish to trigger or the function literal
* @param array $options Options for the event. * @param array $options Options for the event.
* @return string completed event handler * @return string completed event handler
*/ */