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

This commit is contained in:
euromark 2013-04-29 11:05:17 +02:00
parent e4b276c55f
commit 09d9efe235
27 changed files with 97 additions and 97 deletions

View file

@ -36,7 +36,7 @@ class RedisEngine extends CacheEngine {
/** /**
* Settings * 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) * - port = integer port number to the Redis server (default: 6379)
* - timeout = float timeout in seconds (default: 0) * - timeout = float timeout in seconds (default: 0)
* - persistent = bool Connects to the Redis server with a persistent connection (default: true) * - persistent = bool Connects to the Redis server with a persistent connection (default: true)

View file

@ -95,7 +95,7 @@
* *
* 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
* recommended even when you are using mod_rewrite. Handling static * recommended even when you are using mod_rewrite. Handling static

View file

@ -4,7 +4,7 @@
* *
* In this file, you set up routes to your controllers and their actions. * In this file, you set up routes to your controllers and their actions.
* Routes are very important mechanism that allows you to freely connect * 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 * PHP 5
* *
@ -28,7 +28,7 @@
*/ */
Router::connect('/', array('controller' => 'pages', 'action' => 'display', 'home')); 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')); Router::connect('/pages/*', array('controller' => 'pages', 'action' => 'display'));

View file

@ -142,8 +142,8 @@ class Component extends Object {
} }
/** /**
* Called before Controller::redirect(). Allows you to replace the url that will * 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. * 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: * If the return is an array and contains a 'url' key. You may also supply the following:
* *
@ -151,10 +151,10 @@ class Component extends Object {
* - `exit` Whether or not the redirect should exit. * - `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 * 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 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 integer $status The status code of the redirect
* @param boolean $exit Will the script exit. * @param boolean $exit Will the script exit.
* @return array|void Either an array or null. * @return array|void Either an array or null.

View file

@ -173,7 +173,7 @@ class AuthComponent extends Component {
protected static $_user = array(); 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` * logins. Defaults to `/users/login`
* *
* @var mixed * @var mixed
@ -217,9 +217,9 @@ class AuthComponent extends Component {
/** /**
* Controls handling of unauthorized access. * 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 '/'. * 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. * - If set to false a ForbiddenException exception is thrown instead of redirecting.
* *
* @var mixed * @var mixed
@ -645,10 +645,10 @@ class AuthComponent extends Component {
/** /**
* Get the URL a use should be redirected to upon login. * 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. * 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: * returned is as per following rules:
* *
* - Returns the session Auth.redirect value if it is present and for the same * - Returns the session Auth.redirect value if it is present and for the same

View file

@ -40,7 +40,7 @@ App::uses('CakeEventManager', 'Event');
* `$this->response` allows you to manipulate all aspects of the response. * `$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 * 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(). * using Router::connect().
* *
* @package Cake.Controller * @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 * 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 * @var array
*/ */

View file

@ -57,8 +57,8 @@ class Object {
* POST and GET data can be simulated in requestAction. Use `$extra['url']` for * POST and GET data can be simulated in requestAction. Use `$extra['url']` for
* GET data. The `$extra['data']` parameter allows POST data simulation. * 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 * @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. * 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 * @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. * also be used to submit GET/POST data, and named/passed arguments.
* @return mixed Boolean true or false on success/failure, or contents * @return mixed Boolean true or false on success/failure, or contents

View file

@ -580,10 +580,10 @@ class CakeRequest implements ArrayAccess {
} }
/** /**
* 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. * @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) { public function here($base = true) {
$url = $this->here; $url = $this->here;

View file

@ -132,7 +132,7 @@ class HttpSocket extends CakeSocket {
/** /**
* Build an HTTP Socket using the specified configuration. * 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: * all other options:
* *
* `$http = new HttpSocket('http://cakephp.org/');` * `$http = new HttpSocket('http://cakephp.org/');`
@ -148,7 +148,7 @@ class HttpSocket extends CakeSocket {
* *
* See HttpSocket::$config for options that can be used. * 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()) { public function __construct($config = array()) {
if (is_string($config)) { if (is_string($config)) {
@ -462,7 +462,7 @@ class HttpSocket extends CakeSocket {
/** /**
* Issues a POST request to the specified URI, query, and request. * 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( * $response = $http->post('http://example.com', array(
@ -508,14 +508,14 @@ class HttpSocket extends CakeSocket {
} }
/** /**
* Normalizes urls into a $uriTemplate. If no template is provided * Normalizes URLs into a $uriTemplate. If no template is provided
* a default one will be used. Will generate the url using the * a default one will be used. Will generate the URL using the
* current config information. * current config information.
* *
* ### Usage: * ### Usage:
* *
* After configuring part of the request parameters, you can use url() to generate * After configuring part of the request parameters, you can use url() to generate
* urls. * URLs.
* *
* {{{ * {{{
* $http = new HttpSocket('http://www.cakephp.org'); * $http = new HttpSocket('http://www.cakephp.org');
@ -530,9 +530,9 @@ class HttpSocket extends CakeSocket {
* *
* Would return `/search?q=socket`. * Would return `/search?q=socket`.
* *
* @param string|array Either a string or array of url options to create a url with. * @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. * @param string $uriTemplate A template string to use for URL formatting.
* @return mixed Either false on failure or a string containing the composed url. * @return mixed Either false on failure or a string containing the composed URL.
*/ */
public function url($url = null, $uriTemplate = null) { public function url($url = null, $uriTemplate = null) {
if (is_null($url)) { if (is_null($url)) {

View file

@ -54,7 +54,7 @@ abstract class DispatcherFilter implements CakeEventListener {
/** /**
* Method called before the controller is instantiated and called to serve a request. * 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 * 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 * 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 * event cycle, not calling any controller as a result. This will also have the effect of

View file

@ -178,9 +178,9 @@ class CakeRoute {
* Checks to see if the given URL can be parsed by this route. * 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 * 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 * @return mixed Boolean false on failure, otherwise an array or parameters
*/ */
public function parse($url) { public function parse($url) {
@ -368,9 +368,9 @@ class CakeRoute {
} }
/** /**
* 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 * 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 $url The array to apply persistent parameters to.
* @param array $params An array of persistent values to replace persistent ones. * @param array $params An array of persistent values to replace persistent ones.
@ -386,14 +386,14 @@ class CakeRoute {
} }
/** /**
* 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 * 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. * 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. * 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. * @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) { public function match($url) {
if (!$this->compiled()) { if (!$this->compiled()) {
@ -481,12 +481,12 @@ class CakeRoute {
} }
/** /**
* 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. * 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. * @return string Composed route string.
*/ */
protected function _writeUrl($params) { protected function _writeUrl($params) {

View file

@ -24,10 +24,10 @@ App::uses('CakeRoute', 'Routing/Route');
class PluginShortRoute extends CakeRoute { 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 * 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 * @return mixed false on failure, or an array of request parameters
*/ */
public function parse($url) { public function parse($url) {
@ -40,11 +40,11 @@ class PluginShortRoute extends CakeRoute {
} }
/** /**
* 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. * are not the same the match is an auto fail.
* *
* @param array $url Array of parameters to convert to a string. * @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) { public function match($url) {
if (isset($url['controller']) && isset($url['plugin']) && $url['plugin'] != $url['controller']) { if (isset($url['controller']) && isset($url['plugin']) && $url['plugin'] != $url['controller']) {

View file

@ -34,14 +34,14 @@ class RedirectRoute extends CakeRoute {
public $response = null; 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 * @var mixed
*/ */
public $redirect; public $redirect;
/** /**
* Flag for disabling exit() when this route parses a url. * Flag for disabling exit() when this route parses an URL.
* *
* @var boolean * @var boolean
*/ */
@ -60,10 +60,10 @@ class RedirectRoute extends CakeRoute {
} }
/** /**
* 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 * redirection
* *
* @param string $url The url to parse * @param string $url The URL to parse
* @return boolean False on failure * @return boolean False on failure
*/ */
public function parse($url) { public function parse($url) {
@ -96,7 +96,7 @@ class RedirectRoute extends CakeRoute {
* There is no reverse routing redirection routes * There is no reverse routing redirection routes
* *
* @param array $url Array of parameters to convert to a string. * @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) { public function match($url) {
return false; return false;

View file

@ -23,9 +23,9 @@ App::uses('CakeRoute', 'Routing/Route');
/** /**
* Parses the request URL into controller, action, and parameters. Uses the connected routes * Parses the request URL into controller, action, and parameters. Uses the connected routes
* to match the incoming url string to parameters that will allow the request to be dispatched. Also * to match the incoming URL string to parameters that will allow the request to be dispatched. Also
* handles converting parameter lists into url strings, using the connected routes. Routing allows you to decouple * handles converting parameter lists into URL strings, using the connected routes. Routing allows you to decouple
* the way the world interacts with your application (urls) and the implementation (controllers and actions). * the way the world interacts with your application (URLs) and the implementation (controllers and actions).
* *
* ### Connecting routes * ### Connecting routes
* *
@ -36,7 +36,7 @@ App::uses('CakeRoute', 'Routing/Route');
* ### Named parameters * ### Named parameters
* *
* Named parameters allow you to embed key:value pairs into path segments. This allows you create hash * Named parameters allow you to embed key:value pairs into path segments. This allows you create hash
* structures using urls. You can define how named parameters work in your application using Router::connectNamed() * structures using URLs. You can define how named parameters work in your application using Router::connectNamed()
* *
* @package Cake.Routing * @package Cake.Routing
*/ */
@ -72,7 +72,7 @@ class Router {
protected static $_parseExtensions = false; protected static $_parseExtensions = false;
/** /**
* List of valid extensions to parse from a URL. If null, any extension is allowed. * List of valid extensions to parse from an URL. If null, any extension is allowed.
* *
* @var array * @var array
*/ */
@ -238,7 +238,7 @@ class Router {
/** /**
* Connects a new Route in the router. * Connects a new Route in the router.
* *
* Routes are a way of connecting request urls to objects in your application. At their core routes * Routes are a way of connecting request URLs to objects in your application. At their core routes
* are a set or regular expressions that are used to match requests to destinations. * are a set or regular expressions that are used to match requests to destinations.
* *
* Examples: * Examples:
@ -270,7 +270,7 @@ class Router {
* - `pass` is used to define which of the routed parameters should be shifted into the pass array. Adding a * - `pass` is used to define which of the routed parameters should be shifted into the pass array. Adding a
* parameter to pass will remove it from the regular route array. Ex. `'pass' => array('slug')` * parameter to pass will remove it from the regular route array. Ex. `'pass' => array('slug')`
* - `persist` is used to define which route parameters should be automatically included when generating * - `persist` is used to define which route parameters should be automatically included when generating
* new urls. You can override persistent parameters by redefining them in a url or remove them by * new URLs. You can override persistent parameters by redefining them in an URL or remove them by
* setting the parameter to `false`. Ex. `'persist' => array('lang')` * setting the parameter to `false`. Ex. `'persist' => array('lang')`
* - `routeClass` is used to extend and change how individual routes parse requests and handle reverse routing, * - `routeClass` is used to extend and change how individual routes parse requests and handle reverse routing,
* via a custom routing class. Ex. `'routeClass' => 'SlugRoute'` * via a custom routing class. Ex. `'routeClass' => 'SlugRoute'`
@ -351,7 +351,7 @@ class Router {
* `Router::redirect('/home/*', array('controller' => 'posts', 'action' => 'view', array('persist' => true)));` * `Router::redirect('/home/*', array('controller' => 'posts', 'action' => 'view', array('persist' => true)));`
* *
* Redirects /home/* to /posts/view and passes the parameters to /posts/view. Using an array as the * Redirects /home/* to /posts/view and passes the parameters to /posts/view. Using an array as the
* redirect destination allows you to use other routes to define where a url string should be redirected to. * redirect destination allows you to use other routes to define where an URL string should be redirected to.
* *
* `Router::redirect('/posts/*', 'http://google.com', array('status' => 302));` * `Router::redirect('/posts/*', 'http://google.com', array('status' => 302));`
* *
@ -361,10 +361,10 @@ class Router {
* *
* - `status` Sets the HTTP status (default 301) * - `status` Sets the HTTP status (default 301)
* - `persist` Passes the params to the redirected route, if it can. This is useful with greedy routes, * - `persist` Passes the params to the redirected route, if it can. This is useful with greedy routes,
* routes that end in `*` are greedy. As you can remap urls and not loose any passed/named args. * routes that end in `*` are greedy. As you can remap URLs and not loose any passed/named args.
* *
* @param string $route A string describing the template of the route * @param string $route A string describing the template of the route
* @param array $url A url to redirect to. Can be a string or a Cake array-based url * @param array $url An URL to redirect to. Can be a string or a Cake array-based URL
* @param array $options An array matching the named elements in the route to regular expressions which that * @param array $options An array matching the named elements in the route to regular expressions which that
* element should match. Also contains additional parameters such as which routed parameters should be * element should match. Also contains additional parameters such as which routed parameters should be
* shifted into the passed arguments. As well as supplying patterns for routing parameters. * shifted into the passed arguments. As well as supplying patterns for routing parameters.
@ -381,7 +381,7 @@ class Router {
} }
/** /**
* Specifies what named parameters CakePHP should be parsing out of incoming urls. By default * Specifies what named parameters CakePHP should be parsing out of incoming URLs. By default
* CakePHP will parse every named parameter out of incoming URLs. However, if you want to take more * CakePHP will parse every named parameter out of incoming URLs. However, if you want to take more
* control over how named parameters are parsed you can use one of the following setups: * control over how named parameters are parsed you can use one of the following setups:
* *
@ -576,7 +576,7 @@ class Router {
} }
/** /**
* Parses a file extension out of a URL, if Router::parseExtensions() is enabled. * Parses a file extension out of an URL, if Router::parseExtensions() is enabled.
* *
* @param string $url * @param string $url
* @return array Returns an array containing the altered URL and the parsed extension. * @return array Returns an array containing the altered URL and the parsed extension.
@ -750,16 +750,16 @@ class Router {
* *
* - Empty - the method will find address to actual controller/action. * - Empty - the method will find address to actual controller/action.
* - '/' - the method will find base URL of application. * - '/' - the method will find base URL of application.
* - A combination of controller/action - the method will find url for it. * - A combination of controller/action - the method will find URL for it.
* *
* There are a few 'special' parameters that can change the final URL string that is generated * There are a few 'special' parameters that can change the final URL string that is generated
* *
* - `base` - Set to false to remove the base path from the generated url. If your application * - `base` - Set to false to remove the base path from the generated url. If your application
* is not in the root directory, this can be used to generate urls that are 'cake relative'. * is not in the root directory, this can be used to generate URLs that are 'cake relative'.
* cake relative urls are required when using requestAction. * cake relative URLs are required when using requestAction.
* - `?` - Takes an array of query string parameters * - `?` - Takes an array of query string parameters
* - `#` - Allows you to set url hash fragments. * - `#` - Allows you to set URL hash fragments.
* - `full_base` - If true the `FULL_BASE_URL` constant will be prepended to generated urls. * - `full_base` - If true the `FULL_BASE_URL` constant will be prepended to generated URLs.
* *
* @param string|array $url Cake-relative URL, like "/products/edit/92" or "/presidents/elect/4" * @param string|array $url Cake-relative URL, like "/products/edit/92" or "/presidents/elect/4"
* or an array specifying any of the following: 'controller', 'action', * or an array specifying any of the following: 'controller', 'action',
@ -767,7 +767,7 @@ class Router {
* and standard URL arguments (indexed array elements) * and standard URL arguments (indexed array elements)
* @param bool|array $full If (bool) true, the full base URL will be prepended to the result. * @param bool|array $full If (bool) true, the full base URL will be prepended to the result.
* If an array accepts the following keys * If an array accepts the following keys
* - escape - used when making urls embedded in html escapes query string '&' * - escape - used when making URLs embedded in html escapes query string '&'
* - full - if true the full base URL will be prepended. * - full - if true the full base URL will be prepended.
* @return string Full translated URL with base path. * @return string Full translated URL with base path.
*/ */
@ -895,11 +895,11 @@ class Router {
} }
/** /**
* A special fallback method that handles url arrays that cannot match * A special fallback method that handles URL arrays that cannot match
* any defined routes. * any defined routes.
* *
* @param array $url A url that didn't match any routes * @param array $url An URL that didn't match any routes
* @return string A generated url for the array * @return string A generated URL for the array
* @see Router::url() * @see Router::url()
*/ */
protected static function _handleNoRoute($url) { protected static function _handleNoRoute($url) {
@ -1012,14 +1012,14 @@ class Router {
* *
* Works similarly to Router::url(), but since parsed URL's contain additional * Works similarly to Router::url(), but since parsed URL's contain additional
* 'pass' and 'named' as well as 'url.url' keys. Those keys need to be specially * 'pass' and 'named' as well as 'url.url' keys. Those keys need to be specially
* handled in order to reverse a params array into a string url. * handled in order to reverse a params array into a string URL.
* *
* This will strip out 'autoRender', 'bare', 'requested', and 'return' param names as those * This will strip out 'autoRender', 'bare', 'requested', and 'return' param names as those
* are used for CakePHP internals and should not normally be part of an output url. * are used for CakePHP internals and should not normally be part of an output URL.
* *
* @param CakeRequest|array $params The params array or CakeRequest object that needs to be reversed. * @param CakeRequest|array $params The params array or CakeRequest object that needs to be reversed.
* @param boolean $full Set to true to include the full url including the protocol when reversing * @param boolean $full Set to true to include the full URL including the protocol when reversing
* the url. * the URL.
* @return string The string that is the reversed result of the array * @return string The string that is the reversed result of the array
*/ */
public static function reverse($params, $full = false) { public static function reverse($params, $full = false) {
@ -1045,12 +1045,12 @@ class Router {
} }
/** /**
* Normalizes a URL for purposes of comparison. * Normalizes an URL for purposes of comparison.
* *
* Will strip the base path off and replace any double /'s. * Will strip the base path off and replace any double /'s.
* It will not unify the casing and underscoring of the input value. * It will not unify the casing and underscoring of the input value.
* *
* @param array|string $url URL to normalize Either an array or a string url. * @param array|string $url URL to normalize Either an array or a string URL.
* @return string Normalized URL * @return string Normalized URL
*/ */
public static function normalize($url = '/') { public static function normalize($url = '/') {

View file

@ -801,8 +801,8 @@ class RequestHandlerComponentTest extends CakeTestCase {
/** /**
* test that the beforeRedirect callback properly converts * test that the beforeRedirect callback properly converts
* array urls into their correct string ones, and adds base => false so * array URLs into their correct string ones, and adds base => false so
* the correct urls are generated. * the correct URLs are generated.
* *
* @link http://cakephp.lighthouseapp.com/projects/42648-cakephp-1x/tickets/276 * @link http://cakephp.lighthouseapp.com/projects/42648-cakephp-1x/tickets/276
* @return void * @return void

View file

@ -593,7 +593,7 @@ class HttpSocketTest extends CakeTestCase {
} }
/** /**
* Test urls like http://cakephp.org/index.php?somestring without key/value pair for query * Test URLs like http://cakephp.org/index.php?somestring without key/value pair for query
* *
* @return void * @return void
*/ */
@ -780,7 +780,7 @@ class HttpSocketTest extends CakeTestCase {
} }
/** /**
* Test that redirect urls are urldecoded * Test that redirect URLs are urldecoded
* *
* @return void * @return void
*/ */

View file

@ -1128,7 +1128,7 @@ class DispatcherTest extends CakeTestCase {
} }
/** /**
* test plugin shortcut urls with controllers that need to be loaded, * test plugin shortcut URLs with controllers that need to be loaded,
* the above test uses a controller that has already been included. * the above test uses a controller that has already been included.
* *
* @return void * @return void

View file

@ -57,7 +57,7 @@ class PluginShortRouteTest extends CakeTestCase {
} }
/** /**
* test the reverse routing of the plugin shortcut urls. * test the reverse routing of the plugin shortcut URLs.
* *
* @return void * @return void
*/ */

View file

@ -59,7 +59,7 @@ class RouterTest extends CakeTestCase {
public function testFullBaseURL() { public function testFullBaseURL() {
$skip = PHP_SAPI === 'cli'; $skip = PHP_SAPI === 'cli';
if ($skip) { if ($skip) {
$this->markTestSkipped('Cannot validate base urls in CLI'); $this->markTestSkipped('Cannot validate base URLs in CLI');
} }
$this->assertRegExp('/^http(s)?:\/\//', Router::url('/', true)); $this->assertRegExp('/^http(s)?:\/\//', Router::url('/', true));
$this->assertRegExp('/^http(s)?:\/\//', Router::url(null, true)); $this->assertRegExp('/^http(s)?:\/\//', Router::url(null, true));
@ -315,7 +315,7 @@ class RouterTest extends CakeTestCase {
} }
/** /**
* test generation of basic urls. * test generation of basic URLs.
* *
* @return void * @return void
*/ */

View file

@ -2474,7 +2474,7 @@ class PaginatorHelperTest extends CakeTestCase {
} }
/** /**
* test that querystring urls can be generated. * test that query string URLs can be generated.
* *
* @return void * @return void
*/ */
@ -2490,7 +2490,7 @@ class PaginatorHelperTest extends CakeTestCase {
} }
/** /**
* test querystring paging link. * test query string paging link.
* *
* @return void * @return void
*/ */

View file

@ -1,6 +1,6 @@
<?php <?php
/** /**
* TestPluginController used by Dispatcher test to test plugin shortcut urls. * TestPluginController used by Dispatcher test to test plugin shortcut URLs.
* *
* PHP 5 * PHP 5
* *

View file

@ -241,10 +241,10 @@ class Helper extends Object {
/** /**
* Finds URL for specified action. * Finds URL for specified action.
* *
* Returns a URL pointing at the provided parameters. * Returns an URL pointing at the provided parameters.
* *
* @param string|array $url Either a relative string url like `/products/view/23` or * @param string|array $url Either a relative string url like `/products/view/23` or
* an array of url parameters. Using an array for urls will allow you to leverage * an array of url parameters. Using an array for URLs will allow you to leverage
* the reverse routing features of CakePHP. * the reverse routing features of CakePHP.
* @param boolean $full If true, the full base URL will be prepended to the result * @param boolean $full If true, the full base URL will be prepended to the result
* @return string Full translated URL with base path. * @return string Full translated URL with base path.
@ -297,7 +297,7 @@ class Helper extends Object {
* @param string|array Path string or url array * @param string|array Path string or url array
* @param array $options Options array. Possible keys: * @param array $options Options array. Possible keys:
* `fullBase` Return full url with domain name * `fullBase` Return full url with domain name
* `pathPrefix` Path prefix for relative urls * `pathPrefix` Path prefix for relative URLs
* `ext` Asset extension to append * `ext` Asset extension to append
* `plugin` False value will prevent parsing path as a plugin * `plugin` False value will prevent parsing path as a plugin
* @return string Generated url * @return string Generated url
@ -334,7 +334,7 @@ class Helper extends Object {
} }
/** /**
* Encodes a URL for use in HTML attributes. * Encodes an URL for use in HTML attributes.
* *
* @param string $url The url to encode. * @param string $url The url to encode.
* @return string The url encoded for both URL & HTML contexts. * @return string The url encoded for both URL & HTML contexts.

View file

@ -293,7 +293,7 @@ class FormHelper extends AppHelper {
* *
* - `type` Form method defaults to POST * - `type` Form method defaults to POST
* - `action` The controller action the form submits to, (optional). * - `action` The controller action the form submits to, (optional).
* - `url` The url the form submits to. Can be a string or a url array. If you use 'url' * - `url` The URL the form submits to. Can be a string or an URL array. If you use 'url'
* you should leave 'action' undefined. * you should leave 'action' undefined.
* - `default` Allows for the creation of Ajax forms. Set this to false to prevent the default event handler. * - `default` Allows for the creation of Ajax forms. Set this to false to prevent the default event handler.
* Will create an onsubmit attribute if it doesn't not exist. If it does, default action suppression * Will create an onsubmit attribute if it doesn't not exist. If it does, default action suppression

View file

@ -1024,7 +1024,7 @@ class HtmlHelper extends AppHelper {
* - `tag` Type of media element to generate, either "audio" or "video". * - `tag` Type of media element to generate, either "audio" or "video".
* If tag is not provided it's guessed based on file's mime type. * If tag is not provided it's guessed based on file's mime type.
* - `text` Text to include inside the audio/video tag * - `text` Text to include inside the audio/video tag
* - `pathPrefix` Path prefix to use for relative urls, defaults to 'files/' * - `pathPrefix` Path prefix to use for relative URLs, defaults to 'files/'
* - `fullBase` If provided the src attribute will get a full address including domain name * - `fullBase` If provided the src attribute will get a full address including domain name
* *
* @param string|array $path Path to the video file, relative to the webroot/{$options['pathPrefix']} directory. * @param string|array $path Path to the video file, relative to the webroot/{$options['pathPrefix']} directory.

View file

@ -67,7 +67,7 @@ abstract class JsBaseEngineHelper extends AppHelper {
} }
/** /**
* Redirects to a 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

View file

@ -285,7 +285,7 @@ class JsHelper extends AppHelper {
* - `buffer` - Disable the buffering and return a script tag in addition to the link. * - `buffer` - Disable the buffering and return a script tag in addition to the link.
* *
* @param string $title Title for the link. * @param string $title Title for the link.
* @param string|array $url Mixed either a string URL or an cake url array. * @param string|array $url Mixed either a string URL or an cake URL array.
* @param array $options Options for both the HTML element and Js::request() * @param array $options Options for both the HTML element and Js::request()
* @return string Completed link. If buffering is disabled a script tag will be returned as well. * @return string Completed link. If buffering is disabled a script tag will be returned as well.
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/js.html#JsHelper::link * @link http://book.cakephp.org/2.0/en/core-libraries/helpers/js.html#JsHelper::link

View file

@ -141,7 +141,7 @@ require CAKE . 'Core' . DS . 'App.php';
require CAKE . 'Error' . DS . 'exceptions.php'; require CAKE . 'Error' . DS . 'exceptions.php';
/** /**
* Full url prefix * Full URL prefix
*/ */
if (!defined('FULL_BASE_URL')) { if (!defined('FULL_BASE_URL')) {
$s = null; $s = null;