#3371272 Fixing phpcs errors/warnings

#3371272 Fixing phpcs errors/warnings.

src/Plugin/tmgmt/Translator/OpenAiTranslator.php

@@ -33,13 +33,11 @@ class OpenAiTranslator extends TranslatorPluginBase implements ContainerFactoryP
 
   /**
    * OpenAI client.
-   *
    */
   protected Client $client;
 
   /**
    * Data help service.
-   *
    */
   protected Data $dataHelper;
 
@@ -129,8 +127,13 @@ class OpenAiTranslator extends TranslatorPluginBase implements ContainerFactoryP
    * Split HTML into smaller chunks.
    *
    * @param array|string $q
+   *   The text to be split.
    * @param mixed $maxChunkTokens
-   * @return array $segments
+   *   The maximum number of tokens allowed per chunk.
+   *
+   * @return array
+   *   An array of text segments, each not exceeding the specified maximum token
+   *   limit.
    */
   public function htmlSplitter(array|string $q, mixed $maxChunkTokens): array {
     $doc = new \DOMDocument();
@@ -163,8 +166,13 @@ class OpenAiTranslator extends TranslatorPluginBase implements ContainerFactoryP
    * Split text into smaller chunks.
    *
    * @param array|string $q
+   *   The text to be split.
    * @param mixed $maxChunkTokens
-   * @return array $segments
+   *   The maximum number of tokens allowed per chunk.
+   *
+   * @return array
+   *   An array of text segments, each not exceeding the specified maximum token
+   *   limit.
    */
   public function textSplitter(array|string $q, mixed $maxChunkTokens): array {
     // Treat $q as plain text.
@@ -194,6 +202,9 @@ class OpenAiTranslator extends TranslatorPluginBase implements ContainerFactoryP
     return $segments;
   }
 
+  /**
+   * Recursively collects all text nodes from a given DOM node.
+   */
   protected function getAllTextNodes($node): array {
     $textNodes = [];
     if ($node->nodeType == \XML_TEXT_NODE) {
@@ -207,10 +218,16 @@ class OpenAiTranslator extends TranslatorPluginBase implements ContainerFactoryP
     return $textNodes;
   }
 
+  /**
+   * Counts the number of tokens in a given text.
+   */
   protected function countTokens($text): int {
     return TokenizerX::count($text);
   }
 
+  /**
+   * Checks if a given string contains HTML tags.
+   */
   protected function isHtml($string): bool {
     return \preg_match("/<[^<]+>/", $string, $m) != 0;
   }
@@ -218,7 +235,10 @@ class OpenAiTranslator extends TranslatorPluginBase implements ContainerFactoryP
   /**
    * Creates a completion request for the provided prompt and parameters.
    *
-   * @return \OpenAI\Responses\Chat\CreateResponse $response
+   * @return \OpenAI\Responses\Chat\CreateResponse
+   *   The CreateResponse object containing the API's completion response if the
+   *   request is successful. NULL is returned if there's an exception during
+   *   the request process.
    */
   public function completionsRequest($configuration): ?CreateResponse {
     try {
@@ -232,8 +252,7 @@ class OpenAiTranslator extends TranslatorPluginBase implements ContainerFactoryP
   }
 
   /**
-   * Overrides
-   * TMGMTDefaultTranslatorPluginController::getSupportedRemoteLanguages().
+   * Overrides TMGMTDefaultTranslatorPluginController::getSupportedRemoteLanguages().
    */
   public function getSupportedRemoteLanguages(TranslatorInterface $translator): array {
     $languages = [];
@@ -245,8 +264,7 @@ class OpenAiTranslator extends TranslatorPluginBase implements ContainerFactoryP
   }
 
   /**
-   * Overrides
-   * TMGMTDefaultTranslatorPluginController::getSupportedTargetLanguages().
+   * Overrides TMGMTDefaultTranslatorPluginController::getSupportedTargetLanguages().
    */
   public function getSupportedTargetLanguages(TranslatorInterface $translator, $source_language): array {
     $languages = $this->getSupportedRemoteLanguages($translator);
@@ -273,7 +291,7 @@ class OpenAiTranslator extends TranslatorPluginBase implements ContainerFactoryP
    * @param \Drupal\tmgmt\Entity\Translator $translator
    *   The translator entity to get the settings from.
    * @param string $action
-   *   Action to be performed [translate, languages, detect]
+   *   Action to be performed [translate, languages, detect].
    * @param array $request_query
    *   (Optional) Additional query params to be passed into the request.
    * @param array $options
@@ -284,9 +302,9 @@ class OpenAiTranslator extends TranslatorPluginBase implements ContainerFactoryP
    *   Translated string.
    *
    * @throws \Drupal\tmgmt\TMGMTException
-   *   - Invalid action provided
-   *   - Unable to connect to the Google Service
-   *   - Error returned by the Google Service
+   *   - Invalid action provided.
+   *   - Unable to connect to the Google Service.
+   *   - Error returned by the Google Service.
    */
   protected static function doRequest(Translator $translator, $action, array $request_query = [], array $options = []): string {
     if (!\in_array($action, ['translate', 'languages'], TRUE)) {
@@ -412,7 +430,7 @@ class OpenAiTranslator extends TranslatorPluginBase implements ContainerFactoryP
    * @param \Drupal\tmgmt\Entity\Job $job
    *   The tmgmt job entity.
    * @param string $data_key
-   *  The data key.
+   *   The data key.
    * @param string $text
    *   The text to be translated.
    * @param array $keys_sequence