README

This package helps you deal with Boolean value in your laravel project, support action cast model attribute, check value is true/false, convert to your desire boolean form. It's super handy for keeping things clean and avoiding copy-paste, so you can grab what you need quickly and cut down on extra coding.

Work with us

We're PHP and Laravel whizzes, and we'd love to work with you! We can:

Design the perfect fit solution for your app.
Make your code cleaner and faster.
Refactoring and Optimize performance.
Ensure Laravel best practices are followed.
Provide expert Laravel support.
Review code and Quality Assurance.
Offer team and project leadership.
Delivery Manager

PHP and Laravel Version Support

This package supports the following versions of PHP and Laravel:

PHP: ^8.2
Laravel: ^11.0, ^12.0

Installation

You can install the package via composer:

composer require t-labs-co/booleanize

You can publish the config file with:

php artisan vendor:publish --tag="booleanize-config"

This is the contents of the published config file:

return [
// Override your configuration 
];

Feature

Check input value is true or false
Convert input value to desired Boolean form
Cast model attribute to correct value
Query boolean field
Validate rule for boolean field

Usage

Convert to bool with helper

// use helper class 
booleanize('true', null, true); // OUTPUT: true

// or call instance and using
booleanize()->convert('Yes', null, true); // OUTPUT: true 
booleanize()->convert('Yes', null, 1); // OUTPUT: 1 

booleanize()->convert('No', null, true); // OUTPUT: false 
booleanize()->convert('No', null, 1); // OUTPUT: 0

Using in Model class

// model class 

class User extends Authenticatable
{
    use HasBooleanizeTrait;
    
    // cast using 
    protected function casts(): array
    {
        return [
            'agreed' => BooleanizeCast::class
        ];
    }
    
    // setting cast type SET and GET
    public function getTrueValueAs(): array
    {
        // config your default true value for your attribute when GET
        return [
            'agreed' => 1
        ];
    }
    
    public function setTrueValueAs(): array
    {
        // config your default true value for your attribute when SET
        return [
            'agreed' => 'yes'
        ];
    }
}

// query Scope using  whereBooleanize()
$users = User::whereBooleanize('agreed', true)->get(); 
// this will auto convert `true` to `yes` value from `setTrueValueAs()` and do query

// Or shorter 
$users = User::whereBooleanizeTrue('agreed')->get();

Using in validate

$data = [
    'term_confirm' => 'Y'
];
// term_confirm could be any in [y,yes,1,true]
$rules = [
    'term_confirm' => ['required', new BooleanizeTrueRule()],
];

Validator::validate($data, $rules, [
    'term_confirm' => 'Must confirm the term'
]);

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

t-labs-co / booleanize

Maintainers

Details