spinen/ncentral-php-client

SPINEN's PHP Client for N-able's N-Central.

0.1.0 2022-01-10 20:45 UTC

This package is auto-updated.

Last update: 2024-04-11 02:02:03 UTC


README

Latest Stable Version Latest Unstable Version Total Downloads License

PHP Client for N-able's N-Central.

We solely use Laravel for our applications, so there is some Laravel specific files that you can use if you are using this client in a Laravel application. We have tried to make sure that you can use the client outside of Laravel, and have some documentation about it below.

Build Status

Branch Status Coverage Code Quality
Develop Build Status Code Coverage Scrutinizer Code Quality
Master Build Status Code Coverage Scrutinizer Code Quality

Prerequisite

Install

Install Ncentral Client:

$ composer require spinen/ncentral-php-client

[Optional] Add the alias to config/app.php

'aliases' => [
    # other aliases omitted
    'Ncentral' => Spinen\Ncentral\Laravel\Facades\Ncentral::class,
],

Configuration for Laravel

Add the following to config/services.php...

'ncentral' =>  [
    // TODO: Document vars here
],

Add the appropriate values to your .env...

'NCENTRAL_WSDL_PATH' - Path to the Ncentral WSDL file or URL

Usage

Set up a new NcentralClient using its factory...

$client = Spinen\Ncentral\NcentralClientFactory::factory(env('NCENTRAL_WSDL_PATH'));

Non-Laravel Usage

To use the client outside of Laravel, you just need to new-up the objects...

// TODO: Document usages here