Network System Laboratory - Moodle/Programming [Moodle Programing]

[ Freeze | Diff | Backup | Reload ]

Table of contents

Moodle Programing

構成

module
block

SITEID

Network機能を使用するときに使用する識別ID．Local の場合は 1

Context

module

$cm = get_coursemodule_from_instance('mdlds', $minstance->id, $course->id, false, MUST_EXIST); // コースモジュール
- $cm = get_coursemodule_from_id() も使用可

$mcontext = context_module::instance($cm->id); // モジュールコンテキスト
$ccontext = context_course::instance($course->id); // コースコンテキスト

block

$context = context_block::instance($this->instance->id); // ブロックコンテキスト

POST, GET

required_param('course', PARAM_INT);
optional_param('mode', default, PARAM_ALPHA);
- PARAM_*

権限用

~~isadmin()~~
- see jbxl_moodle_tools.php
~~isteacher($course->id)~~
- see jbxl_moodle_tools.php
~~isguest()~~
- isguestuser()

function require_login

ログインしているかどうかをチェックする．
lib/moodlelib.php

require_login($courseorid=NULL, $autologinguest=true, $cm=NULL, $setwantsurltome=true, $preventredirect=false)

この関数を呼ばない場合，contextlevel は CONTEXT_SYSTEM (10) になる．
$cm が NULL の場合， contextlevel は CONTEXT_COURSE (50) になる．
$cm が NULL でない場合，contextlevel は CONTEXT_MODULE (70) になる．
- contextlevel が CONTEXT_MODULE　の場合，管理ブロック(settings) にモジュールの管理メニューが　dock される (lib/navigationlib.php)．

DB

lib/dmllib.php

$DB (データベースアクセス)

データベース作成

XMLDB
- http://dev.moodle.org/mod/resource/view.php?id=48
- blocks/mod にディレクトリを作成し，その中に dbディレクトリを作る．
- 「サイト管理」→「その他」→「XMLDBエディタ」　でデータベース定義用の db/install.xml を作成する．

大域変数, オブジェクト

$CFG

$CFG->wwwroot // top url
$CFG->prefix

$PAGE

$USER

$OUTPUT

$_POST

ポストデータが入る
empty($_POST)

block_base

HTML出力

$OUTPUT

$OUTPUT を使う

ひたすら HTML を書く．

自由度，無限大．または，ひたすら土方仕事．

new flexible_table('...') を使う．

lib/tablelib.php
- $table = new flexible_table('modulename-view-'.$courseid);
- $data = ....
- $table->add_data($data);
- $table->print_html();

new html_table() と html_writer::table() を使用する．

簡単だが，自由度が無い．
表のヘッダを別に定義できる．
html_writer

URL

class moodle_url

lib/weblib.php

$base_url = new moodle_url('/mod/apply/'.$action_file);
$base_url->params(array('id'=>$id, 'courseid'=>$courseid));

Form

Form 一覧

Submit

      if (data_submitted()) {
           if (!confirm_sesskey()) {
               print_error('sesskey_error', 'mdlds', $this->action_url);
           }
       }

$SESSION を使う

$SESSION->sample = new stdClass();
$SESSION->sample->XXXX = 色々セット
submit 後に $SESSION->sample->XXXX をチェック．

File Storage Class

メッセージ

get_string( , )

settings.php

admin_setting_configtext
admin_setting_configcheckbox
admin_setting_configselect

メッセージの送信

messsage_send()

   $eventdata = new stdClass();
   $eventdata->name              = 'processed';
   $eventdata->component         = 'mod_apply';
   $eventdata->userfrom          = $fuser;    // id またはオブジェクト
   $eventdata->userto            = $user;     // id またはオブジェクト
   $eventdata->subject           = $postsubject;
   $eventdata->fullmessage       = $posttext;
   $eventdata->fullmessageformat = FORMAT_PLAIN;
   $eventdata->fullmessagehtml   = $posthtml;
   $eventdata->smallmessage      = '';
   $eventdata->notification      = 1;
   //
   message_send($eventdata);

name の processed に対応した　messageprovidersを db/messages.php に追加

$messageproviders = array (
/// Submitting a apply
   'submission' => array (
   ),

   'processed' => array (
   )
);

moodle のバージョン番号を上げて，アップデート

Capability

RISK_SPAM - ユーザーがサイトに目に見えるコンテンツを追加したり，他のユーザーにメッセージを送ることができます．
RISK_PERSONAL - 個人情報へのアクセス - 例：ユーザー詳細のバックアップ，プロフィールの非公開情報（隠しメール）等；本来は isteacher() で保護されています．
RISK_XSS - ユーザーがクリーンアップされていないコンテンツ (アクティブなコンテンツを含む HTML と保護されていないファイルの両方) を送信することができます．
RISK_CONFIG - ユーザーがグローバルな設定を変更できる，アクションにサニティチェックがない
RISK_MANAGETRUST - 他ユーザーのトラストビットマスクを管理する．
RISK_DATALOSS - 容易に復元できない大量の情報を破壊する可能性があります．

Capability が正常に反映されない場合は，一旦 db/access.php の設定部分をコメントアウトして，更新する（version を上げる）
その後コメントを外して，更新する（version を上げる）

ログ

~~lib/moodlelib.php~~
~~function add_to_log($courseid, $module, $action, $url=, $info=, $cm=0, $user=0)~~

2.6 から add_to_log() は　deprecated
event log を使う
see event log

Table of LOG Data

http://docs.moodle.org/dev/Migrating_log_access_in_reports

mdl_logstore_standard_log

MariaDB [moodle_db]> show columns from mdl_logstore_standard_log;
+-------------------+--------------+------+-----+---------+----------------+
| Field             | Type         | Null | Key | Default | Extra          |
+-------------------+--------------+------+-----+---------+----------------+
| id                | bigint(10)   | NO   | PRI | NULL    | auto_increment |
| eventname         | varchar(255) | NO   |     |         |                |
| component         | varchar(100) | NO   |     |         |                |
| action            | varchar(100) | NO   |     |         |                |
| target            | varchar(100) | NO   |     |         |                |
| objecttable       | varchar(50)  | YES  |     | NULL    |                |
| objectid          | bigint(10)   | YES  |     | NULL    |                |
| crud              | varchar(1)   | NO   |     |         |                |
| edulevel          | tinyint(1)   | NO   |     | NULL    |                |
| contextid         | bigint(10)   | NO   |     | NULL    |                |
| contextlevel      | bigint(10)   | NO   |     | NULL    |                |
| contextinstanceid | bigint(10)   | NO   |     | NULL    |                |
| userid            | bigint(10)   | NO   | MUL | NULL    |                |
| courseid          | bigint(10)   | YES  | MUL | NULL    |                |
| relateduserid     | bigint(10)   | YES  |     | NULL    |                |
| anonymous         | tinyint(1)   | NO   |     | 0       |                |
| other             | longtext     | YES  |     | NULL    |                |
| timecreated       | bigint(10)   | NO   | MUL | NULL    |                |
| origin            | varchar(10)  | YES  |     | NULL    |                |
| ip                | varchar(45)  | YES  |     | NULL    |                |
| realuserid        | bigint(10)   | YES  |     | NULL    |                |
+-------------------+--------------+------+-----+---------+----------------+
21 rows in set (0.00 sec)