Merge pull request #54 from resohead/sitemap

support sitemap report

src/Actions/ManagesSitemaps.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace OhDear\PhpSdk\Actions;
+
+use OhDear\PhpSdk\Resources\SitemapResult;
+use OhDear\PhpSdk\Resources\SitemapIndex;
+use OhDear\PhpSdk\Resources\SitemapIssue;
+use OhDear\PhpSdk\Resources\Sitemap;
+
+trait ManagesSitemaps
+{
+    public function sitemap(int $siteId)
+    {
+        $response = $this->get("sitemap/{$siteId}") ?? [];
+
+        $issues = $this->transformCollection($response['issues'], SitemapIssue::class);
+        $sitemapIndexes = $this->transformCollection($response['sitemapIndexes'], SitemapIndex::class);
+        $sitemaps = $this->transformCollection($response['sitemaps'], Sitemap::class);
+
+        $response['issues'] = $issues;
+        $response['sitemapIndexes'] = $sitemapIndexes;
+        $response['sitemaps'] = $sitemaps;
+
+        return new SitemapResult($response);
+    }
+}

src/OhDear.php

@@ -21,6 +21,7 @@
 use OhDear\PhpSdk\Actions\ManagesStatusPageUpdates;
 use OhDear\PhpSdk\Actions\ManagesUptime;
 use OhDear\PhpSdk\Actions\ManagesUsers;
+use OhDear\PhpSdk\Actions\ManagesSitemaps;
 
 class OhDear
 {
@@ -41,6 +42,7 @@ class OhDear
     use ManagesSites;
     use ManagesStatusPages;
     use ManagesStatusPageUpdates;
+    use ManagesSitemaps;
     use ManagesUptime;
     use ManagesUsers;
 

src/Resources/Sitemap.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace OhDear\PhpSdk\Resources;
+
+class Sitemap extends ApiResource
+{
+    public string $url;
+
+    public int $urlCount;
+
+    public bool $checkedReachabilityOfAllUrls;
+
+    public int $issuesCount;
+
+    /**
+     * @var array<SitemapIssue>
+     */
+    public array $issues;
+}

src/Resources/SitemapIndex.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace OhDear\PhpSdk\Resources;
+
+class SitemapIndex extends ApiResource
+{
+    public string $url;
+
+    /**
+     * @var array<SitemapIssue>
+     */
+    public array $issues;
+}

src/Resources/SitemapIssue.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace OhDear\PhpSdk\Resources;
+
+class SitemapIssue extends ApiResource
+{
+    public string $name;
+
+    public ?string $url;
+
+    public ?int $responseCode;
+
+    public function __construct(mixed $attributes, $ohDear = null)
+    {
+        parent::__construct($attributes, $ohDear);
+    }
+}

src/Resources/SitemapResult.php

@@ -0,0 +1,49 @@
+<?php
+
+namespace OhDear\PhpSdk\Resources;
+
+class SitemapResult extends ApiResource
+{
+    /*
+     * The url that is checked.
+     */
+    public string $checkUrl;
+
+    /*
+     * The total number of issues found.
+     */
+    public int $totalIssuesCount;
+
+    /*
+     * The total number of urls found.
+     */
+    public int $totalUrlCount;
+
+    /*
+     * Whether there are issues found.
+     */
+    public bool $hasIssues;
+
+    /*
+     * A list of issues found.
+     * @return array<int, SitemapIssue>
+     */
+    public array $issues;
+
+    /*
+     * The sitemap indexes found along with any issues.
+     * @return array<int, SitemapIndex>
+     */
+    public array $sitemapIndexes;
+
+    /*
+     * The sitemaps found.
+     * @return array<int, Sitemap>
+     */
+    public array $sitemaps;
+
+    public function __construct(mixed $attributes, $ohDear = null)
+    {
+        parent::__construct($attributes, $ohDear);
+    }
+}