PHP Class Pantheon\Terminus\Collections\Domains

Inheritance: extends EnvironmentOwnedCollection

Show file Open project: pantheon-systems/terminus Class Usage Examples

Protected Properties

Property	Type	Description
$collected_class	string
$hydrate		Use to hydrate the data with additional information
$url	string

Public Methods

Method	Description
create ( string $domain ) : array	Adds a domain to the environment
getUrl ( )
has ( $domain ) : boolean	Does the Domains collection contain the given domain?
setHydration ( mixed $value ) : Domains	Changes the value of the hydration property

Method Details

create() public method

Adds a domain to the environment

public create ( string $domain ) : array
$domain	string	Domain to add to environment
return	array

getUrl() public method

public getUrl ( )

has() public method

Does the Domains collection contain the given domain?

public has ( $domain ) : boolean
$domain
return	boolean	True if the domain exists in the collection.

setHydration() public method

Changes the value of the hydration property

public setHydration ( mixed $value ) : Domains
$value	mixed	Value to set the hydration property to
return	Domains

Property Details

$collected_class protected property

protected string $collected_class
return	string

$hydrate protected property

Use to hydrate the data with additional information

protected $hydrate

$url protected property

protected string $url
return	string