Download the PHP package swichers/acsf-client without Composer
On this page you can find all versions of the php package swichers/acsf-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download swichers/acsf-client
More information about swichers/acsf-client
Files in swichers/acsf-client
Package acsf-client
Short Description A Client library for Acquia's ACSF platform.
License GPL-3.0-or-later
Informations about the package acsf-client
Acquia Cloud Site Factory Client Library
A Symfony-based PHP library for working with the ACSF platform.
Acquia Cloud Site Factory is a hosting platform provided by Acquia. The goal of this library is to wrap the ACSF API in such a way that it becomes trivial to leverage it in PHP applications. This library is a significant boon when it comes to streamlining interactions with ACSF. Usage of this library will, among other things, facilitate a much quicker and less error prone deployment process.
Caution: Test coverage in this library is around validation of calls to the API, and is not testing interaction with the actual ACSF API. Not all wrapped endpoints have been validated as properly implemented, and live calls to the API may have unexpected results. Review all scripts and calls for proper behavior before executing against a live environment.
Why use this project?
You may already be familiar with projects such as ACSF Tools or the Acquia CLI and be wondering what this project has to offer over those.
Feature | ACSF Client | ACSF Tools | Acquia CLI |
---|---|---|---|
PHP library | ✅ | ❌ | ❌ |
Supports Site Factory | ✅ | ✅ | ❌ |
Supports Acquia Cloud | ❌ | ❌ | ✅ |
Complete implementation of ACSF API | ✅ | ❌ | ❌ |
Complete implementation of Cloud API | ❌ | ❌ | ✅ |
Can bundle with codebase | ✅ | ✅ | ❌ |
Can be standalone | ✅ | ✅ | ✅ |
Designed for scripting | ✅ | ❌ | ❌ |
Designed for specific tasks | ❌ | ✅ | ❌ |
The primary use case for this project is creating custom PHP scripts for automating your development and management workflows within ACSF. Anything that you can do within the ACSF UI should be accomplishable through this library.
Common tasks that you can use this library to automate:
- Regular complete backups with custom names
- Regular backup pruning for backups meeting certain criteria
- Bbackports/staging to lower environments along with code deploys
- Production deployments, including backups, backports, and deployments
- Recreating domains on lower environments after backports
- Starting a deployment from your CI system
The examples folder contains several scripts that show some common tasks. They can serve as a starting point to build much more complex workflows custom tailored to your project.
Installation
Requirements
- PHP >= 7.2
- API access to ACSF
- Composer for dependency installs
Installation should be straightforward when using composer.
Usage
Many starter scripts are available in the examples folder.
Development
Running tests
Checking code formatting
All versions of acsf-client with dependencies
ext-json Version *
doctrine/annotations Version ^1.7
symfony/config Version ^4.3
symfony/dependency-injection Version ^4.3
symfony/finder Version ^4.3
symfony/http-client Version ^4.3
symfony/yaml Version ^4.3
symfony/dotenv Version ^4.4