Download the PHP package cjmellor/blockade without Composer

On this page you can find all versions of the php package cjmellor/blockade. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of cjmellor/blockade

Informations about the package blockade

Allow a User Model to Block Another User Model

Packagist Version GitHub Tests Action Status Packagist Downloads Packagist PHP Version Laravel Version

Allow a User to block another User. Blocking a User will prevent the blocker from seeing the blockees data.

Installation

You can install the package via composer:

You can publish and run the migrations with:

and publish the config file with:

This is the contents of the published config file:

Usage

Using the Traits

CanBlock

Add the CanBlock trait to your User model.

This trait should only ever be added to your User model.

HasBlocked

Use this trait in your Models where you would not want a User to see the Model of a User they have blocked.

Example: you have a Comment Model and User 7 has blocked User 8 so User 7 should not be able to see any comments made by User 8.

Block a User

A User can block another User by supplying a User model, or just the ID of the User to be blocked.

Note: You cannot block yourself.

Unblock a User

A User can unblock another User by supplying a User model, or just the ID of the User to be unblocked.

Checking if a User is blocked

You can run a check to see if you're already blocking a User or not.

Set a block expiry

You can set an expiry date when blocking a User. This will automatically unblock the User after the expiry date has passed.

This example will block the User for 7 days. After 7 days, the User will be unblocked.

⏱️ Scheduling the cleanup of expired blocks

By default, a blocked User with an expiry will not be removed after the expiry time as past.

If you want to automatically remove expired blocks, you can set the schedule_cleanup config value in the config/blockade config file to true.

If you want more control over when the cleanup is run, there is an artisan command that can be run to remove expired blocks.

You can also schedule this command to run automatically.

Note

Don't forget to add the command to the App\Console\Kernel schedule() method.

Events

When a User is blocked, a UserBlocked event is fired.

When a User is unblocked, a UserUnblocked event is fired.

The User Model of the blocked or unblocked User is passed to the event so you can listen for these events and perform further actions.

Testing

Changelog

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

License

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

All versions of blockade with dependencies

PHP Build Version
Package Version
Requires php Version ^8.2|^8.3
illuminate/support Version ^10.0|^11.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package cjmellor/blockade contains the following files

Loading the files please wait ....