Download the PHP package ocolin/plume without Composer

On this page you can find all versions of the php package ocolin/plume. 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 ocolin/plume

Informations about the package plume

Plume

Table of Contents

What is Plume?

This plugin is a lightweight PHP API client for Plume cloud services.

Plume hosts a cloud based service for provisioning and managing home and office wifi networks. Plume provides an API to their cloud services that allow partners to manage their customers's wifi and networking needs remotely.

This client was designed so that API calls can be quickly and easily be implemented into your tools for managing Plume services.

Plume website

https://www.plume.com/platform/home

Plume API explorer

Requires partner login:

https://gamma.noc.plume.com/explorer

Ocolin/Plume github

https://github.com/ocolin/Plume

Requirements

Installation

Configuration

There are two ways to configure the Plume client. One is using environment variables and the other is using the constructor.

Instantiating with environment variables

The following environment variables are used:

Name Description
PLUME_AUTH_URL Url to Plume's authentication service.
PLUME_AUTH_HASH Partner token for authentication service.
PLUME_PARTNER_ID Your assigned Plume Partner ID
PLUME_GROUP_ID Your assigned Plume Group ID
PLUME_API_URL URL to the Plume cloud API server

There is an .env.example file included to use as a template for your projects.

Example:

Instantiating With Constructor Arguments

If you don't use environment variables, you can specify your credentials in the constructor through the use of a Config class.

Example:

Additional configuration.

In addition to the Config class, there are a few other options for configuration.

Example

Response

All methods return an Ocolin\Plume\Response object with the following properties:

Property Type Description
status int HTTP status code
status_message string HTTP status message
headers array HTTP response headers
body mixed Decoded JSON response body

Example

Interpolation Concepts

Some variables in the Plume client can be automatically replaced. Here are some examples.

Endpoint variables

Many of the plume endpoints have variables in them, such as . These can be replaced automatically by any values in the query argument where the element key matches the variable in the endpoint.

Additionally, and groupId or partnerId variables in an endpoint will be automatically replaced with your config settings unless you opt to set them yourself. This saved you from having to populate those settings on endpoints that use them.

HTTP Body variables

Inside your body data, the groupId and partnerID values can be auto populated if you include them as blank properties in your body.

Usage

The Plume client comes with a function for each HTTP request method as well as a request function that let's you specify an HTTP method.

Argument descriptions:

name Description type default
endpoint The API endpoint found in Plume API Explorer. string None
method HTTP method to use. string GET
query HTTP query parameters and path parameters array|object []
body HTTP body. JSON or www-form array|object []
formData Use www-form instead of JSON. Needed by some endpoints boolean false

GET

POST

PUT

PATCH

DELETE

HEAD

REQUEST

General all-purpose API request function.

TODO

All versions of plume with dependencies

PHP Build Version
Package Version
Requires php Version ^8.3
psr/http-message Version ^1.0|^2.0
guzzlehttp/guzzle Version ^7.10
ocolin/global-type Version ^2.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 ocolin/plume contains the following files

Loading the files please wait ...