SharePoint API: support for setting taxonomy field values

vgrem · Apr 27, 2022 · 8810e14 · 8810e14
1 parent 95b7251
commit 8810e14
Show file tree

Hide file tree

Showing 9 changed files with 48 additions and 16 deletions.
diff --git a/examples/SharePoint/Taxonomy/SetTaxFieldValue.php b/examples/SharePoint/Taxonomy/SetTaxFieldValue.php
@@ -5,18 +5,20 @@
 use Office365\Runtime\Auth\ClientCredential;
 use Office365\SharePoint\ClientContext;
 use Office365\SharePoint\Taxonomy\TaxonomyFieldValue;
+use Office365\SharePoint\Taxonomy\TaxonomyFieldValueCollection;
 
 $credentials = new ClientCredential($settings['ClientId'], $settings['ClientSecret']);
 $siteUrl = $settings['TeamSiteUrl'];
 $ctx = (new ClientContext($siteUrl))->withCredentials($credentials);
 $tasksList = $ctx->getWeb()->getLists()->getByTitle("Tasks");
 
 $taxFieldValue = new TaxonomyFieldValue("Sweden", "f9a6dae9-633c-474b-b35e-b235cf2b9e73");
+$taxFieldValueAlt = new TaxonomyFieldValue("Germany", "04872f90-9990-4fe4-8cff-32cc8ca05417");
 
 $taskProps = array(
     'Title' => "New task N#" . rand(1, 100000),
     "Country" => $taxFieldValue,
-    #"Countries" => new TaxonomyFieldValueCollection(array($taxFieldValue))
+    "Countries" => new TaxonomyFieldValueCollection(array($taxFieldValue, $taxFieldValueAlt))
 );
 $item = $tasksList->addItem($taskProps)->executeQuery();
 

diff --git a/src/Runtime/Paths/EntityResourcePath.php → src/Runtime/Paths/EntityPath.php b/src/Runtime/Paths/EntityResourcePath.php → src/Runtime/Paths/EntityPath.php
@@ -7,7 +7,7 @@
 /**
  *  Resource path for addressing a single entity
  */
-class EntityResourcePath extends ResourcePath
+class EntityPath extends ResourcePath
 {
 
     /**

diff --git a/src/SharePoint/BaseEntity.php b/src/SharePoint/BaseEntity.php
@@ -8,7 +8,7 @@
 use Office365\Runtime\ClientObject;
 use Office365\Runtime\ClientRuntimeContext;
 use Office365\Runtime\OData\ODataQueryOptions;
-use Office365\Runtime\Paths\EntityResourcePath;
+use Office365\Runtime\Paths\EntityPath;
 use Office365\Runtime\ResourcePath;
 
 /**
@@ -48,7 +48,7 @@ public function setProperty($name, $value, $persistChanges = true)
         //fallback: determine entity by Id
         if ($name === "Id") {
             if (is_null($this->getResourcePath())) {
-                $this->resourcePath = new EntityResourcePath($value, $this->getParentCollection()->getResourcePath());
+                $this->resourcePath = new EntityPath($value, $this->getParentCollection()->getResourcePath());
             }
         }
         parent::setProperty($name, $value, $persistChanges);

diff --git a/src/SharePoint/ContentType.php b/src/SharePoint/ContentType.php
@@ -5,7 +5,7 @@
  */
 namespace Office365\SharePoint;
 
-use Office365\Runtime\Paths\EntityResourcePath;
+use Office365\Runtime\Paths\EntityPath;
 use Office365\Runtime\ResourcePath;
 /**
  * Specifies 
@@ -23,7 +23,7 @@ function setProperty($name, $value, $persistChanges = true)
             $value = $value['StringValue'];
         } else {
             if ($name == "StringId") {
-                $this->resourcePath = new EntityResourcePath($value, $this->getParentCollection()->getResourcePath());
+                $this->resourcePath = new EntityPath($value, $this->getParentCollection()->getResourcePath());
             }
         }
         return parent::setProperty($name, $value, $persistChanges);

diff --git a/src/SharePoint/ListItem.php b/src/SharePoint/ListItem.php
@@ -8,10 +8,11 @@
 use Office365\Runtime\Actions\InvokePostMethodQuery;
 use Office365\Runtime\ClientResult;
 use Office365\Runtime\ClientValueCollection;
-use Office365\Runtime\Paths\EntityResourcePath;
+use Office365\Runtime\Paths\EntityPath;
 use Office365\Runtime\ResourcePath;
 use Office365\Runtime\ServerTypeInfo;
 use Office365\SharePoint\Taxonomy\TaxonomyFieldValue;
+use Office365\SharePoint\Taxonomy\TaxonomyFieldValueCollection;
 
 /**
  * Specifies 
@@ -448,13 +449,13 @@ public function setProperty($name, $value, $persistChanges = true)
             parent::setProperty("{$name}Id", $value->LookupId, true);
             parent::setProperty($name, $value, false);
         }
-        elseif($value instanceof TaxonomyFieldValue){
+        elseif($value instanceof TaxonomyFieldValue || $value instanceof TaxonomyFieldValueCollection){
            $this->setTaxonomyFieldValue($name, $value);
         }
         else{
             parent::setProperty($name, $value, $persistChanges);
         }
-        if($name == "Id" && $this->resourcePath instanceof  EntityResourcePath){
+        if($name == "Id" && $this->resourcePath instanceof  EntityPath){
             $this->resourcePath->setKey($value);
         }
         return $this;

diff --git a/src/SharePoint/Publishing/VideoItem.php b/src/SharePoint/Publishing/VideoItem.php
@@ -5,8 +5,7 @@
  */
 namespace Office365\SharePoint\Publishing;
 
-use Office365\Runtime\Paths\EntityResourcePath;
-use Office365\Runtime\ResourcePath;
+use Office365\Runtime\Paths\EntityPath;
 use Office365\Runtime\Http\HttpMethod;
 use Office365\Runtime\Http\RequestOptions;
 use Office365\Runtime\ServerTypeInfo;
@@ -38,7 +37,7 @@ function setProperty($name, $value, $persistChanges = true)
     {
         if ($name == "ID") {
             if (is_null($this->getResourcePath())) {
-                $this->resourcePath = new EntityResourcePath($value, $this->getParentCollection()->getResourcePath());
+                $this->resourcePath = new EntityPath($value, $this->getParentCollection()->getResourcePath());
             }
         }
         parent::setProperty($name, $value, $persistChanges);

diff --git a/src/SharePoint/SPList.php b/src/SharePoint/SPList.php
@@ -8,7 +8,7 @@
 use Office365\Runtime\Actions\CreateEntityQuery;
 use Office365\Runtime\Actions\InvokeMethodQuery;
 use Office365\Runtime\Actions\InvokePostMethodQuery;
-use Office365\Runtime\Paths\EntityResourcePath;
+use Office365\Runtime\Paths\EntityPath;
 use Office365\Runtime\Paths\ServiceOperationPath;
 use Office365\Runtime\ResourcePath;
 use Office365\Runtime\ServerTypeInfo;
@@ -36,7 +36,7 @@ class SPList extends SecurableObject
     public function addItem(array $listItemCreationInformation)
     {
         $items = new ListItemCollection($this->getContext(), new ResourcePath("items", $this->getResourcePath()));
-        $listItem = new ListItem($this->getContext(), new EntityResourcePath(null,$items->getResourcePath()));
+        $listItem = new ListItem($this->getContext(), new EntityPath(null,$items->getResourcePath()));
         $listItem->setProperty("ParentList", $this, false);
         $items->addChild($listItem);
         foreach ($listItemCreationInformation as $key => $value) {

diff --git a/src/SharePoint/Taxonomy/TaxonomyFieldValueCollection.php b/src/SharePoint/Taxonomy/TaxonomyFieldValueCollection.php
@@ -0,0 +1,30 @@
+<?php
+
+
+namespace Office365\SharePoint\Taxonomy;
+
+
+use Office365\Runtime\ClientValueCollection;
+use Office365\Runtime\ServerTypeInfo;
+
+class TaxonomyFieldValueCollection extends ClientValueCollection
+{
+
+    public function __construct($values)
+    {
+        parent::__construct(TaxonomyFieldValue::class);
+        foreach ($values as $value)
+            $this->addChild($value);
+    }
+
+    public function __toString()
+    {
+        return implode(';#', $this->getData());
+    }
+
+    public function getServerTypeInfo()
+    {
+        return null;
+    }
+
+}
diff --git a/tests/common/ResourcePathTest.php b/tests/common/ResourcePathTest.php
@@ -2,7 +2,7 @@
 
 namespace Office365;
 
-use Office365\Runtime\Paths\EntityResourcePath;
+use Office365\Runtime\Paths\EntityPath;
 use Office365\Runtime\Paths\ServiceOperationPath;
 use Office365\Runtime\Paths\ResourcePathUrl;
 use Office365\Runtime\ResourcePath;
@@ -19,7 +19,7 @@ function testCreateEntitySetPath(){
     }
 
     function testCreateSingleEntityPath(){
-        $path = new EntityResourcePath(1, new ResourcePath("SiteUsers",new ResourcePath("Web")));
+        $path = new EntityPath(1, new ResourcePath("SiteUsers",new ResourcePath("Web")));
         self::assertEquals("/Web/SiteUsers(1)",$path->toUrl());
     }