#308: example to upload a file and set its properties, enhancements for Web getFileByServerRelativePath & getFolderByServerRelativePath methods

Author: vgrem

examples/SharePoint/Files/UploadAndSetProps.php

@@ -0,0 +1,22 @@
+<?php
+
+
+require_once '../../vendor/autoload.php';
+$settings = include('../../../tests/Settings.php');
+
+use Office365\Runtime\Auth\UserCredentials;
+use Office365\SharePoint\ClientContext;
+
+
+$credentials = new UserCredentials($settings['UserName'], $settings['Password']);
+$ctx = (new ClientContext($settings['Url']))->withCredentials($credentials);
+
+$localPath =  "../../data/SharePoint User Guide.docx";
+$libraryTitle = "Documents";
+$lib = $ctx->getWeb()->getLists()->getByTitle($libraryTitle);
+$uploadFile = $lib->getRootFolder()->uploadFile(basename($localPath),file_get_contents($localPath))->executeQuery();
+$listItem = $uploadFile->getListItemAllFields();
+$listItem->setProperty("Title", "Uploaded")->update()->executeQuery(); // update file metadata
+print "File {$uploadFile->getServerRelativeUrl()} has been uploaded\r\n";
+
+

examples/SharePoint/Files/UploadFile.php

@@ -8,7 +8,7 @@
 use Office365\SharePoint\ClientContext;
 
 
-function uploadFileAlt(ClientContext $ctx, $sourceFilePath, $targetFileUrl)
+/*function uploadFileAlt(ClientContext $ctx, $sourceFilePath, $targetFileUrl)
 {
     $fileContent = file_get_contents($sourceFilePath);
     try {
@@ -17,25 +17,19 @@ function uploadFileAlt(ClientContext $ctx, $sourceFilePath, $targetFileUrl)
     } catch (Exception $e) {
         print "File upload failed:\r\n";
     }
-}
-
+}*/
 
-try {
-    $credentials = new UserCredentials($settings['UserName'], $settings['Password']);
-    $ctx = (new ClientContext($settings['Url']))->withCredentials($credentials);
-    $localPath = "../data/";
-    $targetLibraryTitle = "Documents";
-    $targetList = $ctx->getWeb()->getLists()->getByTitle($targetLibraryTitle);
 
-    $searchPrefix = $localPath . '*.*';
-    foreach(glob($searchPrefix) as $filename) {
-        $uploadFile = $targetList->getRootFolder()->uploadFile(basename($filename),file_get_contents($filename));
-        $ctx->executeQuery();
-        print "File {$uploadFile->getServerRelativeUrl()} has been uploaded\r\n";
-    }
+$credentials = new UserCredentials($settings['UserName'], $settings['Password']);
+$ctx = (new ClientContext($settings['Url']))->withCredentials($credentials);
+$localPath =  "../../data/";
+$targetLibraryTitle = "Documents";
+$targetList = $ctx->getWeb()->getLists()->getByTitle($targetLibraryTitle);
 
-}
-catch (Exception $e) {
-    echo 'Error: ',  $e->getMessage(), "\n";
+$searchPrefix = $localPath . '*.*';
+foreach(glob($searchPrefix) as $filename) {
+    $uploadFile = $targetList->getRootFolder()->uploadFile(basename($filename),file_get_contents($filename));
+    $ctx->executeQuery();
+    print "File {$uploadFile->getServerRelativeUrl()} has been uploaded\r\n";
 }
 

examples/SharePoint/Folders/GetByPath.php

@@ -0,0 +1,16 @@
+<?php
+require_once '../../vendor/autoload.php';
+$settings = include('../../../tests/Settings.php');
+
+use Office365\Runtime\Auth\ClientCredential;
+use Office365\SharePoint\ClientContext;
+use Office365\SharePoint\MoveOperations;
+use Office365\SharePoint\SPResourcePath;
+
+$credentials = new ClientCredential($settings['ClientId'], $settings['ClientSecret']);
+$siteUrl = $settings['TeamSiteUrl'];
+$client = (new ClientContext($siteUrl))->withCredentials($credentials);
+
+$folder = $client->getWeb()->getFolderByServerRelativePath("Shared Documents")->get()->executeQuery();
+//$folder = $client->getWeb()->getFolderByServerRelativePath("Shared Documents")->get()->executeQuery();
+print($folder->getServerRelativeUrl());

src/SharePoint/SPResourcePath.php

@@ -22,6 +22,14 @@ public function __toString()
         return $this->DecodedUrl;
     }
 
+    /**
+     * @return array
+     */
+    public function toJson()
+    {
+        return array("DecodedUrl" => rawurlencode($this->DecodedUrl));
+    }
+
     /**
      * @var string
      */

src/SharePoint/Web.php

@@ -195,13 +195,16 @@ public function getFileByServerRelativeUrl($serverRelativeUrl)
     }
     /**
      * Returns the file object located at the specified server-relative Path.
-     * @param SPResourcePath $serverRelativePath The server relative Path of the file.
+     * @param SPResourcePath|string $serverRelativePath The server relative Path of the file.
      * @return File
      */
     public function getFileByServerRelativePath($serverRelativePath)
     {
-        $params = array("decodedUrl" => rawurlencode($serverRelativePath->DecodedUrl));
-        return new File($this->getContext(), new ServiceOperationPath("getFileByServerRelativePath", $params, $this->getResourcePath()));
+        if(is_string($serverRelativePath)) {
+            $serverRelativePath = new SPResourcePath($serverRelativePath);
+        }
+        return new File($this->getContext(),
+            new ServiceOperationPath("getFileByServerRelativePath", $serverRelativePath->toJson(), $this->getResourcePath()));
     }
     /**
      * Returns the file object with the specified GUID.
@@ -223,12 +226,15 @@ public function getFolderByServerRelativeUrl($serverRelativeUrl)
     }
     /**
      * Returns the folder object located at the specified server-relative Path.
-     * @param SPResourcePath $serverRelativePath
+     * @param SPResourcePath|string $serverRelativePath
      * @return Folder
      */
     public function getFolderByServerRelativePath($serverRelativePath)
     {
-        return new Folder($this->getContext(), new ServiceOperationPath("getFolderByServerRelativePath", array("decodedUrl" => rawurlencode($serverRelativePath->DecodedUrl)), $this->getResourcePath()));
+        if(is_string($serverRelativePath)) {
+            $serverRelativePath = new SPResourcePath($serverRelativePath);
+        }
+        return new Folder($this->getContext(), new ServiceOperationPath("getFolderByServerRelativePath", $serverRelativePath->toJson(), $this->getResourcePath()));
     }
     /**
      * Returns the folder object with the specified GUID.