SharePoint API: support for managing modern (communication) sites

Author: vgrem

examples/SharePoint/Sites/CreateModernSite.php

@@ -1,35 +1,22 @@
 <?php
 
-require_once __DIR__ . '../../vendor/autoload.php';
-$settings = include(__DIR__ . '../../../tests/Settings.php');
+require_once __DIR__ . '/../../vendor/autoload.php';
+$settings = include(__DIR__ . '/../../../tests/Settings.php');
 
 use Office365\Runtime\Auth\ClientCredential;
-use Office365\Runtime\Http\RequestOptions;
 use Office365\SharePoint\ClientContext;
+use Office365\SharePoint\Portal\SPSiteManager;
 
 try {
     $credentials = new ClientCredential($settings['ClientId'], $settings['ClientSecret']);
     $ctx = (new ClientContext($settings['Url']))->withCredentials($credentials);
 
-    $url = "{$ctx->getBaseUrl()}/_api/SPSiteManager/create";
-    $request = new RequestOptions($url);
-    $payload = array(
-        "request" => array(
-            "Title" => "Communication Site 1",
-            "Url" => "{$ctx->getBaseUrl()}/sites/commsite2",
-            "Lcid" => 1033,
-            "ShareByEmailEnabled" => false,
-            "Classification" => "Low Business Impact",
-            "Description" => "Description",
-            "WebTemplate" => "SITEPAGEPUBLISHING#0",
-            "SiteDesignId" => "6142d2a0-63a5-4ba0-aede-d9fefca2c767",
-            "Owner" => $settings['TestAccounts'][0]
-        )
-    );
-    $request->Data = json_encode($payload);
-    $resp = $ctx->getPendingRequest()->executeQueryDirect($request);
-    $json = json_decode($resp->getContent(), true);
-    print("Site has been created: {$json["d"]["Create"]["SiteUrl"]} \n");
+    $siteManager = new SPSiteManager($ctx);
+    //create communications site
+    //refer https://docs.microsoft.com/en-us/sharepoint/dev/apis/site-creation-rest for docs
+    $result = $siteManager->create("commsite127", $settings['TestAccountName'], "Low Business Impact");
+    $siteManager->executeQuery();
+    print("Site has been created: {$result->getValue()->SiteUrl} \n");
 }
 catch (Exception $e) {
     echo 'Failed: ',  $e->getMessage(), "\n";

src/Runtime/ClientRequest.php

@@ -90,11 +90,11 @@ public function getCurrentQuery(){
     /**
      * Add query into request queue
      * @param ClientAction $query
-     * @param bool $toBegin
+     * @param bool $executeFirst
      */
-    public function addQuery(ClientAction $query,$toBegin=false)
+    public function addQuery(ClientAction $query, $executeFirst=false)
     {
-        if($toBegin)
+        if($executeFirst)
             array_unshift($this->queries , $query);
         else
             $this->queries[] = $query;

src/Runtime/ClientResult.php

@@ -49,6 +49,9 @@ public function executeQuery(){
     }
 
 
+    /**
+     * @return bool|int|ClientObject|ClientValue|string|null
+     */
     public function getValue(){
         return $this->value;
     }

src/SharePoint/Portal/SPSiteCreationRequest.php

@@ -0,0 +1,54 @@
+<?php
+
+namespace Office365\SharePoint\Portal;
+
+use Office365\Runtime\ClientValue;
+
+class SPSiteCreationRequest extends ClientValue
+{
+
+    function getServerTypeName()
+    {
+        return "Microsoft.SharePoint.Portal.SPSiteCreationRequest";
+    }
+
+    /**
+     * @var string
+     */
+    public $Classification;
+
+    /**
+     * @var string
+     */
+    public $Url;
+
+    /**
+     * @var string
+     */
+    public $WebTemplate;
+    /**
+     * @var int
+     */
+    public $Lcid;
+    /**
+     * @var false
+     */
+    public $ShareByEmailEnabled;
+    /**
+     * @var string
+     */
+    public $SiteDesignId;
+    /**
+     * @var string
+     */
+    public $Title;
+    /**
+     * @var string
+     */
+    public $Description;
+    /**
+     * @var string
+     */
+    public $Owner;
+
+}

src/SharePoint/Portal/SPSiteCreationResponse.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Office365\SharePoint\Portal;
+
+use Office365\Runtime\ClientValue;
+
+class SPSiteCreationResponse extends ClientValue
+{
+    function getServerTypeName()
+    {
+        return "Microsoft.SharePoint.Portal.SPSiteCreationResponse";
+    }
+
+
+    /**
+     * @var string
+     */
+    public $SiteId;
+
+    /**
+     * @var string
+     */
+    public $SiteStatus;
+
+    /**
+     * @var string
+     */
+    public $SiteUrl;
+
+}

src/SharePoint/Portal/SPSiteManager.php

@@ -4,13 +4,54 @@
 namespace Office365\SharePoint\Portal;
 
 
+use Office365\Runtime\Actions\InvokePostMethodQuery;
+use Office365\Runtime\ClientResult;
+use Office365\Runtime\ResourcePath;
 use Office365\SharePoint\BaseEntity;
+use Office365\SharePoint\ClientContext;
 
 class SPSiteManager extends BaseEntity
 {
 
-    public function create(){
+    public function __construct(ClientContext $ctx)
+    {
+        parent::__construct($ctx,new ResourcePath("SPSiteManager"));
+    }
+
+    /**
+     * @param string $title
+     * @param string $owner
+     * @param string $classification
+     * @param int $lcid
+     * @return ClientResult
+     */
+    public function create($title, $owner=null, $classification=null, $lcid=1033){
+        $request = new SPSiteCreationRequest();
+        $request->Title = $title;
+        $request->Description = $title;
+        $request->Owner = $owner;
+        $request->Url = "{$this->getContext()->getBaseUrl()}/sites/{$title}";
+        $request->Lcid = $lcid;
+        $request->ShareByEmailEnabled = false;
+        $request->WebTemplate = "SITEPAGEPUBLISHING#0";
+        $request->SiteDesignId = "6142d2a0-63a5-4ba0-aede-d9fefca2c767";
+        $request->Classification = $classification;
+        $qry = new InvokePostMethodQuery($this,"Create",null, "request", $request);
+
+        $result = new ClientResult($this->context, new SPSiteCreationResponse());
+        $this->getContext()->addQueryAndResultObject($qry, $result);
+        return $result;
+    }
+
 
+    /**
+     * @param string $siteId
+     * @return $this
+     */
+    public function delete($siteId){
+        $qry = new InvokePostMethodQuery($this,"Delete",array($siteId));
+        $this->getContext()->addQuery($qry);
+        return $this;
     }
 
 

tests/sharepoint/SPSiteManagerTest.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Office365;
+
+use Office365\SharePoint\Portal\SPSiteCreationResponse;
+use Office365\SharePoint\Portal\SPSiteManager;
+
+class SPSiteManagerTest extends SharePointTestCase
+{
+    /**
+     * @var string
+     */
+    private static $targetSiteId;
+
+    public function testCreateCommunicationSite()
+    {
+        $siteManager = new SPSiteManager(self::$context);
+        $siteName = self::createUniqueName("CommSite");
+        self::assertNotNull($siteName);
+        $result = $siteManager->create($siteName,self::$settings["UserName"],"Low Business Impact");
+        self::$context->executeQuery();
+        self::assertInstanceOf(SPSiteCreationResponse::class, $result->getValue());
+        self::$targetSiteId = $result->getValue()->SiteId;
+    }
+
+    public function testDeleteCommunicationSite()
+    {
+        $siteManager = new SPSiteManager(self::$context);
+        $siteManager->delete(self::$targetSiteId)->executeQuery();
+    }
+
+}