mirror of
https://github.com/kamilwylegala/cakephp2-php8.git
synced 2024-11-15 03:18:26 +00:00
Correct 'an URL' to 'a URL' in docblocks
This commit is contained in:
parent
e27e887707
commit
d39ced8381
9 changed files with 23 additions and 23 deletions
|
@ -174,7 +174,7 @@ class AuthComponent extends Component {
|
|||
protected static $_user = array();
|
||||
|
||||
/**
|
||||
* An URL (defined as a string or array) to the controller action that handles
|
||||
* A URL (defined as a string or array) to the controller action that handles
|
||||
* logins. Defaults to `/users/login`.
|
||||
*
|
||||
* @var mixed
|
||||
|
@ -220,7 +220,7 @@ class AuthComponent extends Component {
|
|||
* Controls handling of unauthorized access.
|
||||
* - 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 a URL to redirect to.
|
||||
* - If set to false a ForbiddenException exception is thrown instead of redirecting.
|
||||
*
|
||||
* @var mixed
|
||||
|
@ -699,7 +699,7 @@ class AuthComponent extends Component {
|
|||
/**
|
||||
* Get the URL a user should be redirected to upon login.
|
||||
*
|
||||
* Pass an URL in to set the destination a user should be redirected to upon
|
||||
* Pass a 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
|
||||
|
|
|
@ -134,7 +134,7 @@ class HttpSocket extends CakeSocket {
|
|||
/**
|
||||
* Build an HTTP Socket using the specified configuration.
|
||||
*
|
||||
* You can use an URL string to set the URL and use default configurations for
|
||||
* You can use a URL string to set the URL and use default configurations for
|
||||
* all other options:
|
||||
*
|
||||
* `$http = new HttpSocket('http://cakephp.org/');`
|
||||
|
@ -464,7 +464,7 @@ class HttpSocket extends CakeSocket {
|
|||
/**
|
||||
* Issues a POST request to the specified URI, query, and request.
|
||||
*
|
||||
* `post()` can be used to post simple data arrays to an URL:
|
||||
* `post()` can be used to post simple data arrays to a URL:
|
||||
*
|
||||
* {{{
|
||||
* $response = $http->post('http://example.com', array(
|
||||
|
@ -545,7 +545,7 @@ class HttpSocket extends CakeSocket {
|
|||
*
|
||||
* Would return `/search?q=socket`.
|
||||
*
|
||||
* @param string|array Either a string or array of URL options to create an URL with.
|
||||
* @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.
|
||||
*/
|
||||
|
|
|
@ -369,9 +369,9 @@ class CakeRoute {
|
|||
}
|
||||
|
||||
/**
|
||||
* Apply persistent parameters to an URL array. Persistent parameters are a special
|
||||
* Apply persistent parameters to a URL array. Persistent parameters are a special
|
||||
* key used during route creation to force route parameters to persist when omitted from
|
||||
* an URL array.
|
||||
* a URL array.
|
||||
*
|
||||
* @param array $url The array to apply persistent parameters to.
|
||||
* @param array $params An array of persistent values to replace persistent ones.
|
||||
|
@ -390,7 +390,7 @@ class CakeRoute {
|
|||
}
|
||||
|
||||
/**
|
||||
* Check if an URL array matches this route instance.
|
||||
* Check if a 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.
|
||||
|
@ -485,7 +485,7 @@ class CakeRoute {
|
|||
}
|
||||
|
||||
/**
|
||||
* Converts a matching route array into an URL string.
|
||||
* Converts a matching route array into a URL string.
|
||||
*
|
||||
* Composes the string URL using the template
|
||||
* used to create the route.
|
||||
|
|
|
@ -41,7 +41,7 @@ class RedirectRoute extends CakeRoute {
|
|||
public $redirect;
|
||||
|
||||
/**
|
||||
* Flag for disabling exit() when this route parses an URL.
|
||||
* Flag for disabling exit() when this route parses a URL.
|
||||
*
|
||||
* @var boolean
|
||||
*/
|
||||
|
|
|
@ -80,7 +80,7 @@ class Router {
|
|||
protected static $_parseExtensions = false;
|
||||
|
||||
/**
|
||||
* List of valid extensions to parse from an URL. If null, any extension is allowed.
|
||||
* List of valid extensions to parse from a URL. If null, any extension is allowed.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
|
@ -278,7 +278,7 @@ class Router {
|
|||
* - `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')`
|
||||
* - `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 an URL or remove them by
|
||||
* new URLs. You can override persistent parameters by redefining them in a URL or remove them by
|
||||
* 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,
|
||||
* via a custom routing class. Ex. `'routeClass' => 'SlugRoute'`
|
||||
|
@ -359,7 +359,7 @@ class Router {
|
|||
* `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
|
||||
* redirect destination allows you to use other routes to define where an URL string should be redirected to.
|
||||
* redirect destination allows you to use other routes to define where a URL string should be redirected to.
|
||||
*
|
||||
* `Router::redirect('/posts/*', 'http://google.com', array('status' => 302));`
|
||||
*
|
||||
|
@ -589,7 +589,7 @@ class Router {
|
|||
}
|
||||
|
||||
/**
|
||||
* Parses a file extension out of an URL, if Router::parseExtensions() is enabled.
|
||||
* Parses a file extension out of a URL, if Router::parseExtensions() is enabled.
|
||||
*
|
||||
* @param string $url
|
||||
* @return array Returns an array containing the altered URL and the parsed extension.
|
||||
|
@ -758,7 +758,7 @@ class Router {
|
|||
/**
|
||||
* Finds URL for specified action.
|
||||
*
|
||||
* Returns an URL pointing to a combination of controller and action. Param
|
||||
* Returns a URL pointing to a combination of controller and action. Param
|
||||
* $url can be:
|
||||
*
|
||||
* - Empty - the method will find address to actual controller/action.
|
||||
|
@ -938,7 +938,7 @@ class Router {
|
|||
* A special fallback method that handles URL arrays that cannot match
|
||||
* any defined routes.
|
||||
*
|
||||
* @param array $url An URL that didn't match any routes
|
||||
* @param array $url A URL that didn't match any routes
|
||||
* @return string A generated URL for the array
|
||||
* @see Router::url()
|
||||
*/
|
||||
|
@ -1085,7 +1085,7 @@ class Router {
|
|||
}
|
||||
|
||||
/**
|
||||
* Normalizes an URL for purposes of comparison.
|
||||
* Normalizes a URL for purposes of comparison.
|
||||
*
|
||||
* Will strip the base path off and replace any double /'s.
|
||||
* It will not unify the casing and underscoring of the input value.
|
||||
|
|
|
@ -81,7 +81,7 @@ class Xml {
|
|||
* is disabled by default for security reasons.
|
||||
* - If using array as input, you can pass `options` from Xml::fromArray.
|
||||
*
|
||||
* @param string|array $input XML string, a path to a file, an URL or an array
|
||||
* @param string|array $input XML string, a path to a file, a URL or an array
|
||||
* @param array $options The options to use
|
||||
* @return SimpleXMLElement|DOMDocument SimpleXMLElement or DOMDocument
|
||||
* @throws XmlException
|
||||
|
|
|
@ -245,7 +245,7 @@ class Helper extends Object {
|
|||
/**
|
||||
* Finds URL for specified action.
|
||||
*
|
||||
* Returns an URL pointing at the provided parameters.
|
||||
* Returns a URL pointing at the provided parameters.
|
||||
*
|
||||
* @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
|
||||
|
@ -341,7 +341,7 @@ class Helper extends Object {
|
|||
}
|
||||
|
||||
/**
|
||||
* Encodes an URL for use in HTML attributes.
|
||||
* Encodes a URL for use in HTML attributes.
|
||||
*
|
||||
* @param string $url The URL to encode.
|
||||
* @return string The URL encoded for both URL & HTML contexts.
|
||||
|
|
|
@ -297,7 +297,7 @@ class FormHelper extends AppHelper {
|
|||
*
|
||||
* - `type` Form method defaults to POST
|
||||
* - `action` The controller action the form submits to, (optional).
|
||||
* - `url` The URL the form submits to. Can be a string or an URL array. If you use 'url'
|
||||
* - `url` The URL the form submits to. Can be a string or a URL array. If you use 'url'
|
||||
* you should leave 'action' undefined.
|
||||
* - `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
|
||||
|
|
|
@ -67,7 +67,7 @@ abstract class JsBaseEngineHelper extends AppHelper {
|
|||
}
|
||||
|
||||
/**
|
||||
* Redirects to an URL. Creates a window.location modification snippet
|
||||
* Redirects to a URL. Creates a window.location modification snippet
|
||||
* that can be used to trigger 'redirects' from JavaScript.
|
||||
*
|
||||
* @param string|array $url URL
|
||||
|
|
Loading…
Reference in a new issue