wbrawner/server
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added & improved documentation

Browse source
This commit is contained in:
Sam Tuke 2012-05-31 17:57:34 +01:00
parent ef60dcc23e
commit ec0c0f3907
1 changed files with 11 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
lib/filesystemview.php
View file

@ -34,6 +34,8 @@
* built-in file manipulation functions. This will ensure all hooks and proxies * built-in file manipulation functions. This will ensure all hooks and proxies
* are triggered correctly. * are triggered correctly.
* *
* Filesystem functions are not called directly; they are passed to the correct
* OC_Filestorage object
*/ */
class OC_FilesystemView { class OC_FilesystemView {
@ -118,7 +120,9 @@ class OC_FilesystemView {
} }
/** /**
* the following functions operate with arguments and return values identical to those of their PHP built-in equivalents * the following functions operate with arguments and return values identical
* to those of their PHP built-in equivalents. Mostly they are merely wrappers
* for OC_Filestorage via basicOperation().
*/ */
public function mkdir($path){ public function mkdir($path){
return $this->basicOperation('mkdir',$path,array('create','write')); return $this->basicOperation('mkdir',$path,array('create','write'));
@ -351,12 +355,16 @@ class OC_FilesystemView {
} }
/** /**
* abstraction for running most basic operations * @brief abstraction layer for basic filesystem functions: wrapper for OC_Filestorage
* @param string $operation * @param string $operation
* @param string #path * @param string #path
* @param array (optional) hooks * @param array (optional) hooks
* @param mixed (optional) $extraParam * @param mixed (optional) $extraParam
* @return mixed * @return mixed
*
* This method takes requests for basic filesystem functions (e.g. reading & writing
* files), processes hooks and proxies, sanitises paths, and finally passes them on to
* OC_Filestorage for delegation to a storage backend for execution
*/ */
private function basicOperation($operation,$path,$hooks=array(),$extraParam=null){ private function basicOperation($operation,$path,$hooks=array(),$extraParam=null){
if(OC_FileProxy::runPreProxies($operation,$path, $extraParam) and OC_Filesystem::isValidPath($path)){ if(OC_FileProxy::runPreProxies($operation,$path, $extraParam) and OC_Filesystem::isValidPath($path)){