Planner API new types and methods

Author: vgrem

src/Directory/Groups/Group.php

@@ -7,11 +7,11 @@
 
 use Office365\Directory\DirectoryObject;
 use Office365\Directory\Licenses\LicenseProcessingState;
-use Office365\OneDrive\Drive;
-use Office365\OneDrive\DriveCollection;
-use Office365\OneDrive\SiteCollection;
+use Office365\OneDrive\Drives\Drive;
+use Office365\OneDrive\Drives\DriveCollection;
+use Office365\OneDrive\Sites\SiteCollection;
 use Office365\OneNote\Onenote;
-use Office365\Outlook\Calendar;
+use Office365\Outlook\Calendars\Calendar;
 use Office365\Outlook\ProfilePhoto;
 use Office365\Planner\PlannerGroup;
 use Office365\Runtime\ResourcePath;

src/Directory/Groups/GroupCollection.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace Office365\Directory\Groups;
+
+use Office365\EntityCollection;
+use Office365\Runtime\ClientRuntimeContext;
+use Office365\Runtime\ResourcePath;
+
+class GroupCollection extends EntityCollection
+{
+
+    public function __construct(ClientRuntimeContext $ctx, ?ResourcePath $resourcePath = null)
+    {
+        parent::__construct($ctx, $resourcePath, Group::class);
+    }
+
+    /**
+     * Create a Microsoft 365 group
+     * @param $displayName
+     * @param string|null $mailNickName
+     * @param string|null $description
+     * @return Group
+     */
+    public function createM365($displayName, $mailNickName=null, $description=null){
+        /** @var Group $returnType */
+        $returnType = $this->add();
+        $returnType->setDisplayName($displayName);
+        $returnType->setMailNickname($mailNickName ?? $displayName);
+        $returnType->setMailEnabled(true);
+        $returnType->setGroupTypes(["Unified"]);
+        $returnType->setSecurityEnabled(false);
+        $returnType->setDescription($description ?? $displayName);
+        return $returnType;
+    }
+
+}

src/GraphServiceClient.php

@@ -4,7 +4,7 @@
 
 
 use Office365\Directory\Applications\Application;
-use Office365\Directory\Groups\Group;
+use Office365\Directory\Groups\GroupCollection;
 use Office365\Directory\Groups\GroupSetting;
 use Office365\Directory\Users\User;
 use Office365\Directory\Users\UserCollection;
@@ -150,10 +150,10 @@ public function getUsers(){
     }
 
     /**
-     * @return EntityCollection
+     * @return GroupCollection
      */
     public function getGroups(){
-        return new EntityCollection($this,new ResourcePath("groups"), Group::class);
+        return new GroupCollection($this,new ResourcePath("groups"));
     }
 
     /**

src/Planner/PlannerGroup.php

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

src/Planner/PlannerUser.php

@@ -8,19 +8,19 @@
 use Office365\Entity;
 use Office365\EntityCollection;
 use Office365\Planner\Plans\PlannerPlan;
-use Office365\Planner\Tasks\PlannerTask;
+use Office365\Planner\Tasks\PlannerTaskCollection;
 use Office365\Runtime\ResourcePath;
 
 class PlannerUser extends Entity
 {
     /**
-     * @return EntityCollection
+     * @return PlannerTaskCollection
      */
     public function getTasks()
     {
         return $this->getProperty("tasks",
-            new EntityCollection($this->getContext(),
-                new ResourcePath("tasks", $this->getResourcePath()),PlannerTask::class));
+            new PlannerTaskCollection($this->getContext(),
+                new ResourcePath("tasks", $this->getResourcePath())));
     }
 
     /**

src/Planner/Plans/PlannerPlanCollection.php

@@ -0,0 +1,58 @@
+<?php
+
+namespace Office365\Planner\Plans;
+
+
+use Office365\EntityCollection;
+use Office365\Runtime\ClientRuntimeContext;
+use Office365\Runtime\Http\RequestOptions;
+use Office365\Runtime\ResourcePath;
+
+class PlannerPlanCollection extends EntityCollection {
+
+    /**
+     * @var mixed|null
+     */
+    private $parent;
+
+    public function __construct(ClientRuntimeContext $ctx, ?ResourcePath $resourcePath = null, $parent=null)
+    {
+        parent::__construct($ctx, $resourcePath, PlannerPlan::class);
+        $this->parent = $parent;
+    }
+
+    /**
+     * Create a new plannerPlan object.
+     * Note: If the container is a Microsoft 365 group, the user who creates the plan must be a member of the group
+     * that contains the plan. When you create a new group by using Create group, you aren't added to the group
+     * as a member. After the group is created, add yourself as a member by using group post members.
+     * @param $title
+     * @return PlannerPlan
+     */
+    public function create($title){
+        /** @var PlannerPlan $returnType */
+        $containerUrl = $this->getContainerUrl();
+        $returnType = $this->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;
+    }
+
+    public function getContainerUrl()
+    {
+        if ($this->parent === null) {
+            throw new \RuntimeException("Parent resource is not available");
+        }
+        $resourceUrl = $this->parent->getResourceUrl();
+
+        if (str_ends_with($resourceUrl, '/Planner')) {
+            $resourceUrl = substr($resourceUrl, 0, -8);
+        }
+
+        return $resourceUrl;
+    }
+
+}

src/Planner/Tasks/PlannerTaskCollection.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Office365\Planner\Tasks;
+
+use Office365\EntityCollection;
+use Office365\Runtime\ClientRuntimeContext;
+use Office365\Runtime\ResourcePath;
+
+class PlannerTaskCollection extends EntityCollection {
+
+    public function __construct(ClientRuntimeContext $ctx, ?ResourcePath $resourcePath = null)
+    {
+        parent::__construct($ctx, $resourcePath, PlannerTask::class);
+    }
+
+}

tests/planner/PlannerTest.php

@@ -3,11 +3,29 @@
 namespace Office365\planner;
 
 
+use Office365\Directory\Groups\Group;
 use Office365\GraphTestCase;
+use Office365\Planner\Plans\PlannerPlan;
 
 class PlannerTest extends GraphTestCase
 {
+    /**
+     * @var Group
+     */
+    private static $targetGroup;
 
+    public static function setUpBeforeClass(): void
+    {
+        $grpName = "TestGroup_" . rand(1, 100000);
+        parent::setUpBeforeClass();
+        self::$targetGroup = self::$graphClient->getGroups()->createM365($grpName)->executeQuery();
+    }
+
+    public static function tearDownAfterClass(): void
+    {
+       self::$targetGroup->deleteObject()->executeQuery();
+       parent::tearDownAfterClass();
+    }
 
     public function testGetMyPlans()
     {
@@ -22,6 +40,27 @@ public function testGetMyTasks()
         self::assertNotNull($result->getResourcePath());
     }
 
+    /*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()
+    {
+        $result = self::$targetGroup->getPlanner()->getPlans()->get()->executeQuery();
+        self::assertNotNull($result->getResourcePath());
+    }
 
+    /**
+     * @depends testCreateGroupPlan
+     * @param PlannerPlan $plan
+     */
+    /*public function testDeleteGroupPlan(PlannerPlan $plan)
+    {
+        $plan->deleteObject()->executeQuery();
+    }*/
 
 }