README

The Comparator library provides a flexible and powerful way to compare values in PHP, supporting various data types and comparison operators. It is designed to be easy to use while offering extensive functionality for complex comparison scenarios.

Features

Supports multiple data types: string, float, int, bool, array, object, and JSON.
Customizable comparison behavior, including case sensitivity and epsilon for floating-point comparisons.
Extensive set of comparison operators, including mathematical comparisons, regex matching, string containment, and custom comparison functions.
Allows for both strict and loose comparisons.
Configurable match type for array comparisons to require all or any elements to match.

Installation

Ensure you have the package installed in your project. If not, you can typically include it using Composer:

composer require arraypress/comparator

Global Comparison Function

The library provides a convenient global Compare class to facilitate easy comparisons between two values with extensive customization options. This function leverages the Comparator class internally while offering additional flexibility for custom comparison logic and error handling.

Function Signature

Compare::values(
  $value1,
  $value2,
  string $operator,
  ?string $type = null,
  bool $caseSensitive = true,
  bool $useEpsilon = false,
  $value3 = null,
  ?callable $customFunction = null,
  float $epsilon = 1.0e-10,
  ?callable $errorCallback = null
): ?bool

Parameters

$value1, $value2: The values to be compared.
$operator: Defines how the values should be compared. See the operator table for supported operators.
$type: Specifies the type of comparison. If null, the type is auto-detected.
$caseSensitive: Determines if string comparisons are case-sensitive. Defaults to true.
$useEpsilon: Utilize epsilon for floating-point comparisons to handle precision issues.
$value3: The upper bound for BETWEEN comparisons.
$customFunction: A custom function for comparison, used when the operator is set to 'custom'.
$epsilon: The tolerance level for floating-point comparisons. Defaults to 1.0e-10.
$errorCallback: A callback for error handling, invoked if an exception occurs during comparison.

Return Value

Returns a boolean indicating the result of the comparison, or null in case of an error.

Usage Example

$result = Compare::values( 'hello', 'Hello', '=', false ); // Case-insensitive string comparison
if ( $result ) {
    // Values are considered equal
}

This function simplifies complex comparisons by abstracting the instantiation and setup of the Comparator class, allowing developers to perform comparisons with minimal setup and handling errors gracefully.

Supported Comparison Operators and Their Aliases

The Comparator class provides a flexible way to compare different types of values by supporting a wide range of comparison operators. To make the class more intuitive and user-friendly, it allows the use of human-readable aliases for these operators. Below is a table that maps these aliases to their corresponding standard operator symbols, providing an easy reference for users to construct their comparison expressions.

Updated translateOperator Function You've already included the necessary updates in your translateOperator function to

This feature enhances the readability and expressiveness of your code, making it easier to understand and maintain.

Automatic Type Detection

The Comparator class is equipped with an intelligent automatic type detection system, designed to simplify the comparison process between different types of values. This feature automatically identifies the type of the provided values and applies the most appropriate comparison logic based on their types. The table below explains the types that can be automatically detected and the conditions under which each type is identified.

This automatic type detection facilitates a more dynamic and error-resistant comparison process, allowing users to compare different types of data without the need for explicit type casting or manual type checks. It ensures that the comparison logic is always aligned with the nature of the data being compared, enhancing the robustness and versatility of the Comparator class.

Example Test 1: Integer Comparison

Compare two integers to check if the first is less than the second.

$result = Compare::values( 5, 10, '<' ) ? 'Pass' : 'Fail';
// Expected output: Pass

Example Test 2: Float Comparison with Epsilon

Compare two floats for equality, considering a small margin (epsilon).

$result = Compare::values( 0.1 + 0.2, 0.3, '=', 'float', true, true ) ? 'Pass' : 'Fail';
// Expected output: Pass

Example Test 3: String Case-Sensitive Comparison

Compare two strings with case sensitivity.

$result = Compare::values( 'Hello', 'hello', '=', 'string', true ) ? 'Pass' : 'Fail';
// Expected output: Fail (due to case sensitivity)

Example Test 4: Custom Function Comparison

Use a custom function for comparison. In this example, checking if the first number is double the second.

$customFunction = function ( $a, $b ) {
    return $a == ( $b * 2 );
};
$result = Compare::values( 10, 5, 'custom', null, true, false, 'all', $customFunction ) ? 'Pass' : 'Fail';
// Expected output: Pass

Example Test 5: JSON String Comparison

Compare two JSON strings for equality.

$json1 = '{"name": "John", "age": 30}';
$json2 = '{"name": "John", "age": 30}';
$result = Compare::values( $json1, $json2, '=' ) ? 'Pass' : 'Fail';
// Expected output: Pass

Example Test 6: Regular Expression Comparison

Use a regular expression to compare if a string matches the pattern.

$result = Compare::values( 'test123', '^test', 'regex' ) ? 'Pass' : 'Fail';
// Expected output: Pass

Example Test 7: Array Comparison

Compare two arrays for equality.

$array1 = [1, 2, 3];
$array2 = [1, 2, 3];
$result = Compare::values( $array1, $array2, '=' ) ? 'Pass' : 'Fail';
// Expected output: Pass

Example Test 8: Boolean Comparison

Compare two booleans for equality.

$result = Compare::values( true, true, '=', 'bool' ) ? 'Pass' : 'Fail';
// Expected output: Pass

Example Test 9: Object Comparison

Compare two objects for equality.

$obj1 = (object) [ 'key' => 'value' ];
$obj2 = (object) [ 'key' => 'value' ];
$result = Compare::values( $obj1, $obj2, '=', 'object' ) ? 'Pass' : 'Fail';
// Expected output: Pass

Example Test 10: Date Comparison

Compare two dates to check if the first is less than the second.

$result = Compare::values( '2023-01-01', '2024-01-01', '<' ) ? 'Pass' : 'Fail';
// Expected output: Pass

Example Test 11: String Contains

Check if a string contains another string.

$result = Compare::values( 'Hello world', 'world', 'contains' ) ? 'Pass' : 'Fail';
// Expected output: Fail

Example Test 12: String Starts With

Check if a string starts with another string.

$result = Compare::values( 'Hello world', 'Hello', 'starts' ) ? 'Pass' : 'Fail';
// Expected output: Pass

Example Test 13: String Ends With

Check if a string ends with another string.

$result = Compare::values( 'Hello world', 'world', 'ends' ) ? 'Pass' : 'Fail';
// Expected output: Pass

Example Test 14: Not Equal Comparison

Compare two integers to check if they are not equal.

$result = Compare::values( 5, 10, '!=' ) ? 'Pass' : 'Fail';
// Expected output: Pass

Example Test 15: Greater Than Comparison

Compare two integers to check if the first is greater than the second.

$result = Compare::values( 10, 5, '>' ) ? 'Pass' : 'Fail';
// Expected output: Pass

Example Test 16: Between Comparison for Numbers

Check if an integer is between two other integers (inclusive).

$result = Compare::between( 15, 10, 20 ) ? 'Pass' : 'Fail';
// Expected output: Pass

Example Test 17: Not Between Comparison for Numbers

Check if an integer is not between two other integers (inclusive).

$result = Compare::notBetween( 5, 10, 20 ) ? 'Pass' : 'Fail';
// Expected output: Pass

Example Test 18: Between Comparison for Dates

Check if a date is between two other dates.

$dateToCheck = '2023-06-15';
$startDate = '2023-06-01';
$endDate = '2023-06-30';
$result = Compare::between( $dateToCheck, $startDate, $endDate, 'date' ) ? 'Pass' : 'Fail';
// Expected output: Pass

Example Test 19: Not Between Comparison for Dates

Check if a date is not between two other dates.

$dateToCheck = '2023-07-01';
$startDate = '2023-06-01';
$endDate = '2023-06-30';
$result = Compare::notBetween( $dateToCheck, $startDate, $endDate, 'date' ) ? 'Pass' : 'Fail';
// Expected output: Pass

Contributions

Contributions to this library are highly appreciated. Raise issues on GitHub or submit pull requests for bug fixes or new features. Share feedback and suggestions for improvements.

License: GPLv2 or later

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

arraypress / comparator

Maintainers

Details