PHP Class Pantheon\Terminus\Models\Lock

Inheritance: extends TerminusModel

Show file Open project: pantheon-systems/terminus

Public Properties

Property	Type	Description
$environment	Environment

Public Methods

Method	Description
__construct ( $attributes, $options = [] )
add ( array $params ) : Workflow	Enable HTTP Basic Access authentication on the web environment
isLocked ( ) : boolean	Returns whether the associated environment is locked
remove ( ) : Workflow	Disable HTTP Basic Access authentication on the web environment
serialize ( )

Method Details

__construct() public method

public __construct ( $attributes, $options = [] )

add() public method

Enable HTTP Basic Access authentication on the web environment

public add ( array $params ) : Workflow
$params	array	Elements as follow: string username string password
return	Workflow

isLocked() public method

Returns whether the associated environment is locked

public isLocked ( ) : boolean
return	boolean

remove() public method

Disable HTTP Basic Access authentication on the web environment

public remove ( ) : Workflow
return	Workflow

serialize() public method

public serialize ( )

Property Details

$environment public property

public Environment,Pantheon\Terminus\Models $environment
return	Environment