Small utility trait to fluently compare object values.
if ($comparable->is('wallet.available')->aboveZero()) {
return 'You can buy with your wallet credits.';
}
return 'No credits? Buy some in the store!';
Your support allows me to keep this package free, up-to-date and maintainable. Alternatively, you can spread the word!
- Laravel 9.x or later
- PHP 8.0 or later
Fire up Composer and require this package in your project.
composer require laragear/comparable
That's it.
Add the Comparable trait to your object, and that's it. You can start a comparison using is() with the key name, unless you want to compare the whole object.
use Laragear\Compare\Comparable;
class Wallet
{
use Comparable;
// ...
}Once done, you can start a comparison using is().
$wallet = new Wallet(['credits' => 1000]);
if ($wallet->is('credits')->aboveZero()) {
return 'You have credits available, so go and spend some!';
}
return 'Your wallet is empty. Add some credits!';When not issuing a key, the whole object will be used to compare.
Behind the scenes, it uses data_get() from Laravel helpers to retrieve the values from your object using "dot" notation.
if ($wallet->is('pending.total')->aboveZero()) {
return "You have {$wallet->pending->total} pending.";
}To negate a condition, just issue not(), or the not property.
if ($wallet->is('pending.total')->not->belowZero()) {
return 'If you dont have credits, we can lend you some.';
}| aboveZero | equalOrGreaterThan | lessThan |
| belowZero | equalOrLessThan | null |
| between | exactly | true |
| blank | false | truthy |
| containing | falsy | zero |
| containingOneItem | filled | |
| counting | greaterThan |
Checks if a numeric value is above zero.
if ($wallet->is('amount')->aboveZero()) {
return 'You still have credits left.';
}Checks if a numeric value is below zero.
if ($wallet->is('amount')->belowZero()) {
return 'The Wallet is empty.';
}Check if the numeric value is between two numbers.
if ($product->is('weight')->between(10, 20)) {
return 'This product can be picked up at the store.';
}Issuing false as third parameter will make the comparison exclusive.
if ($product->is('weight')->between(10, 20, false)) {
return 'The weight of the product is between 10.1 and 19.9 lbs.';
}Check if the value is "blank".
if ($wallet->is('name')->blank()) {
return 'Default Wallet';
}Checks if a list contains the exact number of items.
if ($cart->is('items')->counting(10)) {
return 'You are elegible for a discount for exactly 10 items.';
}Checks if a string contains a string, or a list contains an item.
if ($product->is('name')->containing('discounted')) {
return 'Discount are not applied to already discounted items.';
}Check if the value is a list and contains only one item.
if ($cart->is('items')->containingOneItem()) {
returns 'For free delivery, you need to add more than one item.';
}Check that a numeric value, or the value list count, is equal or greater than a number.
if ($cart->is('items')->equalOrGreaterThan(10)) {
return 'For more than 10 items, you will need to pick up them in the store.'
}
if ($cart->is('total')->equalOrGreaterThan(1000)) {
return 'Your cart qualifies for free delivery';
}Check that a value is exactly the value given, strictly.
if ($product->is('name')->exactly('shoes')) {
return 'Welp, these are shoes.';
}Check if a value is exactly false.
if ($product->is('can_deliver')->false()) {
return 'The product cannot be delivered.';
}Check if a value evaluates to false.
if ($product->is('address')->false()) {
return 'The product cannot be delivered without an address.';
}Check that a numeric value, or the value list count, is equal or less than a number.
if ($cart->is('items')->equalOrLessThan(1)) {
return 'Add more items to qualify for delivery.'
}
if ($cart->is('total')->equalOrLessThan(1000)) {
return 'Your cart does not qualify for free delivery';
}Check if the value is "filled".
if ($wallet->is('name')->blank()) {
return 'Default Wallet';
}Check if the numeric value, or the list items count, is greater than the issued number,
if ($product->is('weight')->greaterThan(100)) {
return 'This product is too heavy to be sent. You have to pick it up.';
}Check if the numeric value, or the list items count, is less than the issued number,
if ($product->is('weight')->greaterThan(100)) {
return 'This product is too heavy to be sent. You have to pick it up.';
}
if ($cary->is('items')->greaterThan(10)) {
return 'We wil divide your order on multiple deliveries of 10 items';
}Check if the value is null.
if ($cart->is('promo_code')->null()) {
return 'You can add a promo code to your code.';
}Check if a value is exactly true.
if ($product->is('can_deliver')->true()) {
return 'The product can be delivered.';
}Check if a value evaluates to true.
if ($product->is('address')->true()) {
return 'The products will be delivered to the issued address.';
}Check if the numeric value, or the list items count, is exactly zero.
if ($cart->is('delivery_total')->zero()) {
return 'This order has no cost of delivery. Enjoy!';
}
if ($cart->is('items')->zero()) {
return 'Your cart is empty.';
}You can access to a comparison result using dynamic properties:
$object->blank |
$object->false |
$object->aboveZero |
$object->filled |
$object->falsy |
$object->belowZero |
$object->true |
$object->null |
$object->containingOneItem |
$object->truthy |
$object->zero |
- There are no singletons using a stale application instance.
- There are no singletons using a stale config instance.
- There are no singletons using a stale request instance.
- There are no static properties written.
There should be no problems using this package with Laravel Octane.
If you discover any security related issues, please email darkghosthunter@gmail.com instead of using the issue tracker.
This specific package version is licensed under the terms of the MIT License, at time of publishing.
Laravel is a Trademark of Taylor Otwell. Copyright © 2011-2022 Laravel LLC.