Permalink
Browse files

Adding @link tags pointing to cookbook sections

Signed-off-by: Mark Story <mark@mark-story.com>
  • Loading branch information...
1 parent 91332fc commit dde52399cad6fd123ca49a138d3b81123d331f54 @sdoney sdoney committed with markstory Apr 5, 2010
@@ -29,6 +29,7 @@
*
* @package cake
* @subpackage cake.cake.libs.controller.components
+ * @link http://book.cakephp.org/view/1242/Access-Control-Lists
*/
class AclComponent extends Object {
@@ -257,6 +258,7 @@ function initialize(&$component) {
* @param string $action Action (defaults to *)
* @return boolean Success (true if ARO has access to action in ACO, false otherwise)
* @access public
+ * @link http://book.cakephp.org/view/1249/Checking-Permissions-The-ACL-Component
*/
function check($aro, $aco, $action = "*") {
if ($aro == null || $aco == null) {
@@ -348,6 +350,7 @@ function check($aro, $aco, $action = "*") {
* @param integer $value Value to indicate access type (1 to give access, -1 to deny, 0 to inherit)
* @return boolean Success
* @access public
+ * @link http://book.cakephp.org/view/1248/Assigning-Permissions
*/
function allow($aro, $aco, $actions = "*", $value = 1) {
$perms = $this->getAclLink($aro, $aco);
@@ -399,6 +402,7 @@ function allow($aro, $aco, $actions = "*", $value = 1) {
* @param string $actions Action (defaults to *)
* @return boolean Success
* @access public
+ * @link http://book.cakephp.org/view/1248/Assigning-Permissions
*/
function deny($aro, $aco, $action = "*") {
return $this->allow($aro, $aco, $action, -1);
@@ -29,6 +29,7 @@
*
* @package cake
* @subpackage cake.cake.libs.controller.components
+ * @link http://book.cakephp.org/view/1250/Authentication
*/
class AuthComponent extends Object {
@@ -53,6 +54,7 @@ class AuthComponent extends Object {
*
* @var object
* @access public
+ * @link http://book.cakephp.org/view/1278/authenticate
*/
var $authenticate = null;
@@ -66,6 +68,7 @@ class AuthComponent extends Object {
*
* @var mixed
* @access public
+ * @link http://book.cakephp.org/view/1275/authorize
*/
var $authorize = false;
@@ -75,6 +78,7 @@ class AuthComponent extends Object {
*
* @var string
* @access public
+ * @link http://book.cakephp.org/view/1277/ajaxLogin
*/
var $ajaxLogin = null;
@@ -91,6 +95,7 @@ class AuthComponent extends Object {
*
* @var string
* @access public
+ * @link http://book.cakephp.org/view/1266/userModel
*/
var $userModel = 'User';
@@ -100,6 +105,7 @@ class AuthComponent extends Object {
*
* @var array
* @access public
+ * @link http://book.cakephp.org/view/1268/userScope
*/
var $userScope = array();
@@ -109,6 +115,7 @@ class AuthComponent extends Object {
*
* @var array
* @access public
+ * @link http://book.cakephp.org/view/1267/fields
*/
var $fields = array('username' => 'username', 'password' => 'password');
@@ -118,6 +125,7 @@ class AuthComponent extends Object {
*
* @var string
* @access public
+ * @link http://book.cakephp.org/view/1276/sessionKey
*/
var $sessionKey = null;
@@ -129,6 +137,7 @@ class AuthComponent extends Object {
*
* @var string
* @access public
+ * @link http://book.cakephp.org/view/1279/actionPath
*/
var $actionPath = null;
@@ -138,6 +147,7 @@ class AuthComponent extends Object {
*
* @var mixed
* @access public
+ * @link http://book.cakephp.org/view/1269/loginAction
*/
var $loginAction = null;
@@ -149,6 +159,7 @@ class AuthComponent extends Object {
*
* @var mixed
* @access public
+ * @link http://book.cakephp.org/view/1270/loginRedirect
*/
var $loginRedirect = null;
@@ -161,6 +172,7 @@ class AuthComponent extends Object {
* @access public
* @see AuthComponent::$loginAction
* @see AuthComponent::logout()
+ * @link http://book.cakephp.org/view/1271/logoutRedirect
*/
var $logoutRedirect = null;
@@ -178,6 +190,7 @@ class AuthComponent extends Object {
*
* @var string
* @access public
+ * @link http://book.cakephp.org/view/1272/loginError
*/
var $loginError = null;
@@ -187,6 +200,7 @@ class AuthComponent extends Object {
*
* @var string
* @access public
+ * @link http://book.cakephp.org/view/1273/authError
*/
var $authError = null;
@@ -195,6 +209,7 @@ class AuthComponent extends Object {
*
* @var boolean
* @access public
+ * @link http://book.cakephp.org/view/1274/autoRedirect
*/
var $autoRedirect = true;
@@ -204,6 +219,7 @@ class AuthComponent extends Object {
* @var array
* @access public
* @see AuthComponent::allow()
+ * @link http://book.cakephp.org/view/1251/Setting-Auth-Component-Variables
*/
var $allowedActions = array();
@@ -590,6 +606,7 @@ function __authType($auth = null) {
* @param string ... etc.
* @return void
* @access public
+ * @link http://book.cakephp.org/view/1257/allow
*/
function allow() {
$args = func_get_args();
@@ -612,6 +629,7 @@ function allow() {
* @return void
* @see AuthComponent::allow()
* @access public
+ * @link http://book.cakephp.org/view/1258/deny
*/
function deny() {
$args = func_get_args();
@@ -633,6 +651,7 @@ function deny() {
* @param array $map Actions to map
* @return void
* @access public
+ * @link http://book.cakephp.org/view/1260/mapActions
*/
function mapActions($map = array()) {
$crud = array('create', 'read', 'update', 'delete');
@@ -658,6 +677,7 @@ function mapActions($map = array()) {
* @param mixed $data User object
* @return boolean True on login success, false on failure
* @access public
+ * @link http://book.cakephp.org/view/1261/login
*/
function login($data = null) {
$this->__setDefaults();
@@ -681,6 +701,7 @@ function login($data = null) {
* @return string AuthComponent::$loginAction
* @see AuthComponent::$loginAction
* @access public
+ * @link http://book.cakephp.org/view/1262/logout
*/
function logout() {
$this->__setDefaults();
@@ -696,6 +717,7 @@ function logout() {
* @param string $key field to retrive. Leave null to get entire User record
* @return mixed User record. or null if no user is logged in.
* @access public
+ * @link http://book.cakephp.org/view/1264/user
*/
function user($key = null) {
$this->__setDefaults();
@@ -770,6 +792,7 @@ function validate($object, $user = null, $action = null) {
* none is specified.
* @return boolean ACO node path
* @access public
+ * @link http://book.cakephp.org/view/1256/action
*/
function action($action = ':plugin/:controller/:action') {
$plugin = empty($this->params['plugin']) ? null : Inflector::camelize($this->params['plugin']) . '/';
@@ -892,6 +915,7 @@ function identify($user = null, $conditions = null) {
* @param array $data Set of data to look for passwords
* @return array Data with passwords hashed
* @access public
+ * @link http://book.cakephp.org/view/1259/hashPasswords
*/
function hashPasswords($data) {
if (is_object($this->authenticate) && method_exists($this->authenticate, 'hashPasswords')) {
@@ -913,6 +937,7 @@ function hashPasswords($data) {
* @param string $password Password to hash
* @return string Hashed password
* @access public
+ * @link http://book.cakephp.org/view/1263/password
*/
function password($password) {
return Security::hash($password, null, true);
@@ -30,6 +30,7 @@
*
* @package cake
* @subpackage cake.cake.libs.controller.components
+ * @link http://book.cakephp.org/view/1280/Cookies
*
*/
class CookieComponent extends Object {
@@ -27,6 +27,7 @@
*
* @package cake
* @subpackage cake.cake.libs.controller.components
+ * @link http://book.cakephp.org/view/1283/Email
*
*/
class EmailComponent extends Object{
@@ -225,6 +226,7 @@ class EmailComponent extends Object{
*
* @var array
* @access public
+ * @link http://book.cakephp.org/view/1290/Sending-A-Message-Using-SMTP
*/
var $smtpOptions = array(
'port'=> 25, 'host' => 'localhost', 'timeout' => 30
@@ -390,6 +392,7 @@ function send($content = null, $template = null, $layout = null) {
* Reset all EmailComponent internal variables to be able to send out a new email.
*
* @access public
+ * @link http://book.cakephp.org/view/1285/Sending-Multiple-Emails-in-a-loop
*/
function reset() {
$this->template = null;
@@ -25,6 +25,7 @@
*
* @package cake
* @subpackage cake.cake.libs.controller.components
+ * @link http://book.cakephp.org/view/1291/Request-Handling
*
*/
class RequestHandlerComponent extends Object {
@@ -23,6 +23,7 @@
*
* @package cake
* @subpackage cake.cake.libs.controller.components
+ * @link http://book.cakephp.org/view/1296/Security-Component
*/
class SecurityComponent extends Object {
@@ -215,6 +216,7 @@ function startup(&$controller) {
*
* @return void
* @access public
+ * @link http://book.cakephp.org/view/1299/requirePost
*/
function requirePost() {
$args = func_get_args();
@@ -259,6 +261,7 @@ function requireDelete() {
*
* @return void
* @access public
+ * @link http://book.cakephp.org/view/1300/requireSecure
*/
function requireSecure() {
$args = func_get_args();
@@ -270,6 +273,7 @@ function requireSecure() {
*
* @return void
* @access public
+ * @link http://book.cakephp.org/view/1301/requireAuth
*/
function requireAuth() {
$args = func_get_args();
@@ -281,6 +285,7 @@ function requireAuth() {
*
* @return void
* @access public
+ * @link http://book.cakephp.org/view/1302/requireLogin
*/
function requireLogin() {
$args = func_get_args();
@@ -306,6 +311,7 @@ function requireLogin() {
* @param string $type Either 'basic', 'digest', or null. If null/empty, will try both.
* @return mixed If successful, returns an array with login name and password, otherwise null.
* @access public
+ * @link http://book.cakephp.org/view/1303/loginCredentials-string-type
*/
function loginCredentials($type = null) {
switch (strtolower($type)) {
@@ -345,6 +351,7 @@ function loginCredentials($type = null) {
* @param array $options Set of options for header
* @return string HTTP-authentication request header
* @access public
+ * @link http://book.cakephp.org/view/1304/loginRequest-array-options
*/
function loginRequest($options = array()) {
$options = array_merge($this->loginOptions, $options);
@@ -367,6 +374,7 @@ function loginRequest($options = array()) {
* @param string $digest Digest authentication response
* @return array Digest authentication parameters
* @access public
+ * @link http://book.cakephp.org/view/1305/parseDigestAuthData-string-digest
*/
function parseDigestAuthData($digest) {
if (substr($digest, 0, 7) == 'Digest ') {
@@ -395,6 +403,7 @@ function parseDigestAuthData($digest) {
* @return string Digest authentication hash
* @access public
* @see SecurityComponent::parseDigestAuthData()
+ * @link http://book.cakephp.org/view/1306/generateDigestResponseHash-array-data
*/
function generateDigestResponseHash($data) {
return md5(
@@ -413,6 +422,7 @@ function generateDigestResponseHash($data) {
* @return mixed If specified, controller blackHoleCallback's response, or no return otherwise
* @access public
* @see SecurityComponent::$blackHoleCallback
+ * @link http://book.cakephp.org/view/1307/blackHole-object-controller-string-error
*/
function blackHole(&$controller, $error = '') {
if ($this->blackHoleCallback == null) {
Oops, something went wrong.

0 comments on commit dde5239

Please sign in to comment.