Clean-up docs

valzargaming · valzargaming · commit 1a9e98007ac9 · 2025-03-25T10:08:39.000-04:00
diff --git a/src/VerifierServer/Endpoints/VerifiedEndpoint.php b/src/VerifierServer/Endpoints/VerifiedEndpoint.php
@@ -14,11 +14,11 @@ public function __construct(private PersistentState &$state)
     /**
      * Handles the incoming HTTP request and generates the appropriate response.
      *
-     * @param string $method The HTTP method of the request (e.g., 'GET', 'POST').
-     * @param ServerRequestInterface|string $request The request payload, typically used for 'POST' requests.
-     * @param string &$response The variable to store the generated response.
-     * @param array &$content_type The variable to store the content type of the response.
-     * @param string &$body The variable to store the body of the response.
+     * @param string                        $method        The HTTP method of the request (e.g., 'GET', 'POST').
+     * @param ServerRequestInterface|string $request       The request payload, typically used for 'POST' requests.
+     * @param string                        &$response     The variable to store the generated response.
+     * @param array                         &$content_type The variable to store the content type of the response.
+     * @param string                        &$body         The variable to store the body of the response.
      */
     public function handle(string $method, ServerRequestInterface|string $request, int|string &$response, array &$content_type, string &$body, bool $bypass_token = false): void
     {
@@ -41,9 +41,9 @@ public function handle(string $method, ServerRequestInterface|string $request, i
     /**
      * Handles the GET request and prepares the response.
      *
-     * @param string &$response The response string to be sent back to the client.
-     * @param array &$content_type The variable to store the content type of the response.
-     * @param string &$body The variable to store the body of the response.
+     * @param string &$response     The response string to be sent back to the client.
+     * @param array  &$content_type The variable to store the content type of the response.
+     * @param string &$body         The variable to store the body of the response.
      *
      * This method sets the HTTP status code to 200 OK and the Content-Type to application/json.
      * It then appends the JSON-encoded verification list to the response.
@@ -58,10 +58,10 @@ private function get(int|string &$response, array &$content_type, string &$body)
     /**
      * Handles POST requests by parsing the request data and performing actions based on the method type.
      *
-     * @param ServerRequestInterface|string $request The raw HTTP request string.
-     * @param string &$response The response string to be modified based on the request handling.
-     * @param array &$content_type The variable to store the content type of the response.
-     * @param string &$body The variable to store the body of the response.
+     * @param ServerRequestInterface|string $request       The raw HTTP request string.
+     * @param string                        &$response     The response string to be modified based on the request handling.
+     * @param array                         &$content_type The variable to store the content type of the response.
+     * @param string                        &$body         The variable to store the body of the response.
      *
      * The function performs the following steps:
      * 1. Extracts the raw data from the request.
@@ -141,12 +141,12 @@ private function post(ServerRequestInterface|string $request, int|string &$respo
      * If neither exists, it adds the new entry to the list, writes the updated list to a JSON file,
      * updates the state, and sets the response to a 200 OK status.
      *
-     * @param array $list The list of existing entries.
-     * @param string $ckey The ckey to be verified.
-     * @param string $discord The discord identifier to be verified.
-     * @param string &$response The response message to be set based on the verification result.
-     * @param array &$content_type The variable to store the content type of the response.
-     * @param string &$body The variable to store the body of the response.
+     * @param array  $list          The list of existing entries.
+     * @param string $ckey          The ckey to be verified.
+     * @param string $discord       The discord identifier to be verified.
+     * @param string &$response     The response message to be set based on the verification result.
+     * @param array  &$content_type The variable to store the content type of the response.
+     * @param string &$body         The variable to store the body of the response.
      */
     private function __post(array &$list, string $ckey, string $discord, int|string &$response, array &$content_type, string &$body): void
     {
@@ -175,10 +175,10 @@ private function __post(array &$list, string $ckey, string $discord, int|string
      * Handles the deletion of an item from the list.
      *
      * @param int|string|false $existingIndex The index of the item to delete, or false if the item does not exist.
-     * @param array &$list The list from which the item will be deleted.
-     * @param string &$response The HTTP response message to be returned.
-     * @param array &$content_type The variable to store the content type of the response.
-     * @param string &$body The variable to store the body of the response.
+     * @param array            &$list         The list from which the item will be deleted.
+     * @param string           &$response     The HTTP response message to be returned.
+     * @param array            &$content_type The variable to store the content type of the response.
+     * @param string           &$body         The variable to store the body of the response.
      */
     private function delete(int|string|false $existingIndex, array &$list, int|string &$response, array &$content_type, string &$body): void
     {
diff --git a/src/VerifierServer/PersistentState.php b/src/VerifierServer/PersistentState.php
@@ -105,12 +105,12 @@ public function getVerifyList(bool $getLocalCache = false): array
      * it simply assigns the provided list to the verifyList property. If the storage type is not 'filesystem',
      * it updates the verify_list table in the database.
      *
-     * @param array $list The list of verification items to be set. Each item in the list should be an associative array
-     *                    with keys 'ss13', 'discord', and 'create_time'.
-     * @param bool $write Whether to write the list to the database. Default is true.
+     * @param array $list  The list of verification items to be set. Each item in the list should be an associative array
+     *                         with keys 'ss13', 'discord', and 'create_time'.
+     * @param bool  $write Whether to write the list to the database. Default is true.
      * 
      * @throws \PDOException If there is an error deleting from the verify_list table, preparing the insert statement,
-     *                       or executing the insert statement.
+     *                           or executing the insert statement.
      */
     public function setVerifyList(array $list, bool $write = true): void
     {
@@ -240,7 +240,7 @@ public static function loadVerifyFile(string $json_path): ?array
      * Writes the given data to a file in JSON format.
      *
      * @param string $file The path to the file where the JSON data will be written.
-     * @param mixed $data The data to be encoded as JSON and written to the file.
+     * @param mixed  $data The data to be encoded as JSON and written to the file.
      */
     public static function writeJson(string $file, array $data): void
     {
diff --git a/src/VerifierServer/Server.php b/src/VerifierServer/Server.php
@@ -35,9 +35,9 @@ public function __construct(
     /**
      * Logs an error message with details about the exception.
      *
-     * @param \Exception $e The exception to log.
-     * @param bool $fatal Optional. Indicates whether the error is fatal. Defaults to false.
-     *                     If true, the server will stop after logging the error.
+     * @param \Exception $e     The exception to log.
+     * @param bool       $fatal Optional. Indicates whether the error is fatal. Defaults to false.
+     *                              If true, the server will stop after logging the error.
      *
      * @return string
      */
@@ -166,7 +166,7 @@ public function setLogger(Logger|bool $logger = false): void
     /**
      * Handles the incoming client request.
      *
-     * @param ServerRequestInterface|resource $request The client resource to handle.
+     * @param  ServerRequestInterface|resource $request The client resource to handle.
      *
      * @throws \Exception If the client resource is invalid, reading from the client fails, or writing to the client fails.
      * 
@@ -302,8 +302,9 @@ public function handleResource($client): null
      * Each key-value pair in the array is transformed into a string
      * in the format "key: value" and concatenated with a newline character.
      *
-     * @param  array  $formData The associative array to be converted.
-     * @return string           The resulting request string.
+     * @param array $formData The associative array to be converted.
+     * 
+     * @return string The resulting request string.
      */
     public static function arrayToRequestString(array $formData): string
     {
diff --git a/tests/VerifiedEndpointTest.php b/tests/VerifiedEndpointTest.php
@@ -54,6 +54,7 @@ public function testPost() {
          * Converts an associative array back into the original string format.
          *
          * @param array $formData The associative array to be converted.
+         * 
          * @return string The reconstructed string.
          */
         $response = 0;

Original file line number	Diff line number	Diff line change
`@@ -105,12 +105,12 @@ public function getVerifyList(bool $getLocalCache = false): array`
`105`	`105`	`* it simply assigns the provided list to the verifyList property. If the storage type is not 'filesystem',`
`106`	`106`	`* it updates the verify_list table in the database.`
`107`	`107`	`*`
`108`		`- * @param array $list The list of verification items to be set. Each item in the list should be an associative array`
`109`		`- * with keys 'ss13', 'discord', and 'create_time'.`
`110`		`- * @param bool $write Whether to write the list to the database. Default is true.`
	`108`	`+ * @param array $list The list of verification items to be set. Each item in the list should be an associative array`
	`109`	`+ * with keys 'ss13', 'discord', and 'create_time'.`
	`110`	`+ * @param bool $write Whether to write the list to the database. Default is true.`
`111`	`111`	`*`
`112`	`112`	`* @throws \PDOException If there is an error deleting from the verify_list table, preparing the insert statement,`
`113`		`- * or executing the insert statement.`
	`113`	`+ * or executing the insert statement.`
`114`	`114`	`*/`
`115`	`115`	`public function setVerifyList(array $list, bool $write = true): void`
`116`	`116`	`{`
`@@ -240,7 +240,7 @@ public static function loadVerifyFile(string $json_path): ?array`
`240`	`240`	`* Writes the given data to a file in JSON format.`
`241`	`241`	`*`
`242`	`242`	`* @param string $file The path to the file where the JSON data will be written.`
`243`		`- * @param mixed $data The data to be encoded as JSON and written to the file.`
	`243`	`+ * @param mixed $data The data to be encoded as JSON and written to the file.`
`244`	`244`	`*/`
`245`	`245`	`public static function writeJson(string $file, array $data): void`
`246`	`246`	`{`
Original file line number	Diff line number	Diff line change
`@@ -35,9 +35,9 @@ public function __construct(`
`35`	`35`	`/**`
`36`	`36`	`* Logs an error message with details about the exception.`
`37`	`37`	`*`
`38`		`- * @param \Exception $e The exception to log.`
`39`		`- * @param bool $fatal Optional. Indicates whether the error is fatal. Defaults to false.`
`40`		`- * If true, the server will stop after logging the error.`
	`38`	`+ * @param \Exception $e The exception to log.`
	`39`	`+ * @param bool $fatal Optional. Indicates whether the error is fatal. Defaults to false.`
	`40`	`+ * If true, the server will stop after logging the error.`
`41`	`41`	`*`
`42`	`42`	`* @return string`
`43`	`43`	`*/`
`@@ -166,7 +166,7 @@ public function setLogger(Logger\|bool $logger = false): void`
`166`	`166`	`/**`
`167`	`167`	`* Handles the incoming client request.`
`168`	`168`	`*`
`169`		`- * @param ServerRequestInterface\|resource $request The client resource to handle.`
	`169`	`+ * @param ServerRequestInterface\|resource $request The client resource to handle.`
`170`	`170`	`*`
`171`	`171`	`* @throws \Exception If the client resource is invalid, reading from the client fails, or writing to the client fails.`
`172`	`172`	`*`
`@@ -302,8 +302,9 @@ public function handleResource($client): null`
`302`	`302`	`* Each key-value pair in the array is transformed into a string`
`303`	`303`	`* in the format "key: value" and concatenated with a newline character.`
`304`	`304`	`*`
`305`		`- * @param array $formData The associative array to be converted.`
`306`		`- * @return string The resulting request string.`
	`305`	`+ * @param array $formData The associative array to be converted.`
	`306`	`+ *`
	`307`	`+ * @return string The resulting request string.`
`307`	`308`	`*/`
`308`	`309`	`public static function arrayToRequestString(array $formData): string`
`309`	`310`	`{`
Original file line number	Diff line number	Diff line change
`@@ -54,6 +54,7 @@ public function testPost() {`
`54`	`54`	`* Converts an associative array back into the original string format.`
`55`	`55`	`*`
`56`	`56`	`* @param array $formData The associative array to be converted.`
	`57`	`+ *`
`57`	`58`	`* @return string The reconstructed string.`
`58`	`59`	`*/`
`59`	`60`	`$response = 0;`