Skip to content

Commit

Permalink
Update incorrect book links.
Browse files Browse the repository at this point in the history
Update and remove book links in several namespaces.
  • Loading branch information
markstory committed Nov 15, 2014
1 parent 96ccb91 commit 8f11194
Show file tree
Hide file tree
Showing 22 changed files with 42 additions and 120 deletions.
1 change: 0 additions & 1 deletion src/Console/Exception/MissingShellException.php
Expand Up @@ -7,7 +7,6 @@
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://book.cakephp.org/2.0/en/development/testing.html
* @since 3.0.0
* @license http://www.opensource.org/licenses/mit-license.php MIT License
*/
Expand Down
1 change: 0 additions & 1 deletion src/Console/Exception/MissingShellMethodException.php
Expand Up @@ -7,7 +7,6 @@
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://book.cakephp.org/2.0/en/development/testing.html
* @since 3.0.0
* @license http://www.opensource.org/licenses/mit-license.php MIT License
*/
Expand Down
1 change: 0 additions & 1 deletion src/Console/Exception/MissingTaskException.php
Expand Up @@ -7,7 +7,6 @@
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://book.cakephp.org/2.0/en/development/testing.html
* @since 3.0.0
* @license http://www.opensource.org/licenses/mit-license.php MIT License
*/
Expand Down
12 changes: 6 additions & 6 deletions src/Controller/Component/AuthComponent.php
Expand Up @@ -31,7 +31,7 @@
*
* Binds access control with user authentication and session management.
*
* @link http://book.cakephp.org/2.0/en/core-libraries/components/authentication.html
* @link http://book.cakephp.org/3.0/en/controllers/components/authentication.html
*/
class AuthComponent extends Component {

Expand Down Expand Up @@ -531,7 +531,7 @@ public function getAuthorize($alias) {
*
* @param string|array $actions Controller action name or array of actions
* @return void
* @link http://book.cakephp.org/2.0/en/core-libraries/components/authentication.html#making-actions-public
* @link http://book.cakephp.org/3.0/en/controllers/components/authentication.html#making-actions-public
*/
public function allow($actions = null) {
if ($actions === null) {
Expand All @@ -554,7 +554,7 @@ public function allow($actions = null) {
* @param string|array $actions Controller action name or array of actions
* @return void
* @see AuthComponent::allow()
* @link http://book.cakephp.org/2.0/en/core-libraries/components/authentication.html#making-actions-require-authorization
* @link http://book.cakephp.org/3.0/en/controllers/components/authentication.html#making-actions-require-authorization
*/
public function deny($actions = null) {
if ($actions === null) {
Expand All @@ -578,7 +578,7 @@ public function deny($actions = null) {
*
* @param array $user Array of user data.
* @return void
* @link http://book.cakephp.org/2.0/en/core-libraries/components/authentication.html#identifying-users-and-logging-them-in
* @link http://book.cakephp.org/3.0/en/controllers/components/authentication.html#identifying-users-and-logging-them-in
*/
public function setUser(array $user) {
$this->session->renew();
Expand All @@ -595,7 +595,7 @@ public function setUser(array $user) {
* This helps mitigate issues with session replays.
*
* @return string Normalized config `logoutRedirect`
* @link http://book.cakephp.org/2.0/en/core-libraries/components/authentication.html#logging-users-out
* @link http://book.cakephp.org/3.0/en/controllers/components/authentication.html#logging-users-out
*/
public function logout() {
$this->_setDefaults();
Expand All @@ -619,7 +619,7 @@ public function logout() {
*
* @param string $key field to retrieve. Leave null to get entire User record
* @return array|null Either User record or null if no user is logged in.
* @link http://book.cakephp.org/2.0/en/core-libraries/components/authentication.html#accessing-the-logged-in-user
* @link http://book.cakephp.org/3.0/en/controllers/components/authentication.html#accessing-the-logged-in-user
*/
public function user($key = null) {
if (!empty($this->_user)) {
Expand Down
5 changes: 1 addition & 4 deletions src/Controller/Component/CookieComponent.php
Expand Up @@ -31,7 +31,7 @@
* - Store non-scalar data.
* - Use hash compatible syntax to read/write/delete values.
*
* @link http://book.cakephp.org/2.0/en/core-libraries/components/cookie.html
* @link http://book.cakephp.org/3.0/en/controllers/components/cookie.html
*/
class CookieComponent extends Component {

Expand Down Expand Up @@ -204,7 +204,6 @@ public function implementedEvents() {
* @param string|array $key Key for the value
* @param mixed $value Value
* @return void
* @link http://book.cakephp.org/2.0/en/core-libraries/components/cookie.html#CookieComponent::write
*/
public function write($key, $value = null) {
if (!is_array($key)) {
Expand Down Expand Up @@ -233,7 +232,6 @@ public function write($key, $value = null) {
*
* @param string $key Key of the value to be obtained.
* @return string or null, value for specified key
* @link http://book.cakephp.org/2.0/en/core-libraries/components/cookie.html#CookieComponent::read
*/
public function read($key = null) {
$this->_load($key);
Expand Down Expand Up @@ -288,7 +286,6 @@ public function check($key = null) {
*
* @param string $key Key of the value to be deleted
* @return void
* @link http://book.cakephp.org/2.0/en/core-libraries/components/cookie.html#CookieComponent::delete
*/
public function delete($key) {
$this->_load($key);
Expand Down
2 changes: 1 addition & 1 deletion src/Controller/Component/PaginatorComponent.php
Expand Up @@ -27,7 +27,7 @@
*
* You configure pagination when calling paginate(). See that method for more details.
*
* @link http://book.cakephp.org/2.0/en/core-libraries/components/pagination.html
* @link http://book.cakephp.org/3.0/en/controllers/components/pagination.html
*/
class PaginatorComponent extends Component {

Expand Down
2 changes: 1 addition & 1 deletion src/Controller/Component/RequestHandlerComponent.php
Expand Up @@ -34,7 +34,7 @@
* and the like. These units have no use for Ajax requests, and this Component can tell how Cake
* should respond to the different needs of a handheld computer and a desktop machine.
*
* @link http://book.cakephp.org/2.0/en/core-libraries/components/request-handling.html
* @link http://book.cakephp.org/3.0/en/controllers/components/request-handling.html
*/
class RequestHandlerComponent extends Component {

Expand Down
6 changes: 2 additions & 4 deletions src/Controller/Component/SecurityComponent.php
Expand Up @@ -31,7 +31,7 @@
* - Requiring that SSL be used.
* - Limiting cross controller communication.
*
* @link http://book.cakephp.org/2.0/en/core-libraries/components/security-component.html
* @link http://book.cakephp.org/3.0/en/controllers/components/security-component.html
*/
class SecurityComponent extends Component {

Expand Down Expand Up @@ -144,7 +144,6 @@ public function implementedEvents() {
*
* @param string|array $actions Actions list
* @return void
* @link http://book.cakephp.org/2.0/en/core-libraries/components/security-component.html#SecurityComponent::requireSecure
*/
public function requireSecure($actions = null) {
$this->_requireMethod('Secure', (array)$actions);
Expand All @@ -159,7 +158,6 @@ public function requireSecure($actions = null) {
*
* @param string|array $actions Actions list
* @return void
* @link http://book.cakephp.org/2.0/en/core-libraries/components/security-component.html#SecurityComponent::requireAuth
*/
public function requireAuth($actions) {
$this->_requireMethod('Auth', (array)$actions);
Expand All @@ -173,7 +171,7 @@ public function requireAuth($actions) {
* @param string $error Error method
* @return mixed If specified, controller blackHoleCallback's response, or no return otherwise
* @see SecurityComponent::$blackHoleCallback
* @link http://book.cakephp.org/2.0/en/core-libraries/components/security-component.html#handling-blackhole-callbacks
* @link http://book.cakephp.org/3.0/en/controllers/components/security-component.html#handling-blackhole-callbacks
* @throws \Cake\Network\Exception\BadRequestException
*/
public function blackHole(Controller $controller, $error = '') {
Expand Down
10 changes: 2 additions & 8 deletions src/Controller/Component/SessionComponent.php
Expand Up @@ -23,8 +23,8 @@
*
* This class is here for backwards compatibility with CakePHP 2.x
*
* @link http://book.cakephp.org/2.0/en/core-libraries/components/sessions.html
* @link http://book.cakephp.org/2.0/en/development/sessions.html
* @link http://book.cakephp.org/3.0/en/controllers/components/sessions.html
* @link http://book.cakephp.org/3.0/en/development/sessions.html
* @deprecated 3.0.0
*/
class SessionComponent extends Component {
Expand Down Expand Up @@ -56,7 +56,6 @@ public function initialize(array $config) {
* This should be in a Controller.key format for better organizing
* @param string $value The value you want to store in a session.
* @return void
* @link http://book.cakephp.org/2.0/en/core-libraries/components/sessions.html#SessionComponent::write
*/
public function write($name, $value = null) {
$this->_session->write($name, $value);
Expand All @@ -70,7 +69,6 @@ public function write($name, $value = null) {
*
* @param string $name the name of the session key you want to read
* @return mixed value from the session vars
* @link http://book.cakephp.org/2.0/en/core-libraries/components/sessions.html#SessionComponent::read
*/
public function read($name = null) {
return $this->_session->read($name);
Expand All @@ -83,7 +81,6 @@ public function read($name = null) {
*
* @param string $name the name of the session key you want to delete
* @return void
* @link http://book.cakephp.org/2.0/en/core-libraries/components/sessions.html#SessionComponent::delete
*/
public function delete($name) {
$this->_session->delete($name);
Expand All @@ -96,7 +93,6 @@ public function delete($name) {
*
* @param string $name the name of the session key you want to check
* @return bool true is session variable is set, false if not
* @link http://book.cakephp.org/2.0/en/core-libraries/components/sessions.html#SessionComponent::check
*/
public function check($name) {
return $this->_session->check($name);
Expand All @@ -117,7 +113,6 @@ public function check($name) {
* @param string $key Message key, default is 'flash'
* @return void
* @deprecated 3.0 Use FlashComponent::set() instead.
* @link http://book.cakephp.org/2.0/en/core-libraries/components/sessions.html#creating-notification-messages
*/
public function setFlash($message, $element = null, array $params = array(), $key = 'flash') {
$this->_session->write('Flash.' . $key, [
Expand Down Expand Up @@ -145,7 +140,6 @@ public function renew() {
* In your controller: $this->Session->destroy();
*
* @return void
* @link http://book.cakephp.org/2.0/en/core-libraries/components/sessions.html#SessionComponent::destroy
*/
public function destroy() {
$this->_session->destroy();
Expand Down
20 changes: 9 additions & 11 deletions src/Controller/Controller.php
Expand Up @@ -97,7 +97,6 @@ class Controller implements EventListenerInterface {
* Set automatically using conventions in Controller::__construct().
*
* @var string
* @link http://book.cakephp.org/2.0/en/controllers.html#controller-attributes
*/
public $name = null;

Expand All @@ -108,7 +107,7 @@ class Controller implements EventListenerInterface {
* Example: `public $helpers = ['Form', 'Html', 'Time'];`
*
* @var mixed
* @link http://book.cakephp.org/2.0/en/controllers.html#components-helpers-and-uses
* @link http://book.cakephp.org/3.0/en/controllers.html#configuring-helpers-to-load
*/
public $helpers = array();

Expand All @@ -118,15 +117,15 @@ class Controller implements EventListenerInterface {
* additional information about the request.
*
* @var \Cake\Network\Request
* @link http://book.cakephp.org/2.0/en/controllers/request-response.html#Request
* @link http://book.cakephp.org/3.0/en/controllers/request-response.html#request
*/
public $request;

/**
* An instance of a Response object that contains information about the impending response
*
* @var \Cake\Network\Response
* @link http://book.cakephp.org/2.0/en/controllers/request-response.html#cakeresponse
* @link http://book.cakephp.org/3.0/en/controllers/request-response.html#response
*/
public $response;

Expand Down Expand Up @@ -170,7 +169,7 @@ class Controller implements EventListenerInterface {
* Example: `public $components = array('Session', 'RequestHandler', 'Acl');`
*
* @var array
* @link http://book.cakephp.org/2.0/en/controllers/components.html
* @link http://book.cakephp.org/3.0/en/controllers/components.html
*/
public $components = array();

Expand Down Expand Up @@ -568,7 +567,7 @@ public function setAction($action) {
* @param string $view View to use for rendering
* @param string $layout Layout to use
* @return \Cake\Network\Response A response object containing the rendered view.
* @link http://book.cakephp.org/2.0/en/controllers.html#Controller::render
* @link http://book.cakephp.org/3.0/en/controllers.html#rendering-a-view
*/
public function render($view = null, $layout = null) {
if (!empty($this->request->params['bare'])) {
Expand Down Expand Up @@ -596,7 +595,6 @@ public function render($view = null, $layout = null) {
* @param string $default Default URL to use if HTTP_REFERER cannot be read from headers
* @param bool $local If true, restrict referring URLs to local server
* @return string Referring URL
* @link http://book.cakephp.org/2.0/en/controllers.html#Controller::referer
*/
public function referer($default = null, $local = false) {
if (!$this->request) {
Expand Down Expand Up @@ -678,7 +676,7 @@ public function isAction($action) {
*
* @param Event $event An Event instance
* @return void
* @link http://book.cakephp.org/2.0/en/controllers.html#request-life-cycle-callbacks
* @link http://book.cakephp.org/3.0/en/controllers.html#request-life-cycle-callbacks
*/
public function beforeFilter(Event $event) {
}
Expand All @@ -689,7 +687,7 @@ public function beforeFilter(Event $event) {
*
* @param Event $event An Event instance
* @return void
* @link http://book.cakephp.org/2.0/en/controllers.html#request-life-cycle-callbacks
* @link http://book.cakephp.org/3.0/en/controllers.html#request-life-cycle-callbacks
*/
public function beforeRender(Event $event) {
}
Expand All @@ -708,7 +706,7 @@ public function beforeRender(Event $event) {
* or an absolute URL
* @param \Cake\Network\Response $response The response object.
* @return void
* @link http://book.cakephp.org/2.0/en/controllers.html#request-life-cycle-callbacks
* @link http://book.cakephp.org/3.0/en/controllers.html#request-life-cycle-callbacks
*/
public function beforeRedirect(Event $event, $url, Response $response) {
}
Expand All @@ -718,7 +716,7 @@ public function beforeRedirect(Event $event, $url, Response $response) {
*
* @param Event $event An Event instance
* @return void
* @link http://book.cakephp.org/2.0/en/controllers.html#request-life-cycle-callbacks
* @link http://book.cakephp.org/3.0/en/controllers.html#request-life-cycle-callbacks
*/
public function afterFilter(Event $event) {
}
Expand Down
1 change: 0 additions & 1 deletion src/Controller/Exception/MissingActionException.php
Expand Up @@ -7,7 +7,6 @@
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://book.cakephp.org/2.0/en/development/testing.html
* @since 3.0.0
* @license http://www.opensource.org/licenses/mit-license.php MIT License
*/
Expand Down
1 change: 0 additions & 1 deletion src/Controller/Exception/MissingComponentException.php
Expand Up @@ -7,7 +7,6 @@
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://book.cakephp.org/2.0/en/development/testing.html
* @since 3.0.0
* @license http://www.opensource.org/licenses/mit-license.php MIT License
*/
Expand Down
5 changes: 2 additions & 3 deletions src/Core/App.php
Expand Up @@ -38,7 +38,7 @@
* Plugins can be located with App as well. Using Plugin::path('DebugKit') for example, will
* give you the full path to the DebugKit plugin.
*
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/app.html
* @link http://book.cakephp.org/3.0/en/core-utility-libraries/app.html
*/
class App {

Expand Down Expand Up @@ -108,7 +108,7 @@ protected static function _classExistsInBase($name, $namespace) {
* @param string $type type of path
* @param string $plugin name of plugin
* @return array
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/app.html#App::path
* @link http://book.cakephp.org/3.0/en/core-libraries/app.html#finding-paths-to-namespaces
*/
public static function path($type, $plugin = null) {
if ($type === 'Plugin') {
Expand All @@ -134,7 +134,6 @@ public static function path($type, $plugin = null) {
*
* @param string $type Package type.
* @return array Full path to package
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/app.html#App::core
*/
public static function core($type) {
return [CAKE . str_replace('/', DS, $type) . DS];
Expand Down

0 comments on commit 8f11194

Please sign in to comment.