From 670917070e169a4c567355943a6427bd7ff36e17 Mon Sep 17 00:00:00 2001 From: Jose Lorenzo Rodriguez Date: Sat, 15 Oct 2011 10:43:26 -0430 Subject: [PATCH] Changing a bunch of links in doc blocks --- lib/Cake/Configure/PhpReader.php | 2 +- lib/Cake/Console/Command/BakeShell.php | 2 +- lib/Cake/Console/Command/SchemaShell.php | 2 +- .../Controller/Component/AclComponent.php | 8 +++--- .../Controller/Component/AuthComponent.php | 26 ++++++++----------- lib/Cake/basics.php | 22 ++++++++-------- 6 files changed, 29 insertions(+), 33 deletions(-) diff --git a/lib/Cake/Configure/PhpReader.php b/lib/Cake/Configure/PhpReader.php index a19c0771e..f81cd067a 100644 --- a/lib/Cake/Configure/PhpReader.php +++ b/lib/Cake/Configure/PhpReader.php @@ -11,7 +11,7 @@ * Redistributions of files must retain the above copyright notice * * @copyright Copyright 2005-2011, Cake Software Foundation, Inc. (http://cakefoundation.org) - * @link http://book.cakephp.org/view/1196/Testing CakePHP(tm) Tests + * @link http://book.cakephp.org/2.0/en/development/configuration.html#loading-configuration-files CakePHP(tm) Configuration * @package Cake.Configure * @since CakePHP(tm) v 2.0 * @license MIT License (http://www.opensource.org/licenses/mit-license.php) diff --git a/lib/Cake/Console/Command/BakeShell.php b/lib/Cake/Console/Command/BakeShell.php index 65c64959f..82e67b3e5 100644 --- a/lib/Cake/Console/Command/BakeShell.php +++ b/lib/Cake/Console/Command/BakeShell.php @@ -26,7 +26,7 @@ App::uses('Model', 'Model'); * Bake is a command-line code generation utility for automating programmer chores. * * @package Cake.Console.Command - * @link http://book.cakephp.org/view/1522/Code-Generation-with-Bake + * @link http://book.cakephp.org/2.0/en/console-and-shells/code-generation-with-bake.html */ class BakeShell extends Shell { diff --git a/lib/Cake/Console/Command/SchemaShell.php b/lib/Cake/Console/Command/SchemaShell.php index ab24f37ed..2705ffb89 100644 --- a/lib/Cake/Console/Command/SchemaShell.php +++ b/lib/Cake/Console/Command/SchemaShell.php @@ -26,7 +26,7 @@ App::uses('CakeSchema', 'Model'); * Schema is a command-line database management utility for automating programmer chores. * * @package Cake.Console.Command - * @link http://book.cakephp.org/view/1523/Schema-management-and-migrations + * @link http://book.cakephp.org/2.0/en/console-and-shells/schema-management-and-migrations.html */ class SchemaShell extends Shell { diff --git a/lib/Cake/Controller/Component/AclComponent.php b/lib/Cake/Controller/Component/AclComponent.php index c34fb7a52..631c6d30c 100644 --- a/lib/Cake/Controller/Component/AclComponent.php +++ b/lib/Cake/Controller/Component/AclComponent.php @@ -29,7 +29,7 @@ App::uses('Component', 'Controller'); * implementations should extend `AclBase` and implement the methods it defines. * * @package Cake.Controller.Component - * @link http://book.cakephp.org/view/1242/Access-Control-Lists + * @link http://book.cakephp.org/2.0/en/core-libraries/components/access-control-lists.html */ class AclComponent extends Component { @@ -288,7 +288,7 @@ class DbAcl extends Object implements AclInterface { * @param string $aco ACO The controlled object identifier. * @param string $action Action (defaults to *) * @return boolean Success (true if ARO has access to action in ACO, false otherwise) - * @link http://book.cakephp.org/view/1249/Checking-Permissions-The-ACL-Component + * @link http://book.cakephp.org/2.0/en/core-libraries/components/access-control-lists.html#checking-permissions-the-acl-component */ public function check($aro, $aco, $action = "*") { if ($aro == null || $aco == null) { @@ -376,7 +376,7 @@ class DbAcl extends Object implements AclInterface { * @param string $actions Action (defaults to *) * @param integer $value Value to indicate access type (1 to give access, -1 to deny, 0 to inherit) * @return boolean Success - * @link http://book.cakephp.org/view/1248/Assigning-Permissions + * @link http://book.cakephp.org/2.0/en/core-libraries/components/access-control-lists.html#assigning-permissions */ public function allow($aro, $aco, $actions = "*", $value = 1) { $perms = $this->getAclLink($aro, $aco); @@ -427,7 +427,7 @@ class DbAcl extends Object implements AclInterface { * @param string $aco ACO The controlled object identifier. * @param string $action Action (defaults to *) * @return boolean Success - * @link http://book.cakephp.org/view/1248/Assigning-Permissions + * @link http://book.cakephp.org/2.0/en/core-libraries/components/access-control-lists.html#assigning-permissions */ public function deny($aro, $aco, $action = "*") { return $this->allow($aro, $aco, $action, -1); diff --git a/lib/Cake/Controller/Component/AuthComponent.php b/lib/Cake/Controller/Component/AuthComponent.php index 1de22094b..39dd01f45 100644 --- a/lib/Cake/Controller/Component/AuthComponent.php +++ b/lib/Cake/Controller/Component/AuthComponent.php @@ -34,7 +34,7 @@ App::uses('BaseAuthenticate', 'Controller/Component/Auth'); * Binds access control with user authentication and session management. * * @package Cake.Controller.Component - * @link http://book.cakephp.org/view/1250/Authentication + * @link http://book.cakephp.org/2.0/en/core-libraries/components/authentication.html */ class AuthComponent extends Component { @@ -77,7 +77,7 @@ class AuthComponent extends Component { * You can also use AuthComponent::ALL instead of the string 'all'. * * @var array - * @link http://book.cakephp.org/view/1278/authenticate + * @link http://book.cakephp.org/2.0/en/core-libraries/components/authentication.html */ public $authenticate = array('Form'); @@ -133,7 +133,6 @@ class AuthComponent extends Component { * with an invalid or expired session * * @var string - * @link http://book.cakephp.org/view/1277/ajaxLogin */ public $ajaxLogin = null; @@ -158,7 +157,6 @@ class AuthComponent extends Component { * unspecified, it will be "Auth.User". * * @var string - * @link http://book.cakephp.org/view/1276/sessionKey */ public static $sessionKey = 'Auth.User'; @@ -167,7 +165,6 @@ class AuthComponent extends Component { * logins. Defaults to `/users/login` * * @var mixed - * @link http://book.cakephp.org/view/1269/loginAction */ public $loginAction = array( 'controller' => 'users', @@ -182,7 +179,7 @@ class AuthComponent extends Component { * set, the user will be redirected to the page specified in $loginRedirect. * * @var mixed - * @link http://book.cakephp.org/view/1270/loginRedirect + * @link http://book.cakephp.org/2.0/en/core-libraries/components/authentication.html#AuthComponent::$loginRedirect */ public $loginRedirect = null; @@ -194,7 +191,6 @@ class AuthComponent extends Component { * @var mixed * @see AuthComponent::$loginAction * @see AuthComponent::logout() - * @link http://book.cakephp.org/view/1271/logoutRedirect */ public $logoutRedirect = null; @@ -203,7 +199,7 @@ class AuthComponent extends Component { * acccess. * * @var string - * @link http://book.cakephp.org/view/1273/authError + * @link http://book.cakephp.org/2.0/en/core-libraries/components/authentication.html#AuthComponent::$authError */ public $authError = null; @@ -212,7 +208,6 @@ class AuthComponent extends Component { * * @var array * @see AuthComponent::allow() - * @link http://book.cakephp.org/view/1251/Setting-Auth-Component-Variables */ public $allowedActions = array(); @@ -429,7 +424,7 @@ class AuthComponent extends Component { * * @param mixed $action,... Controller action name or array of actions * @return void - * @link http://book.cakephp.org/view/1257/allow + * @link http://book.cakephp.org/2.0/en/core-libraries/components/authentication.html#making-actions-public */ public function allow($action = null) { $args = func_get_args(); @@ -454,7 +449,7 @@ class AuthComponent extends Component { * @param mixed $action,... Controller action name or array of actions * @return void * @see AuthComponent::allow() - * @link http://book.cakephp.org/view/1258/deny + * @link http://book.cakephp.org/2.0/en/core-libraries/components/authentication.html#making-actions-require-authorization */ public function deny($action = null) { $args = func_get_args(); @@ -478,6 +473,7 @@ class AuthComponent extends Component { * @param array $map Actions to map * @return void * @see BaseAuthorize::mapActions() + * @link http://book.cakephp.org/2.0/en/core-libraries/components/authentication.html#mapping-actions-when-using-crudauthorize */ public function mapActions($map = array()) { if (empty($this->_authorizeObjects)) { @@ -496,7 +492,7 @@ class AuthComponent extends Component { * * @param mixed $user Either an array of user data, or null to identify a user using the current request. * @return boolean True on login success, false on failure - * @link http://book.cakephp.org/view/1261/login + * @link http://book.cakephp.org/2.0/en/core-libraries/components/authentication.html#identifying-users-and-logging-them-in */ public function login($user = null) { $this->_setDefaults(); @@ -520,7 +516,7 @@ class AuthComponent extends Component { * * @return string AuthComponent::$logoutRedirect * @see AuthComponent::$logoutRedirect - * @link http://book.cakephp.org/view/1262/logout + * @link http://book.cakephp.org/2.0/en/core-libraries/components/authentication.html#logging-users-out */ public function logout() { $this->_setDefaults(); @@ -542,7 +538,7 @@ class AuthComponent extends Component { * * @param string $key field to retrive. Leave null to get entire User record * @return mixed User record. or null if no user is logged in. - * @link http://book.cakephp.org/view/1264/user + * @link http://book.cakephp.org/2.0/en/core-libraries/components/authentication.html#accessing-the-logged-in-user */ public static function user($key = null) { if (!CakeSession::check(self::$sessionKey)) { @@ -670,7 +666,7 @@ class AuthComponent extends Component { * * @param string $password Password to hash * @return string Hashed password - * @link http://book.cakephp.org/view/1263/password + * @link http://book.cakephp.org/2.0/en/core-libraries/components/authentication.html#hashing-passwords */ public static function password($password) { return Security::hash($password, null, true); diff --git a/lib/Cake/basics.php b/lib/Cake/basics.php index ac1e6c07a..1e853155b 100644 --- a/lib/Cake/basics.php +++ b/lib/Cake/basics.php @@ -39,7 +39,7 @@ * `config('config1', 'config2');` * * @return boolean Success - * @link http://book.cakephp.org/view/1125/config + * @link http://book.cakephp.org/2.0/en/core-libraries/global-constants-and-functions.html#config */ function config() { $args = func_get_args(); @@ -69,8 +69,8 @@ function config() { * @param boolean $var Variable to show debug information for. * @param boolean $showHtml If set to true, the method prints the debug data in a browser-friendly way. * @param boolean $showFrom If set to true, the method prints from where the function was called. - * @link http://book.cakephp.org/view/1190/Basic-Debugging - * @link http://book.cakephp.org/view/1128/debug + * @link http://book.cakephp.org/2.0/en/development/debugging.html#basic-debugging + * @link http://book.cakephp.org/2.0/en/core-libraries/global-constants-and-functions.html#debug */ function debug($var = false, $showHtml = null, $showFrom = true) { if (Configure::read('debug') > 0) { @@ -152,7 +152,7 @@ if (!function_exists('sortByKey')) { * @param boolean $double Encode existing html entities * @param string $charset Character set to use when escaping. Defaults to config value in 'App.encoding' or 'UTF-8' * @return string Wrapped text - * @link http://book.cakephp.org/view/1132/h + * @link http://book.cakephp.org/2.0/en/development/debugging.html#h */ function h($text, $double = true, $charset = null) { if (is_array($text)) { @@ -204,7 +204,7 @@ function pluginSplit($name, $dotAppend = false, $plugin = null) { * * @see debug() * @param array $var Variable to print out - * @link http://book.cakephp.org/view/1136/pr + * @link http://book.cakephp.org/2.0/en/development/debugging.html#pr */ function pr($var) { if (Configure::read('debug') > 0) { @@ -222,7 +222,7 @@ function pr($var) { * @param array Third array * @param array Etc... * @return array All array parameters merged into one - * @link http://book.cakephp.org/view/1124/am + * @link http://book.cakephp.org/2.0/en/development/debugging.html#am */ function am() { $r = array(); @@ -244,7 +244,7 @@ function am() { * * @param string $key Environment variable name. * @return string Environment variable setting. - * @link http://book.cakephp.org/view/1130/env + * @link http://book.cakephp.org/2.0/en/development/debugging.html#env */ function env($key) { if ($key === 'HTTPS') { @@ -464,7 +464,7 @@ function clearCache($params = null, $type = 'views', $ext = '.php') { * * @param array $values Array of values to strip slashes * @return mixed What is returned from calling stripslashes - * @link http://book.cakephp.org/view/1138/stripslashes_deep + * @link http://book.cakephp.org/2.0/en/development/debugging.html#stripslashes_deep */ function stripslashes_deep($values) { if (is_array($values)) { @@ -483,7 +483,7 @@ function stripslashes_deep($values) { * @param string $singular Text to translate * @param mixed $args Array with arguments or multiple arguments in function * @return mixed translated string - * @link http://book.cakephp.org/view/1121/__ + * @link http://book.cakephp.org/2.0/en/development/debugging.html#__ */ function __($singular, $args = null) { if (!$singular) { @@ -701,7 +701,7 @@ function LogError($message) { * * @param string $file File to look for * @return Full path to file if exists, otherwise false - * @link http://book.cakephp.org/view/1131/fileExistsInPath + * @link http://book.cakephp.org/2.0/en/development/debugging.html#fileExistsInPath */ function fileExistsInPath($file) { $paths = explode(PATH_SEPARATOR, ini_get('include_path')); @@ -722,7 +722,7 @@ function fileExistsInPath($file) { * * @param string String to convert * @return string with underscore remove from start and end of string - * @link http://book.cakephp.org/view/1126/convertSlash + * @link http://book.cakephp.org/2.0/en/development/debugging.html#convertSlash */ function convertSlash($string) { $string = trim($string, '/');