first commit

This commit is contained in:
CHIEFSOFT\ameye
2024-09-30 18:11:26 -04:00
commit e592ca6823
27270 changed files with 5002257 additions and 0 deletions
+101
View File
@@ -0,0 +1,101 @@
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* Class for exporting a chat message.
*
* @package mod_chat
* @copyright 2017 Juan Leyva <juan@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace mod_chat\external;
defined('MOODLE_INTERNAL') || die();
use core\external\exporter;
/**
* Class for exporting a chat message.
*
* @copyright 2017 Juan Leyva <juan@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class chat_message_exporter extends exporter {
/**
* Defines exporter properties.
*
* @return array
*/
protected static function define_properties() {
return array(
'id' => array(
'type' => PARAM_INT,
'description' => 'The message record id.',
),
'chatid' => array(
'type' => PARAM_INT,
'description' => 'The chat id.',
'default' => 0,
),
'userid' => array(
'type' => PARAM_INT,
'description' => 'The user who wrote the message.',
'default' => 0,
),
'groupid' => array(
'type' => PARAM_INT,
'description' => 'The group this message belongs to.',
'default' => 0,
),
'issystem' => array(
'type' => PARAM_BOOL,
'description' => 'Whether is a system message or not.',
'default' => false,
),
'message' => array(
'type' => PARAM_RAW,
'description' => 'The message text.',
),
'timestamp' => array(
'type' => PARAM_INT,
'description' => 'The message timestamp (indicates when the message was sent).',
'default' => 0,
),
);
}
/**
* Defines related information.
*
* @return array
*/
protected static function define_related() {
return array(
'context' => 'context',
);
}
/**
* Get the formatting parameters for the name.
*
* @return array
*/
protected function get_format_parameters_for_message() {
return [
'component' => 'mod_chat',
];
}
}
+121
View File
@@ -0,0 +1,121 @@
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
namespace mod_chat\external;
use core_external\external_api;
use core_external\external_function_parameters;
use core_external\external_single_structure;
use core_external\external_value;
use core_external\external_warnings;
/**
* External service to log viewed previous chat sessions.
*
* @package mod_chat
* @category external
* @copyright 2023 Rodrigo Mady <rodrigo.mady@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 4.3
*/
class view_sessions extends external_api {
/**
* Returns description of method parameters
*
* @return external_function_parameters
*/
public static function execute_parameters(): external_function_parameters {
return new external_function_parameters([
'cmid' => new external_value(PARAM_INT, 'Course module id', VALUE_REQUIRED),
'start' => new external_value(PARAM_INT, 'Session start time', VALUE_DEFAULT, 0),
'end' => new external_value(PARAM_INT, 'Session end time', VALUE_DEFAULT, 0),
]);
}
/**
* Execute the chat view sessions event.
*
* @param int $cmid the chat course module id
* @param null|int $start
* @param null|int $end
* @return array
* @throws \restricted_context_exception
*/
public static function execute(int $cmid, ?int $start = 0, ?int $end = 0): array {
global $DB;
$warnings = [];
$status = false;
// Validate the cmid ID.
[
'cmid' => $cmid,
'start' => $start,
'end' => $end,
] = self::validate_parameters(self::execute_parameters(), [
'cmid' => $cmid,
'start' => $start,
'end' => $end,
]);
if (!$cm = get_coursemodule_from_id('chat', $cmid)) {
throw new \moodle_exception('invalidcoursemodule', 'error');
}
if (!$chat = $DB->get_record('chat', ['id' => $cm->instance])) {
throw new \moodle_exception('invalidcoursemodule', 'error');
}
$context = \context_module::instance($cm->id);
self::validate_context($context);
// Check capability.
if (has_capability('mod/chat:readlog', $context)) {
$params = [
'context' => $context,
'objectid' => $chat->id,
'other' => [
'start' => $start,
'end' => $end
]
];
$event = \mod_chat\event\sessions_viewed::create($params);
$status = true;
$event->add_record_snapshot('chat', $chat);
$event->trigger();
} else {
$warnings[] = [
'item' => $cm->id,
'warningcode' => 'nopermissiontoseethechatlog',
'message' => get_string('nopermissiontoseethechatlog', 'chat')
];
}
$result = [
'status' => $status,
'warnings' => $warnings
];
return $result;
}
/**
* Describe the return structure of the external service.
*
* @return external_single_structure
*/
public static function execute_returns(): external_single_structure {
return new external_single_structure([
'status' => new external_value(PARAM_BOOL, 'status: true if success'),
'warnings' => new external_warnings()
]);
}
}