sebtm/inwx-api-bundle

A Symfony bundle for using "inwx/php-client".

Installs: 36

Dependents: 0

Suggesters: 0

Security: 0

Stars: 3

Watchers: 1

Forks: 2

Open Issues: 0

Type:symfony-bundle

v1.0.1 2019-12-22 02:21 UTC

This package is auto-updated.

Last update: 2020-03-22 03:28:02 UTC


README

Build Status Coverage Status Total Downloads GitHub license

A Symfony bundle for including the INWX PHP-Client.

Installation

The INWX bundle can be installed via Composer by requiring the sebtm/inwx-api-bundle package in your project's composer.json:

{
    "require": {
        "sebtm/inwx-api-bundle": "~1.0"
    }
}

and adding an instance of SebTM\INWX\InwxApiBundle to your application's kernel:

class AppKernel extends Kernel
{
    public function registerBundles(): void
    {
        return [
            new \SebTM\INWX\InwxApiBundle(),
        ];
    }
}

(This is NOT needed for Symfony-Flex while using recipes!)

Configuration

Sample YML Configuration

The sample configuration which can be placed in app/config/config.yml file.

inwx_api:
    debug: false
    environment: "development"
    json: true
    language: "en"
    username: "username"
    password: "password"

Supported environments: "production", "development" Supported languages: see documentation of INWX PHP-Client

Usage

This bundle exposes an instance of the SebTM\INWX\Domrobot object:

Service | Instance Of
--- | ---
inwx_api | SebTM\INWX\Domrobot

It provides an additional function called "loginWrapper()" (BC >=1.0.0: login will not overwritten anymore!) for using the login data from configuration.

Links