Download the PHP package dapikk/osrs-toolkit-php without Composer

On this page you can find all versions of the php package dapikk/osrs-toolkit-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of dapikk/osrs-toolkit-php

Informations about the package osrs-toolkit-php

OpenSRS PHP Toolkit — PHP 7.4–8.4 Fork

PHP 7.4 PHP 8.0 PHP 8.1 PHP 8.2 PHP 8.3 PHP 8.4

A community-maintained fork of the OpenSRS PHP Toolkit with compatibility for PHP 7.4 through PHP 8.4. This project is based on the original OpenSRS toolkit and contains additional compatibility fixes, modernization work, and other improvements intended for use with current PHP environments.

[!IMPORTANT] This repository is not an official OpenSRS release.

It is an independently maintained fork based on the official OpenSRS PHP Toolkit.

Features

Table of Contents

Requirements

The maintained fork requires a modern PHP environment.

Requirement Status
PHP 8.4 ✅ Required / Tested
Composer ✅ Required
OpenSSL ✅ Required
cURL / ext-curl ✅ Required for OMA
JSON ✅ Included with PHP
OpenSRS reseller account ✅ Required for API access

Check your PHP version:

Verify required PHP extensions:

PHP Compatibility

This fork targets:

The corresponding Composer requirement is:

Compatibility status

PHP Version Status
PHP 8.4 ✅ Tested
PHP 7.4 and newer ⚠️ Tested and supported from PHP 7.4+
PHP 9.x ⚠️ Not yet declared compatible

PHP compatibility is validated through the project's GitHub Actions test workflow.

The original OpenSRS toolkit predates PHP 7.x. PHP 8.4 compatibility applies specifically to this maintained fork.

Installation

Install this fork using Composer:

Composer will install the package and generate the required autoloader:

Replacing the upstream package

This fork declares itself as a replacement for:

This allows applications depending on the original package to use the maintained fork where appropriate.

Configuration

Create an OpenSRS configuration file using the supplied configuration template.

For example:

Configure the file with your OpenSRS reseller credentials and API settings.

Security

[!WARNING] Never commit production API keys, passwords, or reseller credentials to your Git repository.

For production environments, sensitive configuration should preferably be loaded from:

Bootstrapping

Load the Composer autoloader followed by your OpenSRS configuration:

Composer autoloading is the recommended approach when using this fork.

Usage

A basic OpenSRS request can be performed using the toolkit's Request class.

The contents of $data depend on the OpenSRS command being executed.

Typical API operations include:

Refer to the OpenSRS API documentation for the attributes required by each command.

Example: Domain Lookup

A simple domain lookup request may look like:

Legacy API

Backward compatibility with applications using the older OpenSRS toolkit API is retained where possible.

[!NOTE] New integrations should use Composer autoloading and the modern API instead of the legacy loader.

Testing

Install development dependencies:

Run the test suite:

You can also run Composer's platform checks:

GitHub Actions

PHP 8.4 compatibility is continuously checked using GitHub Actions.

The status badge at the top of this README reflects the current CI result:

This means the PHP compatibility status displayed in the README comes directly from the project's actual test workflow.

OpenSRS Environments

OpenSRS provides separate production and testing environments.

Production

Production API access normally requires:

Horizon Test Environment

The Horizon environment can be used for development and testing without creating real production registrations.

Production and test environments use separate credentials.

Troubleshooting

Check PHP

Check loaded extensions

At minimum, verify the availability of:

Check Composer

and:

Check PHP configuration

Test OpenSRS connectivity

Production:

Horizon:

If authentication fails, verify:

Upstream Project

This project is derived from:

OpenSRS PHP Toolkit

Composer package:

The original project and its authors remain the source of the underlying OpenSRS PHP Toolkit implementation.

Changes in this fork

This fork focuses on maintaining usability with current PHP versions and includes changes such as:

See the repository's commit history and releases for the complete list of changes.

Fork Maintenance

This repository is maintained independently from OpenSRS.

When reporting a problem, first determine whether it relates to:

This fork

Examples:

Report these through this repository's issue tracker:

OpenSRS API

Examples:

These should generally be verified against the official OpenSRS documentation or raised with OpenSRS Support.

Support

Fork support

For bugs related specifically to this maintained version:

When reporting a problem, include where relevant:

Never include:

OpenSRS support

For service-side or OpenSRS API connectivity problems, consult the official OpenSRS support resources.

Documentation

OpenSRS

Original Toolkit

This Fork

Project Status

Component Status
Project type Community-maintained fork
Based on OpenSRS PHP Toolkit
PHP requirement ^8.4
PHP 8.4 CI ✅ Enabled
Dependency management Composer
Autoloading PSR-4
License MIT
Official OpenSRS release ❌ No

Credits

This project is based on the original OpenSRS PHP Toolkit developed by OpenSRS / Tucows and its contributors.

Original authors include:

Additional PHP 8.4 compatibility work, maintenance, and improvements are provided by the maintainers of this fork.

License

This project is distributed under the MIT License.

See LICENSE for details.

OpenSRS PHP Toolkit — PHP 8.4 Fork
Community-maintained for modern PHP environments.

All versions of osrs-toolkit-php with dependencies

PHP Build Version
Package Version
Requires php Version ^7.4 || ^8.0
ext-openssl Version *
mustangostang/spyc Version ^0.5.1 || ^0.6.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package dapikk/osrs-toolkit-php contains the following files

Loading the files please wait ...