Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Adding additional documentation for CrudAuthorize.

Fixes #2034
  • Loading branch information...
commit 9e080951b1a91fc4decd106a8a6c2dbcd1e0b373 1 parent 864cb70
@markstory markstory authored
View
20 lib/Cake/Controller/Component/Auth/BaseAuthorize.php
@@ -116,10 +116,28 @@ public function action($request, $path = '/:plugin/:controller/:action') {
}
/**
- * Maps crud actions to actual controller names. Used to modify or get the current mapped actions.
+ * Maps crud actions to actual action names. Used to modify or get the current mapped actions.
+ *
+ * Create additional mappings for a standard CRUD operation:
+ *
+ * {{{
+ * $this->Auth->mapActions(array('create' => array('add', 'register'));
+ * }}}
+ *
+ * Create mappings for custom CRUD operations:
+ *
+ * {{{
+ * $this->Auth->mapActions(array('my_action' => 'admin'));
+ * }}}
+ *
+ * You can use the custom CRUD operations to create additional generic permissions
+ * that behave like CRUD operations. Doing this will require additional columns on the
+ * permissions lookup. When using with DbAcl, you'll have to add additional _admin type columns
+ * to the `aros_acos` table.
*
* @param mixed $map Either an array of mappings, or undefined to get current values.
* @return mixed Either the current mappings or null when setting.
+ * @see AuthComponent::mapActions()
*/
public function mapActions($map = array()) {
if (empty($map)) {
View
2  lib/Cake/Controller/Component/AuthComponent.php
@@ -477,7 +477,7 @@ public function deny($action = null) {
*
* @param array $map Actions to map
* @return void
- * @link http://book.cakephp.org/view/1260/mapActions
+ * @see BaseAuthorize::mapActions()
*/
public function mapActions($map = array()) {
if (empty($this->_authorizeObjects)) {
Please sign in to comment.
Something went wrong with that request. Please try again.