Skip to content

Commit 9f601ea

Browse files
sdoneymarkstory
authored andcommitted
Adding/Updating @link tags pointing to cookbook sections
Signed-off-by: Mark Story <mark@mark-story.com>
1 parent 94391d7 commit 9f601ea

File tree

10 files changed

+26
-3
lines changed

10 files changed

+26
-3
lines changed

cake/basics.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ function clone($object)
5252
* `config('config1', 'config2');`
5353
*
5454
* @return boolean Success
55+
* @link http://book.cakephp.org/view/1125/config
5556
*/
5657
function config() {
5758
$args = func_get_args();
@@ -82,6 +83,7 @@ function config() {
8283
*
8384
* @param string $name Filename without the .php part
8485
* @deprecated Will be removed in 2.0
86+
* @link http://book.cakephp.org/view/1140/uses
8587
*/
8688
function uses() {
8789
$args = func_get_args();
@@ -99,6 +101,7 @@ function uses() {
99101
* @param boolean $showHtml If set to true, the method prints the debug data in a screen-friendly way.
100102
* @param boolean $showFrom If set to true, the method prints from where the function was called.
101103
* @link http://book.cakephp.org/view/1190/Basic-Debugging
104+
* @link http://book.cakephp.org/view/1128/debug
102105
*/
103106
function debug($var = false, $showHtml = false, $showFrom = true) {
104107
if (Configure::read() > 0) {

cake/console/libs/schema.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
*
2929
* @package cake
3030
* @subpackage cake.cake.console.libs
31-
* @link http://book.cakephp.org/view/1523s/Schema-management-and-migrations
31+
* @link http://book.cakephp.org/view/1523/Schema-management-and-migrations
3232
*/
3333
class SchemaShell extends Shell {
3434

cake/libs/configure.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -439,7 +439,7 @@ function __loadBootstrap($boot) {
439439
/**
440440
* Class/file loader and path management.
441441
*
442-
* @link http://book.cakephp.org/view/499/The-App-Class
442+
* @link http://book.cakephp.org/view/933/The-App-Class
443443
* @since CakePHP(tm) v 1.2.0.6001
444444
* @package cake
445445
* @subpackage cake.cake.libs

cake/libs/controller/app_controller.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
*
3131
* @package cake
3232
* @subpackage cake.cake.libs.controller
33+
* @link http://book.cakephp.org/view/957/The-App-Controller
3334
*/
3435
class AppController extends Controller {
3536
}

cake/libs/controller/pages_controller.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
*
2828
* @package cake
2929
* @subpackage cake.cake.libs.controller
30+
* @link http://book.cakephp.org/view/958/The-Pages-Controller
3031
*/
3132
class PagesController extends AppController {
3233

cake/libs/model/behaviors/acl.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525
*
2626
* @package cake
2727
* @subpackage cake.cake.libs.model.behaviors
28+
* @link http://book.cakephp.org/view/1320/ACL
2829
*/
2930
class AclBehavior extends ModelBehavior {
3031

@@ -69,6 +70,7 @@ function setup(&$model, $config = array()) {
6970
* @param mixed $ref
7071
* @return array
7172
* @access public
73+
* @link http://book.cakephp.org/view/1322/node
7274
*/
7375
function node(&$model, $ref = null) {
7476
$type = $this->__typeMaps[strtolower($this->settings[$model->name]['type'])];

cake/libs/model/behaviors/containable.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
*
2727
* @package cake
2828
* @subpackage cake.cake.console.libs
29+
* @link http://book.cakephp.org/view/1323/Containable
2930
*/
3031
class ContainableBehavior extends ModelBehavior {
3132

@@ -234,6 +235,7 @@ function afterFind(&$Model, $results, $primary) {
234235
* @param object $Model Model on which binding restriction is being applied
235236
* @return void
236237
* @access public
238+
* @link http://book.cakephp.org/view/1323/Containable#Using-Containable-1324
237239
*/
238240
function contain(&$Model) {
239241
$args = func_get_args();

cake/libs/model/behaviors/translate.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
*
2424
* @package cake
2525
* @subpackage cake.cake.libs.model.behaviors
26+
* @link http://book.cakephp.org/view/1328/Translate
2627
*/
2728
class TranslateBehavior extends ModelBehavior {
2829

cake/libs/model/behaviors/tree.php

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@
2828
* @see http://en.wikipedia.org/wiki/Tree_traversal
2929
* @package cake
3030
* @subpackage cake.cake.libs.model.behaviors
31+
* @link http://book.cakephp.org/view/1339/Tree
3132
*/
3233
class TreeBehavior extends ModelBehavior {
3334

@@ -206,6 +207,7 @@ function beforeSave(&$Model) {
206207
* @param boolean $direct whether to count direct, or all, children
207208
* @return integer number of child nodes
208209
* @access public
210+
* @link http://book.cakephp.org/view/1347/Counting-children
209211
*/
210212
function childcount(&$Model, $id = null, $direct = false) {
211213
if (is_array($id)) {
@@ -252,6 +254,7 @@ function childcount(&$Model, $id = null, $direct = false) {
252254
* @param integer $recursive The number of levels deep to fetch associated records
253255
* @return array Array of child nodes
254256
* @access public
257+
* @link http://book.cakephp.org/view/1346/Children
255258
*/
256259
function children(&$Model, $id = null, $direct = false, $fields = null, $order = null, $limit = null, $page = 1, $recursive = null) {
257260
if (is_array($id)) {
@@ -309,6 +312,7 @@ function children(&$Model, $id = null, $direct = false, $fields = null, $order =
309312
* @param integer $recursive The number of levels deep to fetch associated records
310313
* @return array An associative array of records, where the id is the key, and the display field is the value
311314
* @access public
315+
* @link http://book.cakephp.org/view/1348/generatetreelist
312316
*/
313317
function generatetreelist(&$Model, $conditions = null, $keyPath = null, $valuePath = null, $spacer = '_', $recursive = null) {
314318
$overrideRecursive = $recursive;
@@ -364,6 +368,7 @@ function generatetreelist(&$Model, $conditions = null, $keyPath = null, $valuePa
364368
* @param integer $recursive The number of levels deep to fetch associated records
365369
* @return array Array of data for the parent node
366370
* @access public
371+
* @link http://book.cakephp.org/view/1349/getparentnode
367372
*/
368373
function getparentnode(&$Model, $id = null, $fields = null, $recursive = null) {
369374
if (is_array($id)) {
@@ -397,6 +402,7 @@ function getparentnode(&$Model, $id = null, $fields = null, $recursive = null) {
397402
* @param integer $recursive The number of levels deep to fetch associated records
398403
* @return array Array of nodes from top most parent to current node
399404
* @access public
405+
* @link http://book.cakephp.org/view/1350/getpath
400406
*/
401407
function getpath(&$Model, $id = null, $fields = null, $recursive = null) {
402408
if (is_array($id)) {
@@ -434,6 +440,7 @@ function getpath(&$Model, $id = null, $fields = null, $recursive = null) {
434440
* @param mixed $number how many places to move the node or true to move to last position
435441
* @return boolean true on success, false on failure
436442
* @access public
443+
* @link http://book.cakephp.org/view/1352/moveDown
437444
*/
438445
function movedown(&$Model, $id = null, $number = 1) {
439446
if (is_array($id)) {
@@ -492,6 +499,7 @@ function movedown(&$Model, $id = null, $number = 1) {
492499
* @param mixed $number how many places to move the node, or true to move to first position
493500
* @return boolean true on success, false on failure
494501
* @access public
502+
* @link http://book.cakephp.org/view/1353/moveUp
495503
*/
496504
function moveup(&$Model, $id = null, $number = 1) {
497505
if (is_array($id)) {
@@ -556,6 +564,7 @@ function moveup(&$Model, $id = null, $number = 1) {
556564
* delete, or the id of the parent to set as the parent_id
557565
* @return boolean true on success, false on failure
558566
* @access public
567+
* @link http://book.cakephp.org/view/1628/Recover
559568
*/
560569
function recover(&$Model, $mode = 'parent', $missingParentAction = null) {
561570
if (is_array($mode)) {
@@ -634,6 +643,8 @@ function recover(&$Model, $mode = 'parent', $missingParentAction = null) {
634643
* @param AppModel $Model Model instance
635644
* @param array $options array of options to use in reordering.
636645
* @return boolean true on success, false on failure
646+
* @link http://book.cakephp.org/view/1355/reorder
647+
* @link http://book.cakephp.org/view/1629/Reorder
637648
*/
638649
function reorder(&$Model, $options = array()) {
639650
$options = array_merge(array('id' => null, 'field' => $Model->displayField, 'order' => 'ASC', 'verify' => true), $options);
@@ -673,6 +684,7 @@ function reorder(&$Model, $options = array()) {
673684
* @param boolean $delete whether to delete the node after reparenting children (if any)
674685
* @return boolean true on success, false on failure
675686
* @access public
687+
* @link http://book.cakephp.org/view/1354/removeFromTree
676688
*/
677689
function removefromtree(&$Model, $id = null, $delete = false) {
678690
if (is_array($id)) {
@@ -741,6 +753,7 @@ function removefromtree(&$Model, $id = null, $delete = false) {
741753
* @return mixed true if the tree is valid or empty, otherwise an array of (error type [index, node],
742754
* [incorrect left/right index,node id], message)
743755
* @access public
756+
* @link http://book.cakephp.org/view/1630/Verify
744757
*/
745758
function verify(&$Model) {
746759
extract($this->settings[$Model->alias]);

cake/libs/model/model.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
*
4242
* @package cake
4343
* @subpackage cake.cake.libs.model
44-
* @link http://book.cakephp.org/view/66/Models
44+
* @link http://book.cakephp.org/view/1000/Models
4545
*/
4646
class Model extends Overloadable {
4747

0 commit comments

Comments
 (0)