namelesscoder/typo3-repository-client

Client for interacting with the official TYPO3 Extension Repository (TER). Contains API and CLI scripts.

2.1.0 2021-09-02 09:12 UTC

Requires

• php: ^7.0
• ext-soap: *

Requires (Dev)

• mikey179/vfsstream: ~1.3.0
• phpunit/phpunit: ^6.5
• satooshi/php-coveralls: ^2.2

MIT

• Claus Due

README

TYPO3 Extension Repository (TER) client library and CLI commands

Usage

Each command which can be executed has a corresponding class, for example NamelessCoder\TYPO3RepositoryClient\Uploader and a CLI script which acts as a wrapper for said class. The parameters which should be passed to each CLI script must be the same arguments and in the same order as required by the class' method.

Uploader

As component:

$uploader = new \NamelessCoder\TYPO3RepositoryClient\Uploader();
$uploader->upload('/path/to/extension', 'myusername', 'mypassword', 'An optional comment');

And as CLI command:

./bin/upload /path/to/extension myusername mypassword "An optional comment"

Version Updater (local)

As component:

$versioner = new \NamelessCoder\TYPO3RepositoryClient\Versioner();
$version = $versioner->read('/path/to/extension/');
$version[0] = '1.2.3';
$version[1] = 'beta';
$versioner->write('/path/to/extension/', '1.2.3', 'beta');

And as CLI command:

# with all parameters
./bin/setversion 1.2.3 beta /optional/path/to/extension/
# without changing current stability:
./bin/setversion 1.2.3

Version Deleter (admins only)

As component:

$deleter = new \NamelessCoder\TYPO3RepositoryClient\VersionDeleter();
$deleter->deleteExtensionVersion('extensionkey', '1.2.3', 'myusername', 'mypassword');

And as CLI command:

./bin/rmversion extensionkey 1.2.3 myusername mypassword

FAQ

Excluded files and folders

• Dotfiles (like .editorconfig or .php_cs.dist) will be ignored except for .htpasswd and .htaccess files.
• Use a .gitignore file to exclude more files and folders from being included in the final TER release.