feat: add site settings request (#5)

Author: Lyrisbee

src/Facades/WordPress.php

@@ -9,6 +9,7 @@
 use Storipress\WordPress\Requests\GeneralRequest;
 use Storipress\WordPress\Requests\Media;
 use Storipress\WordPress\Requests\Post;
+use Storipress\WordPress\Requests\Site;
 use Storipress\WordPress\Requests\Tag;
 use Storipress\WordPress\Requests\User;
 
@@ -19,19 +20,20 @@
  * @method static Category category()
  * @method static Tag tag()
  * @method static Media media()
+ * @method static Site site()
  * @method static \Storipress\WordPress\WordPress instance()
- * @method static \Storipress\WordPress\WordPress site()
- * @method static \Storipress\WordPress\WordPress setSite(string $site)
- * @method static \Storipress\WordPress\WordPress username()
+ * @method static string url()
+ * @method static \Storipress\WordPress\WordPress setUrl(string $url)
+ * @method static string username()
  * @method static \Storipress\WordPress\WordPress setUsername(string $username)
- * @method static \Storipress\WordPress\WordPress password()
+ * @method static string password()
  * @method static \Storipress\WordPress\WordPress setPassword(string $password)
- * @method static \Storipress\WordPress\WordPress userAgent()
+ * @method static string|null userAgent()
  * @method static \Storipress\WordPress\WordPress withUserAgent(string $userAgent)
- * @method static \Storipress\WordPress\WordPress prefix()
+ * @method static string prefix()
  * @method static \Storipress\WordPress\WordPress setPrefix(string $prefix)
  * @method static \Storipress\WordPress\WordPress prettyUrl()
- * @method static \Storipress\WordPress\WordPress isPrettyUrl()
+ * @method static bool isPrettyUrl()
  */
 class WordPress extends Facade
 {

src/Objects/Site.php

@@ -0,0 +1,48 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Storipress\WordPress\Objects;
+
+class Site extends WordPressObject
+{
+    public string $title;
+
+    public string $description;
+
+    public string $url;
+
+    public string $email;
+
+    public string $timezone;
+
+    public string $date_format;
+
+    public string $time_format;
+
+    public int $start_of_week;
+
+    public string $language;
+
+    public bool $use_smilies;
+
+    public int $default_category;
+
+    public string $default_post_format;
+
+    public int $posts_per_page;
+
+    public string $show_on_front;
+
+    public int $page_on_front;
+
+    public int $page_for_posts;
+
+    public string $default_ping_status;
+
+    public string $default_comment_status;
+
+    public ?int $site_logo;
+
+    public int $site_icon;
+}

src/Requests/GeneralRequest.php

@@ -61,15 +61,15 @@ public function getUrl(string $path, string $prefix, bool $pretty): string
         if ($pretty) {
             return sprintf(
                 '%s/%s/%s',
-                rtrim($this->app->site(), '/'),
+                rtrim($this->app->url(), '/'),
                 $prefix,
                 ltrim($path, '/'),
             );
         }
 
         return sprintf(
             '%s?rest_route=/%s',
-            rtrim($this->app->site(), '/'),
+            rtrim($this->app->url(), '/'),
             ltrim($path, '/'),
         );
     }

src/Requests/Request.php

@@ -105,7 +105,7 @@ public function getUrl(string $path, string $prefix, bool $pretty): string
         if ($pretty) {
             return sprintf(
                 '%s/%s/wp/%s/%s',
-                rtrim($this->app->site(), '/'),
+                rtrim($this->app->url(), '/'),
                 $prefix,
                 self::VERSION,
                 ltrim($path, '/'),
@@ -114,7 +114,7 @@ public function getUrl(string $path, string $prefix, bool $pretty): string
 
         return sprintf(
             '%s?rest_route=/wp/%s/%s',
-            rtrim($this->app->site(), '/'),
+            rtrim($this->app->url(), '/'),
             self::VERSION,
             ltrim($path, '/'),
         );

src/Requests/Site.php

@@ -0,0 +1,67 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Storipress\WordPress\Requests;
+
+use Storipress\WordPress\Exceptions\WordPressException;
+use Storipress\WordPress\Objects\Site as SiteObject;
+
+class Site extends Request
+{
+    /**
+     * https://developer.wordpress.org/rest-api/reference/settings/#retrieve-a-site-setting
+     *
+     *
+     * @throws WordPressException
+     */
+    public function retrieve(): SiteObject
+    {
+        $data = $this->request('get', '/settings');
+
+        if (is_array($data)) {
+            throw $this->unexpectedValueException();
+        }
+
+        return SiteObject::from($data);
+    }
+
+    /**
+     * https://developer.wordpress.org/rest-api/reference/settings/#update-a-site-setting
+     *
+     * @param array{
+     *     title?: string,
+     *     description?: string,
+     *     url?: string,
+     *     email?: string,
+     *     timezone?: string,
+     *     date_format?: string,
+     *     time_format?: string,
+     *     start_of_week?: int,
+     *     language?: string,
+     *     use_smilies?: bool,
+     *     default_category?: int,
+     *     default_post_format?: string,
+     *     posts_per_page?: int,
+     *     show_on_front?: string,
+     *     page_on_front?: int,
+     *     page_for_posts?: int,
+     *     default_ping_status?: string,
+     *     default_comment_status?: string,
+     *     site_logo?: int|null,
+     *     site_icon?: int,
+     * } $arguments
+     *
+     * @throws WordPressException
+     */
+    public function update(array $arguments): SiteObject
+    {
+        $data = $this->request('post', '/settings', $arguments);
+
+        if (is_array($data)) {
+            throw $this->unexpectedValueException();
+        }
+
+        return SiteObject::from($data);
+    }
+}

src/WordPress.php

@@ -9,6 +9,7 @@
 use Storipress\WordPress\Requests\GeneralRequest;
 use Storipress\WordPress\Requests\Media;
 use Storipress\WordPress\Requests\Post;
+use Storipress\WordPress\Requests\Site;
 use Storipress\WordPress\Requests\Tag;
 use Storipress\WordPress\Requests\User;
 
@@ -26,7 +27,9 @@ class WordPress
 
     protected readonly Media $media;
 
-    protected string $site;
+    protected readonly Site $site;
+
+    protected string $url;
 
     protected string $username;
 
@@ -52,21 +55,23 @@ public function __construct(
         $this->tag = new Tag($this);
 
         $this->media = new Media($this);
+
+        $this->site = new Site($this);
     }
 
     public function instance(): static
     {
         return $this;
     }
 
-    public function site(): string
+    public function url(): string
     {
-        return $this->site;
+        return $this->url;
     }
 
-    public function setSite(string $site): static
+    public function setUrl(string $url): static
     {
-        $this->site = $site;
+        $this->url = $url;
 
         return $this;
     }
@@ -160,4 +165,9 @@ public function media(): Media
     {
         return $this->media;
     }
+
+    public function site(): Site
+    {
+        return $this->site;
+    }
 }