Download the PHP package ubnt/ucrm-plugin-sdk without Composer

On this page you can find all versions of the php package ubnt/ucrm-plugin-sdk. 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 ubnt/ucrm-plugin-sdk

Informations about the package ucrm-plugin-sdk

UCRM Plugin SDK

Coverage Latest Release License

This repository contains the open source PHP SDK for UCRM plugins.

Installation

The UCRM Plugin SDK can be installed with Composer. Run this command:

Available classes

Class name Description
Ubnt\UcrmPluginSdk\Service\UcrmApi A service that handles calling UCRM API.
Ubnt\UcrmPluginSdk\Service\UnmsApi A service that handles calling UNMS API.
Ubnt\UcrmPluginSdk\Service\UcrmSecurity A service that handles getting data of user currently logged into UCRM.
Ubnt\UcrmPluginSdk\Service\PluginLogManager A service that handles managing the plugin's log file.
Ubnt\UcrmPluginSdk\Service\UcrmOptionsManager A service that handles loading automatically generated options available to the plugin.
Ubnt\UcrmPluginSdk\Service\PluginConfigManager A service that handles loading configuration of the plugin as defined in the plugin's manifest file.

Usage

Simple example using available SDK classes:

Pack script

To pack your plugin for use in UCRM, you can use the provided pack script. Run this command from the root directory:

The script will create ZIP archive of the plugin, which can be uploaded to UCRM. If you are using the directory structure of official UCRM plugins repository the archive will be created one level up, next to your README.md file and src/ directory. Otherwise it will be created in your root directory.

If the plugin's root directory is not detected correctly, you can give it to the script as an argument. For example:
./vendor/bin/pack-plugin /home/username/my-new-plugin

Tests

Unit tests can be executed by running this command from the root directory:

Static analysis can be executed by running this command from the root directory:

Coding standard check can be executed by running this command from the root directory:

Disclaimer

The software is provided "as is", without any warranty of any kind. Read more in the licence.

All versions of ucrm-plugin-sdk with dependencies

PHP Build Version
Package Version
Requires php Version >=8.1
ext-curl Version *
ext-json Version *
guzzlehttp/guzzle Version ^7.8
symfony/filesystem Version ^6.3
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 ubnt/ucrm-plugin-sdk contains the following files

Loading the files please wait ....