PHP Classes
elePHPant
Icontem

PHP License Detector: Detect the type of project license text

Recommend this page to a friend!
  Info   View files Documentation   View files View files (51)   DownloadInstall with Composer Download .zip   Reputation   Support forum   Blog    
Last Updated Ratings Unique User Downloads Download Rankings
2019-08-30 (17 days ago) RSS 2.0 feedNot yet rated by the usersTotal: 47 This week: 1All time: 9,600 This week: 335Up
Version License PHP version Categories
license-detector 1.0MIT/X Consortium ...5PHP 5, Utilities and Tools, Text proc..., A..., P...
Description Author

This package can detect the type of project license text.

It can take as parameters the text of a license given in the format of a string or a file that contains the license text.

The package can detect the type of license by checking the similarity of the text of the given license with other well known types of license provided by this package as license files.

Innovation Award
PHP Programming Innovation award nominee
August 2019
Nominee
Vote
There are many types of licenses being used by software projects to distribute their code and other types of files. Some of those licenses are just variants of each other.

This package can be used to analyse a license text and detect its type of license comparing with a list of well known licenses that are more popular and are provided withing the package.

Manuel Lemos
  Performance   Level  
Name: Sami Ilyes Mazouz <contact>
Classes: 1 package by
Country: Algeria Algeria
Age: ???
All time rank: 42905 in Algeria Algeria
Week rank: 307 Up1 in Algeria Algeria Up
Innovation award
Innovation award
Nominee: 1x

 

Details

license-detector

A License information detector, inspired by Licensee and relies on data from choosealicense.com

Travis (.org) branch Latest Version php License

Installation

Using Composer run the following

$ composer require sycho/license-detector

Problem

The code uses php's similar_text() function to tell which license is the one used, the function is quiet expensive and can take up to one second for the results.

Usage

Using the Detector class's parse() or parseByPath() methods, you get a License object containing data about the license

require '...\vendor\autoload.php';

use LicenseDetector\Detector;

$detector = new Detector();

// By license contents
$license = $detector->parse($contents);

// By file path
$license = $detector->parseByPath($path_to_license);

Contributing

Sign-off your commits, to acknowledge your submission under the license of the project.

Example: Signed-off-by: Your Name <youremail@example.com>

License

This package is released under the MIT License. A full copy of this license is included in the package file.

  Files folder image Files  
File Role Description
Files folder imagelicense-detector (4 files)
Files folder imagetests (2 files)
Files folder imagevendor (1 directory)
Accessible without login Plain text file .travis.yml Data Auxiliary data
Accessible without login Plain text file composer.json Data Auxiliary data
Accessible without login Plain text file LICENSE Lic. License text
Accessible without login Plain text file README.md Doc. Documentation

  Files folder image Files  /  license-detector  
File Role Description
  Plain text file Detector.php Class Class source
  Plain text file License.php Class Class source
  Plain text file Rule.php Class Class source
  Plain text file RuleType.php Class Class source

  Files folder image Files  /  tests  
File Role Description
  Plain text file DetectorTest.php Class Class source
  Accessible without login Plain text file LICENSE.txt Doc. Documentation

  Files folder image Files  /  vendor  
File Role Description
Files folder imagechoosealicense.com (2 files, 2 directories)

  Files folder image Files  /  vendor  /  choosealicense.com  
File Role Description
Files folder image_data (3 files)
Files folder image_licenses (36 files)
  Accessible without login Plain text file LICENSE.md Lic. License text
  Accessible without login Plain text file README.md Lic. License text

  Files folder image Files  /  vendor  /  choosealicense.com  /  _data  
File Role Description
  Accessible without login Plain text file fields.yml Lic. License text
  Accessible without login Plain text file meta.yml Lic. License text
  Accessible without login Plain text file rules.yml Lic. License text

  Files folder image Files  /  vendor  /  choosealicense.com  /  _licenses  
File Role Description
  Accessible without login Plain text file 0bsd.txt Doc. Documentation
  Accessible without login Plain text file afl-3.0.txt Doc. Documentation
  Accessible without login Plain text file agpl-3.0.txt Doc. Documentation
  Accessible without login Plain text file apache-2.0.txt Doc. Documentation
  Accessible without login Plain text file artistic-2.0.txt Doc. Documentation
  Accessible without login Plain text file bsd-2-clause.txt Doc. Documentation
  Accessible without login Plain text file bsd-3-clause-clear.txt Doc. Documentation
  Accessible without login Plain text file bsd-3-clause.txt Doc. Documentation
  Accessible without login Plain text file bsl-1.0.txt Doc. Documentation
  Accessible without login Plain text file cc-by-4.0.txt Doc. Documentation
  Accessible without login Plain text file cc-by-sa-4.0.txt Doc. Documentation
  Accessible without login Plain text file cc0-1.0.txt Doc. Documentation
  Accessible without login Plain text file ecl-2.0.txt Doc. Documentation
  Accessible without login Plain text file epl-1.0.txt Doc. Documentation
  Accessible without login Plain text file epl-2.0.txt Doc. Documentation
  Accessible without login Plain text file eupl-1.1.txt Doc. Documentation
  Accessible without login Plain text file eupl-1.2.txt Doc. Documentation
  Accessible without login Plain text file gpl-2.0.txt Doc. Documentation
  Accessible without login Plain text file gpl-3.0.txt Doc. Documentation
  Accessible without login Plain text file isc.txt Doc. Documentation
  Accessible without login Plain text file lgpl-2.1.txt Doc. Documentation
  Accessible without login Plain text file lgpl-3.0.txt Doc. Documentation
  Accessible without login Plain text file lppl-1.3c.txt Doc. Documentation
  Accessible without login Plain text file mit.txt Doc. Documentation
  Accessible without login Plain text file mpl-2.0.txt Doc. Documentation
  Accessible without login Plain text file ms-pl.txt Doc. Documentation
  Accessible without login Plain text file ms-rl.txt Doc. Documentation
  Accessible without login Plain text file ncsa.txt Doc. Documentation
  Accessible without login Plain text file odbl-1.0.txt Doc. Documentation
  Accessible without login Plain text file ofl-1.1.txt Doc. Documentation
  Accessible without login Plain text file osl-3.0.txt Doc. Documentation
  Accessible without login Plain text file postgresql.txt Doc. Documentation
  Accessible without login Plain text file unlicense.txt Doc. Documentation
  Accessible without login Plain text file upl-1.0.txt Doc. Documentation
  Accessible without login Plain text file wtfpl.txt Doc. Documentation
  Accessible without login Plain text file zlib.txt Doc. Documentation

 Version Control Unique User Downloads Download Rankings  
 100%
Total:47
This week:1
All time:9,600
This week:335Up