• Página Inicial
• Acquia
• CloudApi
• Client
• CloudApi

PHP Class Acquia\CloudApi\Client\CloudApi

This object provides sensible method signatures for almost all of the cloudapi calls. The only one that is missing at this point is the one that installs a drupal distro. I can't see that being relevant to our work, and actually could be quite dangerous. Configuration: This class is meant to be used from the gardener. The other sites in gardens will not have the appropriate credentials. Example: $api = New CloudApi() print_r($api->listDatabases('tangle001', 'prod')); Exibir arquivo Open project: acquia/cloudapi-php-client

Protected Properties

Property	Type	Description
$allCreds
$cainfo
$default_options

Public Methods

Method	Description
__sleep ( )	This class is not serializable.
addDatabase ( $site, $db, $cluster_map = NULL )	Add a database
addDomain ( $site, $env, $domain )	Add a domain name.
addSSHKey ( $site, $nickname, $ssh_pub_key )	Add an SSH key
addSVNUser ( $site, $username, $password )	Add an SVN user
backupDatabase ( $site, $env, $db )	Create a database instance backup.
copyDatabase ( $site, $db, $source, $target )	Copy a database from one site environment to another
copyFiles ( $site, $source, $target )	Copy files from one site environment to another.
deleteDatabase ( $site, $db, $backup = 1 )	Delete a database
deleteDatabaseBackup ( $site, $env, $db, $backup )	Delete a site environment database instance backup.
deleteDomain ( $site, $env, $domain )	Delete a domain.
deleteSSHKey ( $site, $sshkeyid )	Delete an SSH key.
deleteSVNUser ( $site, $sshuserid )	Delete an SVN user
deployCode ( $site, $source, $target )	Deploy code from one site environment to another.
deployCodePath ( $site, $env, $path )	Deploy a specific VCS branch or tag to an environment.
getAllSiteNames ( )	Returns the set of all site names from the credentials file.
getDatabaseBackupInfo ( $site, $env, $db, $backup )	Get details about a database instance backup.
getDatabaseBackupLocation ( $site, $env, $db, $backup )	Get the location from which a backup can be downloaded.
getDatabaseClusterMap ( $site, $envs = NULL )	Returns an array of suitable database clusters for each environment.
getDatabaseInfo ( $site, $env, $db )	Get a database instance.
getDomainInfo ( $site, $env, $domain )	Get a domain record.
getEnvironmentInfo ( $site, $env )	Gets an environment record.
getInstance ( $site_name = NULL, $stage = NULL, $creds_filename = NULL ) : CloudApi	Returns an instance of CloudApi, reusing a previous one if available.
getSSHKey ( $site, $sshkeyid )	Get an SSH key
getSVNUser ( $site, $svnuserid )	Get an SVN user.
getServerInfo ( $site, $env, $server )	Get a server record.
getSiteName ( {String} $site )	Returns the site name.
getSiteRecord ( $site )	Gets a site record.
getStage ( )	Returns the stage this CloudApi instance is configured to communicate with.
getTaskInfo ( $site, $task )	Get a task record.
getTasks ( $site )	List a site's tasks.
installEnvironment ( $site, $env, $type, $source )	Installs a drupal distro.
listDatabaseBackups ( $site, $env, $db )	List a site environment's database instance backups.
listDatabases ( $site, $env )	List a site environment's database instances.
listDomains ( $site, $env )	List the environment's domains.
listEnvironments ( $site )	List a site's environments.
listSSHKeys ( $site )	List a site's SSH keys.
listSVNUsers ( $site )	List a site's SVN users.
listServers ( $site, $env )	List a site environment's servers.
listSites ( $site )	Lists all sites accessible by the caller.
moveAllDomains ( string $sitegroup, string $from_env, string $to_env, boolean $skip_site_update = TRUE ) : array	Moves all domains on a site atomically from one environment to another.
moveDomains ( string | array $domains, string $sitegroup, string $from_env, string $to_env, boolean $skip_site_update = TRUE )	Moves domains atomically from one environment to another.
purgeVarnish ( $site, $env, $domain )	Purge the Varnish cache for a domain.
restoreDatabase ( $site, $env, $db, $backup )	Restore a site environment database instance backup.
setCaInfo ( $path )	Set the path to a CA file for curl.
setDefaultCallOption ( $key, $value )	Set a default option for the callAcapi() method.

Private Methods

Method	Description
__construct ( $site_name, $stage = NULL, $creds_filename = NULL )	Constructor.
callAcapi ( $site, $method, $resource, $params = [], $body = [], $options = [] )	Call an Acquia Cloud API resource.
getCreds ( {mixed} $site )	Returns the credentials for the specified site.

Method Details

Property Details