nextcloud / server

apps/files_external/lib/Lib/SharePoint/SharePointClient.php

Doc Comments +8 added lines

@@ -53,6 +53,10 @@ 
 	/** @var  string */
 	private $documentLibraryTitle;
 
+	/**
+	 * @param string $sharePointUrl
+	 * @param string $documentLibraryTitle
+	 */
 	public function __construct(ContextsFactory $contextsFactory, $sharePointUrl, array $credentials, $documentLibraryTitle) {
 		$this->contextsFactory = $contextsFactory;
 		$this->sharePointUrl = $sharePointUrl;
@@ -114,6 +118,7 @@ 
 	 *
 	 * @param string $relativeServerPath
 	 * @throws \Exception
+	 * @return string
 	 */
 	public function createFolder($relativeServerPath) {
 		$this->ensureConnection();
@@ -134,6 +139,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $relativeServerPath
+	 */
 	public function deleteFolder($relativeServerPath, Folder $folder = null) {
 		$this->ensureConnection();
 

Spacing +18 added lines, -18 removed lines

@@ -67,10 +67,10 @@ 
 	 * @throws \Exception
 	 */
 	public function fetchFileOrFolder($path, array $properties = null) {
-		$fetchFileFunc = function ($path, $props) { return $this->fetchFile($path, $props);};
-		$fetchFolderFunc = function ($path, $props) { return $this->fetchFolder($path, $props);};
-		$fetchers = [ $fetchFileFunc, $fetchFolderFunc ];
-		if(strpos($path, '.') === false) {
+		$fetchFileFunc = function($path, $props) { return $this->fetchFile($path, $props); };
+		$fetchFolderFunc = function($path, $props) { return $this->fetchFolder($path, $props); };
+		$fetchers = [$fetchFileFunc, $fetchFolderFunc];
+		if (strpos($path, '.') === false) {
 			$fetchers = array_reverse($fetchers);
 		}
 
@@ -79,7 +79,7 @@ 
 				$instance = call_user_func_array($fetchFunction, [$path, $properties]);
 				return $instance;
 			} catch (\Exception $e) {
-				if(preg_match('/^The file \/.* does not exist\.$/', $e->getMessage()) !== 1
+				if (preg_match('/^The file \/.* does not exist\.$/', $e->getMessage()) !== 1
 					&& $e->getMessage() !== 'Unknown Error'
 					&& $e->getMessage() !== 'File Not Found.'
 				) {
@@ -120,7 +120,7 @@ 
 
 		$serverUrlParts = explode('/', $relativeServerPath);
 		$newFolderName = array_pop($serverUrlParts);
-		$parentUrl =  implode('/', $serverUrlParts);
+		$parentUrl = implode('/', $serverUrlParts);
 
 		$parentFolder = $this->context->getWeb()->getFolderByServerRelativeUrl($parentUrl);
 		$folder = $parentFolder->getFolders()->add($newFolderName);
@@ -138,7 +138,7 @@ 
 		$this->ensureConnection();
 
 		try {
-			if($folder === null) {
+			if ($folder === null) {
 				$folder = $this->context->getWeb()->getFolderByServerRelativeUrl($relativeServerPath);
 			}
 			$folder->deleteObject();
@@ -157,7 +157,7 @@ 
 	 */
 	public function fetchFolderContents($relativeServerPath, $properties = null, Folder $folder = null) {
 		$this->ensureConnection();
-		if($folder === null) {
+		if ($folder === null) {
 			$folder = $this->context->getWeb()->getFolderByServerRelativeUrl($relativeServerPath);
 		}
 
@@ -175,20 +175,20 @@ 
 	public function isHidden(ClientObject $file) {
 		// ClientObject itself does not have getListItemAllFields but is
 		// the common denominator of File and Folder
-		if(!$file instanceof File && !$file instanceof Folder) {
+		if (!$file instanceof File && !$file instanceof Folder) {
 			throw new \InvalidArgumentException('File or Folder expected');
 		}
-		if($file instanceof File) {
+		if ($file instanceof File) {
 			// it's expensive, we only check folders
 			return false;
 		}
 		$fields = $file->getListItemAllFields();
-		if($fields->getProperties() === []) {
+		if ($fields->getProperties() === []) {
 			$this->loadAndExecute($fields, ['Id', 'Hidden']);
 		}
 		$id = $fields->getProperty('Id');
 		$hidden = $fields->getProperty('Hidden'); // TODO: get someone to test this in SP 2013
-		if($hidden === false || $id !== null) {
+		if ($hidden === false || $id !== null) {
 			// avoids listing hidden "Forms" folder (and its contents).
 			// Have not found a different mechanism to detect whether
 			// a file or folder is hidden. There used to be a Hidden
@@ -208,11 +208,11 @@ 
 	 * @throws NotFoundException
 	 */
 	private function getDocumentLibrary() {
-		if(!is_null($this->documentLibrary)) {
+		if (!is_null($this->documentLibrary)) {
 			return $this->documentLibrary;
 		}
 
-		$lists = $this->context->getWeb()->getLists()->filter('Title eq \'' . $this->documentLibraryTitle . '\'')->top(1);
+		$lists = $this->context->getWeb()->getLists()->filter('Title eq \''.$this->documentLibraryTitle.'\'')->top(1);
 		$this->context->load($lists)->executeQuery();
 		if ($lists->getCount() === 1 && $lists->getData()[0] instanceof SPList) {
 			$this->documentLibrary = $lists->getData()[0];
@@ -228,18 +228,18 @@ 
 	 * @throws \InvalidArgumentException
 	 */
 	private function ensureConnection() {
-		if($this->context instanceof ClientContext) {
+		if ($this->context instanceof ClientContext) {
 			return;
 		}
 
-		if(!is_string($this->credentials['user']) || empty($this->credentials['user'])) {
+		if (!is_string($this->credentials['user']) || empty($this->credentials['user'])) {
 			throw new \InvalidArgumentException('No user given');
 		}
-		if(!is_string($this->credentials['password']) || empty($this->credentials['password'])) {
+		if (!is_string($this->credentials['password']) || empty($this->credentials['password'])) {
 			throw new \InvalidArgumentException('No password given');
 		}
 		$this->authContext = $this->contextsFactory->getAuthContext($this->credentials['user'], $this->credentials['password']);
-		$this->authContext->AuthType = CURLAUTH_NTLM;		# Basic auth does not work somehow…
+		$this->authContext->AuthType = CURLAUTH_NTLM; # Basic auth does not work somehow…
 		$this->createClientContext();
 		# Auth is not triggered yet. This will happen when something is requested from SharePoint (on demand), e.g.:
 	}

apps/files_external/lib/Lib/Storage/SharePoint.php

Doc Comments +3 added lines, -3 removed lines

@@ -346,7 +346,7 @@ 
 	}
 
 	/**
-	 * @param $serverUrl
+	 * @param string $serverUrl
 	 * @return ClientObjectCollection[]
 	 */
 	private function getFolderContents($serverUrl) {
@@ -378,7 +378,7 @@ 
 	}
 
 	/**
-	 * @param $serverUrl
+	 * @param string $serverUrl
 	 * @return File|Folder
 	 * @throws NotFoundException
 	 */
@@ -405,7 +405,7 @@ 
 	/**
 	 * creates the relative server "url" out of the provided path
 	 *
-	 * @param $path
+	 * @param string $path
 	 * @return string
 	 */
 	private function formatPath($path) {

Spacing +23 added lines, -23 removed lines

@@ -66,14 +66,14 @@ 
 		$this->server = $parameters['host'];
 		$this->documentLibrary = $parameters['documentLibrary'];
 
-		if(strpos($this->documentLibrary, '"') !== false) {
+		if (strpos($this->documentLibrary, '"') !== false) {
 			// they are, amongst others, not allowed and we use it in the filter
 			// cf. https://support.microsoft.com/en-us/kb/2933738
 			// TODO: verify, it talks about files and folders mostly
 			throw new \InvalidArgumentException('Illegal character in Document Library Name');
 		}
 
-		if(!isset($parameters['user']) || !isset($parameters['password'])) {
+		if (!isset($parameters['user']) || !isset($parameters['password'])) {
 			throw new \UnexpectedValueException('No user or password given');
 		}
 		$this->authUser = $parameters['user'];
@@ -91,7 +91,7 @@ 
 	 * @since 6.0.0
 	 */
 	public function getId() {
-		return 'SharePoint::' . $this->server . '::' . $this->documentLibrary . '::' . $this->authUser;
+		return 'SharePoint::'.$this->server.'::'.$this->documentLibrary.'::'.$this->authUser;
 	}
 
 	/**
@@ -132,7 +132,7 @@ 
 		try {
 			$cacheEntry = $this->fileCache->get($serverUrl);
 			$folder = null;
-			if(is_array($cacheEntry) && isset($cacheEntry['instance'])) {
+			if (is_array($cacheEntry) && isset($cacheEntry['instance'])) {
 				$folder = $cacheEntry['instance'];
 			}
 			$this->spClient->deleteFolder($serverUrl, $folder);
@@ -163,7 +163,7 @@ 
 				$items = $collection->getData();
 				foreach ($items as $item) {
 					/** @var ListItem $fields */
-					if(!$this->spClient->isHidden($item)) {
+					if (!$this->spClient->isHidden($item)) {
 						$files[] = $item->getProperty('Name');
 					}
 				}
@@ -203,7 +203,7 @@ 
 			'atime' => time(),
 		];
 
-		if(!is_null($stat['mtime'])) {
+		if (!is_null($stat['mtime'])) {
 			return $stat;
 		}
 
@@ -227,9 +227,9 @@ 
 		} catch (NotFoundException $e) {
 			return false;
 		}
-		if($object instanceof File) {
+		if ($object instanceof File) {
 			return 'file';
-		} else if($object instanceof Folder) {
+		} else if ($object instanceof Folder) {
 			return 'dir';
 		} else {
 			return false;
@@ -267,15 +267,15 @@ 
 	public function unlink($path) {
 		//  FIXME:: all is totally wrong
 		$path = trim($path);
-		if($path === '/' || $path === '') {
+		if ($path === '/' || $path === '') {
 			return false;
 		}
-		foreach([true, false] as $asFile) {
+		foreach ([true, false] as $asFile) {
 			try {
 				$fsObject = $this->spClient->fetchFileOrFolder($path, $asFile);
 				$fsObject->deleteObject();
 				return true;
-			} catch(\Exception $e) {
+			} catch (\Exception $e) {
 				// NOOP
 			}
 		}
@@ -316,7 +316,7 @@ 
 	 * @param array $parameters
 	 */
 	private function fixDI(array $parameters) {
-		if(isset($parameters['contextFactory'])
+		if (isset($parameters['contextFactory'])
 			&& $parameters['contextFactory'] instanceof ContextsFactory)
 		{
 			$this->contextsFactory = $parameters['contextFactory'];
@@ -324,7 +324,7 @@ 
 			$this->contextsFactory = new ContextsFactory();
 		}
 
-		if(isset($parameters['sharePointClientFactory'])
+		if (isset($parameters['sharePointClientFactory'])
 			&& $parameters['sharePointClientFactory'] instanceof SharePointClientFactory)
 		{
 			$spcFactory = $parameters['sharePointClientFactory'];
@@ -334,11 +334,11 @@ 
 		$this->spClient = $spcFactory->getClient(
 			$this->contextsFactory,
 			$this->server,
-			[ 'user' => $this->authUser, 'password' => $this->authPwd],
+			['user' => $this->authUser, 'password' => $this->authPwd],
 			$this->documentLibrary
 		);
 
-		if(isset($parameters['cappedMemoryCache'])) {
+		if (isset($parameters['cappedMemoryCache'])) {
 			$this->fileCache = $parameters['cappedMemoryCache'];
 		} else {
 			$this->fileCache = new CappedMemoryCache('256');
@@ -351,7 +351,7 @@ 
 	 */
 	private function getFolderContents($serverUrl) {
 		$entry = $this->fileCache->get($serverUrl);
-		if($entry === null || !isset($entry['children'])) {
+		if ($entry === null || !isset($entry['children'])) {
 			$folder = isset($entry['instance']) ? $entry['instance'] : null;
 			$contents = $this->spClient->fetchFolderContents($serverUrl, null, $folder);
 			$cacheItem = $entry ?: [];
@@ -365,7 +365,7 @@ 
 					$url = $item->getProperty(self::SP_PROPERTY_URL);
 					$itemEntry = $this->fileCache->get($url);
 					$itemEntry = $itemEntry ?: [];
-					if(!isset($itemEntry['instance'])) {
+					if (!isset($itemEntry['instance'])) {
 						$itemEntry['instance'] = $item;
 						$this->fileCache->set($url, $itemEntry);
 					}
@@ -384,9 +384,9 @@ 
 	 */
 	private function getFileOrFolder($serverUrl) {
 		$entry = $this->fileCache->get($serverUrl);
-		if($entry === false) {
+		if ($entry === false) {
 			throw new NotFoundException('File or Folder not found');
-		} else if($entry === null || !isset($entry['instance'])) {
+		} else if ($entry === null || !isset($entry['instance'])) {
 			try {
 				$file = $this->spClient->fetchFileOrFolder($serverUrl, [self::SP_PROPERTY_SIZE, self::SP_PROPERTY_MTIME]);
 			} catch (NotFoundException $e) {
@@ -410,14 +410,14 @@ 
 	 */
 	private function formatPath($path) {
 		$path = trim($path, '/');
-		$serverUrl = '/' . $this->documentLibrary;
-		if($path !== '') {
-			$serverUrl .= '/' . $path;
+		$serverUrl = '/'.$this->documentLibrary;
+		if ($path !== '') {
+			$serverUrl .= '/'.$path;
 		}
 
 		$pathParts = explode('/', $serverUrl);
 		$filename = array_pop($pathParts);
-		if($filename === '.') {
+		if ($filename === '.') {
 			// remove /. from the end of the path
 			$serverUrl = mb_substr($serverUrl, 0, mb_strlen($serverUrl) - 2);
 		}