Planner API new types and methods, introduced unit tests

Author: vgrem

examples/Planner/ExportPlans.php …mples/Planner/GetAssignedTasksReport.phpexamples/Planner/ExportPlans.php renamed to examples/Planner/GetAssignedTasksReport.php examples/Planner/ExportPlans.php renamed to examples/Planner/GetAssignedTasksReport.php

@@ -15,6 +15,7 @@
 use Office365\Directory\Groups\Group;
 use Office365\GraphServiceClient;
 use Office365\Planner\Plans\PlannerPlan;
+use Office365\Planner\Tasks\PlannerTask;
 
 require_once '../vendor/autoload.php';
 
@@ -26,12 +27,33 @@
 
 /** @var Group $grp */
 foreach ($groups as $grp) {
-    echo sprintf("\nProcessing group: %s \n", $grp->getProperty("DisplayName"));
+    $groupName = $grp->getProperty("DisplayName");
+    echo "\nChecking group: {$groupName}\n";
+
     $plans = $grp->getPlanner()->getPlans()->get()->executeQuery();
 
     /** @var PlannerPlan $plan */
     foreach ($plans as $plan) {
-        echo sprintf("\tPlan: %s \n", $plan->getProperty("Title"));
+        $planName = $plan->getProperty("Title");
+        echo "  - Plan: {$planName}\n";
+
+        // Get all tasks in this plan
+        $tasks = $plan->getTasks()->get()->executeQuery();
+
+        /** @var PlannerTask $task */
+        foreach ($tasks as $task) {
+            $assignments = $task->getAssignments();
+
+            // Check each assignment to see if it matches our target users
+            foreach ($assignments as $userId => $assignment) {
+
+                echo "  - Assignment: {$userId}\n";
+
+            }
+        }
+
+
+
     }
 }
 

src/Planner/PlannerUser.php

@@ -6,8 +6,7 @@
 namespace Office365\Planner;
 
 use Office365\Entity;
-use Office365\EntityCollection;
-use Office365\Planner\Plans\PlannerPlan;
+use Office365\Planner\Plans\PlannerPlanCollection;
 use Office365\Planner\Tasks\PlannerTaskCollection;
 use Office365\Runtime\ResourcePath;
 
@@ -24,12 +23,12 @@ public function getTasks()
     }
 
     /**
-     * @return EntityCollection
+     * @return PlannerPlanCollection
      */
     public function getPlans()
     {
         return $this->getProperty("Plans",
-            new EntityCollection($this->getContext(),
-                new ResourcePath("Plans", $this->getResourcePath()),PlannerPlan::class));
+            new PlannerPlanCollection($this->getContext(),
+                new ResourcePath("Plans", $this->getResourcePath()),$this));
     }
 }

src/Planner/Plans/PlannerPlanCollection.php

@@ -30,14 +30,13 @@ public function __construct(ClientRuntimeContext $ctx, ?ResourcePath $resourcePa
      */
     public function create($title){
         /** @var PlannerPlan $returnType */
-        $containerUrl = $this->getContainerUrl();
         $returnType = $this->getContext()->getPlanner()->getPlans()->add();
         $returnType->setTitle($title);
-        $returnType->setProperty("container", ["url" => $containerUrl]);
+        $returnType->setProperty("container", $this->getContainer());
         return $returnType;
     }
 
-    public function getContainerUrl()
+    public function getContainer()
     {
         if ($this->parent === null) {
             throw new \RuntimeException("Parent resource is not available");
@@ -48,7 +47,7 @@ public function getContainerUrl()
             $resourceUrl = substr($resourceUrl, 0, -8);
         }
 
-        return $resourceUrl;
+        return ["url" => $resourceUrl];
     }
 
 }

src/Planner/Tasks/PlannerTaskCollection.php

@@ -2,15 +2,58 @@
 
 namespace Office365\Planner\Tasks;
 
+use Office365\Entity;
 use Office365\EntityCollection;
+use Office365\Planner\Plans\PlannerPlan;
 use Office365\Runtime\ClientRuntimeContext;
 use Office365\Runtime\ResourcePath;
 
 class PlannerTaskCollection extends EntityCollection {
 
-    public function __construct(ClientRuntimeContext $ctx, ?ResourcePath $resourcePath = null)
+    /**
+     * @var Entity|null
+     */
+    private $parent;
+
+    public function __construct(ClientRuntimeContext $ctx, ?ResourcePath $resourcePath = null, ?Entity $parent=null)
     {
         parent::__construct($ctx, $resourcePath, PlannerTask::class);
+        $this->parent = $parent;
+    }
+
+    /**
+     * Create a new plannerTask.
+     * @param string $title
+     * @param string|null $planId
+     * @param string|null $bucketId
+     * @param array $assignments
+     * @return PlannerTask
+     * @throws \Exception
+     */
+    public function create($title, $planId=null, $bucketId=null, $assignments=[]){
+        /** @var PlannerTask $returnType */
+        if ($this->parent === null && $planId === null) {
+            throw new \Exception("planId is mandatory when creating a task without a parent");
+        }
+
+        $returnType = $this->getContext()->getPlanner()->getTasks()->add();
+        $returnType->setTitle($title);
+
+        if ($this->parent instanceof PlannerPlan) {
+            $this->parent->ensureProperty("Id", function () use ($returnType) {
+                $returnType->setProperty("planId", $this->parent->getId());
+            });
+        }
+        else {
+            $returnType->setProperty("planId", null);
+        }
+
+
+        $returnType->setProperty("bucketId", null);
+        if (!empty($assignments)) {
+            $returnType->setProperty("assignments", $assignments);
+        }
+        return $returnType;
     }
 
 }

tests/planner/PlannerTasksTest.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace Office365;
+
+
+use Office365\Directory\Groups\Group;
+use Office365\GraphTestCase;
+use Office365\Planner\Plans\PlannerPlan;
+use Office365\Runtime\Http\RequestException;
+
+class PlannerTasksTest extends GraphTestCase
+{
+
+    /**
+     * @var PlannerPlan
+     */
+    private static $targetPlan;
+
+    public static function setUpBeforeClass(): void
+    {
+        $title = "TestPlan_" . rand(1, 100000);
+        parent::setUpBeforeClass();
+        $currentUser = self::$graphClient->getUsers()->getByUserPrincipalName(self::$settings['UserName']);
+        self::$targetPlan = $currentUser->getPlanner()->getPlans()->create($title)->executeQuery();
+    }
+
+    public static function tearDownAfterClass(): void
+    {
+        self::$targetPlan->deleteObject()->executeQuery();
+        parent::tearDownAfterClass();
+    }
+
+    public function testCreateMyTask()
+    {
+        $result =  self::$targetPlan->getTasks()->create("Update client list")->executeQuery();
+        self::assertNotNull($result->getResourcePath());
+    }
+
+
+    public function testGetMyTasks()
+    {
+        $result = self::$targetPlan->getTasks()->get()->executeQuery();
+        self::assertNotNull($result->getResourcePath());
+        self::assertNotEmpty($result->getData());
+    }
+
+}

tests/planner/PlannerTest.php

@@ -23,7 +23,7 @@ public static function setUpBeforeClass(): void
         self::$targetGroup = self::$graphClient->getGroups()->createM365($grpName)->executeQuery();
         $user = self::$graphClient->getMe();
         self::$targetGroup->addMemberUser($user)->executeQuery();
-        sleep(3);
+        sleep(5);
     }
 
     public static function tearDownAfterClass(): void
@@ -38,13 +38,6 @@ public function testGetMyPlans()
         self::assertNotNull($result->getResourcePath());
     }
 
-
-    public function testGetMyTasks()
-    {
-        $result = self::$graphClient->getMe()->getPlanner()->getTasks()->get()->executeQuery();
-        self::assertNotNull($result->getResourcePath());
-    }
-
     public function testCreateGroupPlan()
     {
         $planTitle = "TestPlan_" . rand(1, 100000);