core\aws\aws_helper Class Reference

This class contains functions that help plugins to interact with the AWS SDK. More...

Static Public Member Functions
static	configure_client_proxy (AwsClient $client)
	Configure the provided AWS client to route traffic via the moodle proxy for any hosts not excluded.
static	get_proxy_string ()
	This creates a proxy string suitable for use with the AWS SDK.

Static Protected Member Functions
static	add_proxy_when_required ()
	Generate a middleware higher order function to wrap the handler and append proxy configuration based on target.

Detailed Description

This class contains functions that help plugins to interact with the AWS SDK.

Copyright

2020 Catalyst IT

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

add_proxy_when_required()

static core\aws\aws_helper::add_proxy_when_required ( )

staticprotected

Generate a middleware higher order function to wrap the handler and append proxy configuration based on target.

Return values

callable

Middleware high order callable.

configure_client_proxy()

static core\aws\aws_helper::configure_client_proxy ( AwsClient $client )

static

Configure the provided AWS client to route traffic via the moodle proxy for any hosts not excluded.

Parameters

AwsClient

$client

Return values

AwsClient

get_proxy_string()

static core\aws\aws_helper::get_proxy_string ( )

static

This creates a proxy string suitable for use with the AWS SDK.

Return values

string

the string to use for proxy settings.

---

The documentation for this class was generated from the following file:

• lib/classes/aws/aws_helper.php