Download the PHP package madpilot78/freebox-php without Composer

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

Informations about the package freebox-php

FreeBox PHP

Packagist Version Actions Status codecov

This is a small and simple PHP library to interface with Iliad FreeBox (IliadBox for the Italian market) provided broadband routers.

Install

Using composer:

Requirements

This project works with PHP 8.3 and upper.

Library description

I'm writing this library for my own needs. It handles discovery and authentication and then exposes some router APIs via methods.

For a list of implemented methods look in src/Methods.

NOTE: Since I'm in Italy I have tested this only with my router, an IliadBox (Italian version), configured with self provided certificate. If you have a different setup and have problems, please contact me and maybe I can update the library to work with more setups.

NOTE

For documentation on each API specifics please check your OpenBox/IliadBox developer documentation, accessible through the WebUI.

How to use

There is a Configuration object that can be used to customize the library.

First one needs to register with the Box, for example:

(check the FreeBox/IliadBox display to authorize the client)

Once the client has been authorized its permissions can be configured in the FreeBox/IliadBox UI.

With the token it is possible to access all the provided functionality.

For example to display IPv6 configuration:

(NOTE: discover() needs to be called only once per instance, results are cached in the instance)

The IPv6 firewall can be turned on with (this API will also return the new configuration):

APIs requiring an ID take it as an argument, for example to fetch an existing redirect:

And a disabled redirect can be modified (for example enabled) like this:

Implemented APIs

All versions of freebox-php with dependencies

PHP Build Version
Package Version
Requires php Version ^8.3
guzzlehttp/guzzle Version ^7.0
league/container Version ^4.2
psr/container Version ^2.0
psr/http-message Version ^1.1 || ^2.0
psr/log Version ^3.0
chillerlan/php-cache Version ^5.1
psr/simple-cache Version ^3.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 madpilot78/freebox-php contains the following files

Loading the files please wait ....