Skip to content

MIGRATION.md

Latest commit

 

History

History
204 lines (148 loc) · 5.18 KB

MIGRATION.md

File metadata and controls

204 lines (148 loc) · 5.18 KB

Migration Guide

From gosuccess/php-ds24-api-wrapper to gosuccess/digistore24-api

This package has been renamed and refactored with breaking changes.

Package Name Change

Old: gosuccess/php-ds24-api-wrapper New: gosuccess/digistore24-api

Installation

# Remove old package
composer remove gosuccess/php-ds24-api-wrapper

# Install new package
composer require gosuccess/digistore24-api

Breaking Changes

1. Namespace Change

Old namespace: GoSuccess\Digistore24\ New namespace: GoSuccess\Digistore24\Api\

Before:

use GoSuccess\Digistore24\Digistore24;
use GoSuccess\Digistore24\Client\Configuration;
use GoSuccess\Digistore24\Request\BuyUrl\CreateBuyUrlRequest;

After:

use GoSuccess\Digistore24\Api\Digistore24;
use GoSuccess\Digistore24\Api\Client\Configuration;
use GoSuccess\Digistore24\Api\Request\BuyUrl\CreateBuyUrlRequest;

2. Constructor Changes

The Digistore24 class now requires a Configuration object instead of individual parameters.

Before:

$ds24 = new Digistore24(
    apiKey: 'YOUR-API-KEY',
    language: 'en',
    timeout: 30,
    debug: false
);

After:

$config = new Configuration(
    apiKey: 'YOUR-API-KEY',
);

$ds24 = new Digistore24($config);

3. Client Access

The getClient() method has been removed. Use the public $client property instead.

Before:

$client = $ds24->getClient();

After:

$client = $ds24->client;

4. Utils Directory Renamed

Old: GoSuccess\Digistore24\Utils\ New: GoSuccess\Digistore24\Api\Util\

Note: Utils (plural) → Util (singular)

5. Exception Namespace

Old: GoSuccess\Digistore24\Exception\ New: GoSuccess\Digistore24\Api\Exception\

What's New

  • PHP 8.4 Property Hooks - Automatic validation on property assignment
  • Lazy Loading - Resources are initialized on-demand
  • Configuration Object - Centralized configuration with validation
  • Computed Properties - Properties like $apiUrl are automatically computed
  • Type Safety - Enhanced type hints throughout the codebase
  • Optional Request Parameters - Methods with all-optional parameters no longer require explicit Request objects

New Feature: Optional Request Parameters

In version 2.0, methods with all-optional parameters can now be called without creating a Request object:

Before (v1.x):

use GoSuccess\Digistore24\Api\Request\Product\ListProductsRequest;

// Always required Request object, even for simple calls
$request = new ListProductsRequest();
$products = $ds24->products->list($request);

After (v2.0):

// Simple: No Request object needed
$products = $ds24->products->list();

// Advanced: Still works with Request object for filters
$products = $ds24->products->list(
    new ListProductsRequest(sortBy: 'name')
);

Affected Methods (39+ methods across 27 Resources):

  • $ds24->products->list() - no parameters needed
  • $ds24->purchases->list() - optional filters
  • $ds24->users->getInfo() - no parameters needed
  • $ds24->system->ping() - no parameters needed
  • $ds24->countries->listCountries() - no parameters needed
  • $ds24->statistics->sales() - optional date ranges
  • And many more...

Backward Compatibility: All existing code with explicit Request objects continues to work.

Example Migration

Complete Before:

<?php

use GoSuccess\Digistore24\Digistore24;
use GoSuccess\Digistore24\Request\BuyUrl\CreateBuyUrlRequest;
use GoSuccess\Digistore24\DataTransferObject\BuyerData;

$ds24 = new Digistore24(
    apiKey: 'YOUR-API-KEY',
);

$request = new CreateBuyUrlRequest();
$request->productId = 12345;
$response = $ds24->buyUrls->create($request);

Complete After:

<?php

use GoSuccess\Digistore24\Api\Digistore24;
use GoSuccess\Digistore24\Api\Client\Configuration;
use GoSuccess\Digistore24\Api\Request\BuyUrl\CreateBuyUrlRequest;
use GoSuccess\Digistore24\Api\DTO\BuyerData;

$config = new Configuration(
    apiKey: 'YOUR-API-KEY',
);

$ds24 = new Digistore24($config);

$request = new CreateBuyUrlRequest();
$request->productId = 12345;
$response = $ds24->buyUrls->create($request);

Find & Replace Guide

Use your IDE's find & replace feature:

  1. Namespace imports:

    • Find: use GoSuccess\Digistore24\
    • Replace: use GoSuccess\Digistore24\Api\

  2. Exception catches:

    • Find: \GoSuccess\Digistore24\Exception\
    • Replace: \GoSuccess\Digistore24\Api\Exception\

  3. Utils references:

    • Find: GoSuccess\Digistore24\Utils\
    • Replace: GoSuccess\Digistore24\Api\Util\

Need Help?

If you encounter any issues during migration:

  1. Check the README.md for updated examples
  2. Review the examples/ directory for complete usage examples
  3. Open an issue on GitHub

Why the Change?

  • Better Namespace Structure - Aligns with our existing digistore24-ipn package
  • Clearer Package Name - Reflects that this is an API client, not just a wrapper
  • Modern Architecture - Leverages PHP 8.4 features for better developer experience
  • Consistency - Part of the GoSuccess\Digistore24\* package family