PHP Class DeploymentStrategy

Inheritance: extends ViewableData
Afficher le fichier Open project: silverstripe/deploynaut Class Usage Examples

Protected Properties

Свойство Type Description
$actionCode string
$actionTitle string
$changes array
$environment DNEnvironment
$estimatedTime integer
$messages array
$options array
$validationCode string Validation code

Méthodes publiques

Méthode Description
__construct ( DNEnvironment $environment, array $options = [] )
createDeployment ( ) : DNDeployment
fromArray ( string $data ) Load from array.
fromJSON ( string $json ) Load from JSON associative array.
getActionCode ( ) : string
getActionTitle ( ) : string
getChange ( $key ) : ArrayData | null Returns a change or a given key.
getChanges ( ) : array
getChangesModificationNeeded ( ) : array Filter the changeset where modification was not required.
getEstimatedTime ( ) : integer
getMessages ( ) : array
getOption ( string $option ) : string | null
getOptions ( ) : string
getValidationCode ( ) : string
setActionCode ( $code )
setActionTitle ( string $title )
setChange ( string $title, string $from, string $to )
setChangeDescriptionOnly ( string $title, string $desc )
setChanges ( array $data )
setEstimatedTime ( $seconds )
setMessage ( string $msg, $code = self::ERROR_CODE )
setOption ( string $option, string $value )
setValidationCode ( string $code )
toArray ( ) : array Transform the deployment strategy to an array.
toJSON ( ) : string
updateDeployment ( integer $deploymentID ) : DNDeployment

Method Details

__construct() public méthode

public __construct ( DNEnvironment $environment, array $options = [] )
$environment DNEnvironment
$options array

createDeployment() public méthode

public createDeployment ( ) : DNDeployment
Résultat DNDeployment

fromArray() public méthode

Environment must be set by the callee when creating this object.
public fromArray ( string $data )
$data string

fromJSON() public méthode

Environment must be set by the callee when creating this object.
public fromJSON ( string $json )
$json string

getActionCode() public méthode

public getActionCode ( ) : string
Résultat string

getActionTitle() public méthode

public getActionTitle ( ) : string
Résultat string

getChange() public méthode

Returns a change or a given key.
public getChange ( $key ) : ArrayData | null
Résultat ArrayData | null

getChanges() public méthode

public getChanges ( ) : array
Résultat array Associative array of changes, e.g. array( 'SHA' => array( 'from' => 'abc', 'to' => 'def' ) )

getChangesModificationNeeded() public méthode

Filter the changeset where modification was not required.
public getChangesModificationNeeded ( ) : array
Résultat array

getEstimatedTime() public méthode

public getEstimatedTime ( ) : integer
Résultat integer Time in minutes

getMessages() public méthode

public getMessages ( ) : array
Résultat array

getOption() public méthode

public getOption ( string $option ) : string | null
$option string
Résultat string | null

getOptions() public méthode

public getOptions ( ) : string
Résultat string

getValidationCode() public méthode

public getValidationCode ( ) : string
Résultat string

setActionCode() public méthode

public setActionCode ( $code )

setActionTitle() public méthode

public setActionTitle ( string $title )
$title string

setChange() public méthode

public setChange ( string $title, string $from, string $to )
$title string
$from string
$to string

setChangeDescriptionOnly() public méthode

public setChangeDescriptionOnly ( string $title, string $desc )
$title string
$desc string

setChanges() public méthode

public setChanges ( array $data )
$data array

setEstimatedTime() public méthode

public setEstimatedTime ( $seconds )

setMessage() public méthode

public setMessage ( string $msg, $code = self::ERROR_CODE )
$msg string

setOption() public méthode

public setOption ( string $option, string $value )
$option string
$value string

setValidationCode() public méthode

public setValidationCode ( string $code )
$code string

toArray() public méthode

Transform the deployment strategy to an array.
public toArray ( ) : array
Résultat array

toJSON() public méthode

public toJSON ( ) : string
Résultat string

updateDeployment() public méthode

public updateDeployment ( integer $deploymentID ) : DNDeployment
$deploymentID integer
Résultat DNDeployment

Property Details

$actionCode protected_oe property

protected string $actionCode
Résultat string

$actionTitle protected_oe property

protected string $actionTitle
Résultat string

$changes protected_oe property

protected array $changes
Résultat array

$environment protected_oe property

protected DNEnvironment $environment
Résultat DNEnvironment

$estimatedTime protected_oe property

protected int $estimatedTime
Résultat integer

$messages protected_oe property

protected array $messages
Résultat array

$options protected_oe property

protected array $options
Résultat array

$validationCode protected_oe property

Validation code
protected string $validationCode
Résultat string