php-extended/php-record-score-comparator

A library that provides record comparators from scoring values

4.0.0 2022-05-31 06:57 UTC

README

A library that provides record comparators from scoring values.

coverage build status

Installation

The installation of this library is made via composer. Download composer.phar from their website. Then add to your composer.json :

	"require": {
		...
		"php-mtg/php-record-score-comparator": "^3",
		...
	}

Then run php composer.phar update to install this library. The autoloading of all classes of this library is made through composer's autoloader.

Basic Usage

For the basic functions, use :


use PhpExtended\Record\ScoreRecordComparator;
use PhpExtended\Record\ScoreRecordComparatorDefinition;

/* @var $scoreFactory \PhpExtended\Score\ScoreFactoryInterface */
/* @var $record1 \PhpExtended\Record\RecordInterface */
/* @var $record2 \PhpExtended\Record\RecordInterface */

$definitions = new ArrayIterator([
	new ScoreRecordComparatorDefinition('name', 'name', $scoreFactory, 1),
]);

$comparator = new ScoreRecordComparator();

$distance = $comparator->compare($record1, $record2);
// the lower the distance, the more equal the objects are

For the packages that are useful at getting http requests (HttpProcessor), see the require-dev of the composer.json file.

License

MIT (See license file).