Skip to content
Permalink
Browse files

Fixing more links in doc blocks

  • Loading branch information...
lorenzo committed Oct 15, 2011
1 parent 6709170 commit 91d0a081fb23921862af9bbe07c5041585e952d2
@@ -104,7 +104,7 @@ public function __get($name) {
*
* @param Controller $controller Controller with components to initialize
* @return void
* @link http://book.cakephp.org/view/998/MVC-Class-Access-Within-Components
* @link http://book.cakephp.org/2.0/en/controllers/components.html#Component::initialize
*/
public function initialize($controller) { }
@@ -113,7 +113,7 @@ public function initialize($controller) { }
*
* @param Controller $controller Controller with components to startup
* @return void
* @link http://book.cakephp.org/view/998/MVC-Class-Access-Within-Components
* @link http://book.cakephp.org/2.0/en/controllers/components.html#Component::startup
*/
public function startup($controller) { }
@@ -123,6 +123,7 @@ public function startup($controller) { }
*
* @param Controller $controller Controller with components to beforeRender
* @return void
* @link http://book.cakephp.org/2.0/en/controllers/components.html#Component::beforeRender
*/
public function beforeRender($controller) { }
@@ -131,6 +132,7 @@ public function beforeRender($controller) { }
*
* @param Controller $controller Controller with components to shutdown
* @return void
* @link @link http://book.cakephp.org/2.0/en/controllers/components.html#Component::shutdown
*/
public function shutdown($controller) { }
@@ -151,6 +153,7 @@ public function shutdown($controller) { }
* @param integer $status The status code of the redirect
* @param boolean $exit Will the script exit.
* @return array|null Either an array or null.
* @link @link http://book.cakephp.org/2.0/en/controllers/components.html#Component::beforeRedirect
*/
public function beforeRedirect($controller, $url, $status = null, $exit = true) {}
@@ -26,7 +26,7 @@
* Cookie handling for the controller.
*
* @package Cake.Controller.Component
* @link http://book.cakephp.org/view/1280/Cookies
* @link http://book.cakephp.org/2.0/en/core-libraries/components/cookie.html
*
*/
class CookieComponent extends Component {
@@ -28,7 +28,8 @@
* based on the standard outlined in http://www.rfc-editor.org/rfc/rfc2822.txt
*
* @package Cake.Controller.Component
* @link http://book.cakephp.org/view/1283/Email
* @link http://book.cakephp.org/2.0/en/core-libraries/components/email.html
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/email.html
* @deprecated Use Network/CakeEmail
*/
class EmailComponent extends Component {
@@ -215,7 +216,6 @@ class EmailComponent extends Component {
* - client
*
* @var array
* @link http://book.cakephp.org/view/1290/Sending-A-Message-Using-SMTP
*/
public $smtpOptions = array();
@@ -363,7 +363,6 @@ public function send($content = null, $template = null, $layout = null) {
* Reset all EmailComponent internal variables to be able to send out a new email.
*
* @return void
* @link http://book.cakephp.org/view/1285/Sending-Multiple-Emails-in-a-loop
*/
public function reset() {
$this->template = null;
@@ -50,6 +50,7 @@
* This would allow you to have different pagination settings for `Comment` and `Post` models.
*
* @package Cake.Controller.Component
* @link http://book.cakephp.org/2.0/en/core-libraries/components/pagination.html
*/
class PaginatorComponent extends Component {
@@ -25,7 +25,7 @@
* Request object for handling HTTP requests
*
* @package Cake.Controller.Component
* @link http://book.cakephp.org/view/1291/Request-Handling
* @link http://book.cakephp.org/2.0/en/core-libraries/components/request-handling.html
*
*/
class RequestHandlerComponent extends Component {
@@ -25,7 +25,7 @@
* SecurityComponent
*
* @package Cake.Controller.Component
* @link http://book.cakephp.org/view/1296/Security-Component
* @link http://book.cakephp.org/2.0/en/core-libraries/components/security-component.html
*/
class SecurityComponent extends Component {
@@ -214,7 +214,7 @@ public function startup($controller) {
* Sets the actions that require a POST request, or empty for all actions
*
* @return void
* @link http://book.cakephp.org/view/1299/requirePost
* @link http://book.cakephp.org/2.0/en/core-libraries/components/security-component.html#SecurityComponent::requirePost
*/
public function requirePost() {
$args = func_get_args();
@@ -255,7 +255,7 @@ public function requireDelete() {
* Sets the actions that require a request that is SSL-secured, or empty for all actions
*
* @return void
* @link http://book.cakephp.org/view/1300/requireSecure
* @link http://book.cakephp.org/2.0/en/core-libraries/components/security-component.html#SecurityComponent::requireSecure
*/
public function requireSecure() {
$args = func_get_args();
@@ -266,7 +266,7 @@ public function requireSecure() {
* Sets the actions that require an authenticated request, or empty for all actions
*
* @return void
* @link http://book.cakephp.org/view/1301/requireAuth
* @link http://book.cakephp.org/2.0/en/core-libraries/components/security-component.html#SecurityComponent::requireAuth
*/
public function requireAuth() {
$args = func_get_args();
@@ -281,7 +281,7 @@ public function requireAuth() {
* @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/view/1307/blackHole-object-controller-string-error
* @link http://book.cakephp.org/2.0/en/core-libraries/components/security-component.html#handling-blackhole-callbacks
*/
public function blackHole($controller, $error = '') {
if ($this->blackHoleCallback == null) {
@@ -26,8 +26,8 @@
* Session handling from the controller.
*
* @package Cake.Controller.Component
* @link http://book.cakephp.org/view/1310/Sessions
*
* @link http://book.cakephp.org/2.0/en/core-libraries/components/sessions.html
* @link http://book.cakephp.org/2.0/en/development/sessions.html
*/
class SessionComponent extends Component {
@@ -50,7 +50,7 @@ public function userAgent($userAgent = null) {
* This should be in a Controller.key format for better organizing
* @param string $value The value you want to store in a session.
* @return boolean Success
* @link http://book.cakephp.org/view/1312/write
* @link http://book.cakephp.org/2.0/en/core-libraries/components/sessions.html#SessionComponent::write
*/
public function write($name, $value = null) {
return CakeSession::write($name, $value);
@@ -64,7 +64,7 @@ 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/view/1314/read
* @link http://book.cakephp.org/2.0/en/core-libraries/components/sessions.html#SessionComponent::read
*/
public function read($name = null) {
return CakeSession::read($name);
@@ -77,7 +77,7 @@ public function read($name = null) {
*
* @param string $name the name of the session key you want to delete
* @return boolean true is session variable is set and can be deleted, false is variable was not set.
* @link http://book.cakephp.org/view/1316/delete
* @link http://book.cakephp.org/2.0/en/core-libraries/components/sessions.html#SessionComponent::delete
*/
public function delete($name) {
return CakeSession::delete($name);
@@ -90,7 +90,7 @@ public function delete($name) {
*
* @param string $name the name of the session key you want to check
* @return boolean true is session variable is set, false if not
* @link http://book.cakephp.org/view/1315/check
* @link http://book.cakephp.org/2.0/en/core-libraries/components/sessions.html#SessionComponent::check
*/
public function check($name) {
return CakeSession::check($name);
@@ -102,7 +102,6 @@ public function check($name) {
* In your controller: $this->Session->error();
*
* @return string Last session error
* @link http://book.cakephp.org/view/1318/error
*/
public function error() {
return CakeSession::error();
@@ -122,7 +121,7 @@ public function error() {
* @param array $params Parameters to be sent to layout as view variables
* @param string $key Message key, default is 'flash'
* @return void
* @link http://book.cakephp.org/view/1313/setFlash
* @link http://book.cakephp.org/2.0/en/core-libraries/components/sessions.html#creating-notification-messages
*/
public function setFlash($message, $element = 'default', $params = array(), $key = 'flash') {
CakeSession::write('Message.' . $key, compact('message', 'element', 'params'));
@@ -156,7 +155,7 @@ public function valid() {
* In your controller: $this->Session->destroy();
*
* @return void
* @link http://book.cakephp.org/view/1317/destroy
* @link http://book.cakephp.org/2.0/en/core-libraries/components/sessions.html#SessionComponent::destroy
*/
public function destroy() {
return CakeSession::destroy();
Oops, something went wrong.

0 comments on commit 91d0a08

Please sign in to comment.
You can’t perform that action at this time.