README

Requirements

• PHP >=7.4
• Composer

See installation for further instructions.

Documentation

For examples, guides and in-depth information, visit the PHP SDK documentation on the MyParcel Developer Portal.

Support

For questions and support please contact us via support@myparcel.nl or chat with our developers directly on Slack.

Testing

Test Framework

This SDK uses PHPUnit with Mockery for mocking HTTP requests. All tests are completely isolated and do not make real API calls.

Running Tests

# Run all tests
./vendor/bin/phpunit

# Run specific test suite
./vendor/bin/phpunit --testsuite Unit

# Run with test descriptions
./vendor/bin/phpunit --testdox

Writing Tests

All HTTP requests are automatically mocked using Mockery. When writing tests:

1. Use $this->mockCurl() to get a Mockery mock instance
2. Set up expectations for API calls with shouldReceive()
3. Define mock responses that match real API responses
4. All existing tests serve as examples of proper mocking patterns

For detailed examples, see test/Mock/EXAMPLE_UPDATE_TEST.md.

Contribute

1. Check for open issues or open a new issue to start a discussion around a bug or feature
2. Fork the repository and branch off from the main branch
3. Write one or more tests for the new feature or that expose the bug
   • Important: Use Mockery for mocking HTTP requests (see Testing section above)
   • Follow existing test patterns in the codebase
4. Make code changes to implement the feature or fix the bug
5. Ensure all tests pass: ./vendor/bin/phpunit
6. Submit a pull request to main to get your changes merged and published