Skip to content
Snippets Groups Projects
Commit e2677a45 authored by Ryan Smith's avatar Ryan Smith
Browse files

Merge branch 'master' of github.com:xAPI-vle/moodle-logstore_xapi

parents 8a1fc08a 41d15d81
No related branches found
No related tags found
No related merge requests found
# Plugin Design
This page documents how the plugin is designed. The plugin [controls and configures](../classes/log/store.php) the three parts listed below.
- [Moodle Log Expander](https://github.com/LearningLocker/Moodle-Log-Expander)
- [Moodle to xAPI Translator](https://github.com/LearningLocker/Moodle-xAPI-Translator)
- [xAPI Recipe Emitter](https://github.com/LearningLocker/xAPI-Recipe-Emitter)
- [Moodle Log Expander](../lib/expander)
- [Moodle to xAPI Translator](../lib/translator)
- [xAPI Recipe Emitter](../lib/emitter)
The plugin uses the three parts listed above in the following way.
......
......@@ -16,15 +16,15 @@ If you hadn't already installed the plugin, you'll need to login as an admin and
## Adding Events
Assuming you've followed the [instructions above](#setup), you can modify and test events by updating the code inside the directories below.
- vendor/learninglocker/moodle-log-expander
- vendor/learninglocker/moodle-xapi-translator
- vendor/learninglocker/xapi-recipe-emitter
- lib/expander
- lib/translator
- lib/emitter
If you've read the [plugin design](design.md) you should understand what each of these directories are responsible for. Each of the parts have their own documentation on their respective Github repositories (linked below).
- [Moodle Log Expander](https://github.com/LearningLocker/Moodle-Log-Expander/blob/master/docs/readme.md#adding-events)
- [Moodle to xAPI Translator](https://github.com/LearningLocker/Moodle-xAPI-Translator/blob/master/docs/readme.md#adding-events)
- [xAPI Recipe Emitter](https://github.com/LearningLocker/xAPI-Recipe-Emitter/blob/master/docs/readme.md#adding-events)
- [Moodle Log Expander](../lib/expander/docs/readme.md#adding-events)
- [Moodle to xAPI Translator](../lib/translator/docs/readme.md#adding-events)
- [xAPI Recipe Emitter](../lib/emitter/docs/readme.md#adding-events)
## PHPUnit
Run these with the [Moodle PHPUnit test framework](https://docs.moodle.org/dev/PHPUnit):
......
## Installation and Upgrading
You'll need to install [Composer](https://getcomposer.org/) first.
- Install with `composer require learninglocker/xapi-recipe-emitter`.
- Update with `composer update learninglocker/xapi-recipe-emitter`.
## Supported Events
Mapping for recipe names to recipe classes can be found in the [Controller](../src/Controller.php).
......@@ -47,14 +40,14 @@ When adding new events or modifying existing events, we recommend that you follo
If this is your first pull request, you need to follow the steps below.
1. Click the "Fork" button (top right of Github). Github will fork (copy) this repository as your own so you can make changes.
2. Run `git remote set-url origin https://github.com/YOUR_USERNAME/xAPI-Recipe-Emitter.git` (replacing `YOUR_USERNAME` for your Github username).
2. Run `git remote set-url origin https://github.com/YOUR_USERNAME/moodle-logstore_xapi.git` (replacing `YOUR_USERNAME` for your Github username).
Once this is done, you can then follow the steps for [subsequent pull requests](#subsequent-pull-requests) below.
### Subsequent Pull Requests
1. Run `git add -A; git commit -am "DESCRIPTION";` to commit your changes (replacing `DESCRIPTION` with a description of what you've changed).
2. Run `git push` to push your commits to your forked repository.
3. Go to "https://github.com/YOUR_USERNAME/xAPI-Recipe-Emitter/pulls" (replacing `YOUR_USERNAME` for your Github username).
3. Go to "https://github.com/YOUR_USERNAME/moodle-logstore_xapi/pulls" (replacing `YOUR_USERNAME` for your Github username).
4. Click the "New pull request" button to begin creating your pull request.
5. Click the "Create pull request" button (twice) to confirm the creation of your pull request.
......
## Installation and Upgrading
You'll need to install [Composer](https://getcomposer.org/) first.
- Install with `composer require learninglocker/moodle-log-expander`.
- Update with `composer update learninglocker/moodle-log-expander`.
## Supported Events
Mapping for moodle event names to expander event classes can be found in the [Controller](../src/Controller.php).
......@@ -69,14 +62,14 @@ When adding new events or modifying existing events, we recommend that you follo
If this is your first pull request, you need to follow the steps below.
1. Click the "Fork" button (top right of Github). Github will fork (copy) this repository as your own so you can make changes.
2. Run `git remote set-url origin https://github.com/YOUR_USERNAME/Moodle-Log-Expander.git` (replacing `YOUR_USERNAME` for your Github username).
2. Run `git remote set-url origin https://github.com/YOUR_USERNAME/moodle-logstore_xapi.git` (replacing `YOUR_USERNAME` for your Github username).
Once this is done, you can then follow the steps for [subsequent pull requests](#subsequent-pull-requests) below.
### Subsequent Pull Requests
1. Run `git add -A; git commit -am "DESCRIPTION";` to commit your changes (replacing `DESCRIPTION` with a description of what you've changed).
2. Run `git push` to push your commits to your forked repository.
3. Go to "https://github.com/YOUR_USERNAME/Moodle-Log-Expander/pulls" (replacing `YOUR_USERNAME` for your Github username).
3. Go to "https://github.com/YOUR_USERNAME/moodle-logstore_xapi/pulls" (replacing `YOUR_USERNAME` for your Github username).
4. Click the "New pull request" button to begin creating your pull request.
5. Click the "Create pull request" button (twice) to confirm the creation of your pull request.
......
## Installation and Upgrading
You'll need to install [Composer](https://getcomposer.org/) first.
- Install with `composer require learninglocker/moodle-xapi-translator`.
- Update with `composer update learninglocker/moodle-xapi-translator`.
## Supported Events
Mapping for moodle event names to translator event classes can be found in the [Controller](../src/Controller.php).
......@@ -70,14 +63,14 @@ When adding new events or modifying existing events, we recommend that you follo
If this is your first pull request, you need to follow the steps below.
1. Click the "Fork" button (top right of Github). Github will fork (copy) this repository as your own so you can make changes.
2. Run `git remote set-url origin https://github.com/YOUR_USERNAME/Moodle-xAPI-Translator.git` (replacing `YOUR_USERNAME` for your Github username).
2. Run `git remote set-url origin https://github.com/YOUR_USERNAME/moodle-logstore_xapi.git` (replacing `YOUR_USERNAME` for your Github username).
Once this is done, you can then follow the steps for [subsequent pull requests](#subsequent-pull-requests) below.
### Subsequent Pull Requests
1. Run `git add -A; git commit -am "DESCRIPTION";` to commit your changes (replacing `DESCRIPTION` with a description of what you've changed).
2. Run `git push` to push your commits to your forked repository.
3. Go to "https://github.com/YOUR_USERNAME/Moodle-xAPI-Translator/pulls" (replacing `YOUR_USERNAME` for your Github username).
3. Go to "https://github.com/YOUR_USERNAME/moodle-logstore_xapi/pulls" (replacing `YOUR_USERNAME` for your Github username).
4. Click the "New pull request" button to begin creating your pull request.
5. Click the "Create pull request" button (twice) to confirm the creation of your pull request.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment