class MaintenanceProxyExtension extends Extension (View source)

Used to configure proxy settings for bringyourownideas/silverstripe-maintenance and its related modules

Properties

protected object $owner

The object this extension is applied to.

from  Extension

Methods

public
__construct()

No description

public static 
add_to_class(string $class, string $extensionClass, mixed $args = null)

Called when this extension is added to a particular class

public
setOwner(object $owner)

Set the owner of this extension.

public
mixed
withOwner(mixed $owner, callable $callback, array $args = [])

Temporarily modify the owner. The original owner is ensured to be restored

public
clearOwner()

Clear the current owner, and restore extension to the state prior to the last setOwner()

public
object
getOwner()

Returns the owner of this extension.

public static 
string
get_classname_without_arguments(string $extensionStr)

Helper method to strip eval'ed arguments from a string that's passed to DataObject::$extensions or Object::add_extension().

public
onAfterBuild()

Configures required environment settings for Composer's use, applies to \BringYourOwnIdeas\Maintenance\Util\ComposerLoader and is applied before ComposerLoaderExtension in bringyourownideas/silverstripe-composer-update-checker to ensure the proxy information is set before Composer is created

public
updateClientOptions(array $options)

Provide proxy options for \BringYourOwnIdeas\Maintenance\Util\ApiLoader instances to use in their Guzzle clients

protected
string
getCwpProxy()

Returns a formatted CWP proxy string, e.g. tcp://proxy.cwp.govt.nz:1234

Details

__construct()

No description

static add_to_class(string $class, string $extensionClass, mixed $args = null)

Called when this extension is added to a particular class

Parameters

string $class
string $extensionClass
mixed $args

setOwner(object $owner)

Set the owner of this extension.

Parameters

object $owner

The owner object

mixed withOwner(mixed $owner, callable $callback, array $args = [])

Temporarily modify the owner. The original owner is ensured to be restored

Parameters

mixed $owner

Owner to set

callable $callback

Callback to invoke

array $args

Args to pass to callback

Return Value

mixed

clearOwner()

Clear the current owner, and restore extension to the state prior to the last setOwner()

object getOwner()

Returns the owner of this extension.

Return Value

object

static string get_classname_without_arguments(string $extensionStr)

Helper method to strip eval'ed arguments from a string that's passed to DataObject::$extensions or Object::add_extension().

Parameters

string $extensionStr

E.g. "Versioned('Stage','Live')"

Return Value

string

Extension classname, e.g. "Versioned"

onAfterBuild()

Configures required environment settings for Composer's use, applies to \BringYourOwnIdeas\Maintenance\Util\ComposerLoader and is applied before ComposerLoaderExtension in bringyourownideas/silverstripe-composer-update-checker to ensure the proxy information is set before Composer is created

updateClientOptions(array $options)

Provide proxy options for \BringYourOwnIdeas\Maintenance\Util\ApiLoader instances to use in their Guzzle clients

Parameters

array $options

protected string getCwpProxy()

Returns a formatted CWP proxy string, e.g. tcp://proxy.cwp.govt.nz:1234

Return Value

string