From 45c14238add012729c01f3196076e33965e365a9 Mon Sep 17 00:00:00 2001
From: brettp <brettp@36083f99-b078-4883-b0ff-0f9b5a30f544>
Date: Mon, 20 Sep 2010 21:07:18 +0000
Subject: Refs #2450: Documented first bit of the classes.

git-svn-id: http://code.elgg.org/elgg/trunk@6952 36083f99-b078-4883-b0ff-0f9b5a30f544
---
 engine/classes/AccessControlQueryComponent.php | 21 ++++++++++-----------
 1 file changed, 10 insertions(+), 11 deletions(-)

(limited to 'engine/classes/AccessControlQueryComponent.php')

diff --git a/engine/classes/AccessControlQueryComponent.php b/engine/classes/AccessControlQueryComponent.php
index ad5410ddc..7808800bc 100644
--- a/engine/classes/AccessControlQueryComponent.php
+++ b/engine/classes/AccessControlQueryComponent.php
@@ -1,12 +1,13 @@
 <?php
 /**
- * @class AccessControlQueryComponent
- * Access control component.
- * @author Curverider Ltd
- * @see Query
+ * The access control component of the query class.
+ *
+ * @todo probably remove.
+ * @access private
+ * @package Elgg.Core
+ * @subpackage Unimplemented
  */
-class AccessControlQueryComponent extends QueryComponent
-{
+class AccessControlQueryComponent extends QueryComponent {
 	/**
 	 * Construct the ACL.
 	 *
@@ -15,8 +16,7 @@ class AccessControlQueryComponent extends QueryComponent
 	 * @param string $object_owner_table The table containing the owner information for the stuff you're retrieving.
 	 * @param string $object_owner_id_field The field in $object_owner_table containing the owner information
 	 */
-	function __construct($acl_table = "entities", $acl_field = "access_id", $object_owner_table = "entities", $object_owner_id_field = "owner_guid")
-	{
+	function __construct($acl_table = "entities", $acl_field = "access_id", $object_owner_table = "entities", $object_owner_id_field = "owner_guid") {
 		global $CONFIG;
 
 		$this->acl_table = $CONFIG->dbprefix . sanitise_string($acl_table);
@@ -25,8 +25,7 @@ class AccessControlQueryComponent extends QueryComponent
 		$this->object_owner_id_field = sanitise_string($object_owner_id_field);
 	}
 
-	function __toString()
-	{
+	function __toString() {
 		//$access = get_access_list();
 		// KJ - changed to use get_access_sql_suffix
 		// Note: currently get_access_sql_suffix is hardwired to use
@@ -37,4 +36,4 @@ class AccessControlQueryComponent extends QueryComponent
 
 		//return "and ({$this->acl_table}.{$this->acl_field} in {$access} or ({$this->acl_table}.{$this->acl_field} = 0 and {$this->object_owner_table}.{$this->object_owner_id_field} = {$_SESSION['id']}))";
 	}
-}
+}
\ No newline at end of file
-- 
cgit v1.2.3