1
<?php
2
// ケイパビリティを定義；ロール編集時のケイパビリティ一覧に出現する
3
$capabilities = [
4
   // testmodを新規登録する
5
   'mod/testmod:addinstance' => [
6
      'riskbitmask' => RISK_SPAM, // 許可した時のリスク、RISK_SPAM：サイトに表示可能なコンテンツを追加
7
      'captype' => 'write',  // 「read」または「write」を指定
8
      'contextlevel' => CONTEXT_COURSE, // 活動モジュールが最も関連するコンテキストレベル
9
      // 初回インストール時に当該ケイパビリティを割り当てるロールを記載する。標準ロールを記載する。
10
      'archetypes' => [
11
            'editingteacher' => CAP_ALLOW, // 教師
12
            'manager'        => CAP_ALLOW  // マネージャ
13
      ],
14
      // 初回インストール時に指定のケイパビリティを持つ全ロールに当該ケイパビリティを割り当てる。
15
      // 以下は、「コースに活動モジュールを追加/削除/更新を行う」を持つ全ロールに当該ケイパビリティを割り当てる。
16
      'clonepermissionsfrom' => 'moodle/course:manageactivities'
17
   ],
18
   // testmodを表示する
19
   'mod/testmod:view' => [
20
      'captype' => 'read',
21
      'contextlevel' => CONTEXT_MODULE,
22
      'archetypes' => [  // このケイパビリティは全ての標準ロールで許容される
23
            'guest' => CAP_ALLOW,
24
            'student' => CAP_ALLOW,
25
            'teacher' => CAP_ALLOW,
26
            'editingteacher' => CAP_ALLOW,
27
            'manager' => CAP_ALLOW
28
      ],
29
   ],
30
];

1
<?xml version="1.0" encoding="UTF-8" ?>
2
<XMLDB PATH="mod/testmod/db" VERSION="2024103000" COMMENT="XMLDB file for Moodle mod_testmod"
3
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4
xsi:noNamespaceSchemaLocation="../../../lib/xmldb/xmldb.xsd"
5
>
6

7
<TABLES>
8
<TABLE NAME="testmod" COMMENT="test module">
9
   <FIELDS>
10
   <FIELD NAME="id" TYPE="int" LENGTH="10" NOTNULL="true" SEQUENCE="true"/>
11
   <FIELD NAME="course" TYPE="int" LENGTH="10" NOTNULL="true" DEFAULT="0" SEQUENCE="false"/>
12
   <FIELD NAME="name" TYPE="char" LENGTH="255" NOTNULL="true" SEQUENCE="false"/>
13
   <FIELD NAME="timemodified" TYPE="int" LENGTH="10" NOTNULL="true" SEQUENCE="false"/>
14
   <FIELD NAME="intro" TYPE="text" NOTNULL="false" SEQUENCE="false"/>
15
   <FIELD NAME="introformat" TYPE="int" LENGTH="4" NOTNULL="true" DEFAULT="0" SEQUENCE="false"/>
16
   <!-- 活動モジュールで使用するデータを定義する -->
17
   <FIELD NAME="timecreated" TYPE="int" LENGTH="10" NOTNULL="true" SEQUENCE="false"/>
18
   <FIELD NAME="url" TYPE="char" LENGTH="512" NOTNULL="true" SEQUENCE="false"/>
19
   </FIELDS>
20
   <KEYS>
21
   <KEY NAME="primary" TYPE="primary" FIELDS="id"/>
22
   <KEY NAME="course" TYPE="foreign" FIELDS="course" REFTABLE="course" REFFIELDS="id"/>
23
   </KEYS>
24
</TABLE>
25
</TABLES>
26
<!--
27
<TABLES>
28
活動モジュールでサブテーブルを使用するときは追加で定義する
29
</TABLES>
30
-->
31
</XMLDB>

1
<?php
2

3
$string['invalidurl'] = '不正なURLフォーマット.';
4
$string['modulename'] = 'テストモジュール';
5
$string['modulenameplural'] = 'テストモジュール';
6
$string['namealreadyexists'] = '指定の名称は既に存在している.';
7
$string['pluginadministration'] = 'テストモジュール管理';
8
$string['pluginname'] = 'testmod';
9
$string['testmod:addinstance'] = 'testmodをコースに新規登録する';
10
$string['testmod:view'] = 'testmodを表示する';
11
$string['url'] = 'コンテンツURL';

1
<?php
2

3
function testmod_add_instance($instancedata, $mform = null): int {
4
   global $DB;  // Moodleデータベースにアクセスするためのオブジェクト
5

6
   // 以下の値はフォームで入力されないため自ら更新する
7
   $instancedata->timecreated = time();
8
   $instancedata->timemodified = $instancedata->timecreated;
9

10
   // mod_form.phpで入力させた値をすべて含む$instancedataをMoodleデータベースにそのまま登録する
11
   $instancedata->id = $DB->insert_record('testmod', $instancedata);
12

13
   // ※その他依存したレコードを追加
14

15
   return $instancedata->id;
16
}
17

18
function testmod_update_instance($instancedata, $mform): bool {
19
   global $DB;
20

21
   // 以下の値はフォームで入力されないため自ら更新する
22
   $instancedata->timemodified = time();
23

24
   // mod_form.phpで入力させた値で更新
25
   $instancedata->id = $instancedata->instance;
26
   $DB->update_record('testmod', $instancedata);
27

28
   return true;
29
}
30

31
function testmod_delete_instance($id): bool {
32
   global $DB;
33

34
   if ( !$testmod = $DB->get_record('testmod', ['id' => $id]) ) {
35
      return false;
36
   }
37

38
   // ※その他依存したレコードを削除
39

40
   return $DB->delete_records('testmod', array('id' => $testmod->id));
41
}

1
function testmod_supports(string $feature) {
2
   switch ($feature) {
3
      case FEATURE_GROUPS:
4
      case FEATURE_GROUPINGS:
5
      case FEATURE_MOD_INTRO:
6
      case FEATURE_COMPLETION_TRACKS_VIEWS:
7
      case FEATURE_GRADE_HAS_GRADE:
8
      case FEATURE_GRADE_OUTCOMES:
9
      case FEATURE_BACKUP_MOODLE2:
10
      case FEATURE_SHOW_DESCRIPTION:
11
            return false;
12
      case FEATURE_MOD_PURPOSE:
13
            return MOD_PURPOSE_CONTENT;
14

15
      default:
16
            return null;
17
   }
18
}

1
<?php
2
require_once($CFG->dirroot.'/course/moodleform_mod.php');
3
require_once($CFG->dirroot.'/mod/testmod/lib.php');
4

5
class mod_testmod_mod_form extends moodleform_mod {
6
   // 入力フォームを作成する
7
   function definition() {
8
      global $CFG, $DB, $OUTPUT;
9

10
      // ここに入力フォームを実装
11
      $mform = $this->_form;
12
      $mform->addElement('header', 'general', get_string('general', 'form'));
13
      // 活動名称
14
      $mform->addElement('text', 'name', get_string('name'), ['size' => '64']);
15
      $mform->setType('name', PARAM_TEXT);
16
      $mform->addRule('name', null, 'required', null, 'client');
17
      // 動画URL
18
      $mform->addElement('text', 'url', get_string('url', 'testmod'), ['size' => '64']);
19
      $mform->setType('url', PARAM_TEXT);
20
      $mform->addRule('url', null, 'required', null, 'client');
21
      // 標準コースモジュール要素を追加
22
      $this->standard_coursemodule_elements();
23
      // アクションボタン追加
24
      $this->add_action_buttons();
25
   }
26

27
   // 入力データチェックを行う
28
   function validation($data, $files) {
29
      $errors = parent::validation($data, $files);
30

31
      // URLバリデーション
32
      if (!empty($data['url']) && !filter_var($data['url'], FILTER_VALIDATE_URL)) {
33
          $errors['url'] = get_string('invalidurl', 'testmod');
34
      }
35

36
      // 同一名称チェック
37
      global $DB;
38
      if ($DB->record_exists('testmod', ['name' => $data['name']])) {
39
          $errors['name'] = get_string('namealreadyexists', 'testmod');
40
      }
41

42
      return $errors;
43
   }
44
}

1
<?php
2
require_once('../../config.php');
3

4
$id = required_param('id', PARAM_INT);  // URLからコースIDを取得
5

6
// ユーザがこのコースにアクセスする権限があるか確認する
7
if( !$course = $DB->get_record('course', ['id'=> $id], '*', MUST_EXIST) ){
8
   throw new \moodle_exception('Invalid course ID: ' . $id);
9
}
10

11
require_course_login($course);
12
$PAGE->set_pagelayout('incourse');
13

14
// HTMLヘッダの表示
15
$strmodules = get_string("modulenameplural", "testmod");
16
$PAGE->navbar->add($strmodules);
17
$PAGE->set_title("$course->shortname: $strmodules");
18
$PAGE->set_heading($course->fullname);
19
echo $OUTPUT->header();
20
echo $OUTPUT->heading($strmodules, 2);
21

22
$modinfo = get_fast_modinfo($course);
23
foreach ($modinfo->get_instances_of('testmod') as $instanceid => $cm) {
24
    // モジュールの情報を表示する例
25
    echo $OUTPUT->box(format_string($cm->name));
26
}
27

28
echo $OUTPUT->footer();

1
<?php
2

3
// view.phpの必須処理
4
require_once('../../config.php');
5

6
global $DB, $PAGE, $USER, $OUTPUT;
7

8
$cmid = required_param('id', PARAM_INT);
9
list ($course, $cm) = get_course_and_cm_from_cmid($cmid, 'testmod');
10
require_login($course, true, $cm);
11

12
$testmod = $DB->get_record('testmod', ['id'=> $cm->instance], '*', MUST_EXIST);
13
if (!$testmod) {
14
    throw new moodle_exception('Unable to find the specified test module.');
15
}
16

17
// ページ設定：ヘッダー
18
$PAGE->set_url('/mod/testmod/view.php', ['id' => $cmid]);
19
$PAGE->set_title("$course->shortname: " . format_string($testmod->name));
20
$PAGE->set_heading($course->fullname);
21

22
echo $OUTPUT->header();
23

24
// ページ設定：メイン
25
echo html_writer::tag('a', "クリックして再生", ['href' => $testmod->url]);
26

27
// ページ設定：フッター
28
echo $OUTPUT->footer();

1
<?php
2

3
defined('MOODLE_INTERNAL') || die();
4

5
$plugin->component = 'mod_testmod';  //プラグインの名称
6
$plugin->version = 2024103000;       //プラグインのモジュールバージョン(形式: YYYYMMDDXX: 年, 月, 日, リビジョン)
7
$plugin->requires = 2024100700;      //要求する最小Moodleバージョン
8

9
// プラグインの成熟度（安定性）を指定する
10
//   MATURITY_ALPHA (in testing),
11
//   MATURITY_BETA (more stable testing),
12
//   MATURITY_RC (release candidate),
13
//   MATURITY_STABLE (stable for production)
14
$plugin->maturity = MATURITY_ALPHA;

1
<?php
2
$functions = [
3
   'mod_testmod_create_testmod' => [
4
      'classname'    => 'mod_testmod\external\create_testmod', //クラスの名前空間
5
      'description'  => 'Create new testmod.',  // 外部関数の説明
6
      'type'         => 'write',  // 書き込み操作のために「write」を指定
7
      'capabilities' => 'mod/testmod:addinstance'  // 必須ケイパビリティです
8
   ],
9
];

1
<?php
2
namespace mod_testmod\external;
3

4
use core_external\external_api;
5
use core_external\external_function_parameters;
6
use core_external\external_multiple_structure;
7
use core_external\external_single_structure;
8
use core_external\external_value;
9
use core_external\external_warnings;
10
use invalid_parameter_exception;
11
use moodle_exception;
12

13
defined('MOODLE_INTERNAL') || die();
14

15
class create_testmod extends external_api {
16

17
   // APIの入力パラメータ定義を取得する
18
   //   リテラル値だけの定義の場合、external_value()を用いる
19
   //   構造を持つ定義の場合、external_multiple_structure() > external_single_structure()
20
   //    > external_value() の順で各メンバーを構成する
21
   public static function execute_parameters(): external_function_parameters {
22
      return new external_function_parameters (
23
         [
24
            'courseid' => new external_value(
25
               PARAM_INT,
26
               'id of course',
27
               VALUE_REQUIRED
28
            ),
29
            'name' => new external_value(
30
               PARAM_TEXT,
31
               'activity name',
32
               VALUE_REQUIRED
33
            ),
34
            'url' => new external_value(
35
               PARAM_TEXT,
36
               'content url',
37
               VALUE_DEFAULT,
38
               ''
39
            ),
40
         ]
41
      );
42
   }
43

44
   // APIの戻り値パラメータ定義を取得する
45
   public static function execute($courseid, $name, $url): array {
46
      global $DB;
47

48
      // 入力データのバリデーションチェック
49
      $params = self::validate_parameters(self::execute_parameters(), [
50
         'courseid'       => $courseid,
51
         'name'           => $name,
52
         'url'            => $url,
53
      ]);
54
      $course_id = $params['courseid'];
55

56
      // セキュリティチェック
57
      // 外部関数はシステム全体に影響するユーザを用いるためシステムコンテクストを取得する
58
      $context = \context_system::instance();
59
      self::validate_context($context);
60
      // 自らの処理で必要なケイパビリティを列挙する。自己申告なので要求するケイパビリティを記載しないと素通りしてしまうため注意
61
      require_capability('mod/testmod:addinstance', $context);
62

63
      // Moodle DBトランザクションを介し、例外が発生した時は全クエリをロールバック
64
      $transaction = $DB->start_delegated_transaction();
65

66
      // モジュール定義（testmod）を取得
67
      $module = $DB->get_record('modules', ['name' => 'testmod']);
68

69
      // コースを探す
70
      if( !$course = $DB->get_record('course', ['id' => $course_id]) ){
71
         throw new invalid_parameter_exception('course not found');
72
      }
73

74
      // セクションを作る
75
      $maxsection = $DB->get_field('course_sections', 'MAX(section)', ['course' => $course_id]);
76

77
      $section = new \stdClass();
78
      $section->course       = $course_id;
79
      $section->section      = $maxsection + 1;  // セクションの連番を付ける
80
      $section->name         = 'テストモジュール';
81
      $section->timemodified = time();
82

83
      $section->id = $DB->insert_record('course_sections', $section);
84

85
      // 活動モジュールを作る
86
      $testmod = new \stdClass();
87
      $testmod->course         = $course_id;
88
      $testmod->name           = $params['name'];
89
      $testmod->intro          = "";
90
      $testmod->introformat    = 0;
91
      $testmod->timecreated    = time();
92
      $testmod->timemodified   = $testmod->timecreated;
93
      $testmod->url            = $params['url'];
94

95
      $testmod->id = $DB->insert_record('testmod', $testmod);
96

97
      // コースモジュールを作る
98
      $course_module = new \stdClass();
99
      $course_module->course   = $course_id;
100
      $course_module->module   = $module->id;
101
      $course_module->instance = $testmod->id;
102
      $course_module->section  = $section->id;
103
      $course_module->added    = $testmod->timecreated;
104

105
      $course_module->id = $DB->insert_record('course_modules', $course_module);
106

107
      // セクション更新
108
      if( $sequence = $DB->get_field('course_sections', 'sequence', ['id' => $section->id]) ){
109
         $section->sequence .= ',' . $course_module->id;
110
      } else {
111
         $section->sequence = $course_module->id;
112
      }
113
      $section->timemodified = time();
114
      $DB->update_record('course_sections', $section);
115

116
      // エラー時は自動的にロールバック
117
      $transaction->allow_commit();
118

119
      // コースキャッシュ更新
120
      rebuild_course_cache($course_id, true);
121

122
      return [
123
         'status' => true,
124
         'warnings' => [],
125
      ];
126
   }
127

128
   // APIの戻り値のパラメータ定義を取得する
129
   public static function execute_returns() {
130
      return new external_single_structure(
131
            [
132
               'status' => new external_value(PARAM_BOOL, 'status: true if success'),
133
               'warnings' => new external_warnings()
134
            ]
135
      );
136
   }
137
}