Download the PHP package signes/vbulletin-api-php without Composer

On this page you can find all versions of the php package signes/vbulletin-api-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 signes/vbulletin-api-php

Informations about the package vbulletin-api-php

vBulletin 5 API connector

Latest Stable Version Build Status Circle CI codecov.io License

  1. What is this?
  2. Basic usage
  3. Contexts
    • Available contexts
  4. API service
    • Lazy connection
    • Remember configuration and connection

What is this?

This package gives you possibility to easy integrate your system with vBulletin 5 API using simple methods calls.

Tested with vB 5.2

Basic usage

  1. First of all create your API configuration file which should include information's like:

    • vBulletin API key - you can find it in vBulletin control panel, under API section. |
    • Unique ID - Unique id is used to identity your client and platform name, it can be any unique string. Be careful, if you will change unique ID your request will be recognized as request from new API client and new API client ID will be returned. |
    • Client name - Your client name.
    • Client version - Your client version.
    • Platform name - Your platform name.
    • Platform version - Your platform version.

  2. When configuration object is ready, next step is to initiate connection provider. This provider is responsible for communication between your application and vB forum.

    By default you can use included Guzzle provider but before you will do this, you should require guzzlehttp/guzzle package in composer. Guzzle provider required forum URL in constructor with trailing slash.

    If this is not good enough, you can provide own connection class, just implement Signes\vBApi\Connector\ConnectorInterface interface.

  3. After that you are ready to prepare API service, which required Signes\vBApi\ApiConfig and Signes\vBApi\Connector\ConnectorInterface objects.

  4. When API service is initialized, you can call any API resource.

Contexts

Contexts gives you possibility to encapsulation logic into single class. Under the hood contexts also uses raw vB API requests.
Every context must extend Signes\vBApi\Context\Context class and can required different parameters in constructor.

Example code:

Context should handle information about request method type, API request type and should return all required parameters by vB for given request.
For your custom context you can also overwrite parseResponse method to return expected format, not raw vB API response.

Available contexts

API service

What do API service for you:

If you want to integrate with multiple vBulletin instances, you can use API service as a registry. If instance is not remembered null will be returned.

Lazy connection

API service constructor has third parameter $lazy with default true value. This parameter determine moment of init request.

If it is set to true init request will be send during the first callRequest method call. So if you provided incorrect configuration you will learn about it until now.

If it is set to false init request will be send when API service instance is created

Remember configuration and connection

It is possible to keep information about ApiConfig between PHP requests and it is strongly recommend to do that on production. To do that you can use any of your cache services. Just store ApiConfig in cache, and for future use it instance.

That gives you one more benefit, when you login on user account, this information will be remembered in ApiConfig and you do not have to call login request for some period of time (depends of your cache expiration).

Credits

Pawel Grzesiecki - Developer (http://signes.pl/) MIT License

All versions of vbulletin-api-php with dependencies

PHP Build Version
Package Version
Requires php Version >=5.5.9
beberlei/assert Version ^2.5.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 signes/vbulletin-api-php contains the following files

Loading the files please wait ....