Свойство | Тип | Описание | |
---|---|---|---|
$allCreds | |||
$cainfo | |||
$default_options |
Метод | Описание | |
---|---|---|
__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 ) : |
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. |
Метод | Описание | |
---|---|---|
__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. |
public __sleep ( ) |
public addDatabase ( $site, $db, $cluster_map = NULL ) | ||
$site | the site name (ex: tangle001, gardener, etc.) | |
$db | the database name | |
$cluster_map | a mapping containing all environments and the cluster to which the associated database should be created. (See getDatabaseClusterMap). Note that if more than one cluster is associated with a sitegroup, this map is required. |
public addDomain ( $site, $env, $domain ) | ||
$site | the site name (ex: tangle001, gardener, etc.) | |
$env | the environment name | |
$domain | the domain name to add |
public addSSHKey ( $site, $nickname, $ssh_pub_key ) | ||
$site | the site name (ex: tangle001, gardener, etc.) | |
$nickname | key nickname | |
$ssh_pub_key | SSH public key |
public addSVNUser ( $site, $username, $password ) | ||
$site | the site name (ex: tangle001, gardener, etc.) | |
$password | user svn password |
public backupDatabase ( $site, $env, $db ) | ||
$site | the site name (ex: tangle001, gardener, etc.) | |
$env | the environment name | |
$db | the database name |
public copyDatabase ( $site, $db, $source, $target ) | ||
$site | the site name (ex: tangle001, gardener, etc.) | |
$db | the database name | |
$source | the source environment name | |
$target | the target environment name |
public copyFiles ( $site, $source, $target ) | ||
$site | the site name (ex: tangle001, gardener, etc.) | |
$source | the source environment name | |
$target | the target environment name |
public deleteDatabase ( $site, $db, $backup = 1 ) | ||
$site | the site name (ex: tangle001, gardener, etc.) | |
$db | the database name | |
$backup | a final backup of the database instance in each environment is made before deletion unless this query parameter has value 0. |
public deleteDatabaseBackup ( $site, $env, $db, $backup ) | ||
$site | the site name (ex: tangle001, gardener, etc.) | |
$env | the environment name (ex: prod, dev) | |
$db | the database name | |
$backup | the backup id |
public deleteDomain ( $site, $env, $domain ) | ||
$site | the site name (ex: tangle001, gardener, etc.) | |
$env | the environment name (ex: prod, dev) | |
$domain | the domain name to delete |
public deleteSSHKey ( $site, $sshkeyid ) | ||
$site | the site name (ex: tangle001, gardener, etc.) | |
$sshkeyid | Key id |
public deleteSVNUser ( $site, $sshuserid ) | ||
$site | the site name (ex: tangle001, gardener, etc.) |
public deployCode ( $site, $source, $target ) | ||
$site | the site name (ex: tangle001, gardener, etc.) | |
$source | the source environment name | |
$target | the target environment name |
public deployCodePath ( $site, $env, $path ) | ||
$site | the site name (ex: tangle001, gardener, etc.) | |
$env | the environment name | |
$path | the name of the branch or tag (e.g. master or tags/tagname) |
public getAllSiteNames ( ) |
public getDatabaseBackupInfo ( $site, $env, $db, $backup ) | ||
$site | the site name (ex: tangle001, gardener, etc.) | |
$env | the environment name (ex: prod, dev) | |
$db | the database name (ex: 'g76') | |
$backup | the backup id (ex: 217005) |
public getDatabaseBackupLocation ( $site, $env, $db, $backup ) | ||
$site | the site name (ex: tangle001, gardener, etc.) | |
$env | the environment name (ex: prod, dev) | |
$db | the database name (ex: 'g76') | |
$backup | the backup id (ex: 217005) |
public getDatabaseClusterMap ( $site, $envs = NULL ) | ||
$site | the site name (ex: tangle001, gardener, etc.) | |
$envs | The environment list (from listEnvironments). If not provided the environments will be retrieved. |
public getDatabaseInfo ( $site, $env, $db ) | ||
$site | the site name (ex: tangle001, gardener, etc.) | |
$env | the environment name (ex: prod, dev) | |
$db | the database name (ex: 'g76') |
public getDomainInfo ( $site, $env, $domain ) | ||
$site | the site name (ex: tangle001, gardener, etc.) | |
$env | the environment name (ex: prod, dev) | |
$domain | the domain name (ex: bar.com) |
public getEnvironmentInfo ( $site, $env ) | ||
$site | the site name (ex: tangle001, gardener, etc.) | |
$env | the environment name (ex: prod, dev) |
public static getInstance ( $site_name = NULL, $stage = NULL, $creds_filename = NULL ) : |
||
$site_name | The name of the site for which credentials should be used. | |
$stage | Optional. If provided a file with the suffix matching the stage will be used rather than the default cloudapi.ini file. | |
Результат | An instance of the CloudApi class. |
public getSSHKey ( $site, $sshkeyid ) | ||
$site | the site name (ex: tangle001, gardener, etc.) | |
$sshkeyid | SSH key id |
public getSVNUser ( $site, $svnuserid ) | ||
$site | the site name (ex: tangle001, gardener, etc.) | |
$svnuserid | SVN user id |
public getServerInfo ( $site, $env, $server ) | ||
$site | the site name (ex: tangle001, gardener, etc.) | |
$env | the environment name (ex: prod, dev) | |
$server | the server name |
public getSiteName ( {String} $site ) | ||
$site | {String} |
public getSiteRecord ( $site ) | ||
$site | the site name (ex: tangle001, gardener, etc.) |
public getStage ( ) |
public getTaskInfo ( $site, $task ) | ||
$site | the site name (ex: tangle001, gardener, etc.) | |
$task | the task id |
public getTasks ( $site ) | ||
$site | the site name (ex: tangle001, gardener, etc.) |
public installEnvironment ( $site, $env, $type, $source ) | ||
$site | the site name (ex: tangle001, gardener, etc.) | |
$env | the environment name (ex: prod, dev) | |
$type | the type of distro source. ex: 'distro_name', 'distro_url', 'make_url' | |
$source | a distro name, URL to a distro, or URL to a Drush make file. |
public listDatabaseBackups ( $site, $env, $db ) | ||
$site | the site name (ex: tangle001, gardener, etc.) | |
$env | the environment name (ex: prod, dev) | |
$db | the database name (ex: 'g76') |
public listDatabases ( $site, $env ) | ||
$site | the site name (ex: tangle001, gardener, etc.) | |
$env | the environment name (ex: prod, dev) |
public listDomains ( $site, $env ) | ||
$site | the site name (ex: tangle001, gardener, etc.) | |
$env | the environment name (ex: prod, dev) |
public listEnvironments ( $site ) | ||
$site | the site name (ex: tangle001, gardener, etc.) |
public listSSHKeys ( $site ) | ||
$site | the site name (ex: tangle001, gardener, etc.) |
public listSVNUsers ( $site ) | ||
$site | the site name (ex: tangle001, gardener, etc.) |
public listServers ( $site, $env ) | ||
$site | the site name (ex: tangle001, gardener, etc.) | |
$env | the environment name (ex: prod, dev) |
public listSites ( $site ) | ||
$site | the site name (ex: tangle001, gardener, etc.) |
public moveAllDomains ( string $sitegroup, string $from_env, string $to_env, boolean $skip_site_update = TRUE ) : array | ||
$sitegroup | string | The hosting sitegroup name. |
$from_env | string | The hosting environment to take domains from. |
$to_env | string | The hosting environment to move domains to. |
$skip_site_update | boolean | If set to TRUE (default), this will inhibit running fields-config-web.php for this domain move. |
Результат | array | The task record for moving the domains. |
public moveDomains ( string | array $domains, string $sitegroup, string $from_env, string $to_env, boolean $skip_site_update = TRUE ) | ||
$domains | string | array | The domain name(s) as an array of strings, or the string '*' to move all domains. |
$sitegroup | string | The hosting sitegroup name. |
$from_env | string | The environment which currently has this domain. |
$to_env | string | The destination environment for the domain. |
$skip_site_update | boolean | If set to TRUE (default), this will inhibit running fields-config-web.php for this domain move. |
public purgeVarnish ( $site, $env, $domain ) | ||
$site | the site name (ex: tangle001, gardener, etc.) | |
$env | the environment name (ex: prod, dev) | |
$domain | the domain name to delete |
public restoreDatabase ( $site, $env, $db, $backup ) | ||
$site | the site name (ex: tangle001, gardener, etc.) | |
$env | the environment name | |
$db | the database name | |
$backup | the backup id |
public setCaInfo ( $path ) | ||
$path | The path to a CA PEM file. |
public setDefaultCallOption ( $key, $value ) | ||
$key | String key. | |
$value | mixed value. |