Skip to content

Commit

Permalink
Adding/Updating @link tags pointing to cookbook sections
Browse files Browse the repository at this point in the history
Signed-off-by: Mark Story <mark@mark-story.com>
  • Loading branch information
sdoney authored and markstory committed Apr 9, 2010
1 parent 94391d7 commit 9f601ea
Show file tree
Hide file tree
Showing 10 changed files with 26 additions and 3 deletions.
3 changes: 3 additions & 0 deletions cake/basics.php
Expand Up @@ -52,6 +52,7 @@ function clone($object)
* `config('config1', 'config2');`
*
* @return boolean Success
* @link http://book.cakephp.org/view/1125/config
*/
function config() {
$args = func_get_args();
Expand Down Expand Up @@ -82,6 +83,7 @@ function config() {
*
* @param string $name Filename without the .php part
* @deprecated Will be removed in 2.0
* @link http://book.cakephp.org/view/1140/uses
*/
function uses() {
$args = func_get_args();
Expand All @@ -99,6 +101,7 @@ function uses() {
* @param boolean $showHtml If set to true, the method prints the debug data in a screen-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
*/
function debug($var = false, $showHtml = false, $showFrom = true) {
if (Configure::read() > 0) {
Expand Down
2 changes: 1 addition & 1 deletion cake/console/libs/schema.php
Expand Up @@ -28,7 +28,7 @@
*
* @package cake
* @subpackage cake.cake.console.libs
* @link http://book.cakephp.org/view/1523s/Schema-management-and-migrations
* @link http://book.cakephp.org/view/1523/Schema-management-and-migrations
*/
class SchemaShell extends Shell {

Expand Down
2 changes: 1 addition & 1 deletion cake/libs/configure.php
Expand Up @@ -439,7 +439,7 @@ function __loadBootstrap($boot) {
/**
* Class/file loader and path management.
*
* @link http://book.cakephp.org/view/499/The-App-Class
* @link http://book.cakephp.org/view/933/The-App-Class
* @since CakePHP(tm) v 1.2.0.6001
* @package cake
* @subpackage cake.cake.libs
Expand Down
1 change: 1 addition & 0 deletions cake/libs/controller/app_controller.php
Expand Up @@ -30,6 +30,7 @@
*
* @package cake
* @subpackage cake.cake.libs.controller
* @link http://book.cakephp.org/view/957/The-App-Controller
*/
class AppController extends Controller {
}
Expand Down
1 change: 1 addition & 0 deletions cake/libs/controller/pages_controller.php
Expand Up @@ -27,6 +27,7 @@
*
* @package cake
* @subpackage cake.cake.libs.controller
* @link http://book.cakephp.org/view/958/The-Pages-Controller
*/
class PagesController extends AppController {

Expand Down
2 changes: 2 additions & 0 deletions cake/libs/model/behaviors/acl.php
Expand Up @@ -25,6 +25,7 @@
*
* @package cake
* @subpackage cake.cake.libs.model.behaviors
* @link http://book.cakephp.org/view/1320/ACL
*/
class AclBehavior extends ModelBehavior {

Expand Down Expand Up @@ -69,6 +70,7 @@ function setup(&$model, $config = array()) {
* @param mixed $ref
* @return array
* @access public
* @link http://book.cakephp.org/view/1322/node
*/
function node(&$model, $ref = null) {
$type = $this->__typeMaps[strtolower($this->settings[$model->name]['type'])];
Expand Down
2 changes: 2 additions & 0 deletions cake/libs/model/behaviors/containable.php
Expand Up @@ -26,6 +26,7 @@
*
* @package cake
* @subpackage cake.cake.console.libs
* @link http://book.cakephp.org/view/1323/Containable
*/
class ContainableBehavior extends ModelBehavior {

Expand Down Expand Up @@ -234,6 +235,7 @@ function afterFind(&$Model, $results, $primary) {
* @param object $Model Model on which binding restriction is being applied
* @return void
* @access public
* @link http://book.cakephp.org/view/1323/Containable#Using-Containable-1324
*/
function contain(&$Model) {
$args = func_get_args();
Expand Down
1 change: 1 addition & 0 deletions cake/libs/model/behaviors/translate.php
Expand Up @@ -23,6 +23,7 @@
*
* @package cake
* @subpackage cake.cake.libs.model.behaviors
* @link http://book.cakephp.org/view/1328/Translate
*/
class TranslateBehavior extends ModelBehavior {

Expand Down
13 changes: 13 additions & 0 deletions cake/libs/model/behaviors/tree.php
Expand Up @@ -28,6 +28,7 @@
* @see http://en.wikipedia.org/wiki/Tree_traversal
* @package cake
* @subpackage cake.cake.libs.model.behaviors
* @link http://book.cakephp.org/view/1339/Tree
*/
class TreeBehavior extends ModelBehavior {

Expand Down Expand Up @@ -206,6 +207,7 @@ function beforeSave(&$Model) {
* @param boolean $direct whether to count direct, or all, children
* @return integer number of child nodes
* @access public
* @link http://book.cakephp.org/view/1347/Counting-children
*/
function childcount(&$Model, $id = null, $direct = false) {
if (is_array($id)) {
Expand Down Expand Up @@ -252,6 +254,7 @@ function childcount(&$Model, $id = null, $direct = false) {
* @param integer $recursive The number of levels deep to fetch associated records
* @return array Array of child nodes
* @access public
* @link http://book.cakephp.org/view/1346/Children
*/
function children(&$Model, $id = null, $direct = false, $fields = null, $order = null, $limit = null, $page = 1, $recursive = null) {
if (is_array($id)) {
Expand Down Expand Up @@ -309,6 +312,7 @@ function children(&$Model, $id = null, $direct = false, $fields = null, $order =
* @param integer $recursive The number of levels deep to fetch associated records
* @return array An associative array of records, where the id is the key, and the display field is the value
* @access public
* @link http://book.cakephp.org/view/1348/generatetreelist
*/
function generatetreelist(&$Model, $conditions = null, $keyPath = null, $valuePath = null, $spacer = '_', $recursive = null) {
$overrideRecursive = $recursive;
Expand Down Expand Up @@ -364,6 +368,7 @@ function generatetreelist(&$Model, $conditions = null, $keyPath = null, $valuePa
* @param integer $recursive The number of levels deep to fetch associated records
* @return array Array of data for the parent node
* @access public
* @link http://book.cakephp.org/view/1349/getparentnode
*/
function getparentnode(&$Model, $id = null, $fields = null, $recursive = null) {
if (is_array($id)) {
Expand Down Expand Up @@ -397,6 +402,7 @@ function getparentnode(&$Model, $id = null, $fields = null, $recursive = null) {
* @param integer $recursive The number of levels deep to fetch associated records
* @return array Array of nodes from top most parent to current node
* @access public
* @link http://book.cakephp.org/view/1350/getpath
*/
function getpath(&$Model, $id = null, $fields = null, $recursive = null) {
if (is_array($id)) {
Expand Down Expand Up @@ -434,6 +440,7 @@ function getpath(&$Model, $id = null, $fields = null, $recursive = null) {
* @param mixed $number how many places to move the node or true to move to last position
* @return boolean true on success, false on failure
* @access public
* @link http://book.cakephp.org/view/1352/moveDown
*/
function movedown(&$Model, $id = null, $number = 1) {
if (is_array($id)) {
Expand Down Expand Up @@ -492,6 +499,7 @@ function movedown(&$Model, $id = null, $number = 1) {
* @param mixed $number how many places to move the node, or true to move to first position
* @return boolean true on success, false on failure
* @access public
* @link http://book.cakephp.org/view/1353/moveUp
*/
function moveup(&$Model, $id = null, $number = 1) {
if (is_array($id)) {
Expand Down Expand Up @@ -556,6 +564,7 @@ function moveup(&$Model, $id = null, $number = 1) {
* delete, or the id of the parent to set as the parent_id
* @return boolean true on success, false on failure
* @access public
* @link http://book.cakephp.org/view/1628/Recover
*/
function recover(&$Model, $mode = 'parent', $missingParentAction = null) {
if (is_array($mode)) {
Expand Down Expand Up @@ -634,6 +643,8 @@ function recover(&$Model, $mode = 'parent', $missingParentAction = null) {
* @param AppModel $Model Model instance
* @param array $options array of options to use in reordering.
* @return boolean true on success, false on failure
* @link http://book.cakephp.org/view/1355/reorder
* @link http://book.cakephp.org/view/1629/Reorder
*/
function reorder(&$Model, $options = array()) {
$options = array_merge(array('id' => null, 'field' => $Model->displayField, 'order' => 'ASC', 'verify' => true), $options);
Expand Down Expand Up @@ -673,6 +684,7 @@ function reorder(&$Model, $options = array()) {
* @param boolean $delete whether to delete the node after reparenting children (if any)
* @return boolean true on success, false on failure
* @access public
* @link http://book.cakephp.org/view/1354/removeFromTree
*/
function removefromtree(&$Model, $id = null, $delete = false) {
if (is_array($id)) {
Expand Down Expand Up @@ -741,6 +753,7 @@ function removefromtree(&$Model, $id = null, $delete = false) {
* @return mixed true if the tree is valid or empty, otherwise an array of (error type [index, node],
* [incorrect left/right index,node id], message)
* @access public
* @link http://book.cakephp.org/view/1630/Verify
*/
function verify(&$Model) {
extract($this->settings[$Model->alias]);
Expand Down
2 changes: 1 addition & 1 deletion cake/libs/model/model.php
Expand Up @@ -41,7 +41,7 @@
*
* @package cake
* @subpackage cake.cake.libs.model
* @link http://book.cakephp.org/view/66/Models
* @link http://book.cakephp.org/view/1000/Models
*/
class Model extends Overloadable {

Expand Down

0 comments on commit 9f601ea

Please sign in to comment.