Added new folderItem functions. Fixed up the Role and Permission Allocation func…

…tionality and unit tests. Committed by: Megan Watson Reviewed by: Kevin Cyster git-svn-id: https://kt-dms.svn.sourceforge.net/svnroot/kt-dms/trunk@9741 c91229c3-7414-0410-bfa2-8a42b809f60b

Added new folderItem functions. Fixed up the Role and Permission Allocation func…
…tionality and unit tests. Committed by: Megan Watson Reviewed by: Kevin Cyster git-svn-id: https://kt-dms.svn.sourceforge.net/svnroot/kt-dms/trunk@9741 c91229c3-7414-0410-bfa2-8a42b809f60b
Megan Watson
1 parent bb22bafd
Showing 7 changed files with 342 additions and 102 deletions
ktapi/KTAPIAcl.inc.php
ktapi/KTAPIDocument.inc.php
ktapi/KTAPIFolder.inc.php
ktapi/ktapi.inc.php
tests/api/testAcl.php
tests/api/testDocument.php
tests/api/testFolder.php
@@ -56,6 +56,7 @@ abstract class KTAPI_Dynamic
 	/**
 	 * Generic getter method
 	 *
+     * @author KnowledgeTree Team
 	 * @access protected
 	 * @param string $property
 	 * @return mixed
@@ -70,15 +71,16 @@ abstract class KTAPI_Dynamic
         }
         throw new Exception('Unknown method ' . get_class($this) . '.' . $method);
     }
-    
+
 	/**
 	 * Generic setter method
-	 * 
+	 *
+     * @author KnowledgeTree Team
 	 * @access protected
 	 * @param string $property
 	 * @param mixed $value
 	 */
-    
+
     protected
     function __set($property, $value)
     {
@@ -137,7 +139,9 @@ class KTAPI_User extends KTAPI_Member
     /**
      * Using the id, the user can be resolved.
      *
-     * @static 
+     * @author KnowledgeTree Team
+     * @access public
+     * @static
      * @param int $id
      * @return KTAPI_User Returns null if  there is no match.
      */
@@ -158,6 +162,8 @@ class KTAPI_User extends KTAPI_Member
     /**
      * Using the full name, the user can be resolved.
      *
+     * @author KnowledgeTree Team
+     * @access public
      * @static
      * @param string $name
      * @return KTAPI_User Returns null if  there is no match.
@@ -179,6 +185,8 @@ class KTAPI_User extends KTAPI_Member
     /**
      * Using the username, the user is resolved.
      *
+     * @author KnowledgeTree Team
+     * @access public
      * @static
      * @param string $username
      * @return KTAPI_User  Returns null if  there is no match.
@@ -199,6 +207,8 @@ class KTAPI_User extends KTAPI_Member
     /**
      * Using the email, the user is resolved.
      *
+     * @author KnowledgeTree Team
+     * @access public
      * @static
      * @param string $email
      * @return KTAPI_User  Returns null if  there is no match.
@@ -220,6 +230,8 @@ class KTAPI_User extends KTAPI_Member
     /**
      * Returns a list of users matching the filter criteria.
      *
+     * @author KnowledgeTree Team
+     * @access public
      * @static
      * @param string $filter
      * @param array $options
@@ -245,15 +257,19 @@ class KTAPI_User extends KTAPI_Member
     }
     /**
-     * Return username property. (readonly)
+     * Return id property. (readonly)
      *
-     * @return string
+     * @author KnowledgeTree Team
+     * @access public
+     * @return integer
      */
     public function getId() { return $this->user->getId(); }
     /**
      * Return username property. (readonly)
      *
+     * @author KnowledgeTree Team
+     * @access public
      * @return string
      */
     public function getUsername() { return $this->user->getUserName(); }
@@ -261,6 +277,8 @@ class KTAPI_User extends KTAPI_Member
     /**
      * Return display name property. (readonly)
      *
+     * @author KnowledgeTree Team
+     * @access public
      * @return string
      */
     public function getName() { return $this->user->getName(); }
@@ -268,6 +286,8 @@ class KTAPI_User extends KTAPI_Member
     /**
      * Return email property. (readonly)
      *
+     * @author KnowledgeTree Team
+     * @access public
      * @return string
      */
     public function getEmail() { return $this->user->getEmail(); }
@@ -294,6 +314,7 @@ class KTAPI_Group extends KTAPI_Member
     /**
      * Constructor for KTAPI_Group. This is private, and can only be constructed by the static getByXXX() functions.
      *
+     * @author KnowledgeTree Team
      * @access private
      * @param Group $group
      */
@@ -306,6 +327,8 @@ class KTAPI_Group extends KTAPI_Member
     /**
      * Using the id, the group can be resolved.
      *
+     * @author KnowledgeTree Team
+     * @access public
      * @static
      * @param int $id
      * @return KTAPI_Group Returns null if  there is no match.
@@ -327,6 +350,8 @@ class KTAPI_Group extends KTAPI_Member
     /**
      * Using the name, the group can be resolved.
      *
+     * @author KnowledgeTree Team
+     * @access public
      * @static
      * @param string $name
      * @return KTAPI_Group Returns null if  there is no match.
@@ -347,6 +372,8 @@ class KTAPI_Group extends KTAPI_Member
     /**
      * Returns a list of groups matching the filter criteria.
      *
+     * @author KnowledgeTree Team
+     * @access public
      * @static
      * @param string $filter
      * @param array $options
@@ -374,6 +401,8 @@ class KTAPI_Group extends KTAPI_Member
     /**
      * Return username property. (readonly)
      *
+     * @author KnowledgeTree Team
+     * @access public
      * @return string
      */
     public function getId() { return $this->group->getId(); }
@@ -381,6 +410,8 @@ class KTAPI_Group extends KTAPI_Member
     /**
      * Return display name property. (readonly)
      *
+     * @author KnowledgeTree Team
+     * @access public
      * @return string
      */
     public function getName() { return $this->group->getName(); }
@@ -388,6 +419,8 @@ class KTAPI_Group extends KTAPI_Member
     /**
      * Indicates if the group members are system administrators. (readonly)
      *
+     * @author KnowledgeTree Team
+     * @access public
      * @return boolean
      */
     public function getIsSystemAdministrator() { return $this->group->getSysAdmin(); }
@@ -414,6 +447,7 @@ class KTAPI_Role extends KTAPI_Member
     /**
      * Constructor for KTAPI_Group. This is private, and can only be constructed by the static getByXXX() functions.
      *
+     * @author KnowledgeTree Team
      * @access private
      * @param Role $role
      */
@@ -426,6 +460,8 @@ class KTAPI_Role extends KTAPI_Member
     /**
      * Using the id, the role can be resolved.
      *
+     * @author KnowledgeTree Team
+     * @access public
      * @static
      * @param int $id
      * @return KTAPI_Role Returns null if  there is no match.
@@ -445,6 +481,8 @@ class KTAPI_Role extends KTAPI_Member
     /**
      * Using the name, the role can be resolved.
      *
+     * @author KnowledgeTree Team
+     * @access public
      * @static
      * @param string $name
      * @return KTAPI_Role Returns null if  there is no match.
@@ -467,6 +505,8 @@ class KTAPI_Role extends KTAPI_Member
     /**
      * Returns a list of roles matching the filter criteria.
      *
+     * @author KnowledgeTree Team
+     * @access public
      * @static
      * @param string $filter
      * @param array $options
@@ -494,6 +534,8 @@ class KTAPI_Role extends KTAPI_Member
     /**
      * Return id property. (readonly)
      *
+     * @author KnowledgeTree Team
+     * @access public
      * @return string
      */
     public function getId() { return $this->role->getId(); }
@@ -501,6 +543,8 @@ class KTAPI_Role extends KTAPI_Member
     /**
      * Return display name property. (readonly)
      *
+     * @author KnowledgeTree Team
+     * @access public
      * @return string
      */
     public function getName() { return $this->role->getName(); }
@@ -529,6 +573,7 @@ class KTAPI_Permission extends KTAPI_Dynamic
     /**
      * Constructor for KTAPI_Permission. This is private, and can only be constructed by the static getByXXX() functions.
      *
+     * @author KnowledgeTree Team
      * @access private
      * @param KTPermission $permission
      */
@@ -541,6 +586,8 @@ class KTAPI_Permission extends KTAPI_Dynamic
     /**
      * Return a list of permissions.
      *
+     * @author KnowledgeTree Team
+     * @access public
      * @static
      * @param string $filter
      * @param array $options
@@ -567,6 +614,8 @@ class KTAPI_Permission extends KTAPI_Dynamic
     /**
      * Returns a KTAPI_Permission based on id.
      *
+     * @author KnowledgeTree Team
+     * @access public
      * @static
      * @param int $id
      * @return KTAPI_Permission Returns null if the namespace could not be resolved.
@@ -587,6 +636,8 @@ class KTAPI_Permission extends KTAPI_Dynamic
     /**
      * Returns a KTAPI_Permission based on namespace.
      *
+     * @author KnowledgeTree Team
+     * @access public
      * @static
      * @param string $namespace
      * @return KTAPI_Permission Returns null if the namespace could not be resolved.
@@ -607,6 +658,8 @@ class KTAPI_Permission extends KTAPI_Dynamic
     /**
      * Returns the permission id.
      *
+     * @author KnowledgeTree Team
+     * @access public
      * @return int
      */
     public
@@ -615,6 +668,8 @@ class KTAPI_Permission extends KTAPI_Dynamic
     /**
      * Returns the permission name.
      *
+     * @author KnowledgeTree Team
+     * @access public
      * @return string
      */
     public
@@ -623,6 +678,8 @@ class KTAPI_Permission extends KTAPI_Dynamic
     /**
      * Returns the permission namespace.
      *
+     * @author KnowledgeTree Team
+     * @access public
      * @return string
      */
     public
@@ -630,7 +687,7 @@ class KTAPI_Permission extends KTAPI_Dynamic
 }
 /**
- * AllocationBase.
+ * Allocation Base class
  *
  * @author KnowledgeTree Team
  * @package KTAPI
@@ -672,6 +729,8 @@ abstract class KTAPI_AllocationBase extends KTAPI_Dynamic
     /**
+     * Instance of the KTAPI object
+     *
      * @access protected
      * @var KTAPI
      */
@@ -680,6 +739,7 @@ abstract class KTAPI_AllocationBase extends KTAPI_Dynamic
     /**
      * Constructor for KTAPI_Permission. This is protected, and can only be constructed by the static getAllocation() function.
      *
+     * @author KnowledgeTree Team
      * @access protected
      * @param KTAPI_FolderItem $folderItem
      */
@@ -695,6 +755,7 @@ abstract class KTAPI_AllocationBase extends KTAPI_Dynamic
     /**
      * Helper method to identify the member type for the map.
      *
+     * @author KnowledgeTree Team
      * @access protected
      * @param KTAPI_Member $member
      * @return string
@@ -707,7 +768,7 @@ abstract class KTAPI_AllocationBase extends KTAPI_Dynamic
         {
             case 'KTAPI_User': $type = 'user'; break;
             case 'KTAPI_Group': $type = 'group'; break;
-            case 'KTAPI_Route': $type = 'route'; break;
+            case 'KTAPI_Role': $type = 'role'; break;
             default:
                 throw new Exception('Unknown type: ' . $type);
         }
@@ -717,6 +778,7 @@ abstract class KTAPI_AllocationBase extends KTAPI_Dynamic
     /**
      * Log the transaction for the current user.
      *
+     * @author KnowledgeTree Team
      * @access protected
      * @param string $comment
      * @param string $namespace
@@ -761,6 +823,8 @@ abstract class KTAPI_AllocationBase extends KTAPI_Dynamic
     /**
      * Restore working copy, voiding the add(), remove() changes.
      *
+     * @author KnowledgeTree Team
+     * @access public
      */
     public
     function restore()
@@ -792,7 +856,9 @@ final class KTAPI_PermissionAllocation extends KTAPI_AllocationBase
     /**
      * Returns the permission allocation for a specified folder item.
      *
-     * @static 
+     * @author KnowledgeTree Team
+     * @access public
+     * @static
      * @param KTAPI
      * @param KTAPI_FolderItem
      * @return KTAPI_PermissionAllocation
@@ -808,6 +874,8 @@ final class KTAPI_PermissionAllocation extends KTAPI_AllocationBase
     /**
      * Force the current folder item to inherit permission from the parent.
      *
+     * @author KnowledgeTree Team
+     * @access public
      */
     public
     function inheritAllocation()
@@ -822,6 +890,8 @@ final class KTAPI_PermissionAllocation extends KTAPI_AllocationBase
     /**
      * Creates a copy of the current permissions.
      *
+     * @author KnowledgeTree Team
+     * @access public
      */
     public
     function overrideAllocation()
@@ -834,6 +904,8 @@ final class KTAPI_PermissionAllocation extends KTAPI_AllocationBase
     /**
      * Gives permission to the specified member.
      *
+     * @author KnowledgeTree Team
+     * @access public
      * @param KTAPI_Member $member A KTAPI_Role, KTAPI_Group or KTAPI_User.
      * @param KTAPI_Permission $permission
      */
@@ -847,6 +919,8 @@ final class KTAPI_PermissionAllocation extends KTAPI_AllocationBase
      * Removes permission from the specified member.
      * NOTE: This only removes permission if it was already granted.
      *
+     * @author KnowledgeTree Team
+     * @access public
      * @param KTAPI_Member $member A KTAPI_Role, KTAPI_Group or KTAPI_User.
      * @param KTAPI_Permission $permission
      */
@@ -859,6 +933,7 @@ final class KTAPI_PermissionAllocation extends KTAPI_AllocationBase
     /**
      * Helper method to update the permission map for the current folder item.
      *
+     * @author KnowledgeTree Team
      * @access private
      * @param KTAPI_Member $member
      * @param KTAPI_Permission $permission
@@ -881,6 +956,7 @@ final class KTAPI_PermissionAllocation extends KTAPI_AllocationBase
     /**
      * Returns a list of members.
      *
+     * @author KnowledgeTree Team
      * @access private
      * @param string $type
      * @return array
@@ -894,6 +970,8 @@ final class KTAPI_PermissionAllocation extends KTAPI_AllocationBase
     /**
      * Return list of users for which there are allocations.
      *
+     * @author KnowledgeTree Team
+     * @access public
      * @return array
      */
     public
@@ -905,6 +983,8 @@ final class KTAPI_PermissionAllocation extends KTAPI_AllocationBase
     /**
      * Return list of groups for which there are allocations.
      *
+     * @author KnowledgeTree Team
+     * @access public
      * @return array
      */
     public
@@ -916,6 +996,8 @@ final class KTAPI_PermissionAllocation extends KTAPI_AllocationBase
     /**
      * Return list of members for which there are allocations.
      *
+     * @author KnowledgeTree Team
+     * @access public
      * @return array
      */
     public
@@ -927,6 +1009,8 @@ final class KTAPI_PermissionAllocation extends KTAPI_AllocationBase
     /**
      * Returns the map of permissions for the specific member.
      *
+     * @author KnowledgeTree Team
+     * @access public
      * @param KTAPI_Member $member
      * @return array
      */
@@ -941,6 +1025,8 @@ final class KTAPI_PermissionAllocation extends KTAPI_AllocationBase
     /**
      * Returns true if the permission is set for the specific member.
      *
+     * @author KnowledgeTree Team
+     * @access public
      * @param KTAPI_Member $member
      * @param KTAPI_Permission $permission
      * @return boolean
@@ -970,6 +1056,8 @@ final class KTAPI_PermissionAllocation extends KTAPI_AllocationBase
     /**
      * Returns the properties defined in the system.
      *
+     * @author KnowledgeTree Team
+     * @access public
      * @return array
      *
      */
@@ -982,6 +1070,8 @@ final class KTAPI_PermissionAllocation extends KTAPI_AllocationBase
     /**
      * Returns an associative array with permissions mapped onto users, groups and roles.
      *
+     * @author KnowledgeTree Team
+     * @access public
      * @access protected
      */
     protected
@@ -1097,13 +1187,13 @@ final class KTAPI_PermissionAllocation extends KTAPI_AllocationBase
         $inheritedId = $inherited->getId();
         $objectId = $object->getId();
-        $map['inherited'] = ($inheritedId === $objectId) && ($objectId != 1);
+        $map['inherited'] = ($inheritedId !== $objectId) && ($objectId != 1);
-        // only allow inheritance if not inherited, -and- folders is editable
+        // only allow inheritance of permissions from parent if not inherited, -and- folder is editable
         $map['inheritable'] = $editable && !$map['inherited'] && ($objectId != 1);
-        // only allow edit if the folder is editable.
-        $map['editable'] = $editable && $map['inherited'];
+        // only allow edit if the folder is editable and not inherited
+        $map['editable'] = $editable && !$map['inherited'];
         $this->map = $map;
         $this->mapCopy = $map;
@@ -1113,6 +1203,8 @@ final class KTAPI_PermissionAllocation extends KTAPI_AllocationBase
     /**
      * Saves changes made by add() and remove().
      *
+     * @author KnowledgeTree Team
+     * @access public
      */
     public
     function save()
@@ -1124,7 +1216,7 @@ final class KTAPI_PermissionAllocation extends KTAPI_AllocationBase
         }
         // if the current setup is inherited, then we must create a new copy to store the new associations.
-        if ($this->IsInherited)
+        if ($this->getIsInherited())
         {
             $this->overrideAllocation();
         }
@@ -1185,6 +1277,8 @@ final class KTAPI_PermissionAllocation extends KTAPI_AllocationBase
     /**
      * Indicates if any changes have been made.
      *
+     * @author KnowledgeTree Team
+     * @access public
      * @return boolean
      */
     public
@@ -1193,6 +1287,8 @@ final class KTAPI_PermissionAllocation extends KTAPI_AllocationBase
     /**
      * Indicates if the current folder item is allowed to inherit permissions from the parent.
      *
+     * @author KnowledgeTree Team
+     * @access public
      * @return boolean
      */
     public
@@ -1201,6 +1297,8 @@ final class KTAPI_PermissionAllocation extends KTAPI_AllocationBase
     /**
      * Indicates it the current folder item currently inherits the permissions from the parent.
      *
+     * @author KnowledgeTree Team
+     * @access public
      * @return boolean
      */
     public
@@ -1209,6 +1307,8 @@ final class KTAPI_PermissionAllocation extends KTAPI_AllocationBase
     /**
      * Indicates if the permissions are editable but the current user.
      *
+     * @author KnowledgeTree Team
+     * @access public
      * @return boolean
      */
     public
@@ -1226,7 +1326,10 @@ final class KTAPI_PermissionAllocation extends KTAPI_AllocationBase
 final class KTAPI_RoleAllocation extends KTAPI_AllocationBase
 {
 	/**
-	 * 
+	 * Resolve the folder item allocations
+	 *
+     * @author KnowledgeTree Team
+     * @access public
 	 * @access protected
 	 */
     protected
@@ -1293,7 +1396,9 @@ final class KTAPI_RoleAllocation extends KTAPI_AllocationBase
     /**
      * Returns a reference to the role alloction on a folder item.
      *
-     * @static 
+     * @author KnowledgeTree Team
+     * @access public
+     * @static
      * @param KTAPI $ktapi
      * @param KTAPI_FolderItem $folderItem
      * @return KTAPI_RoleAllocation
@@ -1308,7 +1413,9 @@ final class KTAPI_RoleAllocation extends KTAPI_AllocationBase
     /**
      * Return an array mapping the membership.
      *
-     * @static 
+     * @author KnowledgeTree Team
+     * @access public
+     * @static
      * @param string $filter
      * @param array $options
      * @return array of KTAPIMember
@@ -1322,6 +1429,8 @@ final class KTAPI_RoleAllocation extends KTAPI_AllocationBase
     /**
      * Link a member to a role on the current folder item.
      *
+     * @author KnowledgeTree Team
+     * @access public
      * @param KTAPI_Role $role Must be a KTAPIRole, or an array of roles.
      * @param KTAPI_Member $member A KTAPI_Group, KTAPI_User, array.
      */
@@ -1356,6 +1465,8 @@ final class KTAPI_RoleAllocation extends KTAPI_AllocationBase
     /**
      * Remove a member from a role on the current folder item.
      *
+     * @author KnowledgeTree Team
+     * @access public
      * @param KTAPI_Role $role Must be a KTAPIRole, or an array of roles.
      * @param KTAPI_Member $member A KTAPI_Group or KTAPI_User.
      */
@@ -1382,6 +1493,8 @@ final class KTAPI_RoleAllocation extends KTAPI_AllocationBase
     /**
      * Check's if a role has a specific member
      *
+     * @author KnowledgeTree Team
+     * @access public
      * @param KTAPI_Role $role
      * @param KTAPI_Member $member
      * @return boolean
@@ -1411,6 +1524,8 @@ final class KTAPI_RoleAllocation extends KTAPI_AllocationBase
     /**
      * Removes all members associated with roles on the current folder item.
      *
+     * @author KnowledgeTree Team
+     * @access public
      * @param KTAPI_Role $role Must be a KTAPI_Role, or an array of roles.
      * @param KTAPI_Member $member A KTAPI_Group or KTAPI_User.
      */
@@ -1436,8 +1551,10 @@ final class KTAPI_RoleAllocation extends KTAPI_AllocationBase
     }
     /**
-     * 
+     * Override the role allocation for each role
      *
+     * @author KnowledgeTree Team
+     * @access public
      */
     public
     function overrideAllocation()
@@ -1447,10 +1564,12 @@ final class KTAPI_RoleAllocation extends KTAPI_AllocationBase
             $this->overrideRoleAllocation(KTAPI_Role::getById($roleId));
         }
     }
-    
+
 	/**
 	 * Overrides a role allocation
 	 *
+     * @author KnowledgeTree Team
+     * @access public
 	 * @param KTAPI_Role $role
 	 */
     public
@@ -1497,12 +1616,15 @@ final class KTAPI_RoleAllocation extends KTAPI_AllocationBase
         // regenerate permissions
-		$this->renegeratePermissionsForRole($roleId);
+		$this->_regeneratePermissionsForRole($roleId);
+		return $roleAllocation;
     }
     /**
      * Force all roles to inherit role associations.
      *
+     * @author KnowledgeTree Team
+     * @access public
      */
     public
     function inheritAllocation()
@@ -1520,6 +1642,13 @@ final class KTAPI_RoleAllocation extends KTAPI_AllocationBase
         }
     }
+    /**
+     * Can the folder inherit allocations
+     *
+     * @author KnowledgeTree Team
+     * @access public
+     * @return unknown
+     */
     public
     function canInheritRoleAllocation()
     {
@@ -1532,6 +1661,8 @@ final class KTAPI_RoleAllocation extends KTAPI_AllocationBase
     /**
      * Inherit the role associations from the parent.
      *
+     * @author KnowledgeTree Team
+     * @access public
      * @param KTAPI_Role $role
      * @param boolean $log
      */
@@ -1565,19 +1696,21 @@ final class KTAPI_RoleAllocation extends KTAPI_AllocationBase
             return PEAR::raiseError(_kt('Could not inherit allocation from parent.'));
         }
-        $this->_renegeratePermissionsForRole($roleId);
+        $this->_regeneratePermissionsForRole($roleId);
     }
     /**
      * Regenerate permissions for a role.
      *
-     * Adapted from KTRoleAllocationPlugin::renegeratePermissionsForRole()
+     * Adapted from KTRoleAllocationPlugin::regeneratePermissionsForRole()
      *
+     * @author KnowledgeTree Team
+     * @access public
      * @access private
      * @param int $iRoleId
      */
     private
-	function _renegeratePermissionsForRole($iRoleId)
+	function _regeneratePermissionsForRole($iRoleId)
 	{
 	    $object = $this->folderItem->getObject();
@@ -1642,6 +1775,8 @@ final class KTAPI_RoleAllocation extends KTAPI_AllocationBase
 	/**
 	 * Save's the role allocation
 	 *
+     * @author KnowledgeTree Team
+     * @access public
 	 */
     public
     function save()
@@ -1692,4 +1827,4 @@ final class KTAPI_RoleAllocation extends KTAPI_AllocationBase
     }
 }
 -?>
+?>
 \ No newline at end of file
@@ -2257,6 +2257,30 @@ class KTAPI_Document extends KTAPI_FolderItem
 	}
 	/**
+	 * Get the role allocation for the document
+	 *
+	 * @return KTAPI_RoleAllocation Instance of the role allocation object
+	 */
+	public function getRoleAllocation()
+	{
+	    $allocation = KTAPI_RoleAllocation::getAllocation($this->ktapi, $this);
+
+	    return $allocation;
+	}
+
+	/**
+	 * Get the permission allocation for the document
+	 *
+	 * @return KTAPI_PermissionAllocation Instance of the permission allocation object
+	 */
+	public function getPermissionAllocation()
+	{
+	    $allocation = KTAPI_PermissionAllocation::getAllocation($this->ktapi, $this);
+
+	    return $allocation;
+	}
+
+	/**
 	 * Checks if the user is subscribed to the document
 	 *
 	 * @author KnowledgeTree Team
@@ -32,7 +32,7 @@
  * logo is not reasonably feasible for technical reasons, the Appropriate Legal Notices
  * must display the words "Powered by KnowledgeTree" and retain the original
  * copyright notice.
- * 
+ *
  * @copyright 2008-2009, KnowledgeTree Inc.
  * @license GNU General Public License version 3
  * @author KnowledgeTree Team
@@ -50,7 +50,7 @@ require_once(KT_DIR . &#39;/ktwebservice/KTUploadManager.inc.php&#39;);
  * @author KnowledgeTree Team
  * @package KTAPI
  * @version Version 0.9
- * 
+ *
 */
 class KTAPI_Folder extends KTAPI_FolderItem
 {
@@ -112,7 +112,7 @@ class KTAPI_Folder extends KTAPI_FolderItem
 	/**
 	 * Checks if the folder is a shortcut
-	 * 
+	 *
 	 * @author KnowledgeTree Team
 	 * @access public
 	 * @return boolean
@@ -124,7 +124,7 @@ class KTAPI_Folder extends KTAPI_FolderItem
 	/**
 	 * Retrieves the shortcuts linking to this folder
-	 * 
+	 *
 	 * @author KnowledgeTree Team
 	 * @access public
 	 * @return array
@@ -194,7 +194,7 @@ class KTAPI_Folder extends KTAPI_FolderItem
 	}
 	/**
 	 * This clears the global object cashe of the folder class.
-	 * 
+	 *
 	 * @author KnowledgeTree Team
 	 * @access public
 	 *
@@ -211,8 +211,8 @@ class KTAPI_Folder extends KTAPI_FolderItem
 	}
 	/**
-	 * 
-	 * 
+	 *
+	 *
 	 * @author KnowledgeTree Team
 	 * @access public
 	 * @return unknown
@@ -247,7 +247,7 @@ class KTAPI_Folder extends KTAPI_FolderItem
 	/**
 	 * This function will return a folder by it's name (not ID)
-	 * 
+	 *
 	 * @author KnowledgeTree Team
 	 * @access public
 	 * @param KTAPI $ktapi
@@ -303,7 +303,7 @@ class KTAPI_Folder extends KTAPI_FolderItem
 	/**
 	 * This will return the full path string of the current folder object
-	 * 
+	 *
 	 * @author KnowledgeTree Team
 	 * @access public
 	 * @return string
@@ -318,7 +318,7 @@ class KTAPI_Folder extends KTAPI_FolderItem
 	/**
 	 * This gets a document by filename or name.
-	 * 
+	 *
 	 * @author KnowledgeTree Team
 	 * @access private
 	 * @param string $documentname
@@ -409,7 +409,7 @@ class KTAPI_Folder extends KTAPI_FolderItem
 	/**
 	 * Gets a User class based on the user id
-	 * 
+	 *
 	 * @author KnowledgeTree Team
 	 * @param int $userid
 	 * @return User
@@ -431,7 +431,7 @@ class KTAPI_Folder extends KTAPI_FolderItem
 	/**
 	 * Get's a permission string for a folder eg: 'RW' or 'RWA'
-	 * 
+	 *
 	 * @author KnowledgeTree Team
 	 * @access public
 	 * @param Folder $folder
@@ -457,7 +457,7 @@ class KTAPI_Folder extends KTAPI_FolderItem
 	/**
 	 * Get's a folder listing, recursing to the given depth
-	 * 
+	 *
 	 * <code>
 	 * $root = $this->ktapi->get_root_folder();
 	 * $listing = $root->get_listing();
@@ -468,7 +468,7 @@ class KTAPI_Folder extends KTAPI_FolderItem
 	 *  }
 	 * }
 	 * </code>
-	 * 
+	 *
 	 * @author KnowledgeTree Team
 	 * @access public
 	 * @param int $depth
@@ -753,7 +753,7 @@ class KTAPI_Folder extends KTAPI_FolderItem
 	/**
 	 * This adds a shortcut to an existing document to the current folder
-	 * 
+	 *
 	 * @author KnowledgeTree Team
 	 * @access public
 	 * @param int $document_id The ID of the document to create a shortcut to
@@ -787,7 +787,7 @@ class KTAPI_Folder extends KTAPI_FolderItem
 	/**
 	 * This adds a shortcut pointing to an existing folder to the current folder
-	 * 
+	 *
 	 * @author KnowledgeTree Team
 	 * @access public
 	 * @param int $folder_id The ID of the folder to create a shortcut to
@@ -827,7 +827,7 @@ class KTAPI_Folder extends KTAPI_FolderItem
 	 * $folder = $kt->get_folder_by_name("My New folder");
 	 * $res = $folder->add_document("Test Document", "test.txt", "Default", $tmpfname);
 	 * </code>
-	 * 
+	 *
 	 * @author KnowledgeTree Team
 	 * @access public
 	 * @param string $title This is the title for the file in the repository.
@@ -905,7 +905,7 @@ class KTAPI_Folder extends KTAPI_FolderItem
 	 * $root->add_folder("My New folder");
 	 * ?>
 	 * </code>
-	 * 
+	 *
 	 * @author KnowledgeTree Team
 	 * @access public
 	 * @param string $foldername
@@ -944,7 +944,7 @@ class KTAPI_Folder extends KTAPI_FolderItem
 	 * $folder = $kt->get_folder_by_name("My New folder");
 	 * $folder->delete("It was getting old!");
 	 * </code>
-	 * 
+	 *
 	 * @author KnowledgeTree Team
 	 * @access public
 	 * @param string $reason
@@ -975,7 +975,7 @@ class KTAPI_Folder extends KTAPI_FolderItem
 	/**
 	 * This renames the folder
-	 * 
+	 *
 	 * @author KnowledgeTree Team
 	 * @access public
 	 * @param string $newname
@@ -1043,7 +1043,7 @@ class KTAPI_Folder extends KTAPI_FolderItem
 	 * $new_folder = $root->add_folder("New test folder");
 	 * $res = $folder->copy($new_folder, "Test copy");
 	 * </code>
-	 * 
+	 *
 	 * @author KnowledgeTree Team
 	 * @access public
 	 * @param KTAPI_Folder $ktapi_target_folder
@@ -1113,6 +1113,30 @@ class KTAPI_Folder extends KTAPI_FolderItem
 	}
 	/**
+	 * Get the role allocation for the folder
+	 *
+	 * @return KTAPI_RoleAllocation Instance of the role allocation object
+	 */
+	public function getRoleAllocation()
+	{
+	    $allocation = KTAPI_RoleAllocation::getAllocation($this->ktapi, $this);
+
+	    return $allocation;
+	}
+
+	/**
+	 * Get the permission allocation for the folder
+	 *
+	 * @return KTAPI_PermissionAllocation Instance of the permission allocation object
+	 */
+	public function getPermissionAllocation()
+	{
+	    $allocation = KTAPI_PermissionAllocation::getAllocation($this->ktapi, $this);
+
+	    return $allocation;
+	}
+
+	/**
 	 * Determines whether the currently logged on user is subscribed
 	 *
 	 * @author KnowledgeTree Team
@@ -1129,10 +1153,10 @@ class KTAPI_Folder extends KTAPI_FolderItem
 	}
 	/**
-	 * 
+	 *
 	 * @author KnowledgeTree Team
 	 * @access public
-	 * 
+	 *
 	 */
 	public function unsubscribe()
 	{
@@ -1154,7 +1178,7 @@ class KTAPI_Folder extends KTAPI_FolderItem
 	 *
 	 * @author KnowledgeTree Team
 	 * @access public
-	 * 
+	 *
 	 */
 	public function subscribe()
 	{
@@ -96,6 +96,10 @@ abstract class KTAPI_FolderItem
 	public abstract function getObject();
+	public abstract function getRoleAllocation();
+
+	public abstract function getPermissionAllocation();
+
 	public abstract function isSubscribed();
 	public abstract function unsubscribe();
 <?php
-require_once (KTAPI_TEST_DIR . '/test.php');
+require_once (KT_DIR . '/tests/test.php');
 require_once (KT_DIR . '/ktapi/ktapi.inc.php');
 class APIAclTestCase extends KTUnitTestCase {
@@ -123,8 +123,10 @@ class APIAclTestCase extends KTUnitTestCase {
     function testRoleAllocation()
     {
         $root = $this->ktapi->get_root_folder();
-        $folder = $this->ktapi->get_folder_by_name('/test123');
-
+        $folder = $this->ktapi->get_folder_by_name('test123');
+        if(!$folder instanceof KTAPI_Folder){
+            $folder = $root->add_folder('test123');
+        }
         $allocation = KTAPI_RoleAllocation::getAllocation($this->ktapi, $folder);
         $role2 = KTAPI_Role::getByName('Reviewer');
@@ -133,27 +135,27 @@ class APIAclTestCase extends KTUnitTestCase {
         $user2 = KTAPI_User::getByUsername('anonymous');
         $group = KTAPI_Group::getByName('System Administrators');
-//        $this->assertFalse($allocation->doesRoleHaveMember($role, $user));
-//        $this->assertTrue($allocation->doesRoleHaveMember($role2, $user));
-
-
+        $this->assertFalse($allocation->doesRoleHaveMember($role, $user));
+        $this->assertFalse($allocation->doesRoleHaveMember($role2, $user));
+        // Add Admin user to Reviewer role
         $allocation->add($role2, $user);
+        // Add Admin user to Publisher role
         $allocation->add($role, $user);
+        // Add Sys admin group to Publisher role
         $allocation->add($role, $group);
+        // Add Anonymous to Publisher role - duplicate to test
+        $allocation->add($role, $user2);
+        $allocation->add($role, $user2);
         $allocation->save();
-/*        $allocation->add($role, $user2);
-        $allocation->add($role, $user2); // yup. this is a dup. just to test.
-        $allocation->add($role, $group);
         $this->assertTrue($allocation->doesRoleHaveMember($role, $user));
+        $this->assertTrue($allocation->doesRoleHaveMember($role, $group));
         $allocation->remove($role, $user);
-
         $this->assertFalse($allocation->doesRoleHaveMember($role, $user));
         $allocation->remove($role, $user2);
-
         $this->assertFalse($allocation->doesRoleHaveMember($role, $user2));
         $allocation->save();
@@ -162,8 +164,9 @@ class APIAclTestCase extends KTUnitTestCase {
         $allocation = KTAPI_RoleAllocation::getAllocation($this->ktapi, $root);
         $this->assertFalse($allocation->doesRoleHaveMember($role, $user));
-        $this->assertFalse($allocation->doesRoleHaveMember($role, $user2));*/
+        $this->assertFalse($allocation->doesRoleHaveMember($role, $user2));
+        $folder->delete('Testing role allocation');
     }
     /**
@@ -173,12 +176,16 @@ class APIAclTestCase extends KTUnitTestCase {
     function testPermissionAllocation()
     {
         $root = $this->ktapi->get_root_folder();
-        $folder = $this->ktapi->get_folder_by_name('/test123');
+        $folder = $this->ktapi->get_folder_by_name('test123');
+        if(!$folder instanceof KTAPI_Folder){
+            $folder = $root->add_folder('test123');
+        }
-        $allocation = KTAPI_PermissionAllocation::getAllocation($this->ktapi, $root);
+        $allocation = KTAPI_PermissionAllocation::getAllocation($this->ktapi, $folder);
         $group = KTAPI_Group::getByName('System Administrators');
         $user = KTAPI_User::getByUsername('anonymous');
+        $role = KTAPI_Role::getByName('Publisher');
         $read = KTAPI_Permission::getByNamespace('ktcore.permissions.read');
         $write = KTAPI_Permission::getByNamespace('ktcore.permissions.write');
         $addFolder = KTAPI_Permission::getByNamespace('ktcore.permissions.addFolder');
@@ -188,21 +195,22 @@ class APIAclTestCase extends KTUnitTestCase {
         $allocation->add($user, $write);
         $allocation->add($user, $addFolder);
         $allocation->add($user, $security);
+        $allocation->add($role, $read);
+        $allocation->add($role, $write);
         $allocation->remove($group, $write);
         $allocation->save();
+        // refresh object and check permission allocations
+        $folder2 = $this->ktapi->get_folder_by_name('test123');
-        $root2 = $this->ktapi->get_root_folder();
-
-        $allocation = KTAPI_PermissionAllocation::getAllocation($this->ktapi, $root2);
+        $allocation = KTAPI_PermissionAllocation::getAllocation($this->ktapi, $folder2);
         $this->assertTrue($allocation->isMemberPermissionSet($user, $read));
         $this->assertTrue($allocation->isMemberPermissionSet($user, $write));
-
+        $this->assertTrue($allocation->isMemberPermissionSet($role, $write));
         $this->assertFalse($allocation->isMemberPermissionSet($group, $write));
+        $folder->delete('Testing permission allocation');
     }
-
 }
-?>
-
+?>
 \ No newline at end of file
@@ -271,6 +271,31 @@ class APIDocumentTestCase extends KTUnitTestCase {
     }
     /**
+     * Test role allocation and permission allocation
+     */
+    function testPermissions()
+    {
+        $randomFile = APIDocumentHelper::createRandomFile();
+        $this->assertTrue(is_file($randomFile));
+
+        $document = $this->root->add_document('testtitle', 'testname', 'Default', $randomFile);
+        @unlink($randomFile);
+        $this->assertNotError($document);
+        if(PEAR::isError($document)) return;
+
+        $permAllocation = $document->getPermissionAllocation();
+        $this->assertNotNull($permAllocation);
+        $this->assertEntity($permAllocation, KTAPI_PermissionAllocation);
+
+        $roleAllocation = $document->getRoleAllocation();
+        $this->assertNotNull($roleAllocation);
+        $this->assertEntity($roleAllocation, KTAPI_RoleAllocation);
+
+        $document->delete('Testing');
+        $document->expunge();
+    }
+
+    /**
      * Tests the adding of a duplicate document title
      *
     function testAddingDuplicateTitle()
 <?php
-require_once (dirname(__FILE__) . '/../test.php');
+require_once (KT_DIR . '/tests/test.php');
 require_once (KT_DIR . '/ktapi/ktapi.inc.php');
 class APIFolderTestCase extends KTUnitTestCase {
     /**
@@ -26,36 +26,36 @@ class APIFolderTestCase extends KTUnitTestCase {
             $folder2->delete('because');
         }
     }
-    
+
     function testAddDocument() {
     	$tmpfname = tempnam("/tmp", "KTUNIT");
     	$fp = fopen($tmpfname, "w");
     	fwrite($fp, "Hello");
     	fclose($fp);
-    	
+
     	$folder = $this->ktapi->get_root_folder();
     	$res = $folder->add_document("Test Document", "test.txt", "Default", $tmpfname);
     	$this->assertEntity($res, 'KTAPI_Document');
-    	
-    	
-    	
+
+
+
     	$res = $res->delete("Test deletion");
-    	
-    	
-    	
+
+
+
     }
-    
+
     function testDeleteFolder() {
     	$folder = $this->ktapi->get_root_folder();
     	$folder = $folder->add_folder('temp1');
         $this->assertEntity($folder, 'KTAPI_Folder');
         $folder->delete('because');
-        
+
         $folder = $this->ktapi->get_folder_by_name('temp1');
         $this->assertError($folder);
     }
-    
-   
+
+
 /*    function testRename() {
         $root = $this->ktapi->get_root_folder();
         $this->assertEntity($root, 'KTAPI_Folder');
@@ -77,26 +77,26 @@ class APIFolderTestCase extends KTUnitTestCase {
 		$root = $this->ktapi->get_root_folder();
 		$folder = $root->get_folder();
 		$this->assertEntity($folder, 'Folder');
-		
+
 		$folder = $this->ktapi->get_folder_by_name("NONAMEFOLDER");
 		$this->assertError($folder);
-		
+
 		$junk = pack("H*", "000102030405060708090A0B0C0D0E0F101112131415161718191A1B1C1D1E1F");
 		$junk = $junk.$junk.$junk.$junk.$junk.$junk.$junk.$junk.$junk;
 		$folder = $this->ktapi->get_folder_by_name($junk);
 		$this->assertError($folder);
-		
+
 	}
-	
+
 	function testListing() {
 		$root = $this->ktapi->get_root_folder();
 		$listing = $root->get_listing();
 		$this->assertExpectedResults(true, is_array($listing));
 		foreach($listing as $key => $val) {
-				
+
 		}
 	}
-	
+
 	 function testCreateFolders() {
         $root = $this->ktapi->get_root_folder();
         $this->assertEntity($root, 'KTAPI_Folder');
@@ -132,8 +132,8 @@ class APIFolderTestCase extends KTUnitTestCase {
             $this->assertEntity($folder, 'PEAR_Error');
         }
     }
-	
-	
+
+
 	function testPermission() {
 		$root = $this->ktapi->get_root_folder();
 		$perm = $root->get_permissions();
@@ -142,43 +142,63 @@ class APIFolderTestCase extends KTUnitTestCase {
     function getSystemListing() {
         // TODO .. can do anything as admin...
-        
+
     }
     function getAnonymousListing() {
         // TODO
         // probably won't be able to do unless the api caters for setting up anonymous...
-        
+
     }
     function getUserListing() {
         // TODO
-        
+
     }
     function testCopy() {
     	$root = $this->ktapi->get_root_folder();
     	$folder = $root->add_folder("Test folder2");
     	$new_folder = $root->add_folder("New test folder2");
     	$res = $folder->copy($new_folder, "Unit test copy2");
-    	
+
     	$folder->delete("Clean up test");
     	$new_folder->delete("Clean up test");
-    	
+
     	$this->assertNull($res, "Error returned");
-        
-        
+
+
     }
    function testMove() {
     	$root = $this->ktapi->get_root_folder();
     	$folder = $root->add_folder("Test folder2");
     	$new_folder = $root->add_folder("New test folder2");
     	$res = $folder->move($new_folder, "Unit test copy2");
-    	
+
     	$folder->delete("Clean up test");
     	$new_folder->delete("Clean up test");
-    	
+
     	$this->assertNull($res, "Error returned");
-        
-        
+
+
     }
+    /**
+     * Test role allocation and permission allocation
+     */
+    function testPermissions()
+    {
+        $root = $this->ktapi->get_root_folder();
+        $folder = $root->add_folder('testX');
+        $this->assertEntity($folder, 'KTAPI_Folder');
+        if(PEAR::isError($folder)) return;
+
+        $permAllocation = $folder->getPermissionAllocation();
+        $this->assertNotNull($permAllocation);
+        $this->assertEntity($permAllocation, KTAPI_PermissionAllocation);
+
+        $roleAllocation = $folder->getRoleAllocation();
+        $this->assertNotNull($roleAllocation);
+        $this->assertEntity($roleAllocation, KTAPI_RoleAllocation);
+
+        $folder->delete('Testing');
+    }
 }
 ?>