1. class
  2. CWP
  3. \
  4. CWP
  5. \
  6. Extension
  7. \
  8. MaintenanceProxyExtension

MaintenanceProxyExtension

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

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

Called when this extension is added to a particular class

from  Extension
public
setOwner(object $owner)

Set the owner of this extension.

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

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

from  Extension
public
clearOwner()

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

from  Extension
public
object
getOwner()

Returns the owner of this extension.

from  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().

from  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

in Extension at line 39
__construct()

No description

in Extension at line 50
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

in Extension at line 60
setOwner(object $owner)

Set the owner of this extension.

Parameters

object $owner

The owner object

in Extension at line 74
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

in Extension at line 87
clearOwner()

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

in Extension at line 100
object getOwner()

Returns the owner of this extension.

Return Value

object

in Extension at line 113
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"

at line 22
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

at line 36
updateClientOptions(array $options)

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

Parameters

array $options

at line 48
protected string getCwpProxy()

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

Return Value

string