Planner API examples updates

Author: vgrem

examples/Planner/GetSharedTasksReport.php

@@ -1,14 +1,19 @@
 <?php
 
 /**
+ * Planner Plan and Task Report
  *
- * Description:
- * - List all groups containing Planner plans
- * - Identify plans accessible to the specific group
- * - Extract all tasks from qualifying plans
+ * This script:
+ * 1. Retrieves all Planner plans associated with the group
+ * 2. Extracts all tasks for each plan with relevant details
+ * 3. Returns structured JSON output containing plans with their tasks
  *
- * Permissions:
- * Accessing group plans requires both Group.Read.All and Tasks.Read.All permissions.
+ * Required Permissions:
+ * - Group.Read.All (to read group information)
+ * - Tasks.Read.All (to read Planner tasks)
+ *
+ * Note: The service principal/app registration must have these permissions granted
+ * with admin consent in the Azure AD portal.
  */
 
 
@@ -21,13 +26,19 @@
 $settings = include('../../tests/Settings.php');
 $client = GraphServiceClient::withClientSecret($settings['TenantName'], $settings['ClientId'], $settings['ClientSecret']);
 
+$groupName = "TestSharedGroup";
 
 // 1. Get the specific group
 $groups = $client->getGroups()
-    ->filter("displayName eq 'PlanGroup'")
+    ->filter("displayName eq '$groupName'")
     ->get()
     ->executeQuery();
 
+if (count($groups->getData()) === 0) {
+    throw new Exception("Group '$groupName' not found");
+}
+
+
 // 2. Get all plans in this group
 $plans = $groups[0]->getPlanner()
     ->getPlans()

examples/Reports/getReports.php

@@ -12,7 +12,7 @@
 var_dump($result->getValue());
 
 $result = $client->getReports()->getOffice365ActiveUserDetail("D7")->executeQuery();
-var_dump($result->getValue());
+var_dump($result->getValue()->toJson());
 
 
 

generator/GenerateModel.php

@@ -140,7 +140,7 @@ function syncSharePointMetadataFile($fileName){
 
 try {
 
-    $modelName = "MicrosoftGraph";
+    $modelName = "SharePoint";
     if (count($argv) > 1)
         $modelName = $argv[1];
 

src/EntityCollection.php

@@ -14,14 +14,24 @@
  */
 class EntityCollection extends ClientObjectCollection
 {
+    /**
+     * @var Entity|null
+     */
+    private $parent;
+
     /**
      * @param ClientRuntimeContext $ctx
      * @param ResourcePath|null $resourcePath
      * @param null $itemTypeName
      */
-    public function __construct(ClientRuntimeContext $ctx, ?ResourcePath $resourcePath = null, $itemTypeName = null)
+    public function __construct(ClientRuntimeContext $ctx, ?ResourcePath $resourcePath = null, $itemTypeName = null, $parent=null)
     {
         parent::__construct($ctx, $resourcePath, $itemTypeName);
+        $this->parent = $parent;
+    }
+
+    public function getParent(){
+        return $this->parent;
     }
 
     /**

src/Planner/Buckets/PlannerBucket.php

@@ -6,9 +6,12 @@
 namespace Office365\Planner\Buckets;
 
 use Office365\Entity;
+use Office365\Planner\Tasks\PlannerTaskCollection;
+use Office365\Runtime\ResourcePath;
 
 /**
- * The **plannerBucket** resource represents a bucket (or "custom column") for tasks in a plan in Office 365. It is contained in a [plannerPlan](plannerplan.md) and can have a collection of [plannerTasks](plannertask.md).
+ * The **plannerBucket** resource represents a bucket (or "custom column") for tasks in a plan in Office 365.
+ * It is contained in a [plannerPlan](plannerplan.md) and can have a collection of [plannerTasks](plannertask.md).
  */
 class PlannerBucket extends Entity
 {
@@ -63,4 +66,14 @@ public function setOrderHint($value)
     {
         $this->setProperty("OrderHint", $value, true);
     }
+
+    /**
+     * @return PlannerTaskCollection
+     */
+    public function getTasks()
+    {
+        return $this->getProperty("Tasks",
+            new PlannerTaskCollection($this->getContext(),
+                new ResourcePath("Tasks", $this->getResourcePath()), $this));
+    }
 }

src/Planner/Buckets/PlannerBucketCollection.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Office365\Planner\Buckets;
+
+use Office365\Entity;
+use Office365\EntityCollection;
+use Office365\Runtime\ClientRuntimeContext;
+use Office365\Runtime\ResourcePath;
+
+class PlannerBucketCollection extends EntityCollection
+{
+    public function __construct(ClientRuntimeContext $ctx, ?ResourcePath $resourcePath = null, ?Entity $parent=null)
+    {
+        parent::__construct($ctx, $resourcePath, PlannerBucket::class, $parent);
+    }
+
+}

src/Planner/Planner.php

@@ -6,6 +6,7 @@
 namespace Office365\Planner;
 
 use Office365\Entity;
+use Office365\Planner\Buckets\PlannerBucketCollection;
 use Office365\Planner\Plans\PlannerPlanCollection;
 use Office365\Planner\Tasks\PlannerTaskCollection;
 use Office365\Runtime\ResourcePath;
@@ -31,4 +32,14 @@ public function getTasks()
             new PlannerTaskCollection($this->getContext(),
                 new ResourcePath("Tasks", $this->getResourcePath()), $this));
     }
+
+    /**
+     * @return PlannerBucketCollection
+     */
+    public function getBuckets()
+    {
+        return $this->getProperty("Buckets",
+            new PlannerBucketCollection($this->getContext(),
+                new ResourcePath("Buckets", $this->getResourcePath()), $this));
+    }
 }

src/Planner/Plans/PlannerPlan.php

@@ -7,6 +7,7 @@
 
 use Office365\Directory\Identities\IdentitySet;
 use Office365\Entity;
+use Office365\Planner\Buckets\PlannerBucketCollection;
 use Office365\Planner\Tasks\PlannerTaskCollection;
 use Office365\Runtime\Http\RequestOptions;
 use Office365\Runtime\ResourcePath;
@@ -92,6 +93,16 @@ public function getTasks()
                 new ResourcePath("Tasks", $this->getResourcePath()), $this));
     }
 
+    /**
+     * @return PlannerBucketCollection
+     */
+    public function getBuckets()
+    {
+        return $this->getProperty("Buckets",
+            new PlannerBucketCollection($this->getContext(),
+                new ResourcePath("Buckets", $this->getResourcePath()), $this));
+    }
+
     /**
      * @return $this
      */

src/Planner/Plans/PlannerPlanCollection.php

@@ -9,15 +9,9 @@
 
 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;
+        parent::__construct($ctx, $resourcePath, PlannerPlan::class, $parent);
     }
 
     /**
@@ -36,12 +30,16 @@ public function create($title){
         return $returnType;
     }
 
+    /**
+     * Returns the container of the plan.
+     * @return array
+     */
     public function getContainer()
     {
-        if ($this->parent === null) {
+        if ($this->getParent() === null) {
             throw new \RuntimeException("Parent resource is not available");
         }
-        $resourceUrl = $this->parent->getResourceUrl();
+        $resourceUrl = $this->getParent()->getResourceUrl();
 
         if (str_ends_with($resourceUrl, '/Planner')) {
             $resourceUrl = substr($resourceUrl, 0, -8);

src/SharePoint/AgreementsSolutionFileContext.php

@@ -1,7 +1,7 @@
 <?php
 
 /**
- * Generated  2025-08-15T21:03:47+00:00 16.0.26330.12011
+ * Generated  2025-08-17T18:16:20+00:00 16.0.26330.12012
  */
 namespace Office365\SharePoint;
 
@@ -72,4 +72,28 @@ class AgreementsSolutionFileContext extends ClientValue
      * @var string
      */
     public $WebUrl;
+    /**
+     * @var EffectiveBasePermissions
+     */
+    public $EffectiveBasePermissions;
+    /**
+     * @var LibraryDetails
+     */
+    public $FieldLibrary;
+    /**
+     * @var LibraryDetails
+     */
+    public $ModernTemplateLibrary;
+    /**
+     * @var LibraryDetails
+     */
+    public $ParentLibrary;
+    /**
+     * @var LibraryDetails
+     */
+    public $SnippetLibrary;
+    /**
+     * @var DestinationLibraryInfo
+     */
+    public $TargetLibrary;
 }