Skip to content

Upgrading to V2 from V1

TS3tools edited this page Nov 19, 2019 · 3 revisions

THIS IS A DRAFT UNTIL VERSION 2 IS OFFICIALLY RELEASED

TS3PHPFramework V2.x is a complete renewal of the entire library with the main goal to support the PSR-4 standard. It is a recommended upgrade for all users. This version contains a few breaking changes, so please read the following notes carefully when upgrading your application.

Upgrading to V2 from V1

Estimated Upgrade Time: Not estimated yet (TODO)

PHP

TS3PHPFramework V2 requires PHP 5.6 or higher.

The following PHP extensions are required:

  • JSON (php-json)
  • CTYPE (php-ctype)

It's recommend to use PHP 7.3 or higher since PHP 7.2 support ended on 20 November 2019 and after that, PHP 7.2 will only receive security updates: PHP: Supported Versions

Updating Dependencies

Update your planetteamspeak/ts3-php-framework dependency to ^2.0 in your composer.json file. In addition, you should update your phpunit/phpunit dependency to ^7.5.

Of course, don't forget to examine any 3rd party packages consumed by your application and verify you are not destroying any dependencies.

After updating your composer.json, you should update the dependencies:

composer update

Main Category (eg. TS3 Viewer) (TODO)

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.

Sub Category (eg. Standard Viewer or Customized Viewers) (TODO)

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.

Miscellaneous (All Changes)

We also encourage you to view the changes in the planetteamspeak/ts3phpframework repository. We try to cover all of these changes here. You may wish to check the changes by your own to be 100 % sure. You can easily view the changes with the GitHub comparison tool and choose which updates are important to you: https://github.com/planetteamspeak/ts3phpframework/compare/master...eSports-Alliance:master (TODO: Replace URL with latest V1 and V2 comparision URL)