Add comments

Author: Pavlusha311245

README.md

@@ -1,8 +1,8 @@
-# PHP SDK for Nginx Unit 
+# PHP SDK for Nginx Unit
 
-## Installation
+_THIS PROJECT IN DEVELOPMENT. DON'T USE IT IN PRODUCTION_
 
+## Quick start
 ```shell
-composer install
+composer require pavlusha311245/unit-php-sdk
 ```
-

src/Config.php

@@ -18,6 +18,8 @@ class Config implements ConfigInterface
     private array $_upstreams;
 
     /**
+     * Constructor
+     *
      * @throws \Exception
      */
     public function __construct(array $data)
@@ -45,26 +47,53 @@ public function __construct(array $data)
         $this->_upstreams = $data['upstreams'] ?? [];
     }
 
+    /**
+     * Get listeners from config
+     *
+     * @return array
+     */
     public function getListeners(): array
     {
         return $this->_listeners ?? [];
     }
 
+    /**
+     * Get applications from config
+     *
+     * @return array
+     */
     public function getApplications(): array
     {
         return $this->_applications;
     }
 
+    /**
+     * Get application from config by name
+     *
+     * @param $applicationName
+     * @return mixed
+     */
     public function getApplication($applicationName)
     {
         return $this->_applications[$applicationName];
     }
 
+    /**
+     * Get routes from config
+     *
+     * @return array
+     */
     public function getRoutes(): array
     {
         return $this->_routes;
     }
 
+    /**
+     * Get route from config by name
+     *
+     * @param $routeName
+     * @return mixed
+     */
     public function getRoute($routeName)
     {
         return $this->_routes[$routeName];
@@ -78,6 +107,11 @@ public function getUpstreams(): mixed
         return $this->_upstreams;
     }
 
+    /**
+     * Return config as array
+     *
+     * @return array
+     */
     public function toArray(): array
     {
         return [

src/Config/Application.php

@@ -28,7 +28,7 @@ class Application
 
     private $_data;
 
-    private array $_arguments;
+    private array $_arguments = [];
 
     private array $_listeners = [];
 
@@ -37,6 +37,7 @@ public function __construct($applicationName, $applicationData)
         $this->_name = $applicationName;
         $this->_type = $applicationData['type'];
         $this->_data = $applicationData;
+
         foreach ($this->_data as $key => $value) {
             $this->{"_{$key}"} = $value;
         }
@@ -47,7 +48,7 @@ public function __construct($applicationName, $applicationData)
      */
     public function getArguments(): array
     {
-        return $this->_arguments;
+        return array_values($this->_arguments);
     }
 
     public function getType(): string
@@ -56,7 +57,7 @@ public function getType(): string
     }
 
     /**
-     * @param  mixed  $listener
+     * @param mixed $listener
      */
     public function setListener(Listener $listener): void
     {

src/Interfaces/ConfigInterface.php

@@ -8,8 +8,12 @@ public function getListeners();
 
     public function getRoutes();
 
+    public function getRoute($routeName);
+
     public function getApplications();
 
+    public function getApplication($applicationName);
+
     public function getUpstreams();
 
     public function toArray(): array;

src/UnitRequest.php

@@ -8,7 +8,10 @@ class UnitRequest
 
     private $_data = null;
 
-    public function __construct(private string $socket, private string $address)
+    public function __construct(
+        private string $socket,
+        private string $address
+    )
     {
         //
     }