eliasis-framework/license-handler

Licensing and applications manager.

License Handler · Eliasis PHP Framework plugin

, _(*1)

Versión en español, _(*2)

Licensing and applications manager., _(*3)

• Requirements
• Installation
• Available Methods
• Quick Start
• Usage
• Database
• Tests
• Sponsor
• License

Requirements

This plugin is supported by PHP versions 5.6 or higher and is compatible with HHVM versions 3.0 or higher., _(*4)

Installation

The preferred way to install this extension is through Composer., _(*5)

To install License Handler, simply:, _(*6)

composer require eliasis-framework/license-handler

The previous command will only install the necessary files, if you prefer to download the entire source code you can use:, _(*7)

composer require eliasis-framework/license-handler --prefer-source

You can also clone the complete repository with Git:, _(*8)

git clone https://github.com/eliasis-framework/license-handler.git

Available Methods

Available methods in this plugin:, _(*9)

Applications

- Add application

$application->add($name, $type, $category, $active);

@return (int) → Application inserted ID., _(*10)

- Update application

$application->update($id, $name, $type, $category, $active);

@return (int) → Rows affected., _(*11)

Sites

- Add site

$site->add($domain, $host, $ip, $authorized);

@return (int) → Site inserted ID., _(*12)

- Update site

$site->update($id, $domain, $host, $ip, $authorized);

@return (int) → Rows affected., _(*13)

License

- Generate license key

$license->generateKey($characters, $segments);

@return (string) → License key., _(*14)

- Add license

$license->add($appID, $siteID, $key, $state, $expire);

@return (int) → License inserted ID., _(*15)

- Update license

$license->update($id, $appID, $siteID, $key, $state, $expire);

@return (int) → Rows affected., _(*16)

- Check if license exists

$license->keyExists($license);

@return (boolean), _(*17)

Options

- Add option

$option->add($licenseID, $name, $value);

@return (int) → Option inserted ID., _(*18)

- Update option

$option->update($id, $licenseID, $name, $value);

@return (int) → Rows affected., _(*19)

Quick Start

To use this plugin, your Eliasis application must use the PHP-Database library and add the following to the application configuration files:, _(*20)

/**
 * eliasis-app/config/complements.php
 */
return [

    'plugin' => [

        'license-handler' => [

            'db-id' => 'app',
            'db-prefix' => 'test_',
            'db-charset' => 'utf8',
            'db-engine' => 'innodb'
        ],
    ],
];

And get the instances from each table:, _(*21)

use Eliasis\Complement\Type\Plugin;

$site = Plugin::WP_Plugin_Info()->getControllerInstance('Site');
$option = Plugin::WP_Plugin_Info()->getControllerInstance('Option');
$license = Plugin::WP_Plugin_Info()->getControllerInstance('License);
$application = Plugin::WP_Plugin_Info()->getControllerInstance('Application');

Usage

Applications

- Add application

$appID = $application->add('app-name', 'plugin', 'WordPress', 1);

- Update application

$application->update($appID, 'new-app-name', 'module', 'Prestashop', 1);

Sites

- Add site

$siteID = $site->add(
 'domain.com', 
 'host.domain.com',
 '87.142.85.70', 1
);

- Update site

$site->update(
 $siteID, 
 'new-domain.com', 
 'host.new-domain.com', 
 '87.142.85.70', 1
);

License

- Generate license key

$license = $license->generateKey(); // 3FGSV-BZ49N-U79EA-S96ZY-MFQ63

$license = $license->generateKey(5, 5); // 3FGSV-BZ49N-U79EA-S96ZY-MFQ63

$license = $license->generateKey(4, 4); // 3FGS-BZ4N-U7EA-S9ZY

$license = $license->generateKey(6, 5); // SF4W2H-FEJKZ5-PU7KAD-N77486-BKMJSW

$license = $license->generateKey(4, 2); // FT3Q-EBT5

- Add license

$licenseID = $license->add(1, 1, $key, $license, '+1day');

$licenseID = $license->add(1, 1, $key, $license, '+10days');

$licenseID = $license->add(1, 1, $key, $license, '+1week');

$licenseID = $license->add(1, 1, $key, $license, '+1month');

$licenseID = $license->add(1, 1, $key, $license, '+2months');

$licenseID = $license->add(1, 1, $key, $license, '+1year');

$licenseID = $license->add(1, 1, $key, $license, '+2years');

- Update license

$license->update(1, 1, $key, $license, '+3weeks');

- Check if license exists

$license->keyExists('SF4W2H-FEJKZ5-PU7KAD-N77486-BKMJSW');

Options

- Add option

$option->add($licenseID, 'lang', 'es-ES');

- Update option

$option->update($id, $licenseID, 'lang', 'en-EN');

Database

This plugin will create the following tables., _(*22)

- test_applications

The table structure created is as follows:, _(*23)

- test_sites

The table structure created is as follows:, _(*24)

- test_licenses

The table structure created is as follows:, _(*25)

- test_options

The table structure created is as follows:, _(*26)

Tests

To run tests you just need composer and to execute the following:, _(*27)

git clone https://github.com/eliasis-framework/license-handler.git

cd license-handler

composer install

Run unit tests with PHPUnit:, _(*28)

composer phpunit

Run PSR2 code standard tests with PHPCS:, _(*29)

composer phpcs

Run PHP Mess Detector tests to detect inconsistencies in code style:, _(*30)

composer phpmd

Run all previous tests:, _(*31)

composer tests

Sponsor

If this project helps you to reduce your development time, you can sponsor me to support my open source work :blush:, _(*32)

License

This repository is licensed under the MIT License., _(*33)

Copyright © 2017-2022, Josantonius, _(*34)