GITBOOK-3: Update doc

Pavlusha311245 · gitbook-bot · commit 536d7b89c112 · 2023-07-16T08:48:05.000Z
diff --git a/docs/README.md b/docs/README.md
@@ -12,8 +12,8 @@ This project allows developers to interact with the Nginx Unit web server throug
 
 You can easy start work with SDK with Quick start guide below:
 
-{% content-ref url="quick-start-in-development.md" %}
-[quick-start-in-development.md](quick-start-in-development.md)
+{% content-ref url="quick-start.md" %}
+[quick-start.md](quick-start.md)
 {% endcontent-ref %}
 
 ## Want to learn SDK deeper?
@@ -23,3 +23,13 @@ Dive a deeper and start exploring our SDK API reference:
 {% content-ref url="reference/api-reference/" %}
 [api-reference](reference/api-reference/)
 {% endcontent-ref %}
+
+## Changelog
+
+More information about changes you can see here
+
+## Contribution
+
+More info about contribution you can read [here](https://docs.github.com/en/get-started/quickstart/contributing-to-projects)
+
+## _THIS PACKAGE IN DEVELOPMENT DON'T USE IT IN PRODUCTION_
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
@@ -1,15 +1,23 @@
 # Table of contents
 
 * [Welcome!](README.md)
-* [Quick Start (In development)](quick-start-in-development.md)
+* [Quick Start](quick-start.md)
 
 ## Reference
 
 * [API Reference](reference/api-reference/README.md)
-  * [Unit](reference/api-reference/unit.md)
-  * [Statistics](reference/api-reference/statistics.md)
-  * [Config (In development)](reference/api-reference/config-in-development.md)
-  * [Certificates (In development)](reference/api-reference/certificates-in-development.md)
-  * [Listeners (In development)](reference/api-reference/listeners-in-development.md)
-  * [Routes (In development)](reference/api-reference/routes-in-development.md)
-  * [Applications (In development)](reference/api-reference/applications-in-development.md)
+  * [Classes](reference/api-reference/classes/README.md)
+    * [Unit](reference/api-reference/classes/unit/README.md)
+      * [Statistic](reference/api-reference/classes/unit/statistic.md)
+      * [Config](reference/api-reference/classes/unit/config/README.md)
+        * [Listener](reference/api-reference/classes/unit/config/listener.md)
+        * [Route (In development)](reference/api-reference/classes/unit/config/route-in-development/README.md)
+          * [RouteBlock (In development)](reference/api-reference/classes/unit/config/route-in-development/routeblock-in-development/README.md)
+            * [RouteAction](reference/api-reference/classes/unit/config/route-in-development/routeblock-in-development/routeaction.md)
+            * [RouteMatch](reference/api-reference/classes/unit/config/route-in-development/routeblock-in-development/routematch.md)
+        * [Application (In development)](reference/api-reference/classes/unit/config/application-in-development.md)
+      * [Certificate (In development)](reference/api-reference/classes/unit/certificate-in-development.md)
+  * [Interfaces](reference/api-reference/interfaces/README.md)
+    * [UnitInterface](reference/api-reference/interfaces/unitinterface.md)
+    * [ConfigInterface](reference/api-reference/interfaces/configinterface.md)
+    * [StatisticInterface](reference/api-reference/interfaces/statisticinterface.md)
diff --git a/docs/quick-start-in-development.md b/docs/quick-start-in-development.md
diff --git a/docs/quick-start.md b/docs/quick-start.md
@@ -0,0 +1,22 @@
+---
+description: This page wants help you to start using package
+---
+
+# Quick Start
+
+## Pre-requirements
+
+* PHP >= 8.2
+* PHP curl extension
+* [Composer](https://getcomposer.org/download/) >= 2
+
+## Installation
+
+1. Create folder `mkdir example-php-project`
+2. Open folder `cd example-php-project`
+3. Init composer `composer init`
+4. Add package `composer require pavlusha311245/unit-php-sdk`
+
+Congratulations. You installed package. Now you can use the full power of this SDK.&#x20;
+
+#### Happy coding 😊
diff --git a/docs/reference/api-reference/applications-in-development.md b/docs/reference/api-reference/applications-in-development.md
diff --git a/docs/reference/api-reference/classes/README.md b/docs/reference/api-reference/classes/README.md
@@ -0,0 +1,2 @@
+# Classes
+
diff --git a/docs/reference/api-reference/classes/unit/README.md b/docs/reference/api-reference/classes/unit/README.md
@@ -0,0 +1,39 @@
+---
+description: This is main class of Nginx Unit manipulation
+---
+
+# Unit
+
+## Properties
+
+### string $socket (Private readonly)
+
+Contains path to socket
+
+### string $address (Private readonly)
+
+Contains http path
+
+## Methods:
+
+### `__construct(string $socket, string $address)`
+
+### `getSocket()`
+
+_Return type: String_
+
+### `getAddress()`
+
+_Return type: String_
+
+### `getConfig()`
+
+_Return type:_ [_Config_](config/)
+
+### `getStatistics()`
+
+_Return type:_ [_Statistic_](statistic.md)
+
+### `getCertificates()`
+
+_Return type:_ [_Certificate_](certificate-in-development.md)
diff --git a/docs/reference/api-reference/classes/unit/certificate-in-development.md b/docs/reference/api-reference/classes/unit/certificate-in-development.md
diff --git a/docs/reference/api-reference/classes/unit/config/README.md b/docs/reference/api-reference/classes/unit/config/README.md
@@ -0,0 +1,69 @@
+---
+description: This class contains Nginx Unit config data
+---
+
+# Config
+
+## Properties
+
+### $\_listeners (Private)
+
+Contains array of values
+
+### $\_routes (Private)
+
+Contains array of values
+
+### $\_applications (Private)
+
+Contains array of values
+
+### $\_upstreams (Private)
+
+Contains array of values
+
+## Methods
+
+### `__construct(array $data)`
+
+_Return type: Void_
+
+### `getListeners()`
+
+_Return type: Array_
+
+### `getApplications()`
+
+_Return type: Array_
+
+### `getApplication($applicationName)`
+
+Params:
+
+* $applicationName - Existing application name from Nginx Unit config
+
+_Return type:_ [_Application_](application-in-development.md)
+
+### `getRoutes()`
+
+_Return type: Array_
+
+### `getRoute($routeName)`
+
+Params:
+
+* $routeName - Existing route name from Nginx Unit config
+
+_Return type:_ [_Route_](route-in-development/)
+
+### `getUpstreams()`
+
+_Return type: Mixed_
+
+### `setApplicationLogPath($path) - (In development)`
+
+### `setApplicationLogFormat($format) - (In development)`
+
+### `toArray()`
+
+_Return type: Array_
diff --git a/docs/reference/api-reference/classes/unit/config/application-in-development.md b/docs/reference/api-reference/classes/unit/config/application-in-development.md
@@ -0,0 +1,6 @@
+---
+description: This class presents "application" section from config
+---
+
+# Application (In development)
+
diff --git a/docs/reference/api-reference/classes/unit/config/listener.md b/docs/reference/api-reference/classes/unit/config/listener.md
@@ -0,0 +1,41 @@
+---
+description: This class presents "listeners" section from config
+---
+
+# Listener
+
+## Properties:
+
+### string $\_link (Private)
+
+Contains generated link
+
+### array $\_pass (Private)
+
+Contains divided pass value
+
+### int $\_port (Private)
+
+Contains port from pass key
+
+## Methods:
+
+### `__construct( private string $_listener, string $pass = '', private array $_tls = [], private array $_forwarded = [], )`
+
+### `getLink()`
+
+### `generateLink()`
+
+### `parsePort() (Private)`
+
+### `getPort()`
+
+### `getForwarded()`
+
+### `getPass()`
+
+### `getTls()`
+
+### `getListener()`
+
+### `parseFromArray()`
diff --git a/docs/reference/api-reference/classes/unit/config/route-in-development/README.md b/docs/reference/api-reference/classes/unit/config/route-in-development/README.md
@@ -0,0 +1,19 @@
+---
+description: This class presents "routes" section from config
+---
+
+# Route (In development)
+
+## Properties
+
+### $\_routeBlocks (Private)
+
+### $\_listeners (Private)
+
+## Methods
+
+### `__construct()`
+
+### `setListener()`
+
+### `getListeners()`
diff --git a/docs/reference/api-reference/classes/unit/config/route-in-development/routeblock-in-development/README.md b/docs/reference/api-reference/classes/unit/config/route-in-development/routeblock-in-development/README.md
@@ -0,0 +1,2 @@
+# RouteBlock (In development)
+
diff --git a/docs/reference/api-reference/classes/unit/config/route-in-development/routeblock-in-development/routeaction.md b/docs/reference/api-reference/classes/unit/config/route-in-development/routeblock-in-development/routeaction.md
@@ -0,0 +1,2 @@
+# RouteAction
+
diff --git a/docs/reference/api-reference/classes/unit/config/route-in-development/routeblock-in-development/routematch.md b/docs/reference/api-reference/classes/unit/config/route-in-development/routeblock-in-development/routematch.md
@@ -0,0 +1,2 @@
+# RouteMatch
+
diff --git a/docs/reference/api-reference/classes/unit/statistic.md b/docs/reference/api-reference/classes/unit/statistic.md
diff --git a/docs/reference/api-reference/config-in-development.md b/docs/reference/api-reference/config-in-development.md
diff --git a/docs/reference/api-reference/interfaces/README.md b/docs/reference/api-reference/interfaces/README.md
@@ -0,0 +1,6 @@
+---
+description: Here you can find SDK interfaces
+---
+
+# Interfaces
+
diff --git a/docs/reference/api-reference/interfaces/configinterface.md b/docs/reference/api-reference/interfaces/configinterface.md
@@ -0,0 +1,23 @@
+# ConfigInterface
+
+
+
+```php
+public function getListeners();
+
+public function getRoutes();
+
+public function getRoute($routeName);
+
+public function getApplications();
+
+public function getApplication($applicationName);
+
+public function getUpstreams();
+
+public function setApplicationLogPath($path);
+
+public function setApplicationLogFormat($format);
+
+public function toArray(): array;
+```
diff --git a/docs/reference/api-reference/interfaces/statisticinterface.md b/docs/reference/api-reference/interfaces/statisticinterface.md
@@ -0,0 +1,11 @@
+# StatisticInterface
+
+
+
+```php
+public function getConnections();
+
+public function getRequests();
+
+public function getApplications();
+```
diff --git a/docs/reference/api-reference/interfaces/unitinterface.md b/docs/reference/api-reference/interfaces/unitinterface.md
@@ -0,0 +1,15 @@
+# UnitInterface
+
+
+
+```php
+public function getSocket(): string;
+
+public function getAddress(): string;
+
+public function getConfig(): ConfigInterface;
+
+public function getStatistics(): StatisticsInterface;
+
+public function getCertificates(): array;
+```
diff --git a/docs/reference/api-reference/listeners-in-development.md b/docs/reference/api-reference/listeners-in-development.md
diff --git a/docs/reference/api-reference/routes-in-development.md b/docs/reference/api-reference/routes-in-development.md
diff --git a/docs/reference/api-reference/unit.md b/docs/reference/api-reference/unit.md

-Original file line number
+Diff line change
@@ @@ -0,0 +1,6 @@ @@
 +---
 +description: This class presents "application" section from config
 +---
++
 +# Application (In development)
++