Browse Source

Merge pull request #2928 from h4ck3rm1k3/master

adding in simple doc for db_acl
Mark Story 12 years ago
parent
commit
e89081a3ce
1 changed files with 10 additions and 0 deletions
  1. 10 0
      app/Config/Schema/db_acl.php

+ 10 - 0
app/Config/Schema/db_acl.php

@@ -33,6 +33,9 @@ class DbAclSchema extends CakeSchema {
 	public function after($event = array()) {
 	}
 
+/**
+ * ACO - Access Control Object - Something that is wanted
+ */
 	public $acos = array(
 		'id' => array('type' => 'integer', 'null' => false, 'default' => null, 'length' => 10, 'key' => 'primary'),
 		'parent_id' => array('type' => 'integer', 'null' => true, 'default' => null, 'length' => 10),
@@ -44,6 +47,9 @@ class DbAclSchema extends CakeSchema {
 		'indexes' => array('PRIMARY' => array('column' => 'id', 'unique' => 1))
 	);
 
+/**
+ * ARO - Access Request Object - Something that wants something
+ */
 	public $aros = array(
 		'id' => array('type' => 'integer', 'null' => false, 'default' => null, 'length' => 10, 'key' => 'primary'),
 		'parent_id' => array('type' => 'integer', 'null' => true, 'default' => null, 'length' => 10),
@@ -55,6 +61,10 @@ class DbAclSchema extends CakeSchema {
 		'indexes' => array('PRIMARY' => array('column' => 'id', 'unique' => 1))
 	);
 
+/**
+ * Used by the Cake::Model:Permission class.
+ * Checks if the given $aro has access to action $action in $aco.
+ */
 	public $aros_acos = array(
 		'id' => array('type' => 'integer', 'null' => false, 'default' => null, 'length' => 10, 'key' => 'primary'),
 		'aro_id' => array('type' => 'integer', 'null' => false, 'length' => 10, 'key' => 'index'),