GrokDocumentProvider::requestGrokAI() - Code Metrics - Inspection of "AI: Add basic support for multi-modal AI services..." - chamilo/chamilo-lms - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#7304)

by Yannick

created 2026-01-02 17:04 UTC

GrokDocumentProvider::requestGrokAI() B

↳ Parent: GrokDocumentProvider

Complexity

Conditions	7
Paths	29

Size

Total Lines	74
Code Lines	43

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	7
eloc	43
c	1
b	0
f	0
nc	29
nop	3
dl	0
loc	74
rs	8.2986

How to fix Long Method

<?php

declare(strict_types=1);

namespace Chamilo\CoreBundle\AiProvider;

use Chamilo\CoreBundle\Entity\AiRequests;
use Chamilo\CoreBundle\Repository\AiRequestsRepository;
use Chamilo\CoreBundle\Settings\SettingsManager;
use RuntimeException;
use Symfony\Bundle\SecurityBundle\Security;
use Symfony\Contracts\HttpClient\HttpClientInterface;
use Symfony\Component\Security\Core\User\UserInterface;

/**
 * Grok (xAI) provider for document generation.
 * Note: As of January 2026, document generation is not natively supported in the xAI API as binary files (e.g., PDF).
 * This implementation uses the text responses endpoint to generate structured text content (e.g., Markdown),
 * which can be post-processed into a document format client-side.
 */
class GrokDocumentProvider implements AiDocumentProviderInterface
{
    private string $apiUrl;
    private string $apiKey;
    private string $model;
    private array $defaultOptions;
    private HttpClientInterface $httpClient;
    private AiRequestsRepository $aiRequestsRepository;
    private SettingsManager $settingsManager;


    public function __construct(
        HttpClientInterface $httpClient,
        AiRequestsRepository $aiRequestsRepository,
        SettingsManager $settingsManager,
        Security $security
    ) {
        $this->httpClient = $httpClient;
        $this->aiRequestsRepository = $aiRequestsRepository;
        $this->security = $security;

        // Get AI providers from settings
        $configJson = $settingsManager->getSetting('ai_helpers.ai_providers', true);
        $config = json_decode($configJson, true) ?? [];

        if (!isset($config['grok'])) {
            throw new RuntimeException('Grok configuration is missing.');
        }
        if (!isset($config['grok']['document'])) {
            throw new RuntimeException('Grok configuration for document generation is missing.');
        }
        $grokConfig = $config['grok'];

        $this->apiUrl = $grokConfig['url'] ?? 'https://api.x.ai/v1/responses';
        $this->apiKey = $grokConfig['api_key'] ??'';
        $this->model = $grokConfig['model'] ?? 'grok-4-1-fast-reasoning';

        if (empty($this->apiKey)) {
            throw new \RuntimeException('Grok API key is missing.');
        }

        $this->defaultOptions = [
            'temperature' => $grokConfig['temperature'] ?? 0.7,
            'format' => $grokConfig['format'] ?? 'pdf', // e.g., 'markdown', 'pdf' (for prompt instruction)
        ];
    }

    public function generateDocument(string $prompt, string $toolName, ?array $options = []): ?string
    {
        return $this->requestGrokAI($prompt, $toolName, $options);
    }

    private function requestGrokAI(string $prompt, string $toolName, array $options = []): ?string
    {
        $userId = $this->getUserId();
        if (!$userId) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            throw new \RuntimeException('User not authenticated.');
        }

        // Build system prompt to instruct document generation
        $systemContent = 'You are a helpful assistant that generates well-structured documents. Output in the specified format (e.g., Markdown for easy conversion to PDF).';

        // Append format instruction to user prompt if provided
        $userContent = $prompt;
        $format = $options['format'] ?? $this->defaultOptions['format'];
        if ($format) {
            $userContent .= "\n\nOutput the document in {$format} format.";
        }

        $payload = [
            'model' => $this->model,
            'input' => [
                ['role' => 'system', 'content' => $systemContent],
                ['role' => 'user', 'content' => $userContent],
            ],
            ...array_merge($this->defaultOptions, $options),
        ];

        try {
            $response = $this->httpClient->request('POST', $this->apiUrl, [
                'headers' => [
                    'Authorization' => 'Bearer ' . $this->apiKey,
                    'Content-Type' => 'application/json',
                ],
                'json' => $payload,
            ]);

            $statusCode = $response->getStatusCode();
            if ($statusCode !== 200) {
                throw new \RuntimeException('API request failed with status: ' . $statusCode);
            }

            $data = $response->toArray();

            // Check for error key first
            if (isset($data['error'])) {
                throw new \RuntimeException('API error: ' . $data['error']['message']);
            }

            // Extract generated content from response structure
            if (isset($data['output'][0]['content'][0]['text'])) {
                $generatedContent = $data['output'][0]['content'][0]['text'];

                // Usage is available for text generation
                $usage = $data['usage'] ?? ['prompt_tokens' => 0, 'completion_tokens' => 0, 'total_tokens' => 0];

                // Log request
                $aiRequest = new AiRequests();
                $aiRequest->setUserId($userId)
                    ->setToolName($toolName)
                    ->setRequestText($prompt)
                    ->setPromptTokens($usage['prompt_tokens'])
                    ->setCompletionTokens($usage['completion_tokens'])
                    ->setTotalTokens($usage['total_tokens'])
                    ->setAiProvider('grok')
                ;

                $this->aiRequestsRepository->save($aiRequest);

                return $generatedContent;
            }

            return null;
        } catch (\Exception $e) {
            error_log('[AI][Grok] Exception: ' . $e->getMessage());
            return null;
        }
    }

    private function getUserId(): ?int
    {
        return $this->user ? $this->user->getId() : null;

    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Chamilo\CoreBundle\AiProvider;
6
7			use Chamilo\CoreBundle\Entity\AiRequests;
8			use Chamilo\CoreBundle\Repository\AiRequestsRepository;
9			use Chamilo\CoreBundle\Settings\SettingsManager;
10			use RuntimeException;
11			use Symfony\Bundle\SecurityBundle\Security;
12			use Symfony\Contracts\HttpClient\HttpClientInterface;
13			use Symfony\Component\Security\Core\User\UserInterface;
14
15			/**
16			* Grok (xAI) provider for document generation.
17			* Note: As of January 2026, document generation is not natively supported in the xAI API as binary files (e.g., PDF).
18			* This implementation uses the text responses endpoint to generate structured text content (e.g., Markdown),
19			* which can be post-processed into a document format client-side.
20			*/
21			class GrokDocumentProvider implements AiDocumentProviderInterface
22			{
23			private string $apiUrl;
24			private string $apiKey;
25			private string $model;
26			private array $defaultOptions;
27			private HttpClientInterface $httpClient;
28			private AiRequestsRepository $aiRequestsRepository;
29			private SettingsManager $settingsManager;
			0 ignored issues – show introduced 2026-01-02 17:15 UTC by Report Bug Copy Issue Report The private property `$settingsManager` is not used, and could be removed. Loading history...
30
31			public function __construct(
32			HttpClientInterface $httpClient,
33			AiRequestsRepository $aiRequestsRepository,
34			SettingsManager $settingsManager,
35			Security $security
36			) {
37			$this->httpClient = $httpClient;
38			$this->aiRequestsRepository = $aiRequestsRepository;
39			$this->security = $security;
40
41			// Get AI providers from settings
42			$configJson = $settingsManager->getSetting('ai_helpers.ai_providers', true);
43			$config = json_decode($configJson, true) ?? [];
44
45			if (!isset($config['grok'])) {
46			throw new RuntimeException('Grok configuration is missing.');
47			}
48			if (!isset($config['grok']['document'])) {
49			throw new RuntimeException('Grok configuration for document generation is missing.');
50			}
51			$grokConfig = $config['grok'];
52
53			$this->apiUrl = $grokConfig['url'] ?? 'https://api.x.ai/v1/responses';
54			$this->apiKey = $grokConfig['api_key'] ??'';
55			$this->model = $grokConfig['model'] ?? 'grok-4-1-fast-reasoning';
56
57			if (empty($this->apiKey)) {
58			throw new \RuntimeException('Grok API key is missing.');
59			}
60
61			$this->defaultOptions = [
62			'temperature' => $grokConfig['temperature'] ?? 0.7,
63			'format' => $grokConfig['format'] ?? 'pdf', // e.g., 'markdown', 'pdf' (for prompt instruction)
64			];
65			}
66
67			public function generateDocument(string $prompt, string $toolName, ?array $options = []): ?string
68			{
69			return $this->requestGrokAI($prompt, $toolName, $options);
70			}
71
72			private function requestGrokAI(string $prompt, string $toolName, array $options = []): ?string
73			{
74			$userId = $this->getUserId();
75			if (!$userId) {
			0 ignored issues – show Bug Best Practice introduced 2025-12-29 23:30 UTC by Report Bug Copy Issue Report The expression `$userId` of type `integer\|null` is loosely compared to `false`; this is ambiguous if the integer can be 0. You might want to explicitly use `=== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `integer` values, zero is a special case, in particular the following results might be unexpected: 0 == false // true 0 == null // true 123 == false // false 123 == null // false // It is often better to use strict comparison 0 === false // false 0 === null // false Loading history...
76			throw new \RuntimeException('User not authenticated.');
77			}
78
79			// Build system prompt to instruct document generation
80			$systemContent = 'You are a helpful assistant that generates well-structured documents. Output in the specified format (e.g., Markdown for easy conversion to PDF).';
81
82			// Append format instruction to user prompt if provided
83			$userContent = $prompt;
84			$format = $options['format'] ?? $this->defaultOptions['format'];
85			if ($format) {
86			$userContent .= "\n\nOutput the document in {$format} format.";
87			}
88
89			$payload = [
90			'model' => $this->model,
91			'input' => [
92			['role' => 'system', 'content' => $systemContent],
93			['role' => 'user', 'content' => $userContent],
94			],
95			...array_merge($this->defaultOptions, $options),
96			];
97
98			try {
99			$response = $this->httpClient->request('POST', $this->apiUrl, [
100			'headers' => [
101			'Authorization' => 'Bearer ' . $this->apiKey,
102			'Content-Type' => 'application/json',
103			],
104			'json' => $payload,
105			]);
106
107			$statusCode = $response->getStatusCode();
108			if ($statusCode !== 200) {
109			throw new \RuntimeException('API request failed with status: ' . $statusCode);
110			}
111
112			$data = $response->toArray();
113
114			// Check for error key first
115			if (isset($data['error'])) {
116			throw new \RuntimeException('API error: ' . $data['error']['message']);
117			}
118
119			// Extract generated content from response structure
120			if (isset($data['output'][0]['content'][0]['text'])) {
121			$generatedContent = $data['output'][0]['content'][0]['text'];
122
123			// Usage is available for text generation
124			$usage = $data['usage'] ?? ['prompt_tokens' => 0, 'completion_tokens' => 0, 'total_tokens' => 0];
125
126			// Log request
127			$aiRequest = new AiRequests();
128			$aiRequest->setUserId($userId)
129			->setToolName($toolName)
130			->setRequestText($prompt)
131			->setPromptTokens($usage['prompt_tokens'])
132			->setCompletionTokens($usage['completion_tokens'])
133			->setTotalTokens($usage['total_tokens'])
134			->setAiProvider('grok')
135			;
136
137			$this->aiRequestsRepository->save($aiRequest);
138
139			return $generatedContent;
140			}
141
142			return null;
143			} catch (\Exception $e) {
144			error_log('[AI][Grok] Exception: ' . $e->getMessage());
145			return null;
146			}
147			}
148
149			private function getUserId(): ?int
150			{
151			return $this->user ? $this->user->getId() : null;
			0 ignored issues – show Bug Best Practice introduced 2026-01-02 17:15 UTC by Report Bug Copy Issue Report The property `user` does not exist on `Chamilo\CoreBundle\AiProvider\GrokDocumentProvider`. Did you maybe forget to declare it? Loading history...
152			}
153			}
154

chamilo / chamilo-lms

Pull Request — master (#7304)

GrokDocumentProvider::requestGrokAI() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like