Recommend this page to a friend! |
Download |
Info | Documentation | Files | Install with Composer | Download | Reputation | Support forum | Blog | Links |
Ratings | Unique User Downloads | Download Rankings | ||||
Not yet rated by the users | Total: 232 | All time: 8,135 This week: 524 |
Version | License | PHP version | Categories | |||
license-handler 1.0.0 | MIT/X Consortium ... | 5 | PHP 5, Tools |
Description | Author | |
This package can manage PHP applications license keys. |
What is the best PHP licence key system class?
I need a license key system to lock out users upon expiring date
Licensing and applications manager.
This plugin is supported by PHP versions 5.6 or higher and is compatible with HHVM versions 3.0 or higher.
The preferred way to install this extension is through Composer.
To install License Handler, simply:
$ 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:
$ composer require eliasis-framework/license-handler --prefer-source
You can also clone the complete repository with Git:
$ git clone https://github.com/eliasis-framework/license-handler.git
Available methods in this plugin:
$application->add($name, $type, $category, $active);
| Atttribute | Description | Type | Required | --- | --- | --- | --- | | $name | Application name. | string | Yes | | $type | Application type. | string | Yes | | $category | Application category. | string | Yes | | $active | Application state. | boolean| Yes |
@return (int) ? Application inserted ID.
$application->update($id, $name, $type, $category, $active);
| Atttribute | Description | Type | Required | --- | --- | --- | --- | | $id | Application ID. | string | Yes | | $name | Application name. | string | Yes | | $type | Application type. | string | Yes | | $category | Application category. | string | Yes | | $active | Application state. | boolean| Yes |
@return (int) ? Rows affected.
$site->add($domain, $host, $ip, $authorized);
| Atttribute | Description | Type | Required | --- | --- | --- | --- | | $domain | Site domain. | string | Yes | | $host | Site host. | string | Yes | | $ip | Site ip. | string | Yes | | $authorized | Authorized?. | boolean| Yes |
@return (int) ? Site inserted ID.
$site->update($id, $domain, $host, $ip, $authorized);
| Atttribute | Description | Type | Required | --- | --- | --- | --- | | $id | Site ID. | string | Yes | | $domain | Site domain. | string | Yes | | $host | Site host. | string | Yes | | $ip | Site ip. | string | Yes | | $authorized | Authorized?. | boolean| Yes |
@return (int) ? Rows affected.
$license->generateKey($characters, $segments);
| Atttribute | Description | Type | Required | Default | --- | --- | --- | --- | --- | | $characters | Characters number by segments. | int | No | 5 | | $segments | Segments number. | int | No | 5 |
@return (string) ? License key.
$license->add($appID, $siteID, $key, $state, $expire);
| Atttribute | Description | Type | Required | --- | --- | --- | --- | | $appID | Application table id. | int | Yes | | $siteID | Site table id. | int | Yes | | $key | License key. | string | Yes | | $state | License state. | bool | Yes | | $expire | License expiration date. | string| Yes |
@return (int) ? License inserted ID.
$license->update($id, $appID, $siteID, $key, $state, $expire);
| Atttribute | Description | Type | Required | --- | --- | --- | --- | | $id | License ID. | string | Yes | | $appID | Application table id. | int | Yes | | $siteID | Site table id. | int | Yes | | $key | License key. | string | Yes | | $state | License state. | bool | Yes | | $expire | License expiration date. | string| Yes |
@return (int) ? Rows affected.
$license->keyExists($license);
| Atttribute | Description | Type | Required | --- | --- | --- | --- | | $license | License key. | string | Yes |
@return (boolean)
$option->add($licenseID, $name, $value);
| Atttribute | Description | Type | Required | --- | --- | --- | --- | | $licenseID | License table id. | string | Yes | | $name | Option name. | string | Yes | | $value | Option value. | string | Yes |
@return (int) ? Option inserted ID.
$option->update($id, $licenseID, $name, $value);
| Atttribute | Description | Type | Required | --- | --- | --- | --- | | $id | Option ID. | string | Yes | | $licenseID | License table id. | string | Yes | | $name | Option name. | string | Yes | | $value | Option value. | string | Yes |
@return (int) ? Rows affected.
To use this plugin, your Eliasis application must use the PHP-Database library and add the following to the application configuration files:
/
* 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:
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');
$appID = $application->add('app-name', 'plugin', 'WordPress', 1);
$application->update($appID, 'new-app-name', 'module', 'Prestashop', 1);
$siteID = $site->add(
'domain.com',
'host.domain.com',
'87.142.85.70', 1
);
$site->update(
$siteID,
'new-domain.com',
'host.new-domain.com',
'87.142.85.70', 1
);
$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
$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');
$license->update(1, 1, $key, $license, '+3weeks');
$license->keyExists('SF4W2H-FEJKZ5-PU7KAD-N77486-BKMJSW');
$option->add($licenseID, 'lang', 'es-ES');
$option->update($id, $licenseID, 'lang', 'en-EN');
This plugin will create the following tables.
The table structure created is as follows:
| Columns | Data type | | --- | --- | | app_id | INT(9) | | app_name | VARCHAR(80) | | app_type | VARCHAR(80) | | app_category | VARCHAR(80) | | app_state | INT(1) | | updated | TIMESTAMP | | created | TIMESTAMP |
The table structure created is as follows:
| Columns | Data type | | --- | --- | | site_id | INT(9) | | site_domain | VARCHAR(255) | | site_host | VARCHAR(255) | | site_ip | VARCHAR(1) | | site_authorized | INT(1) | | updated | TIMESTAMP | | created | TIMESTAMP |
The table structure created is as follows:
| Columns | Data type | | --- | --- | | lic_id | INT(9) | | app_id | INT(9) | | site_id | INT(9) | | lic_key | VARCHAR(29) | | lic_state | INT(1) | | lic_expire | DATETIME | | site_authorized | INT(1) | | updated | TIMESTAMP | | created | TIMESTAMP |
The table structure created is as follows:
| Columns | Data type | | --- | --- | | option_id | INT(9) | | lic_id | INT(9) | | option_name | VARCHAR(180) | | option_value | LONGTEXT |
To run tests you just need composer and to execute the following:
$ git clone https://github.com/eliasis-framework/license-handler.git
$ cd license-handler
$ composer install
Run unit tests with PHPUnit:
$ composer phpunit
Run PSR2 code standard tests with PHPCS:
$ composer phpcs
Run PHP Mess Detector tests to detect inconsistencies in code style:
$ composer phpmd
Run all previous tests:
$ composer tests
If you would like to help, please take a look at the list of issues or the To Do checklist.
Pull requests
This project is licensed under MIT license. See the LICENSE file for more info.
2017 - 2018 Josantonius, josantonius.com
If you find it useful, let me know :wink:
Files (54) |
File | Role | Description | ||
---|---|---|---|---|
config (6 files) | ||||
src (2 directories) | ||||
tests (5 files, 1 directory) | ||||
.editorconfig | Data | Auxiliary data | ||
.php_cs.dist | Example | Example script | ||
.travis.yml | Data | Auxiliary data | ||
CHANGELOG.md | Data | Auxiliary data | ||
composer.json | Data | Auxiliary data | ||
CONDUCT.md | Data | Auxiliary data | ||
LICENSE | Lic. | License text | ||
license-handler.json | Lic. | License text | ||
phpcs.xml | Data | Auxiliary data | ||
phpmd.xml | Data | Auxiliary data | ||
README-ES.md | Doc. | Documentation | ||
README.md | Doc. | Documentation | ||
_config.yml | Data | Auxiliary data |
Files (54) | / | config |
File | Role | Description |
---|---|---|
database.php | Aux. | Auxiliary script |
datetime.php | Aux. | Auxiliary script |
namespaces.php | Aux. | Auxiliary script |
rows.php | Aux. | Auxiliary script |
set-hooks.php | Example | Example script |
tables.php | Aux. | Auxiliary script |
Files (54) | / | src | / | Controller |
File | Role | Description | ||
---|---|---|---|---|
Exception (1 file) | ||||
Application.php | Class | Class source | ||
Launcher.php | Class | Class source | ||
License.php | Class | Class source | ||
Option.php | Class | Class source | ||
Site.php | Class | Class source |
Files (54) | / | src | / | Model |
File | Role | Description |
---|---|---|
Application.php | Class | Class source |
License.php | Class | Class source |
Option.php | Class | Class source |
Site.php | Class | Class source |
Files (54) | / | tests |
File | Role | Description | ||
---|---|---|---|---|
sample-app (2 directories) | ||||
ApplicationTest.php | Class | Class source | ||
bootstrap.php | Aux. | Auxiliary script | ||
LicenseTest.php | Class | Class source | ||
OptionTest.php | Class | Class source | ||
SiteTest.php | Class | Class source |
Files (54) | / | tests | / | sample-app |
Files (54) | / | tests | / | sample-app | / | config |
File | Role | Description |
---|---|---|
complements.php | Aux. | Auxiliary script |
database.php | Aux. | Auxiliary script |
Files (54) | / | tests | / | sample-app | / | plugins |
File | Role | Description | ||
---|---|---|---|---|
license-handler (1 file, 2 directories) | ||||
.plugins-states.json | Data | Auxiliary data |
Files (54) | / | tests | / | sample-app | / | plugins | / | license-handler |
File | Role | Description | ||
---|---|---|---|---|
config (6 files) | ||||
src (2 directories) | ||||
license-handler.json | Lic. | License text |
Files (54) | / | tests | / | sample-app | / | plugins | / | license-handler | / | config |
File | Role | Description |
---|---|---|
database.php | Aux. | Auxiliary script |
datetime.php | Aux. | Auxiliary script |
namespaces.php | Aux. | Auxiliary script |
rows.php | Aux. | Auxiliary script |
set-hooks.php | Example | Example script |
tables.php | Aux. | Auxiliary script |
Files (54) | / | tests | / | sample-app | / | plugins | / | license-handler | / | src |
File | Role | Description | ||
---|---|---|---|---|
Controller (5 files, 1 directory) | ||||
Model (4 files) |
Files (54) | / | tests | / | sample-app | / | plugins | / | license-handler | / | src | / | Controller |
File | Role | Description | ||
---|---|---|---|---|
Exception (1 file) | ||||
Application.php | Class | Class source | ||
Launcher.php | Class | Class source | ||
License.php | Class | Class source | ||
Option.php | Class | Class source | ||
Site.php | Class | Class source |
Files (54) | / | tests | / | sample-app | / | plugins | / | license-handler | / | src | / | Controller | / | Exception |
File | Role | Description |
---|---|---|
LHException.php | Class | Class source |
Files (54) | / | tests | / | sample-app | / | plugins | / | license-handler | / | src | / | Model |
File | Role | Description |
---|---|---|
Application.php | Class | Class source |
License.php | Class | Class source |
Option.php | Class | Class source |
Site.php | Class | Class source |
The PHP Classes site has supported package installation using the Composer tool since 2013, as you may verify by reading this instructions page. |
Install with Composer |
Version Control | Unique User Downloads | Download Rankings | |||||||||||||||
100% |
|
|
Applications that use this package |
If you know an application of this package, send a message to the author to add a link here.