adulau/cakephp2-php8
1
0
Fork 0
mirror of https://github.com/kamilwylegala/cakephp2-php8.git synced 2025-01-31 09:06:17 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fixing more links in doc blocks

Browse source
This commit is contained in:
Jose Lorenzo Rodriguez 2011-10-15 11:38:49 -04:30
parent 670917070e
commit 91d0a081fb
13 changed files with 55 additions and 54 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
lib/Cake/Controller/Component.php
View file

@ -104,7 +104,7 @@ class Component extends Object {
*
* @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 @@ class Component extends Object {
*
* @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 @@ class Component extends Object {
*
* @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 @@ class Component extends Object {
*
* @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 @@ class Component extends Object {
* @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) {}

2
lib/Cake/Controller/Component/CookieComponent.php
View file

@ -26,7 +26,7 @@ App::uses('Security', 'Utility');
* 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 {

5
lib/Cake/Controller/Component/EmailComponent.php
View file

@ -28,7 +28,8 @@ App::uses('CakeEmail', 'Network/Email');
* 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 @@ class EmailComponent extends Component {
* 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;

1
lib/Cake/Controller/Component/PaginatorComponent.php
View file

@ -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 {

2
lib/Cake/Controller/Component/RequestHandlerComponent.php
View file

@ -25,7 +25,7 @@ App::uses('Xml', 'Utility');
* 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 {

10
lib/Cake/Controller/Component/SecurityComponent.php
View file

@ -25,7 +25,7 @@ App::uses('Security', 'Utility');
* 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 @@ class SecurityComponent extends Component {
* 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 @@ class SecurityComponent extends Component {
* 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 @@ class SecurityComponent extends Component {
* 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 @@ class SecurityComponent extends Component {
* @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) {

17
lib/Cake/Controller/Component/SessionComponent.php
View file

@ -26,8 +26,8 @@ App::uses('CakeSession', 'Model/Datasource');
* 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 @@ class SessionComponent extends Component {
* 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 @@ class SessionComponent extends Component {
*
* @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 @@ class SessionComponent extends Component {
*
* @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 @@ class SessionComponent extends Component {
*
* @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 @@ class SessionComponent extends Component {
* 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 @@ class SessionComponent extends Component {
* @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 @@ class SessionComponent extends Component {
* 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();

43
lib/Cake/Controller/Controller.php
View file

@ -55,7 +55,7 @@ App::uses('View', 'View');
* @property RequestHandlerComponent $RequestHandler
* @property SecurityComponent $Security
* @property SessionComponent $Session
* @link http://book.cakephp.org/view/956/Introduction
* @link http://book.cakephp.org/2.0/en/controllers.html
*/
class Controller extends Object {
@ -63,7 +63,7 @@ class Controller extends Object {
* The name of this controller. Controller names are plural, named after the model they manipulate.
*
* @var string
* @link http://book.cakephp.org/view/959/Controller-Attributes
* @link http://book.cakephp.org/2.0/en/controllers.html#controller-attributes
*/
public $name = null;
@ -76,7 +76,7 @@ class Controller extends Object {
* use no models and prevent the merging of $uses with AppController
*
* @var mixed A single name as a string or a list of names as an array.
* @link http://book.cakephp.org/view/961/components-helpers-and-uses
* @link http://book.cakephp.org/2.0/en/controllers.html#components-helpers-and-uses
*/
public $uses = false;
@ -87,7 +87,7 @@ class Controller extends Object {
* Example: `public $helpers = array('Html', 'Javascript', 'Time', 'Ajax');`
*
* @var mixed A single name as a string or a list of names as an array.
* @link http://book.cakephp.org/view/961/components-helpers-and-uses
* @link http://book.cakephp.org/2.0/en/controllers.html#components-helpers-and-uses
*/
public $helpers = array('Session', 'Html', 'Form');
@ -141,7 +141,6 @@ class Controller extends Object {
* is the filename in /app/View/<SubFolder> without the .ctp extension.
*
* @var string
* @link http://book.cakephp.org/view/962/Page-related-Attributes-layout-and-pageTitle
*/
public $view = null;
@ -151,7 +150,6 @@ class Controller extends Object {
* extension.
*
* @var string
* @link http://book.cakephp.org/view/962/Page-related-Attributes-layout-and-pageTitle
*/
public $layout = 'default';
@ -579,7 +577,7 @@ class Controller extends Object {
*
* @return mixed true if models found and instance created.
* @see Controller::loadModel()
* @link http://book.cakephp.org/view/977/Controller-Methods#constructClasses-986
* @link http://book.cakephp.org/2.0/en/controllers.html#Controller::constructClasses
* @throws MissingModelException
*/
public function constructClasses() {
@ -685,7 +683,7 @@ class Controller extends Object {
* @param integer $status Optional HTTP status code (eg: 404)
* @param boolean $exit If true, exit() will be called after the redirect
* @return mixed void if $exit = false. Terminates script if $exit = true
* @link http://book.cakephp.org/view/982/redirect
* @link http://book.cakephp.org/2.0/en/controllers.html#Controller::redirect
*/
public function redirect($url, $status = null, $exit = true) {
$this->autoRender = false;
@ -775,7 +773,7 @@ class Controller extends Object {
* @param mixed $two Value in case $one is a string (which then works as the key).
* Unused if $one is an associative array, otherwise serves as the values to $one's keys.
* @return void
* @link http://book.cakephp.org/view/979/set
* @link http://book.cakephp.org/2.0/en/controllers.html#interacting-with-views
*/
public function set($one, $two = null) {
if (is_array($one)) {
@ -860,7 +858,7 @@ class Controller extends Object {
* @param string $view View to use for rendering
* @param string $layout Layout to use
* @return CakeResponse A response object containing the rendered view.
* @link http://book.cakephp.org/view/980/render
* @link http://book.cakephp.org/2.0/en/controllers.html#Controller::render
*/
public function render($view = null, $layout = null) {
$this->beforeRender();
@ -907,7 +905,7 @@ class Controller extends Object {
* @param string $default Default URL to use if HTTP_REFERER cannot be read from headers
* @param boolean $local If true, restrict referring URLs to local server
* @return string Referring URL
* @link http://book.cakephp.org/view/987/referer
* @link http://book.cakephp.org/2.0/en/controllers.html#Controller::referer
*/
public function referer($default = null, $local = false) {
if ($this->request) {
@ -924,7 +922,7 @@ class Controller extends Object {
* Forces the user's browser not to cache the results of the current request.
*
* @return void
* @link http://book.cakephp.org/view/988/disableCache
* @link http://book.cakephp.org/2.0/en/controllers.html#Controller::disableCache
* @deprecated Use CakeResponse::disableCache()
*/
public function disableCache() {
@ -941,7 +939,7 @@ class Controller extends Object {
* @param integer $pause Time to show the message
* @param string $layout Layout you want to use, defaults to 'flash'
* @return void Renders flash layout
* @link http://book.cakephp.org/view/983/flash
* @link http://book.cakephp.org/2.0/en/controllers.html#Controller::flash
*/
public function flash($message, $url, $pause = 1, $layout = 'flash') {
$this->autoRender = false;
@ -962,7 +960,7 @@ class Controller extends Object {
* @param boolean $exclusive If true, and $op is an array, fields not included in $op will not be
* included in the returned conditions
* @return array An array of model conditions
* @link http://book.cakephp.org/view/989/postConditions
* @deprecated
*/
public function postConditions($data = array(), $op = null, $bool = 'AND', $exclusive = false) {
if (!is_array($data) || empty($data)) {
@ -1018,7 +1016,7 @@ class Controller extends Object {
* @param mixed $scope Conditions to use while paginating
* @param array $whitelist List of allowed options for paging
* @return array Model query results
* @link http://book.cakephp.org/view/1232/Controller-Setup
* @link http://book.cakephp.org/2.0/en/controllers.html#Controller::paginate
* @deprecated Use PaginatorComponent instead
*/
public function paginate($object = null, $scope = array(), $whitelist = array()) {
@ -1030,7 +1028,7 @@ class Controller extends Object {
* or perform logic that needs to happen before each controller action.
*
* @return void
* @link http://book.cakephp.org/view/984/Callbacks
* @link http://book.cakephp.org/2.0/en/controllers.html#request-life-cycle-callbacks
*/
public function beforeFilter() {
}
@ -1040,7 +1038,7 @@ class Controller extends Object {
* to perform logic or set view variables that are required on every request.
*
* @return void
* @link http://book.cakephp.org/view/984/Callbacks
* @link http://book.cakephp.org/2.0/en/controllers.html#request-life-cycle-callbacks
*/
public function beforeRender() {
}
@ -1057,6 +1055,7 @@ class Controller extends Object {
* @param integer $status Optional HTTP status code (eg: 404)
* @param boolean $exit If true, exit() will be called after the redirect
* @return boolean
* @link http://book.cakephp.org/2.0/en/controllers.html#request-life-cycle-callbacks
*/
public function beforeRedirect($url, $status = null, $exit = true) {
return true;
@ -1066,7 +1065,7 @@ class Controller extends Object {
* Called after the controller action is run and rendered.
*
* @return void
* @link http://book.cakephp.org/view/984/Callbacks
* @link http://book.cakephp.org/2.0/en/controllers.html#request-life-cycle-callbacks
*/
public function afterFilter() {
}
@ -1076,7 +1075,7 @@ class Controller extends Object {
*
* @param string $method name of method called example index, edit, etc.
* @return boolean Success
* @link http://book.cakephp.org/view/984/Callbacks
* @link http://book.cakephp.org/2.0/en/controllers.html#callbacks
*/
public function beforeScaffold($method) {
return true;
@ -1099,7 +1098,7 @@ class Controller extends Object {
*
* @param string $method name of method called either edit or update.
* @return boolean Success
* @link http://book.cakephp.org/view/984/Callbacks
* @link http://book.cakephp.org/2.0/en/controllers.html#callbacks
*/
public function afterScaffoldSave($method) {
return true;
@ -1122,7 +1121,7 @@ class Controller extends Object {
*
* @param string $method name of method called either edit or update.
* @return boolean Success
* @link http://book.cakephp.org/view/984/Callbacks
* @link http://book.cakephp.org/2.0/en/controllers.html#callbacks
*/
public function afterScaffoldSaveError($method) {
return true;
@ -1147,7 +1146,7 @@ class Controller extends Object {
*
* @param string $method name of method called example index, edit, etc.
* @return boolean Success
* @link http://book.cakephp.org/view/984/Callbacks
* @link http://book.cakephp.org/2.0/en/controllers.html#callbacks
*/
public function scaffoldError($method) {
return false;

2
lib/Cake/Controller/PagesController.php
View file

@ -27,7 +27,7 @@ App::uses('AppController', 'Controller');
* Override this controller by placing a copy in controllers directory of an application
*
* @package Cake.Controller
* @link http://book.cakephp.org/view/958/The-Pages-Controller
* @link http://book.cakephp.org/2.0/en/controllers/pages-controller.html
*/
class PagesController extends AppController {

4
lib/Cake/Core/App.php
View file

@ -57,7 +57,7 @@
* You can find out which objects App knows about using App::objects('Controller') for example to find
* which application controllers App knows about.
*
* @link http://book.cakephp.org/view/933/The-App-Class
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/app.html
* @package Cake.Core
*/
class App {
@ -552,7 +552,7 @@ class App {
* Finds classes based on $name or specific file(s) to search. Calling App::import() will
* not construct any classes contained in the files. It will only find and require() the file.
*
* @link http://book.cakephp.org/view/934/Using-App-import
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/app.html#including-files-with-app-import
* @param mixed $type The type of Class if passed as a string, or all params can be passed as
* an single array to $type,
* @param string $name Name of the Class or a unique name for the file

1
lib/Cake/Core/CakePlugin.php
View file

@ -21,6 +21,7 @@
* CakePlugin class
*
* @package Cake.Core
* @link http://book.cakephp.org/2.0/en/plugins.html
*/
class CakePlugin {

11
lib/Cake/Core/Configure.php
View file

@ -27,7 +27,7 @@ App::uses('Set', 'Utility');
* for future use.
*
* @package Cake.Core
* @link http://book.cakephp.org/view/924/The-Configuration-Class
* @link http://book.cakephp.org/2.0/en/development/configuration.html#configure-class
*/
class Configure {
@ -113,7 +113,7 @@ class Configure {
* ));
* }}}
*
* @link http://book.cakephp.org/view/926/write
* @link http://book.cakephp.org/2.0/en/development/configuration.html#Configure::write
* @param array $config Name of var to write
* @param mixed $value Value to set for var
* @return boolean True if write was successful
@ -166,7 +166,7 @@ class Configure {
* Configure::read('Name.key'); will return only the value of Configure::Name[key]
* }}}
*
* @link http://book.cakephp.org/view/927/read
* @linkhttp://book.cakephp.org/2.0/en/development/configuration.html#Configure::read
* @param string $var Variable to obtain. Use '.' to access array elements.
* @return mixed value stored in configure, or null.
*/
@ -212,7 +212,7 @@ class Configure {
* Configure::delete('Name.key'); will delete only the Configure::Name[key]
* }}}
*
* @link http://book.cakephp.org/view/928/delete
* @link http://book.cakephp.org/2.0/en/development/configuration.html#Configure::delete
* @param string $var the var to be deleted
* @return void
*/
@ -290,7 +290,7 @@ class Configure {
* If using `default` config and no reader has been configured for it yet,
* one will be automatically created using PhpReader
*
* @link http://book.cakephp.org/view/929/load
* @link http://book.cakephp.org/2.0/en/development/configuration.html#Configure::load
* @param string $key name of configuration resource to load.
* @param string $config Name of the configured reader to use to read the resource identified by $key.
* @param boolean $merge if config files should be merged instead of simply overridden
@ -325,7 +325,6 @@ class Configure {
*
* Usage `Configure::version();`
*
* @link http://book.cakephp.org/view/930/version
* @return string Current version of CakePHP
*/
public static function version() {

4
lib/Cake/Model/Behavior/AclBehavior.php
View file

@ -24,7 +24,7 @@ App::uses('AclNode', 'Model');
* ACL behavior
*
* @package Cake.Model.Behavior
* @link http://book.cakephp.org/view/1320/ACL
* @link http://book.cakephp.org/2.0/en/core-libraries/behaviors/acl.html
*/
class AclBehavior extends ModelBehavior {
@ -69,7 +69,7 @@ class AclBehavior extends ModelBehavior {
* @param mixed $ref
* @param string $type Only needed when Acl is set up as 'both', specify 'Aro' or 'Aco' to get the correct node
* @return array
* @link http://book.cakephp.org/view/1322/node
* @link http://book.cakephp.org/2.0/en/core-libraries/behaviors/acl.html#node
*/
public function node($model, $ref = null, $type = null) {
if (empty($type)) {