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 SS_Object $owner

The object this extension is applied to.

 from  Extension
protected DataObject $ownerBaseClass

The base class that this extension was applied to; $this->owner must be one of these

 from  Extension
public $class 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(SS_Object $owner, string $ownerBaseClass = null)

Set the owner of this extension.

from  Extension
public
clearOwner()

No description

from  Extension
public
SS_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 thats 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 42
__construct()

No description

in Extension at line 54
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 66
setOwner(SS_Object $owner, string $ownerBaseClass = null)

Set the owner of this extension.

Parameters

SS_Object $owner

The owner object,
string $ownerBaseClass

The base class that the extension is applied to; this may be the class of owner, or it may be a parent. For example, if Versioned was applied to SiteTree, and then a Page object was instantiated, $owner would be a Page object, but $ownerBaseClass would be 'SiteTree'.

in Extension at line 74
clearOwner()

No description

in Extension at line 85
SS_Object getOwner()

Returns the owner of this extension.

Return Value

SS_Object

in Extension at line 97
static string get_classname_without_arguments(string $extensionStr)

Helper method to strip eval'ed arguments from a string thats 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 20
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 34
updateClientOptions(array $options)

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

Parameters

array $options

at line 46
protected string getCwpProxy()

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

Return Value

string