PHP

The PHP target is experimental.

Add php under targets to generate a PHP SDK package.

{
  "targets": {
    "php": {
      "packageName": "Acme\\Api",
      "composerPackageName": "acme/api",
      "composerRepositoryUrl": "https://repo.packagist.org",
      "version": "1.0.0",
      "destinations": {
        "production": {
          "repo": "acme/acme-php"
        }
      }
    }
  }
}

Target Options

Property Type Description
packageName string PHP package namespace or name.
composerPackageName string Composer and Packagist package name, such as acme/api.
composerRepositoryUrl string Composer repository URL for PHP package publishing.
version string Target-specific SDK version override.
skip boolean Set to true to keep the config without generating this target.
destinations object GitHub destinations for generated output.

Composer Package Names

Use packageName for the generated PHP package namespace and composerPackageName for the package users install through Composer.

{
  "targets": {
    "php": {
      "packageName": "Acme\\Api",
      "composerPackageName": "acme/api"
    }
  }
}

Destinations

Use destinations.production to push generated output to a GitHub repository.

Property Description
repo GitHub repository in owner/name form.
branch Branch to push generated output to. Defaults to the repository default.