Planner API new types and methods

Author: vgrem

src/Directory/Groups/Group.php

@@ -7,13 +7,16 @@
 
 use Office365\Directory\DirectoryObject;
 use Office365\Directory\Licenses\LicenseProcessingState;
+use Office365\Directory\Users\User;
+use Office365\EntityCollection;
 use Office365\OneDrive\Drives\Drive;
 use Office365\OneDrive\Drives\DriveCollection;
 use Office365\OneDrive\Sites\SiteCollection;
 use Office365\OneNote\Onenote;
 use Office365\Outlook\Calendars\Calendar;
 use Office365\Outlook\ProfilePhoto;
 use Office365\Planner\PlannerGroup;
+use Office365\Runtime\Actions\InvokePostMethodQuery;
 use Office365\Runtime\ResourcePath;
 use Office365\Teams\Team;
 
@@ -23,6 +26,32 @@
 class Group extends DirectoryObject
 {
 
+    /**
+     @param string $uid
+     * Add members
+     */
+    public function addMember($uid)
+    {
+        $payload = [
+            "@odata.id" => "https://graph.microsoft.com/v1.0/directoryObjects/{$uid}",
+        ];
+        $qry = new InvokePostMethodQuery($this->getMembers(),"\$ref",null,null, $payload);
+        $this->getContext()->addQuery($qry);
+        return $this;
+    }
+
+    /**
+     * @param User $user
+     * @return $this
+     */
+    public function addMemberUser(User $user): Group
+    {
+        $user->ensureProperty("Id",function () use($user){
+            $this->addMember($user->getId());
+        });
+        return $this;
+    }
+
     /**
      * Create a new team under a group.
      */
@@ -35,7 +64,7 @@ public function addTeam(){
      * Describes a classification for the group (such as low, medium or high business impact). Valid values for this property are defined by creating a ClassificationList [setting](groupsetting.md) value, based on the [template definition](groupsettingtemplate.md).<br><br>Returned by default.
      * @return string
      */
-    public function getClassification()
+    public function getClassification(): string
     {
         return $this->getProperty("Classification");
     }
@@ -520,4 +549,26 @@ public function setHideFromAddressLists($value)
     {
         $this->setProperty("HideFromAddressLists", $value, true);
     }
+
+    /**
+     * List group members
+     * @return EntityCollection
+     */
+    public function getMembers()
+    {
+        return $this->getProperty("members",
+            new EntityCollection($this->getContext(),
+                new ResourcePath("members",$this->getResourcePath()),DirectoryObject::class));
+    }
+
+    /**
+     * List group owners
+     * @return EntityCollection
+     */
+    public function getOwners()
+    {
+        return $this->getProperty("owners",
+            new EntityCollection($this->getContext(),
+                new ResourcePath("owners",$this->getResourcePath()),DirectoryObject::class));
+    }
 }

src/Directory/Users/UserCollection.php

@@ -5,6 +5,7 @@
 
 
 use Office365\EntityCollection;
+use Office365\Runtime\ClientObject;
 use Office365\Runtime\ClientRuntimeContext;
 use Office365\Runtime\ResourcePath;
 
@@ -16,4 +17,15 @@ public function __construct(ClientRuntimeContext $ctx, ?ResourcePath $resourcePa
         parent::__construct($ctx, $resourcePath, User::class);
     }
 
+    /**
+     * @param string $value User principal name
+     * @return User
+     */
+    function getByUserPrincipalName($value)
+    {
+        /** @var User $user */
+        $user = $this->createType(new ResourcePath($value, $this->getResourcePath()));
+        return $user;
+    }
+
 }

src/GraphServiceClient.php

@@ -11,6 +11,7 @@
 use Office365\OneDrive\DriveItems\DriveItem;
 use Office365\OneDrive\Drives\DriveCollection;
 use Office365\OneDrive\Sites\Site;
+use Office365\Planner\Planner;
 use Office365\Reports\ReportRoot;
 use Office365\Runtime\Auth\AADTokenProvider;
 use Office365\Runtime\Auth\ClientCredential;
@@ -163,6 +164,15 @@ public function getGroupSettings(){
         return new EntityCollection($this,new ResourcePath("groupSettings"), GroupSetting::class);
     }
 
+    /**
+     *  Entry-point to the Planner resource. Read-only.
+     * @return Planner
+     */
+    public function getPlanner()
+    {
+        return new Planner($this, new ResourcePath("planner"));
+    }
+
     /**
      * @return TeamCollection
      */

src/Planner/Planner.php

@@ -6,7 +6,18 @@
 namespace Office365\Planner;
 
 use Office365\Entity;
+use Office365\Planner\Plans\PlannerPlanCollection;
+use Office365\Runtime\ResourcePath;
 
 class Planner extends Entity
 {
+    /**
+     * @return PlannerPlanCollection
+     */
+    public function getPlans()
+    {
+        return $this->getProperty("plans",
+            new PlannerPlanCollection($this->getContext(),
+                new ResourcePath("plans", $this->getResourcePath()), $this));
+    }
 }

src/Planner/Plans/PlannerPlan.php

@@ -7,12 +7,22 @@
 
 use Office365\Directory\Identities\IdentitySet;
 use Office365\Entity;
+use Office365\Runtime\Http\RequestOptions;
 use Office365\Runtime\ResourcePath;
 /**
  * The **plannerPlan** resource represents a plan in Office 365. A plan can be owned by a [group](group.md) and contains a collection of [plannerTasks](plannertask.md). It can also have a collection of [plannerBuckets](plannerbucket.md). Each plan object has a [details](plannerplandetails.md) object that can contain more information about the plan. For more information about the relationships between groups, plans, and tasks, see [Planner](planner-overview.md).
  */
 class PlannerPlan extends Entity
 {
+
+    /**
+     * @return string
+     */
+    public function getEtag()
+    {
+        return $this->getProperty("Etag");
+    }
+
     /**
      * Read-only. The user who created the plan.
      * @return IdentitySet
@@ -70,4 +80,13 @@ public function getDetails()
         return $this->getProperty("Details",
             new PlannerPlanDetails($this->getContext(),new ResourcePath("Details", $this->getResourcePath())));
     }
+
+    public function deleteObject()
+    {
+        parent::deleteObject();
+        $this->getContext()->getPendingRequest()->beforeExecuteRequestOnce(function (RequestOptions $request) {
+            $request->Headers["If-Match"] = $this->getEtag();
+        });
+        return $this;
+    }
 }

src/Planner/Plans/PlannerPlanCollection.php

@@ -5,7 +5,6 @@
 
 use Office365\EntityCollection;
 use Office365\Runtime\ClientRuntimeContext;
-use Office365\Runtime\Http\RequestOptions;
 use Office365\Runtime\ResourcePath;
 
 class PlannerPlanCollection extends EntityCollection {
@@ -32,12 +31,9 @@ public function __construct(ClientRuntimeContext $ctx, ?ResourcePath $resourcePa
     public function create($title){
         /** @var PlannerPlan $returnType */
         $containerUrl = $this->getContainerUrl();
-        $returnType = $this->add();
+        $returnType = $this->getContext()->getPlanner()->getPlans()->add();
         $returnType->setTitle($title);
         $returnType->setProperty("container", ["url" => $containerUrl]);
-        $this->getContext()->getPendingRequest()->beforeExecuteRequestOnce(function (RequestOptions $request){
-            $request->Url = $this->getContext()->getServiceRootUrl() . "/planner/plans";
-        });
         return $returnType;
     }
 

src/Runtime/OData/ODataRequest.php

@@ -264,7 +264,7 @@ private function nextProperty($json, $format)
      * @param ODataFormat $format
      * @return bool
      */
-    private function isValidProperty($key,$value,$format)
+    private function isValidProperty(&$key,$value,$format)
     {
         if ($format instanceof JsonLightFormat) {
             if (is_array($value) && array_key_exists($format->DeferredTag, $value))
@@ -274,6 +274,12 @@ private function isValidProperty($key,$value,$format)
             );
             return !in_array($key, $propsToExclude);
         } else if ($format instanceof JsonFormat) {
+
+            if ($key === "$format->ControlFamilyTag.etag"){
+                $key = "etag";
+                return true;
+            }
+
             return fnmatch("$format->ControlFamilyTag.*", $key) !== true
                 && fnmatch("*$format->ControlFamilyTag.*", $key) !== true
                 && fnmatch("$format->TypeTag.*", $key) !== true

src/SharePoint/OneDriveItemCollection.php

@@ -5,10 +5,6 @@
  */
 namespace Office365\SharePoint;
 
-use Office365\Runtime\ClientObject;
-use Office365\Runtime\Actions\DeleteEntityQuery;
-use Office365\Runtime\ResourcePath;
-use Office365\Runtime\Actions\UpdateEntityQuery;
 class OneDriveItemCollection extends BaseEntity
 {
 }

tests/directory/GroupsTest.php

@@ -0,0 +1,64 @@
+<?php
+
+namespace Office365;
+
+
+use Office365\Directory\Groups\Group;
+use Office365\Runtime\Http\RequestException;
+
+class GroupsTest extends GraphTestCase
+{
+
+    /**
+     * @var Group
+     */
+    private static $targetGroup;
+
+    public function testCreateM365Group()
+    {
+        $grpName = "TestGroup_" . rand(1, 100000);
+        self::$targetGroup = self::$graphClient->getGroups()->createM365($grpName)->executeQuery();
+        self::assertNotNull(self::$targetGroup->getResourcePath());
+    }
+
+    public function testListGroups()
+    {
+        $result = self::$graphClient->getGroups()->get()->top(10)->executeQuery();
+        self::assertNotNull($result->getResourcePath());
+        self::assertNotEmpty($result->getData());
+    }
+
+
+    public function testListOwners()
+    {
+        $result = self::$targetGroup->getOwners()->get()->top(10)->executeQuery();
+        self::assertNotNull($result->getResourcePath());
+        self::assertNotEmpty($result->getData());
+    }
+
+    public function testAddMember()
+    {
+        $user = self::$graphClient->getUsers()->getByUserPrincipalName(self::$testAccountName);
+        $result = self::$targetGroup->addMemberUser($user)->executeQuery();
+        self::assertNotNull($result->getResourcePath());
+    }
+
+    public function testListMembers()
+    {
+        $result = self::$targetGroup->getMembers()->get()->top(10)->executeQuery();
+        self::assertNotNull($result->getResourcePath());
+        self::assertNotEmpty($result->getData());
+    }
+
+
+    public function testDeleteGroup()
+    {
+        self::$targetGroup->deleteObject()->executeQuery();
+
+        $this->expectException(RequestException::class);
+        $this->expectExceptionCode(404);
+        self::$targetGroup->get()->executeQuery();
+    }
+
+
+}

tests/planner/PlannerTest.php

@@ -6,6 +6,7 @@
 use Office365\Directory\Groups\Group;
 use Office365\GraphTestCase;
 use Office365\Planner\Plans\PlannerPlan;
+use Office365\Runtime\Http\RequestException;
 
 class PlannerTest extends GraphTestCase
 {
@@ -18,7 +19,11 @@ public static function setUpBeforeClass(): void
     {
         $grpName = "TestGroup_" . rand(1, 100000);
         parent::setUpBeforeClass();
+
         self::$targetGroup = self::$graphClient->getGroups()->createM365($grpName)->executeQuery();
+        $user = self::$graphClient->getMe();
+        self::$targetGroup->addMemberUser($user)->executeQuery();
+        sleep(3);
     }
 
     public static function tearDownAfterClass(): void
@@ -40,13 +45,13 @@ public function testGetMyTasks()
         self::assertNotNull($result->getResourcePath());
     }
 
-    /*public function testCreateGroupPlan()
+    public function testCreateGroupPlan()
     {
         $planTitle = "TestPlan_" . rand(1, 100000);
         $result = self::$targetGroup->getPlanner()->getPlans()->create($planTitle)->executeQuery();
         self::assertNotNull($result->getResourcePath());
         return $result;
-    }*/
+    }
 
     public function testGetGroupPlans()
     {
@@ -58,9 +63,13 @@ public function testGetGroupPlans()
      * @depends testCreateGroupPlan
      * @param PlannerPlan $plan
      */
-    /*public function testDeleteGroupPlan(PlannerPlan $plan)
+    public function testDeleteGroupPlan(PlannerPlan $plan)
     {
         $plan->deleteObject()->executeQuery();
-    }*/
+
+        $this->expectException(RequestException::class);
+        $this->expectExceptionCode(404);
+        $plan->get()->executeQuery();
+    }
 
 }