https://github.com/catalyst/moodle-local_aws
A moodle plugin containing Amazon's SDK for PHP.
https://github.com/catalyst/moodle-local_aws
Last synced: about 1 year ago
JSON representation
A moodle plugin containing Amazon's SDK for PHP.
- Host: GitHub
- URL: https://github.com/catalyst/moodle-local_aws
- Owner: catalyst
- Created: 2017-03-01T02:46:03.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-05-21T23:22:54.000Z (about 2 years ago)
- Last Synced: 2025-04-05T00:41:23.855Z (about 1 year ago)
- Language: PHP
- Size: 10.8 MB
- Stars: 17
- Watchers: 35
- Forks: 31
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://github.com/catalyst/moodle-local_aws/actions)
# AWS SDK - Moodle Plugin
A moodle plugin containing Amazon's SDK for PHP.
## Why does this exist? ##
There is a growing collection of various moodle plugins that require these AWS libraries in order to work.
We don't want to have multiple copies of these libraries bundled into each plugin, firstly because they
are quite large, but also because it can cause issues with library namespaces and php auto loading.
Plugins that depend on this library are:
https://github.com/catalyst/moodle-fileconverter_librelambda
https://github.com/catalyst/moodle-filter_smartmedia
https://github.com/catalyst/moodle-local_smartmedia
https://github.com/catalyst/moodle-logstore_standardqueued
https://github.com/catalyst/moodle-search_elastic
https://github.com/catalyst/moodle-tool_cloudmetrics
https://github.com/catalyst/moodle-tool_emailutils
https://github.com/catalyst/moodle-tool_mfa/tree/master/factor/sms
https://github.com/catalyst/moodle-tool_objectfs
https://github.com/catalyst/moodle-tool_s3logs
## Branches
| Moodle version | Branch |
| ----------------- | ---------------- |
| Moodle 3.3+ | master |
## SDK Usage
To use the SDK, simply include the autoloader contained within this plugin.
```php
require_once($CFG->dirroot . '/local/aws/sdk/aws-autoloader.php');
```
If you are writing a plugin that will use this SDK, it is recommended that you add this to the plugin's version.php:
```php
$plugin->dependencies = array(
'local_aws' => 2022011300
);
```
Also you can use AWS region admin setting in your plugin like:
```php
use local_aws\admin_settings_aws_region;
...
$settings->add(new admin_settings_aws_region('my_plugin/s3_region',
new \lang_string('settings:aws:region', 'my_plugin'),
new \lang_string('settings:aws:region_help', 'my_plugin'), ''));
```
## Installation
You can install this plugin from the plugin directory or get the latest version
on GitHub.
```bash
git clone https://github.com/catalyst/moodle-local_aws local/aws
```
# Crafted by Catalyst IT
This plugin was developed by Catalyst IT Australia:
https://www.catalyst-au.net/
# Contributing and Support
Issues, and pull requests using github are welcome and encouraged!
https://github.com/catalyst/moodle-local_aws/issues
If you would like commercial support or would like to sponsor additional improvements
to this plugin please contact us:
https://www.catalyst-au.net/contact-us