Adhere to Moodle code checker.

lucaboesch · lucaboesch · commit a925cb76babf · 2026-02-16T23:46:53.000+01:00
diff --git a/classes/ai_manager_utils.php b/classes/ai_manager_utils.php
@@ -55,6 +55,8 @@ class ai_manager_utils {
      * @param bool $includedeleted if log entries which are marked as deleted, should be included in the result
      * @param string $fields Comma separated list of SQL fields that should be contained in the result, defaults to all fields
      * @param array $purposes Array of purpose name strings that should be returned. If empty, all purposes will be returned.
+     * @param int $limit the maximum number of records to return, sorted by timecreated descending.
+     *  If 0, all records will be returned.
      * @return array array of records of the log table
      */
     public static function get_log_entries(
@@ -122,8 +124,7 @@ public static function get_log_entries(
     /**
      * Retrieves the entries from the request_log table and structures it for delivering them to the "view prompts" table.
      *
-     * External function that delivers this data: @param int $contextid The main context id the prompts should be retrieved
-     *
+     * @param int $contextid the main context id the prompts should be retrieved for
      * @param int $userid the id of the user to retrieve the prompts
      * @param int $time the time since when the prompts should be retrieved
      * @return array complex structured array containing the prompts
@@ -309,7 +310,9 @@ public static function get_connector_instance_by_purpose(string $purpose, ?int $
      * API function to get all needed information about the AI configuration for a user.
      *
      * @param stdClass $user the user to retrieve the information for
+     * @param int $contextid the contextid on which the availability should be determined
      * @param ?string $tenant the tenant to retrieve the information for. If null, the current tenant will be used
+     * @param ?array $selectedpurposes array of purpose strings to check. If empty all purposes will be checked
      * @return array complex associative array containing all the needed configurations
      */
     public static function get_ai_config(
diff --git a/classes/base_purpose.php b/classes/base_purpose.php
@@ -182,7 +182,7 @@ public function format_output(string $output): string {
      * Formats the given prompt text based on the provided sanitized options.
      *
      * @param string $prompttext The prompt text to be formatted.
-     * @param array $sanitizedoptions An array of sanitized options for formatting.
+     * @param request_options $requestoptions The request_options object containing the request options.
      *
      * @return string The formatted prompt text as string.
      */
diff --git a/classes/external/get_ai_config.php b/classes/external/get_ai_config.php
@@ -70,6 +70,8 @@ public static function execute_parameters(): external_function_parameters {
      * Retrieve the purpose config.
      *
      * @param ?string $tenant the tenant to use, only useful for accounts which can access/manage more than their own tenant
+     * @param int $contextid the contextid for which the config should be retrieved, if 0 the system context is used
+     * @param ?array $purposes if set, only the config for the given purposes
      * @return array associative array containing the result of the request
      */
     public static function execute(?string $tenant = null, int $contextid = 0, ?array $purposes = null): array {
diff --git a/classes/external/get_prompts.php b/classes/external/get_prompts.php
@@ -62,6 +62,7 @@ public static function execute_parameters(): external_function_parameters {
      * @param int $contextid The context in which the prompts should be retrieved, should either be a course context or below or a
      *  tenant context
      * @param int $userid The id of the user to retrieve the prompts for
+     * @param int $time The unix time stamp since when prompts should be retrieved, if 0 all prompts will be retrieved
      *
      * @return array associative array containing the result of the request
      */
diff --git a/classes/external/submit_query.php b/classes/external/submit_query.php
@@ -55,6 +55,8 @@ public static function execute_parameters(): external_function_parameters {
      *
      * @param string $purpose the purpose to use
      * @param string $prompt the user's prompt
+     * @param string $component the component from which the request is being made, e.g. 'mod_forum'
+     * @param int $contextid the context id of the context from which the request is
      * @param string $options additional options which should be passed to the request to the AI tool
      * @return array associative array containing the result of the request
      */
diff --git a/classes/external/vertex_cache_status.php b/classes/external/vertex_cache_status.php
@@ -59,6 +59,7 @@ public static function execute_parameters(): external_function_parameters {
      * Retrieve the purpose config.
      *
      * @param string $serviceaccountinfo The service account info stringified JSON
+     * @param bool|null $newstatus The new status to set the caching config to
      * @return array associative array containing the result of the request
      */
     public static function execute(string $serviceaccountinfo, ?bool $newstatus = null): array {
diff --git a/classes/hook/purpose_usage.php b/classes/hook/purpose_usage.php
@@ -45,6 +45,7 @@ class purpose_usage {
     /**
      * Getter for the component/plugin display name.
      *
+     * @param string $component The component for which the display name should be retrieved
      * @return string The localized display name of the component
      */
     public function get_component_displayname(string $component): string {
diff --git a/classes/local/aitool_option_temperature.php b/classes/local/aitool_option_temperature.php
@@ -31,6 +31,7 @@ class aitool_option_temperature {
      * Extends the form definition of the edit instance form by adding the temperature option.
      *
      * @param \MoodleQuickForm $mform the mform object
+     * @param array $modelswithouttemperature array with model names for which the temperature option should be hidden
      */
     public static function extend_form_definition(\MoodleQuickForm $mform, array $modelswithouttemperature = []): void {
         $radioarray = [];
diff --git a/classes/local/aitool_option_vertexai_authhandler.php b/classes/local/aitool_option_vertexai_authhandler.php
@@ -31,6 +31,9 @@
 class aitool_option_vertexai_authhandler {
     /**
      * Constructor for the auth handler.
+     *
+     * @param int $instanceid The ID of the instance being used. Will be used as key for the cache handling.
+     * @param string $serviceaccountinfo The serviceaccountinfo stringified JSON
      */
     public function __construct(
         /** @var int The ID of the instance being used. Will be used as key for the cache handling. */
diff --git a/classes/local/view_prompts_table.php b/classes/local/view_prompts_table.php
@@ -45,6 +45,7 @@ class view_prompts_table extends table_sql {
      * @param string $uniqid a unique id to use for the table
      * @param tenant $tenant the tenant to display the table for
      * @param moodle_url $baseurl the current base url on which the table is being displayed
+     * @param \context $context the context in which the table is being displayed
      */
     public function __construct(
         string $uniqid,
diff --git a/classes/manager.php b/classes/manager.php
@@ -274,6 +274,7 @@ public function perform_request(string $prompttext, string $component, int $cont
      * @param prompt_response $promptcompletion The prompt response object from which information will be extracted and stored
      *  in the log table
      * @param float $executiontime the duration that the request has taken
+     * @param request_options $requestoptions the request options object from which information will be extracted and stored
      * @return int the record id of the log record which has been stored to the database
      */
     public function log_request(
diff --git a/classes/privacy/provider.php b/classes/privacy/provider.php
@@ -42,8 +42,8 @@
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class provider implements
-    \core_privacy\local\request\core_userlist_provider,
     \core_privacy\local\metadata\provider,
+    \core_privacy\local\request\core_userlist_provider,
     \core_privacy\local\request\plugin\provider {
     #[\Override]
     public static function get_metadata(collection $collection): collection {
diff --git a/tests/base_connector_test.php b/tests/base_connector_test.php
@@ -31,6 +31,7 @@ final class base_connector_test extends \advanced_testcase {
     /**
      * Test if all connector plugins implement a model definition for each existing purpose.
      *
+     * @param string $purpose the purpose to check for
      * @covers \local_ai_manager\base_purpose::get_models_by_purpose
      * @dataProvider get_models_by_purpose_all_purposes_exist_provider
      */
diff --git a/tests/manager_test.php b/tests/manager_test.php
@@ -43,6 +43,9 @@ final class manager_test extends \advanced_testcase {
     /**
      * Tests the method perform_request.
      *
+     * @param array $configuration the configuration for this test case, see {@see self::perform_request_provider}
+     * @param int $expectedcode the expected http code result of the perform_request call
+     * @param string $message the expected message in the result of the perform_request call
      * @covers       \local_ai_manager\ai_manager::perform_request
      * @dataProvider perform_request_provider
      */

Original file line number	Diff line number	Diff line change
`@@ -182,7 +182,7 @@ public function format_output(string $output): string {`
`182`	`182`	`* Formats the given prompt text based on the provided sanitized options.`
`183`	`183`	`*`
`184`	`184`	`* @param string $prompttext The prompt text to be formatted.`
`185`		`- * @param array $sanitizedoptions An array of sanitized options for formatting.`
	`185`	`+ * @param request_options $requestoptions The request_options object containing the request options.`
`186`	`186`	`*`
`187`	`187`	`* @return string The formatted prompt text as string.`
`188`	`188`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -70,6 +70,8 @@ public static function execute_parameters(): external_function_parameters {`
`70`	`70`	`* Retrieve the purpose config.`
`71`	`71`	`*`
`72`	`72`	`* @param ?string $tenant the tenant to use, only useful for accounts which can access/manage more than their own tenant`
	`73`	`+ * @param int $contextid the contextid for which the config should be retrieved, if 0 the system context is used`
	`74`	`+ * @param ?array $purposes if set, only the config for the given purposes`
`73`	`75`	`* @return array associative array containing the result of the request`
`74`	`76`	`*/`
`75`	`77`	`public static function execute(?string $tenant = null, int $contextid = 0, ?array $purposes = null): array {`
Original file line number	Diff line number	Diff line change
`@@ -62,6 +62,7 @@ public static function execute_parameters(): external_function_parameters {`
`62`	`62`	`* @param int $contextid The context in which the prompts should be retrieved, should either be a course context or below or a`
`63`	`63`	`* tenant context`
`64`	`64`	`* @param int $userid The id of the user to retrieve the prompts for`
	`65`	`+ * @param int $time The unix time stamp since when prompts should be retrieved, if 0 all prompts will be retrieved`
`65`	`66`	`*`
`66`	`67`	`* @return array associative array containing the result of the request`
`67`	`68`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -55,6 +55,8 @@ public static function execute_parameters(): external_function_parameters {`
`55`	`55`	`*`
`56`	`56`	`* @param string $purpose the purpose to use`
`57`	`57`	`* @param string $prompt the user's prompt`
	`58`	`+ * @param string $component the component from which the request is being made, e.g. 'mod_forum'`
	`59`	`+ * @param int $contextid the context id of the context from which the request is`
`58`	`60`	`* @param string $options additional options which should be passed to the request to the AI tool`
`59`	`61`	`* @return array associative array containing the result of the request`
`60`	`62`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -59,6 +59,7 @@ public static function execute_parameters(): external_function_parameters {`
`59`	`59`	`* Retrieve the purpose config.`
`60`	`60`	`*`
`61`	`61`	`* @param string $serviceaccountinfo The service account info stringified JSON`
	`62`	`+ * @param bool\|null $newstatus The new status to set the caching config to`
`62`	`63`	`* @return array associative array containing the result of the request`
`63`	`64`	`*/`
`64`	`65`	`public static function execute(string $serviceaccountinfo, ?bool $newstatus = null): array {`
Original file line number	Diff line number	Diff line change
`@@ -45,6 +45,7 @@ class purpose_usage {`
`45`	`45`	`/**`
`46`	`46`	`* Getter for the component/plugin display name.`
`47`	`47`	`*`
	`48`	`+ * @param string $component The component for which the display name should be retrieved`
`48`	`49`	`* @return string The localized display name of the component`
`49`	`50`	`*/`
`50`	`51`	`public function get_component_displayname(string $component): string {`
Original file line number	Diff line number	Diff line change
`@@ -31,6 +31,7 @@ class aitool_option_temperature {`
`31`	`31`	`* Extends the form definition of the edit instance form by adding the temperature option.`
`32`	`32`	`*`
`33`	`33`	`* @param \MoodleQuickForm $mform the mform object`
	`34`	`+ * @param array $modelswithouttemperature array with model names for which the temperature option should be hidden`
`34`	`35`	`*/`
`35`	`36`	`public static function extend_form_definition(\MoodleQuickForm $mform, array $modelswithouttemperature = []): void {`
`36`	`37`	`$radioarray = [];`