Class ProviderPantheon

Pantheon specific API interactions.

Fluxsauce\Switchboard\Provider

Extended by

Fluxsauce\Switchboard\ProviderPantheon

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

Methods summary

`public string`	# `siteGetField( string $site_name, string $field )` A mapping function that calls the appropriate API to populate a field. A mapping function that calls the appropriate API to populate a field. Parameters `$site_name` `string` $site_name Machine name of the site in question. `$field` `string` $field Name of the field to populate. Returns `string` The value of the field. Throws `Exception` Unknown field name.
`public`	# `apiGetSite( string $site_name )` Perform an API call to get site information from a Provider. Perform an API call to get site information from a Provider. Parameters `$site_name` `string` $site_name The name of the site in question.
`public`	# `apiGetSites( )` Populate available Sites from a Provider. Populate available Sites from a Provider.
`public`	# `apiGetSiteName( string $site_name )` API call to get the human readable name of a Site. API call to get the human readable name of a Site. Parameters `$site_name` `string` $site_name The machine name of a site.
`public array`	# `requestsOptionsCustom( )` Provider specific options for Requests. Provider specific options for Requests. Returns `array` Options for the request; see Requests::request for details.
`public boolean`	# `authLogin( string $email, string $password )` Log in to target Provider. Log in to target Provider. Parameters `$email` `string` $email The email address of the user. `$password` `string` $password The password of the user. Returns `boolean` Indicates success.
`public boolean`	# `authIsLoggedIn( )` Determine whether a user is logged-in to a Provider. Determine whether a user is logged-in to a Provider. Returns `boolean` TRUE if they are.
`public string`	# `authLoginGetSessionFromHeaders( array $headers )` Parse session out of a header. Parse session out of a header. Based on terminus_pauth_get_session_from_headers(). Parameters `$headers` `array` $headers Headers to parse. Returns `string` The session cookie, if found.
`public string`	# `authLoginGetFormBuildId( string $html )` Parse form build ID, based on terminus_pauth_login_get_form_build_id(). Parse form build ID, based on terminus_pauth_login_get_form_build_id(). Parameters `$html` `string` $html The raw HTML to parse. Returns `string` The login form_build_id, if found.
`public`	# `apiGetSiteEnvironments( string $site_name )` Populate available Site Environments from a Provider. Populate available Site Environments from a Provider. Parameters `$site_name` `string` $site_name The machine name of the site in question.
`public`	# `apiGetSiteEnvDbs( string $site_name, string $env_name )` Get and populate list of Databases for a particular Environment. Get and populate list of Databases for a particular Environment. Parameters `$site_name` `string` $site_name The machine name of the Site. `$env_name` `string` $env_name The machine name of the Site Environment.
`public array`	# `apiGetSiteEnvDbBackups( string $site_name, string $env_name )` Get a list of database backups for a particular Site Environment. Get a list of database backups for a particular Site Environment. Parameters `$site_name` `string` $site_name The machine name of the Site. `$env_name` `string` $env_name The machine name of the Site Environment. Returns `array` An array of Backup arrays keyed by the timestamp. Each Backup array has the following keys: - 'filename' - 'url' - 'timestamp'
`public array`	# `getSiteEnvDbBackupLatest( string $site_name, string $env_name )` Helper function to get the latest database backup. Helper function to get the latest database backup. Parameters `$site_name` `string` $site_name The machine name of the Site in question. `$env_name` `string` $env_name The machine name of the Site Environment in question. Returns `array` A backup array as defined in apiGetSiteEnvDbBackups(). Overrides `Fluxsauce\Switchboard\Provider::getSiteEnvDbBackupLatest`
`public string`	# `apiGetBackupDownloadUrl( string $site_name, string $env_name, string $bucket, string $element )` Helper function to get the S3 backup URL. Helper function to get the S3 backup URL. Parameters `$site_name` `string` $site_name The machine name of the Site in question. `$env_name` `string` $env_name The machine name of the Site Environment in question. `$bucket` `string` $bucket The S3 bucket. `$element` `string` $element Elements are db, code, files. Returns `string` The S3 URL of the backup.
`public string`	# `apiDownloadBackup( array $backup, string $destination )` Download a backup. Download a backup. Parameters `$backup` `array` $backup An array from apiGetSiteEnvDbBackups(). `$destination` `string` $destination The path to the destination. Returns `string` The full path to the downloaded backup.
`public string`	# `getFilesPath( string $site_name, string $env_name )` Get the remote path to files for a particular Site Environment. Get the remote path to files for a particular Site Environment. Parameters `$site_name` `string` $site_name The machine name of the Site in question. `$env_name` `string` $env_name The machine name of the Site Environment in question. Returns `string` The full path of the files directory.

Methods inherited from Fluxsauce\Switchboard\Provider

__construct(), __get(), authLogout(), drushCacheBinAuthName(), getInstance(), requestsOptions(), siteDestroy(), siteExists(), sitesDestroy()

Magic methods summary

Properties summary

`protected string`	`$name`	# Machine name of the Provider. Machine name of the Provider.
`protected string`	`$label`	# Human readable label for the Provider. Human readable label for the Provider.
`protected string`	`$homepage`	# Homepage URL for the provider. Homepage URL for the provider.
`protected string`	`$endpoint`	# Endpoint URL for the provider. Endpoint URL for the provider.

Properties inherited from Fluxsauce\Switchboard\Provider