Class Site

Remote Site.

Fluxsauce\Switchboard\Persistent

Extended by

Fluxsauce\Switchboard\Site

Namespace: Fluxsauce\Switchboard
Package: Fluxsauce\Switchboard
Located at library/fluxsauce/switchboard/src/Site.php

Methods summary

`public mixed`	# `__get( string $name )` Magic __get, overriding Persistent. Magic __get, overriding Persistent. Parameters `$name` `string` $name Name of the property. Returns `mixed` Value of set property. Throws `Exception` Overrides `Fluxsauce\Switchboard\Persistent::__get`
`public`	# `environmentAdd( Fluxsauce\Switchboard\Environment $environment )` Helper to add an environment to a Site. Helper to add an environment to a Site. Parameters `$environment` `Fluxsauce\Switchboard\Environment` $environment Environment to add.
`public`	# `environmentRemove( Fluxsauce\Switchboard\Environment $environment )` Helper to remove an environment from a Site. Helper to remove an environment from a Site. Parameters `$environment` `Fluxsauce\Switchboard\Environment` $environment Environment to remove.
`public`	# `read( )` Read a site. Read a site. Overrides `Fluxsauce\Switchboard\Persistent::read`
`public`	# `renderEnvironmentsDrushTable( )` Render a Site's environments as a Drush table. Render a Site's environments as a Drush table.
`public`	# `renderEnvironmentsJson( )` Render a Site's environments as JSON. Render a Site's environments as JSON.
`public array`	# `toArray( )` Dump to an array. Dump to an array. Returns `array` Property names and values. Overrides `Fluxsauce\Switchboard\Persistent::toArray`
`public string`	# `getVcsUrl( )` Build VCS URL. Build VCS URL. Returns `string` A full VCS connection URL.

Methods inherited from Fluxsauce\Switchboard\Persistent

__construct(), __set(), create(), destroy(), getTableName(), render(), renderDrushTable(), renderJson(), update()

Magic methods summary

Properties summary

`protected string`	`$provider`	# The machine name of the Provider. The machine name of the Provider.
`protected string`	`$uuid`	# The UUID of the Site. The UUID of the Site.
`protected string`	`$realm`	# The realm of the site, like devcloud for Acquia. The realm of the site, like devcloud for Acquia.
`protected string`	`$title`	# The machine name of the site. The machine name of the site.
`protected string`	`$unixUsername`	# The UNIX-style username used when SSHing to the site. The UNIX-style username used when SSHing to the site.
`protected string`	`$vcsUrl`	# The Version Control System URL for the site. The Version Control System URL for the site.
`protected string`	`$vcsType`	# The Version Control System type, such as git or svn. The Version Control System type, such as git or svn.
`protected string`	`$vcsProtocol`	# The Version Control System protocol, such as git or ssh. The Version Control System protocol, such as git or ssh.
`protected integer`	`$sshPort`	# The target port for SSH. The target port for SSH.
`protected array`	`$environments`	# Contains instances of Fluxsauce\Switchboard\Environment Contains instances of Fluxsauce\Switchboard\Environment
`protected string`	`$externalKeyName`	# Metadata for ORM defining database structure. Metadata for ORM defining database structure.

Properties inherited from Fluxsauce\Switchboard\Persistent

$id, $name, $updated