README

This is my package laravel-memberships

This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.

Support us

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.

Installation

You can install the package via composer:

composer require spoyntersmith/laravel-memberships

You can publish and run the migrations with:

php artisan vendor:publish --tag="laravel-memberships-migrations"
php artisan migrate

You can publish the config file with:

php artisan vendor:publish --tag="laravel-memberships-config"

This is the contents of the published config file:

return [
    // @todo: copy contents of the config file here
];

Usage

First add the InteractsWithMemberships trait to your model:

<?php

    namespace App;

    use Spoynt\LaravelMemberships\InteractsWithMemberships;

    class User extends Authenticatable
    {
        use InteractsWithMemberships;

        // ...
    }

Then you can use the isMemberOf method to check if the user is currently a member of a membership:

<?php

    $user = User::first();

    if ($user->isMemberOf('gold')) {
        //
    }

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.

spoyntersmith / laravel-memberships

Maintainers

Details