Permalink
Browse files

spelling corrections (a url to an URL, unify URL)

  • Loading branch information...
1 parent e4b276c commit 09d9efe235a37c379ac8bd78d0028ff587943184 @dereuromark dereuromark committed Apr 29, 2013
@@ -36,7 +36,7 @@ class RedisEngine extends CacheEngine {
/**
* Settings
*
- * - server = string url or ip to the Redis server host
+ * - server = string URL or ip to the Redis server host
* - port = integer port number to the Redis server (default: 6379)
* - timeout = float timeout in seconds (default: 0)
* - persistent = bool Connects to the Redis server with a persistent connection (default: true)
@@ -95,7 +95,7 @@
*
* And uncomment the App.baseUrl below. But keep in mind
* 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
* the plugin assets into you app's webroot directory. This is
* recommended even when you are using mod_rewrite. Handling static
@@ -4,7 +4,7 @@
*
* In this file, you set up routes to your controllers and their actions.
* Routes are very important mechanism that allows you to freely connect
- * different urls to chosen controllers and their actions (functions).
+ * different URLs to chosen controllers and their actions (functions).
*
* PHP 5
*
@@ -28,7 +28,7 @@
*/
Router::connect('/', array('controller' => 'pages', 'action' => 'display', 'home'));
/**
- * ...and connect the rest of 'Pages' controller's urls.
+ * ...and connect the rest of 'Pages' controller's URLs.
*/
Router::connect('/pages/*', array('controller' => 'pages', 'action' => 'display'));
@@ -142,19 +142,19 @@ public function shutdown(Controller $controller) {
}
/**
- * Called before Controller::redirect(). Allows you to replace the url that will
- * be redirected to with a new url. The return of this method can either be an array or a string.
+ * Called before Controller::redirect(). Allows you to replace the URL that will
+ * be redirected to with a new URL. The return of this method can either be an array or a string.
*
* If the return is an array and contains a 'url' key. You may also supply the following:
*
* - `status` The status code for the redirect
* - `exit` Whether or not the redirect should exit.
*
* If your response is a string or an array that does not contain a 'url' key it will
- * be used as the new url to redirect to.
+ * be used as the new URL to redirect to.
*
* @param Controller $controller Controller with components to beforeRedirect
- * @param string|array $url Either the string or url array that is being redirected to.
+ * @param string|array $url Either the string or URL array that is being redirected to.
* @param integer $status The status code of the redirect
* @param boolean $exit Will the script exit.
* @return array|void Either an array or null.
@@ -173,7 +173,7 @@ class AuthComponent extends Component {
protected static $_user = array();
/**
- * A URL (defined as a string or array) to the controller action that handles
+ * An URL (defined as a string or array) to the controller action that handles
* logins. Defaults to `/users/login`
*
* @var mixed
@@ -217,9 +217,9 @@ class AuthComponent extends Component {
/**
* Controls handling of unauthorized access.
- * - For default value `true` unauthorized user is redirected to the referrer url
+ * - For default value `true` unauthorized user is redirected to the referrer URL
* or AuthComponent::$loginRedirect or '/'.
- * - If set to a string or array the value is used as an url to redirect to.
+ * - If set to a string or array the value is used as an URL to redirect to.
* - If set to false a ForbiddenException exception is thrown instead of redirecting.
*
* @var mixed
@@ -645,10 +645,10 @@ public function redirect($url = null) {
/**
* Get the URL a use should be redirected to upon login.
*
- * Pass a url in to set the destination a user should be redirected to upon
+ * Pass an URL in to set the destination a user should be redirected to upon
* logging in.
*
- * If no parameter is passed, gets the authentication redirect URL. The url
+ * If no parameter is passed, gets the authentication redirect URL. The URL
* returned is as per following rules:
*
* - Returns the session Auth.redirect value if it is present and for the same
@@ -40,7 +40,7 @@
* `$this->response` allows you to manipulate all aspects of the response.
*
* Controllers are created by Dispatcher based on request parameters and routing. By default controllers and actions
- * use conventional names. For example `/posts/index` maps to `PostsController::index()`. You can re-map urls
+ * use conventional names. For example `/posts/index` maps to `PostsController::index()`. You can re-map URLs
* using Router::connect().
*
* @package Cake.Controller
@@ -259,7 +259,7 @@ class Controller extends Object implements CakeEventListener {
/**
* Holds current methods of the controller. This is a list of all the methods reachable
- * via url. Modifying this array, will allow you to change which methods can be reached.
+ * via URL. Modifying this array, will allow you to change which methods can be reached.
*
* @var array
*/
View
@@ -57,8 +57,8 @@ public function toString() {
* POST and GET data can be simulated in requestAction. Use `$extra['url']` for
* GET data. The `$extra['data']` parameter allows POST data simulation.
*
- * @param string|array $url String or array-based url. Unlike other url arrays in CakePHP, this
- * url will not automatically handle passed and named arguments in the $url parameter.
+ * @param string|array $url String or array-based URL. Unlike other URL arrays in CakePHP, this
+ * URL will not automatically handle passed and named arguments in the $url parameter.
* @param array $extra if array includes the key "return" it sets the AutoRender to true. Can
* also be used to submit GET/POST data, and named/passed arguments.
* @return mixed Boolean true or false on success/failure, or contents
@@ -580,10 +580,10 @@ public function addPaths($paths) {
}
/**
- * Get the value of the current requests url. Will include named parameters and querystring arguments.
+ * Get the value of the current requests URL. Will include named parameters and querystring arguments.
*
* @param boolean $base Include the base path, set to false to trim the base path off.
- * @return string the current request url including query string args.
+ * @return string the current request URL including query string args.
*/
public function here($base = true) {
$url = $this->here;
@@ -132,7 +132,7 @@ class HttpSocket extends CakeSocket {
/**
* Build an HTTP Socket using the specified configuration.
*
- * You can use a url string to set the url and use default configurations for
+ * You can use an URL string to set the URL and use default configurations for
* all other options:
*
* `$http = new HttpSocket('http://cakephp.org/');`
@@ -148,7 +148,7 @@ class HttpSocket extends CakeSocket {
*
* See HttpSocket::$config for options that can be used.
*
- * @param string|array $config Configuration information, either a string url or an array of options.
+ * @param string|array $config Configuration information, either a string URL or an array of options.
*/
public function __construct($config = array()) {
if (is_string($config)) {
@@ -462,7 +462,7 @@ public function get($uri = null, $query = array(), $request = array()) {
/**
* Issues a POST request to the specified URI, query, and request.
*
- * `post()` can be used to post simple data arrays to a url:
+ * `post()` can be used to post simple data arrays to an URL:
*
* {{{
* $response = $http->post('http://example.com', array(
@@ -508,14 +508,14 @@ public function delete($uri = null, $data = array(), $request = array()) {
}
/**
- * Normalizes urls into a $uriTemplate. If no template is provided
- * a default one will be used. Will generate the url using the
+ * Normalizes URLs into a $uriTemplate. If no template is provided
+ * a default one will be used. Will generate the URL using the
* current config information.
*
* ### Usage:
*
* After configuring part of the request parameters, you can use url() to generate
- * urls.
+ * URLs.
*
* {{{
* $http = new HttpSocket('http://www.cakephp.org');
@@ -530,9 +530,9 @@ public function delete($uri = null, $data = array(), $request = array()) {
*
* Would return `/search?q=socket`.
*
- * @param string|array Either a string or array of url options to create a url with.
- * @param string $uriTemplate A template string to use for url formatting.
- * @return mixed Either false on failure or a string containing the composed url.
+ * @param string|array Either a string or array of URL options to create an URL with.
+ * @param string $uriTemplate A template string to use for URL formatting.
+ * @return mixed Either false on failure or a string containing the composed URL.
*/
public function url($url = null, $uriTemplate = null) {
if (is_null($url)) {
@@ -54,7 +54,7 @@ public function implementedEvents() {
/**
* Method called before the controller is instantiated and called to serve a request.
* If used with default priority, it will be called after the Router has parsed the
- * url and set the routing params into the request object.
+ * URL and set the routing params into the request object.
*
* If a CakeResponse object instance is returned, it will be served at the end of the
* event cycle, not calling any controller as a result. This will also have the effect of
@@ -178,9 +178,9 @@ protected function _writeRoute() {
* Checks to see if the given URL can be parsed by this route.
*
* If the route can be parsed an array of parameters will be returned; if not
- * false will be returned. String urls are parsed if they match a routes regular expression.
+ * false will be returned. String URLs are parsed if they match a routes regular expression.
*
- * @param string $url The url to attempt to parse.
+ * @param string $url The URL to attempt to parse.
* @return mixed Boolean false on failure, otherwise an array or parameters
*/
public function parse($url) {
@@ -368,9 +368,9 @@ protected function _matchNamed($val, $rule, $context) {
}
/**
- * Apply persistent parameters to a url array. Persistent parameters are a special
+ * Apply persistent parameters to an URL array. Persistent parameters are a special
* key used during route creation to force route parameters to persist when omitted from
- * a url array.
+ * an URL array.
*
* @param array $url The array to apply persistent parameters to.
* @param array $params An array of persistent values to replace persistent ones.
@@ -386,14 +386,14 @@ public function persistParams($url, $params) {
}
/**
- * Check if a url array matches this route instance.
+ * Check if an URL array matches this route instance.
*
- * If the url matches the route parameters and settings, then
- * return a generated string url. If the url doesn't match the route parameters, false will be returned.
- * This method handles the reverse routing or conversion of url arrays into string urls.
+ * If the URL matches the route parameters and settings, then
+ * return a generated string URL. If the URL doesn't match the route parameters, false will be returned.
+ * This method handles the reverse routing or conversion of URL arrays into string URLs.
*
* @param array $url An array of parameters to check matching with.
- * @return mixed Either a string url for the parameters if they match or false.
+ * @return mixed Either a string URL for the parameters if they match or false.
*/
public function match($url) {
if (!$this->compiled()) {
@@ -481,12 +481,12 @@ public function match($url) {
}
/**
- * Converts a matching route array into a url string.
+ * Converts a matching route array into an URL string.
*
- * Composes the string url using the template
+ * Composes the string URL using the template
* used to create the route.
*
- * @param array $params The params to convert to a string url.
+ * @param array $params The params to convert to a string URL.
* @return string Composed route string.
*/
protected function _writeUrl($params) {
@@ -24,10 +24,10 @@
class PluginShortRoute extends CakeRoute {
/**
- * Parses a string url into an array. If a plugin key is found, it will be copied to the
+ * Parses a string URL into an array. If a plugin key is found, it will be copied to the
* controller parameter
*
- * @param string $url The url to parse
+ * @param string $url The URL to parse
* @return mixed false on failure, or an array of request parameters
*/
public function parse($url) {
@@ -40,11 +40,11 @@ public function parse($url) {
}
/**
- * Reverse route plugin shortcut urls. If the plugin and controller
+ * Reverse route plugin shortcut URLs. If the plugin and controller
* are not the same the match is an auto fail.
*
* @param array $url Array of parameters to convert to a string.
- * @return mixed either false or a string url.
+ * @return mixed either false or a string URL.
*/
public function match($url) {
if (isset($url['controller']) && isset($url['plugin']) && $url['plugin'] != $url['controller']) {
@@ -34,14 +34,14 @@ class RedirectRoute extends CakeRoute {
public $response = null;
/**
- * The location to redirect to. Either a string or a cake array url.
+ * The location to redirect to. Either a string or a cake array URL.
*
* @var mixed
*/
public $redirect;
/**
- * Flag for disabling exit() when this route parses a url.
+ * Flag for disabling exit() when this route parses an URL.
*
* @var boolean
*/
@@ -60,10 +60,10 @@ public function __construct($template, $defaults = array(), $options = array())
}
/**
- * Parses a string url into an array. Parsed urls will result in an automatic
+ * Parses a string URL into an array. Parsed URLs will result in an automatic
* redirection
*
- * @param string $url The url to parse
+ * @param string $url The URL to parse
* @return boolean False on failure
*/
public function parse($url) {
@@ -96,7 +96,7 @@ public function parse($url) {
* There is no reverse routing redirection routes
*
* @param array $url Array of parameters to convert to a string.
- * @return mixed either false or a string url.
+ * @return mixed either false or a string URL.
*/
public function match($url) {
return false;
Oops, something went wrong.

0 comments on commit 09d9efe

Please sign in to comment.