add new function to update manually

Author: koderzi

README.md

@@ -64,6 +64,7 @@ To initialize the Updater class and start the update process, follow these steps
         array|null $releaseExclusions  = ['path' => [], 'filename' => []],
         bool $clear = true,
         string $dir = ""
+        bool $autoUpdate = true
     );
 ```
 
@@ -77,6 +78,7 @@ To initialize the Updater class and start the update process, follow these steps
 > `$releaseExclusions` (Optional) An array of directories or files in the release to exclude from the update.<br>
 > `$clear` (Optional) Clear the downloaded file after the update has completed if set to true.<br>
 > `$dir` (Optional) Set the directory of the update. Default to current working dir.
+> `$autoUpdate` (Optional) Whether or not to automatically update the project. Defaults to true.
 
 > The exclusions array keys:
 
@@ -92,22 +94,33 @@ To initialize the Updater class and start the update process, follow these steps
     ]
 ```
 
-If a new release is available, the class will update your project automatically. 
+To check the release version, use the following code:
+
+```
+    $update->release();
+```
+
+If a new release is available, the class will update your project automatically.
+To update manually, set $autoUpdate to false and use the following code to start update:
+
+```
+    $update->update();
+```
 
 To check the status of the update, use the following code:
- 
+
 ```
     $update->status();
 ```
 
 The update status can have the following int values:
 
-> `Updater::STARTED` (100): Indicates that the update has started.<br>
+> `Updater::INIT` (100): Indicates that update class has been initialized.<br>
 > `Updater::UPDATED` (200): Indicates that the update was successful.<br>
 > `Updater::LATEST` (204): Indicates that the project is already up to date.<br>
 > `Updater::ERROR` (500): Indicates that the update failed.<br>
-> `Updater::BUSY` (504): Indicates that an update process is already in progress.<br>
+> `Updater::BUSY` (504): Indicates that an update process is in progress.<br>
 
 ## Conclusion
 
-The GitHub Release Updater is a simple and efficient way to keep your project up-to-date with the latest releases on GitHub. It is easy to use and can save you a lot of time and effort. If you have any questions or issues, please feel free to contact us.
+The GitHub Release Updater is a simple and efficient way to keep your project up-to-date with the latest releases on GitHub. It is easy to use and can save you a lot of time and effort. If you have any questions or issues, please feel free create an issue.

src/Updater.php

@@ -6,7 +6,7 @@
 
 final class Updater
 {
-    const STARTED = 100;
+    const INIT = 100;
     const UPDATED = 200;
     const LATEST = 204;
     const ERROR = 500;
@@ -23,12 +23,12 @@ final class Updater
     private $dir;
     private $exclude = [];
     private $log = [];
-    private $status;
+    private $status = self::ERROR;
     private $clear;
     private $archive_relative_paths;
 
     /**
-     * Constructs a new instance of the class and starts the update process for the provided version.
+     * Constructs a new instance of the updater class.
      *
      * @param string $username Your GitHub username.
      * @param string $repository The name of your GitHub repository.
@@ -42,12 +42,13 @@ final class Updater
      * @param array|null $releaseExclusions (Optional) An array of directories or files in the release to exclude from the update. The array keys:
      *      'path' => an array of release excluded paths
      *      'filename' => an array of release excluded filenames
+     * @param bool $clear (Optional) Whether or not to clear the downloaded file. Defaults to true.
+     * @param string $dir (Optional) The directory where the update will occur. Defaults to current working directory.
+     * @param bool $autoUpdate (Optional) Whether or not to automatically update the project. Defaults to true.
      * @return void
      */
-    public function __construct(string $username, string $repository, string $token, string $version, string|null $admin = '', string|null $mailer = '', array|null $sourceExclusions  = ['path' => [], 'filename' => []], array|null $releaseExclusions  = ['path' => [], 'filename' => []], bool $clear = true, $dir = "")
+    public function __construct(string $username, string $repository, string $token, string $version, string|null $admin = '', string|null $mailer = '', array|null $sourceExclusions  = ['path' => [], 'filename' => []], array|null $releaseExclusions  = ['path' => [], 'filename' => []], bool $clear = true, $dir = "", $autoUpdate = true)
     {
-        $this->status = $this::STARTED;
-
         if ($admin == null) {
             $this->admin = '';
         }
@@ -63,6 +64,7 @@ public function __construct(string $username, string $repository, string $token,
         if (!isset($sourceExclusions['path'])) {
             $sourceExclusions['path'] = [];
         }
+
         if (!isset($sourceExclusions['filename'])) {
             $sourceExclusions['filename'] = [];
         }
@@ -93,22 +95,18 @@ public function __construct(string $username, string $repository, string $token,
             $this->dir = getcwd();
         }
 
-        $update = $this->Install();
+        $this->status = $this::INIT;
 
-        if ($update == $this::ERROR) {
-            if ($this->admin != '' && $this->mailer != '') {
-                $this->Mail();
-            }
+        if ($autoUpdate) {
+            $this->update();
         }
-        $this->Log();
-        $this->status = $update;
     }
 
     /**
      * Retrieves the status of the updater.
      *
      * @return int One of the following status codes:
-     *  - `STARTED` (100): Indicates that the update has started.
+     *  - `INIT` (100): Indicates that update class has been initialized.
      *  - `UPDATED` (200): Indicates that the update was successful.
      *  - `LATEST` (204): Indicates that the project is already up to date.
      *  - `ERROR` (500): Indicates that the update failed.
@@ -119,6 +117,38 @@ public function status()
         return $this->status;
     }
 
+    /**
+     * Retrieves the release version.
+     *
+     * @return mixed The release version if the information retrieved successfully, otherwise false.
+     */
+    public function release()
+    {
+        if ($this->Download()) {
+            return $this->release;
+        } else {
+            return false;
+        }
+    }
+
+    /**
+     * Executes update.
+     *
+     * @return void
+     */
+    public function update()
+    {
+        $update = $this->Install();
+
+        if ($update == $this::ERROR) {
+            if ($this->admin != '' && $this->mailer != '') {
+                $this->Mail();
+            }
+        }
+        $this->Log();
+        $this->status = $update;
+    }
+
     private function Log()
     {
         $log = implode("\n", array_map(function ($entry) {