Add comments in the updateQuota method to explain the behavior
Signed-off-by: Arthur Schiwon <blizzz@arthur-schiwon.de>
This commit is contained in:
parent
ebd1a7d4b2
commit
3676189e05
|
@ -459,6 +459,20 @@ class User {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* Overall process goes as follow:
|
||||||
|
* 1. fetch the quota from LDAP and check if it's parseable with the "verifyQuotaValue" function
|
||||||
|
* 2. if the value can't be fetched, is empty or not parseable, use the default LDAP quota
|
||||||
|
* 3. if the default LDAP quota can't be parsed, use the ownCloud's default quota (use 'default')
|
||||||
|
* 4. check if the target user exists and set the quota for the user.
|
||||||
|
*
|
||||||
|
* In order to improve performance and prevent an unwanted extra LDAP call, the $valueFromLDAP
|
||||||
|
* parameter can be passed with the value of the attribute. This value will be considered as the
|
||||||
|
* quota for the user coming from the LDAP server (step 1 of the process) It can be useful to
|
||||||
|
* fetch all the user's attributes in one call and use the fetched values in this function.
|
||||||
|
* The expected value for that parameter is a string describing the quota for the user. Valid
|
||||||
|
* values are 'none' (unlimited), 'default' (the ownCloud's default quota), '1234' (quota in
|
||||||
|
* bytes), '1234 MB' (quota in MB - check the \OC_Helper::computerFileSize method for more info)
|
||||||
|
*
|
||||||
* fetches the quota from LDAP and stores it as ownCloud user value
|
* fetches the quota from LDAP and stores it as ownCloud user value
|
||||||
* @param string $valueFromLDAP the quota attribute's value can be passed,
|
* @param string $valueFromLDAP the quota attribute's value can be passed,
|
||||||
* to save the readAttribute request
|
* to save the readAttribute request
|
||||||
|
|
Loading…
Reference in New Issue