Created 0.10 tag

marijnkampf · Jan 31, 2010 · fc097c7 · fc097c7
1 parent 09a5e83
commit fc097c7
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 6 deletions.
diff --git a/README b/README
@@ -1,5 +1,5 @@
 ###############################################
-Secure Files Module                     v trunk
+Secure Files Module                        0.10
 ###############################################
 
 A light-weight secure file provider.
@@ -15,7 +15,7 @@ SilverStripe 2.3
 
 Documentation
 -----------------------------------------------
-http://doc.silverstripe.com/doku.php?id=modules:securefiles
+http://polemic.net.nz/secure-files-module/?refer=docs
 
 Installation Instructions
 -----------------------------------------------

diff --git a/code/SecureFileController.php b/code/SecureFileController.php
@@ -8,6 +8,9 @@
  */
 class SecureFileController extends Controller implements PermissionProvider {
 
+	/**
+	 * @var string htaccess file as set by apache config
+	 */
 	static $htaccess_file = ".htaccess";
 
 	/**

diff --git a/code/SecureFileGroupPermissionDecorator.php b/code/SecureFileGroupPermissionDecorator.php
@@ -16,6 +16,12 @@ function extraStatics() {
 		);
 	}
 
+	/**
+	 * View permission check
+	 * 
+	 * @param Member $member
+	 * @return noolean
+	 */
 	function canView(Member $member = null) {
 		if($this->owner->basicViewChecks($member))
 			return true;
@@ -24,6 +30,11 @@ function canView(Member $member = null) {
 		return $member->inGroups($this->owner->AllGroupPermissions());
 	}
 
+	/**
+	 * Collate permissions for this and all parent folders.
+	 * 
+	 * @return DataObjectSet
+	 */
 	function AllGroupPermissions() {
 		$groupSet = new DataObjectSet();
 		$groups = $this->owner->GroupPermissions();
@@ -35,6 +46,11 @@ function AllGroupPermissions() {
 		return $groupSet;
 	}
 
+	/**
+	 * Collage permissions for all parent folders
+	 * 
+	 * @return DataObjectSet
+	 */
 	function InheritedGroupPermissions() {
 		if($this->owner->ParentID)
 			return $this->owner->Parent()->AllGroupPermissions();
@@ -43,8 +59,11 @@ function InheritedGroupPermissions() {
 	}
 
 	/**
-	 * Security tab for folders
-	 */
+	 * Adds group select fields to CMS
+	 * 
+ 	 * @param FieldSet $fields
+ 	 * @return void
+ 	 */
 	public function updateCMSFields(FieldSet &$fields) {
 
 			if(!($this->owner instanceof Folder) || !$this->owner->ID)
@@ -65,8 +84,6 @@ public function updateCMSFields(FieldSet &$fields) {
 				$InheritedGroupsField = new ReadonlyField("InheritedGroupPermissionsText", "Inherited Group Permissions", $fieldText);
 				$fields->addFieldToTab('Root.Security', $InheritedGroupsField);
 			}
-
-
 
 	}