Planner API examples

Author: vgrem

examples/Planner/GetAssignedTasksReport.php

@@ -0,0 +1,74 @@
+<?php
+
+/**
+ *
+ * Description:
+ * - List all groups containing Planner plans
+ * - Identify plans accessible to the specific group
+ * - Extract all tasks from qualifying plans
+ *
+ * Permissions:
+ * Accessing group plans requires both Group.Read.All and Tasks.Read.All permissions.
+ */
+
+
+use Office365\GraphServiceClient;
+use Office365\Planner\Plans\PlannerPlan;
+use Office365\Planner\Tasks\PlannerTask;
+
+require_once '../vendor/autoload.php';
+
+$settings = include('../../tests/Settings.php');
+$client = GraphServiceClient::withClientSecret($settings['TenantName'], $settings['ClientId'], $settings['ClientSecret']);
+
+
+// 1. Get the specific group
+$groups = $client->getGroups()
+    ->filter("displayName eq 'PlanGroup'")
+    ->get()
+    ->executeQuery();
+
+// 2. Get all plans in this group
+$plans = $groups[0]->getPlanner()
+    ->getPlans()
+    ->get()
+    ->executeQuery();
+
+$allPlansWithTasks = [];
+
+/** @var PlannerPlan $plan */
+foreach ($plans as $plan) {
+    try {
+        // 3. Get all tasks for each plan
+        $tasks = $plan->getTasks()
+            ->get()
+            ->executeQuery();
+
+        $planData = [
+            'plan_id' => $plan->getId(),
+            'plan_title' => $plan->getTitle(),
+            //'plan_created' => $plan->getOwner()->getCreatedDateTime(),
+            'tasks' => []
+        ];
+
+        /** @var PlannerTask $task */
+        foreach ($tasks as $task) {
+            $planData['tasks'][] = [
+                'task_id' => $task->getId(),
+                'task_title' => $task->getTitle(),
+                'assignments' => $task->getAssignments(),
+                'created_date' => $task->getCreatedDateTime(),
+                'completed_date' => $task->getCompletedDateTime(),
+            ];
+        }
+
+        $allPlansWithTasks[] = $planData;
+
+    } catch (\Exception $e) {
+        echo "Error processing plan {$plan->getTitle()}: {$e->getMessage()}\n";
+        continue;
+    }
+}
+
+// Output the results
+echo json_encode($allPlansWithTasks, JSON_PRETTY_PRINT);

examples/Planner/GetSharedTasksReport.php

@@ -8,4 +8,33 @@
 use Office365\Runtime\ClientValue;
 class PlannerUserIds extends ClientValue
 {
+
+    /**
+     * Checks if the object is empty (has no GUIDs set)
+     * @return bool
+     */
+    public function isEmpty(): bool
+    {
+        foreach ($this as $value) {
+            if ($value === true) {
+                return false;
+            }
+        }
+        return true;
+    }
+
+    /**
+     * Returns array of all User Ids
+     * @return array
+     */
+    public function getIds(): array
+    {
+        $guids = [];
+        foreach ($this as $guid => $value) {
+            if ($value === true) {
+                $guids[] = $guid;
+            }
+        }
+        return $guids;
+    }
 }

src/Planner/PlannerUserIds.php

@@ -6,7 +6,6 @@
 namespace Office365\Planner\Plans;
 
 use Office365\Entity;
-use Office365\Planner\PlannerCategoryDescriptions;
 use Office365\Planner\PlannerUserIds;
 
 /**

src/Planner/Plans/PlannerPlanDetails.php

@@ -16,6 +16,23 @@
  */
 class PlannerTask extends Entity
 {
+
+    /**
+     * @return string
+     */
+    public function getCreatedDateTime()
+    {
+        return $this->getProperty("CreatedDateTime");
+    }
+
+    /**
+     * @return string
+     */
+    public function getCompletedDateTime()
+    {
+        return $this->getProperty("CompletedDateTime");
+    }
+
     /**
      * Identity of the user that created the task.
      * @return IdentitySet

src/Planner/Tasks/PlannerTask.php

@@ -5,6 +5,7 @@
 use Office365\Entity;
 use Office365\EntityCollection;
 use Office365\Planner\Plans\PlannerPlan;
+use Office365\Runtime\Actions\CreateEntityQuery;
 use Office365\Runtime\ClientRuntimeContext;
 use Office365\Runtime\ResourcePath;
 
@@ -36,23 +37,28 @@ public function create($title, $planId=null, $bucketId=null, $assignments=[]){
             throw new \Exception("planId is mandatory when creating a task without a parent");
         }
 
-        $returnType = $this->getContext()->getPlanner()->getTasks()->add();
+        $returnType = new PlannerTask($this->getContext());
+        $this->getContext()->getPlanner()->getTasks()->addChild($returnType);
+
         $returnType->setTitle($title);
+        $returnType->setProperty("bucketId", $bucketId);
+        if (!empty($assignments)) {
+            $returnType->setProperty("assignments", $assignments);
+        }
+
+        $qry = new CreateEntityQuery($returnType);
 
         if ($this->parent instanceof PlannerPlan) {
-            $this->parent->ensureProperty("Id", function () use ($returnType) {
+            $this->parent->ensureProperty("Id", function () use ($qry, $returnType) {
                 $returnType->setProperty("planId", $this->parent->getId());
+                $this->getContext()->addQueryAndResultObject($qry,$returnType);
             });
         }
         else {
-            $returnType->setProperty("planId", null);
+            $returnType->setProperty("planId", $planId);
+            $this->getContext()->addQueryAndResultObject($qry,$returnType);
         }
 
-
-        $returnType->setProperty("bucketId", null);
-        if (!empty($assignments)) {
-            $returnType->setProperty("assignments", $assignments);
-        }
         return $returnType;
     }
 

src/Planner/Tasks/PlannerTaskCollection.php

@@ -0,0 +1,55 @@
+<?php
+
+namespace Office365;
+
+
+use Office365\Directory\Groups\Group;
+use Office365\GraphTestCase;
+use Office365\Planner\Plans\PlannerPlan;
+use Office365\Runtime\Http\RequestException;
+
+class PlannerPlansTest extends GraphTestCase
+{
+
+
+
+    public function testCreateUserPlan ()
+    {
+        $title = "TestUserPlan_" . rand(1, 100000);
+        $user = self::$graphClient->getUsers()->getByUserPrincipalName(self::$settings['UserName']);
+        $result = $user->getPlanner()->getPlans()->create($title)->executeQuery();
+        self::assertNotNull($result->getResourcePath());
+        return $result;
+    }
+
+    public function testListUserPlans()
+    {
+        $user = self::$graphClient->getUsers()->getByUserPrincipalName(self::$settings['UserName']);
+        $result = $user->getPlanner()->getPlans()->get()->executeQuery();
+        self::assertNotNull($result->getResourcePath());
+    }
+
+    /**
+     * @depends testCreateUserPlan
+     * @param PlannerPlan $plan
+     */
+    public function testGetUserPlan(PlannerPlan $plan)
+    {
+        $result = $plan->getDetails()->get()->executeQuery();
+        self::assertNotNull($result->getResourcePath());
+    }
+
+    /**
+     * @depends testCreateUserPlan
+     * @param PlannerPlan $plan
+     */
+    public function testDeleteUserPlan(PlannerPlan $plan)
+    {
+        $plan->deleteObject()->executeQuery();
+
+        $this->expectException(RequestException::class);
+        $this->expectExceptionCode(404);
+        $plan->get()->executeQuery();
+    }
+
+}

tests/planner/PlannerPlansTest.php

@@ -20,8 +20,8 @@ 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();
+        $user = self::$graphClient->getUsers()->getByUserPrincipalName(self::$settings['UserName']);
+        self::$targetPlan = $user->getPlanner()->getPlans()->create($title)->executeQuery();
     }
 
     public static function tearDownAfterClass(): void

tests/planner/PlannerTasksTest.php

@@ -32,12 +32,6 @@ public static function tearDownAfterClass(): void
        parent::tearDownAfterClass();
     }
 
-    public function testGetMyPlans()
-    {
-        $result = self::$graphClient->getMe()->getPlanner()->getPlans()->get()->executeQuery();
-        self::assertNotNull($result->getResourcePath());
-    }
-
     public function testCreateGroupPlan()
     {
         $planTitle = "TestPlan_" . rand(1, 100000);