Laravel Acquaintances

https://github.com/multicaret/laravel-acquaintances
Admin
A Laravel package that provides Eloquent models with abilities to manage friendships, groups, and...
Tokens:126,269
Snippets:1,072
Trust Score:6.9
License:MIT
Update:1 week ago
Show doc for...
Tokens:
Raw
### Install: Composer require

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/README.md

Install the package via Composer.

```bash
composer require multicaret/laravel-acquaintances
```

--------------------------------

### getVerifiers() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/Verifiable.md

Example of retrieving verifiers with and without pagination.

```php
$verifiers = $user2->getVerifiers();
$paged = $user2->getVerifiers(15, '', ['id', 'name'], true);
```

--------------------------------

### toggleLike() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanLike.md

Example call to toggleLike() storing the result.

```php
$result = $user->toggleLike($post);
```

--------------------------------

### likers() and fans() usage examples

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanLike.md

Example retrieving likers and fans of a post.

```php
$likers = $post->likers()->get();
$fans = $post->fans()->get();
```

--------------------------------

### viewers() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanView.md

Example of retrieving all viewers of an article.

```php
$viewers = $article->viewers()->get();
```

--------------------------------

### likes() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanLike.md

Example retrieving liked posts of a given class.

```php
$liked = $user->likes(Post::class)->get();
```

--------------------------------

### Using averageRating() and userSumRating()

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanRate.md

Example of getting the average rating for a specific type and the authenticated user's sum rating.

```php
$avg = $restaurant->averageRating('quality');
$mine = $restaurant->userSumRating();
```

--------------------------------

### views() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanView.md

Example of retrieving viewed targets for a user.

```php
$viewed = $user->views(Article::class)->get();
```

--------------------------------

### flushRequestCache() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/Interaction.md

Example call to flush the request cache.

```php
Interaction::flushRequestCache();
```

--------------------------------

### like() usage examples

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanLike.md

Example calls to like() with a single model and with an array of ids and explicit class.

```php
$user->like($post);
$user->like([1, 2], Post::class);
```

--------------------------------

### isLikedBy() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanLike.md

Example checking if the authenticated user likes a post.

```php
if ($post->isLikedBy(auth()->id())) { /* ... */ }
```

--------------------------------

### verify() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/Verifiable.md

Example of calling verify() with a message. The method returns false if a non-denied verification already exists, so check the return value before proceeding.

```php
$verification = $user1->verify($user2, 'Trusted collaborator.');
if ($verification === false) {
    // a non-denied verification already exists
}
```

--------------------------------

### view() usage examples

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanView.md

Examples of calling view() with a single model or an array of IDs and class.

```php
$user->view($article);
$user->view([1, 2], Article::class);
```

--------------------------------

### toggleView() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanView.md

Example of calling toggleView() with a single model.

```php
$user->toggleView($article);
```

--------------------------------

### unlike() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanLike.md

Example call to unlike() with a single model.

```php
$user->unlike($post);
```

--------------------------------

### Run migrations

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/docs/2.installation.md

Execute this command to run the package's migrations after publishing.

```bash
php artisan migrate
```

--------------------------------

### isVerifiedWith() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/Verifiable.md

Example of using isVerifiedWith() to check verification status and output a message.

```php
if ($user1->isVerifiedWith($user2)) {
    echo "Verified!";
}
```

--------------------------------

### Count helper usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanView.md

Example of using the viewers_count accessor and viewersCountReadable() method.

```php
echo $article->viewers_count;          // int
echo $article->viewersCountReadable(); // "5.5K"
```

--------------------------------

### unview() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanView.md

Example of calling unview() with a single model.

```php
$user->unview($article);
```

--------------------------------

### subscribersCount() usage examples

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanSubscribe.md

Get the subscriber count as an integer or as a readable string like '10.5K'.

```php
echo $channel->subscribers_count;         // int
echo $channel->subscribersCountReadable(); // "10.5K"
```

--------------------------------

### numberToReadable() usage examples

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/Interaction.md

Example calls showing output for 12500 with default precision and precision 0.

```php
echo Interaction::numberToReadable(12500); // "12.5K"
echo Interaction::numberToReadable(12500, 0); // "13K"
```

--------------------------------

### toggleRelations() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/Interaction.md

Example toggling a 'favorites' relation, with possible result comments.

```php
$result = Interaction::toggleRelations($user, 'favorites', $post, \App\Models\Post::class);
// ['attached' => [...]] or ['detached' => [...]]
```

--------------------------------

### subscribe() usage examples

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanSubscribe.md

Subscribe a user to a channel or to multiple channels by ID. The second example passes the target class explicitly.

```php
$user->subscribe($channel);
$user->subscribe([1, 2], Channel::class);
```

--------------------------------

### likersCount() usage examples

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanLike.md

Example echoing the likers_count attribute (int) and the readable count (formatted string).

```php
echo $post->likers_count;             // int
echo $post->likersCountReadable();    // "2.5K"
```

--------------------------------

### upvoters() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanVote.md

Example of retrieving all upvoters for an answer.

```php
$upvoters = $answer->upvoters()->get();
```

--------------------------------

### Publish config and migrations (optional)

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/docs/2.installation.md

Publish the package's config and migrations for customization. Use the provider flag or granular tags.

```bash
php artisan vendor:publish --provider="Multicaret\Acquaintances\AcquaintancesServiceProvider"
```

```bash
# or granular:
php artisan vendor:publish --tag=acquaintances-config
php artisan vendor:publish --tag=acquaintances-migrations
```

--------------------------------

### TL;DR: Friendships and Verifications Example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/README.md

Shows the core API for friendships and verifications: befriending, accepting friend requests, unfriending, verifying, accepting verification requests, and checking verification status.

```php
$user1 = User::find(1);
$user2 = User::find(2);

// Friendships
$user1->befriend($user2);
$user2->acceptFriendRequest($user1);

// The messy breakup :(
$user2->unfriend($user1);

// Verifications (message is optional)
$user1->verify($user2, "Worked together on several Laravel projects.");
$user2->acceptVerificationRequest($user1);

if ($user1->isVerifiedWith($user2)) {
    echo "Verified!";
}
```

--------------------------------

### Using ratings() to get rows with user loaded

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanRate.md

Example of calling ratings() and accessing the loaded user relation on each row.

```php
$rows = $restaurant->ratings()->get(); // each row has ->user loaded
```

--------------------------------

### votes() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanVote.md

Example of retrieving all votes for an Answer model.

```php
$votes = $user->votes(Answer::class)->get();
```

--------------------------------

### Complete example with CanLike and CanBeLiked

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/HasAcquaintanceCounters.md

Shows how like/unlike update counters, but toggleLike does not.

```php
use Multicaret\Acquaintances\Traits\CanLike;
use Multicaret\Acquaintances\Traits\CanBeLiked;
use Multicaret\Acquaintances\Traits\HasAcquaintanceCounters;

class User extends Model { use CanLike; }

class Post extends Model {
    use CanBeLiked, HasAcquaintanceCounters;
    // posts table has a likes_count integer column
}

// like() triggers attachRelations() -> updateCounters() -> posts.likes_count += 1
$user->like($post);
// unlike() decrements it
$user->unlike($post);
// toggleLike() does NOT update the counter
$user->toggleLike($post);
```

--------------------------------

### hasLiked() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanLike.md

Example using hasLiked() to conditionally like a post.

```php
if (! $user->hasLiked($post)) {
    $user->like($post);
}
```

--------------------------------

### Usage example for groupFriend and ungroupFriend

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/Friendable.md

Shows how to call groupFriend and ungroupFriend on a user instance to manage group memberships.

```php
$user1->groupFriend($user2, 'close_friends');
$user1->ungroupFriend($user2, 'close_friends');
```

--------------------------------

### Count helper usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanVote.md

Example of using the upvoters_count accessor and votersCountReadable() method.

```php
echo $answer->upvoters_count;   // int
echo $answer->votersCountReadable();
```

--------------------------------

### Using ratingPercent() and ratingPercentAllTypes()

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanRate.md

Example of calculating rating percentages with default and custom max values.

```php
$percent = $restaurant->ratingPercent(); // e.g. 84
$percent = $restaurant->ratingPercentAllTypes(10);
```

--------------------------------

### Friendship lifecycle example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/Friendable.md

Demonstrates sending a friend request, accepting it, checking friendship, and retrieving friends.

```php
$user1->befriend($user2);
$user2->acceptFriendRequest($user1);
$user1->isFriendWith($user2); // true
$friends = $user1->getFriends();
```

--------------------------------

### attachRelations() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/Interaction.md

Example attaching a 'likes' relation from $user to $post, with expected result comment.

```php
$result = Interaction::attachRelations($user, 'likes', $post, \App\Models\Post::class);
// $result = ['attached' => [1]]
```

--------------------------------

### subscriptions() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanSubscribe.md

Retrieve the channels a user is subscribed to.

```php
$channels = $user->subscriptions(Channel::class)->get();
```

--------------------------------

### follow() usage examples

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanFollow.md

Follow a model by passing the model instance or an array of IDs with the target class. Dispatches the acq.followships.follow event.

```php
$user->follow($post);                    // by model
$user->follow([1, 2, 3], Post::class);   // by ids
```

--------------------------------

### hasViewed() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanView.md

Example of checking if a user has viewed an article before viewing it.

```php
if (! $user->hasViewed($article)) {
    $user->view($article);
}
```

--------------------------------

### reporters() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanReport.md

Retrieve all users who reported the comment.

```php
$reporters = $comment->reporters()->get();
```

--------------------------------

### followings() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanFollow.md

Retrieve the followed models of a specific class.

```php
$followings = $user->followings(Post::class)->get();
```

--------------------------------

### subscribers() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanSubscribe.md

Retrieve all subscribers of a channel.

```php
$subscribers = $channel->subscribers()->get();
```

--------------------------------

### vote() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanVote.md

Example of calling vote() to cast a downvote on an answer.

```php
$user->vote($answer, 'downvote');
```

--------------------------------

### reports() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanReport.md

Retrieve reported targets for a given class.

```php
$reported = $user->reports(Comment::class)->get();
```

--------------------------------

### blockFriend() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/Friendable.md

Example call to blockFriend() that creates a friendship row with status='blocked'.

```php
$user1->blockFriend($user2); // friendship row with status='blocked'
```

--------------------------------

### upvote() and downvote() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanVote.md

Example of upvoting and then downvoting an answer. The downvote replaces the upvote.

```php
$user->upvote($answer);
$user->downvote($answer); // replaces the upvote
```

--------------------------------

### followingCount() usage examples

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanFollow.md

Access the following count as an integer or as a readable string.

```php
echo $user->following_count;      // int
echo $user->followingCountReadable(); // "1.2K"
```

--------------------------------

### favorites() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanFavorite.md

Retrieve the user's wishlist (favorited products).

```php
$wishlist = $user->favorites(Product::class)->get();
```

--------------------------------

### report() usage examples

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanReport.md

Report a single model or multiple targets by ID with an explicit class.

```php
$user->report($comment);
$user->report([1, 2], Comment::class);
```

--------------------------------

### unfavorite() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanFavorite.md

Unfavorite a single product.

```php
$user->unfavorite($product);
```

--------------------------------

### Grouping and ungrouping usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/Verifiable.md

Groups user1 under user2 with slug 'text', then removes that group row.

```php
$user2->groupVerification($user1, 'text');
$user2->ungroupVerification($user1, 'text');
```

--------------------------------

### favoritersCount() usage examples

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanFavorite.md

Echo the favoriters count and a readable version with zero precision.

```php
echo $product->favoriters_count;
echo $product->favoritersCountReadable(0);
```

--------------------------------

### Trait usage example for CanView and CanBeViewed

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanView.md

Shows how to apply the CanView trait to an actor model (User) and CanBeViewed to a target model (Article).

```php
use Multicaret\Acquaintances\Traits\CanView;
use Multicaret\Acquaintances\Traits\CanBeViewed;

class User extends Model { use CanView; }
class Article extends Model { use CanBeViewed; }
```

--------------------------------

### Publish and migrate

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/README.md

Publish the package's assets (optional) and run migrations.

```bash
php artisan vendor:publish --provider="Multicaret\\Acquaintances\\AcquaintancesServiceProvider"
php artisan migrate
```

--------------------------------

### isViewedBy() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanView.md

Example of checking if the current authenticated user has viewed an article.

```php
if ($article->isViewedBy(auth()->id())) { /* read before */ }
```

--------------------------------

### rate() usage examples

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanRate.md

Shows rating with default type, explicit type, and via setRateType.

```php
$user->rate($restaurant, 4.5);                    // type 'general' (default)
$user->rate($restaurant, 5.0, 'quality');
$user->setRateType('delivery-time')->rate($restaurant, 3.0);
```

--------------------------------

### toggleSubscribe() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanSubscribe.md

Toggle a user's subscription to a channel.

```php
$user->toggleSubscribe($channel);
```

--------------------------------

### findVerifications() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/Verifiable.md

Retrieves verifications with status ACCEPTED, group slug 'text', and type 'recipient'.

```php
$mine = $user1->findVerifications(Status::ACCEPTED, 'text', 'recipient')->get();
```

--------------------------------

### ratingsTo() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanRate.md

Retrieves all restaurants rated by the user.

```php
$rated = $user->ratingsTo(Restaurant::class)->get();
```

--------------------------------

### followers() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanFollow.md

Retrieve the followers of a post.

```php
$followers = $post->followers()->get();
```

--------------------------------

### favoriters() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanFavorite.md

Retrieve all users who favorited a product.

```php
$favoriters = $product->favoriters()->get();
```

--------------------------------

### unsubscribe() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanSubscribe.md

Unsubscribe a user from a channel.

```php
$user->unsubscribe($channel);
```

--------------------------------

### boot() method signature

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/AcquaintancesServiceProvider.md

Public method that runs on every application boot. Performs migration registration, morph map registration, and registers the withAcquaintanceCounts macro.

```php
public function boot(): void
```

--------------------------------

### acceptFriendRequest() usage

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/Friendable.md

Example of accepting a friend request; returns 1 on success.

```php
$user2->acceptFriendRequest($user1); // 1
```

--------------------------------

### Status::getOrderPriority() usage examples

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/Status.md

Shows how to call getOrderPriority() with a known constant and with an unknown string. The first returns 2, the second returns 999.

```php
$priority = Status::getOrderPriority(Status::ACCEPTED); // 2
$priority = Status::getOrderPriority('unknown');        // 999
```

--------------------------------

### cancelVote() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanVote.md

Example of cancelling a vote on an answer.

```php
$user->cancelVote($answer);
```

--------------------------------

### toggleReport() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanReport.md

Toggle report status on a target.

```php
$user->toggleReport($comment);
```

--------------------------------

### denyFriendRequest() usage

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/Friendable.md

Example of denying a friend request.

```php
$user2->denyFriendRequest($user1);
```

--------------------------------

### Status::getOrderedStatuses() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/Status.md

Shows how to call getOrderedStatuses() to retrieve the ordered statuses array.

```php
$statuses = Status::getOrderedStatuses(); // ['pending', 'accepted', 'denied', 'blocked']
```

--------------------------------

### toggleRate() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanRate.md

Toggles a rating of 5.0 with type 'quality' on a restaurant.

```php
$result = $user->toggleRate($restaurant, 5.0, 'quality');
```

--------------------------------

### Usage example with CanBeLiked and CanBeRated traits

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/AcquaintanceScopes.md

Shows how to use withAcquaintanceCounts on a Post model that uses CanBeLiked and CanBeRated traits. Demonstrates loading all nine counts or a subset, and accessing the resulting {relation}_count attributes.

```php
use Multicaret\Acquaintances\Traits\CanBeLiked;
use Multicaret\Acquaintances\Traits\CanBeRated;

class Post extends Model {
    use CanBeLiked, CanBeRated;
}

// All nine counts in one query:
$posts = Post::query()->withAcquaintanceCounts()->get();

// Only like + rating counts:
$posts = Post::query()->withAcquaintanceCounts(['likers', 'raters'])->get();

foreach ($posts as $post) {
    echo $post->likers_count; // available via withCount()'s attribute
}
```

--------------------------------

### Usage example for InteractionRelation

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/types.md

Shows how to query popular interactions and access the related user. Uses the popular scope with a type filter and retrieves a pivot record by ID.

```php
use Multicaret\Acquaintances\Models\InteractionRelation;

$popular = InteractionRelation::popular('Post')->take(10)->get();
$about = InteractionRelation::find($pivotId);
echo $about->user->name;
```

--------------------------------

### hasUpvoted() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanVote.md

Example of checking if the user has upvoted an answer.

```php
if ($user->hasUpvoted($answer)) { /* ... */ }
```

--------------------------------

### detachRelations() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/Interaction.md

Example detaching a 'likes' relation from $user to $post.

```php
$removed = Interaction::detachRelations($user, 'likes', $post, \App\Models\Post::class);
```

--------------------------------

### reportersCount() usage examples

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanReport.md

Access the reporters count via the accessor or readable format.

```php
echo $comment->reporters_count;
echo $comment->reportersCountReadable(0);
```

--------------------------------

### toggleFavorite() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanFavorite.md

Toggle favorite status for a product, useful for wish-list toggling.

```php
$user->toggleFavorite($product); // wish-list toggle
```

--------------------------------

### followersCount() usage examples

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanFollow.md

Access the followers count as an integer or as a readable string with custom precision.

```php
echo $post->followers_count;       // int
echo $post->followersCountReadable(0); // "1K"
```

--------------------------------

### Accessing average_rating attribute

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanRate.md

Example of echoing the average_rating attribute accessor.

```php
echo $restaurant->average_rating;
```

--------------------------------

### getOrPaginate() method signature

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/Friendable.md

Defines the getOrPaginate helper method. When $perPage is 0, it calls get($fields); when $cursor is true, it uses cursorPaginate(); otherwise it uses paginate().

```php
protected function getOrPaginate($builder, $perPage, array $fields = ['*'], bool $cursor = false)
```

--------------------------------

### favorite() usage examples

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanFavorite.md

Favorite a single product or multiple products by IDs. The class parameter is required when passing IDs.

```php
$user->favorite($product);
$user->favorite([1, 2, 3], Product::class);
```

--------------------------------

### befriend() usage with false check

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/Friendable.md

Example of handling the false return when a friendship already exists or the user is blocked.

```php
$friendship = $user1->befriend($user2);
if ($friendship === false) {
    // a friendship already exists (and isn't denied), or user1 has blocked user2
}
```

--------------------------------

### Using Friendship::betweenModels

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/types.md

Example usage of the Friendship model's betweenModels scope to find a friendship between two models and iterate over its groups.

```php
use Multicaret\Acquaintances\Models\Friendship;

$f = Friendship::betweenModels($user1, $user2)->first();
foreach ($f->groups as $group) { /* FriendFriendshipGroups */ }
```

--------------------------------

### isUpvotedBy() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanVote.md

Example of checking if an answer is upvoted by a given user ID.

```php
if ($answer->isUpvotedBy(auth()->id())) { /* ... */ }
```

--------------------------------

### isRelationExists() usage with model target

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/Interaction.md

Example call checking if $user likes $post using the 'likes' relation.

```php
$exists = Interaction::isRelationExists($user, 'likes', $post);
```

--------------------------------

### Basic rating operations

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/docs/7.ratings.md

Perform basic rating actions: rate, unrate, toggle, check if rated, get raters, check if rated by user, and retrieve average, sum, and percentage ratings.

```php
$user->rate($target);       // uses default type from config('acquaintances.rating.defaults.type')
$user->unrate($target);
$user->toggleRate($target);
$user->hasRated($target);

$object->raters();
$object->isRatedBy($user);

$object->averageRating();
$object->sumRating();
$object->ratingPercent($max = 5);
```

--------------------------------

### Artisan vendor:publish commands

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/AcquaintancesServiceProvider.md

Commands to publish the config and interactions migration. Use the --tag option to publish specific assets.

```bash
php artisan vendor:publish --tag=acquaintances-config
```

```bash
php artisan vendor:publish --tag=acquaintances-migrations-interactions
```

--------------------------------

### Publish specific feature migrations

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/README.md

Publish migrations for only the interactions, friendships, or verifications features using granular tags.

```bash
# Only interaction migrations
php artisan vendor:publish --tag=acquaintances-migrations-interactions
```

```bash
# Only friendship migrations
php artisan vendor:publish --tag=acquaintances-migrations-friendships
```

```bash
# Only verification migrations
php artisan vendor:publish --tag=acquaintances-migrations-verifications
```

--------------------------------

### findFriendships() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/Friendable.md

Retrieves pending incoming friendships for a user by passing Status::PENDING, empty group slug, and 'recipient' type.

```php
$pendingIncoming = $user1->findFriendships(Status::PENDING, '', 'recipient')->get();
```

--------------------------------

### getEnabledMigrationPaths() and getEnabledMigrationFiles() signatures

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/AcquaintancesServiceProvider.md

Protected methods that list enabled migration files and map them to paths.

```php
protected function getEnabledMigrationPaths(): array
```

```php
protected function getEnabledMigrationFiles(): array
```

--------------------------------

### getFriends() signature and usage examples

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/Friendable.md

Retrieves friend models (not friendship rows) with optional pagination, group filter, field selection, and cursor pagination. Excludes the current model.

```php
public function getFriends($perPage = 0, $groupSlug = '', array $fields = ['*'], bool $cursor = false)
```

```php
$friends = $user1->getFriends();
$closeFriends = $user1->getFriends(0, 'close_friends');
$paged = $user1->getFriends(15, '', ['id', 'name'], true);
```

--------------------------------

### register() method signature

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/AcquaintancesServiceProvider.md

Public method that calls configure() to merge config and offerPublishing().

```php
public function register(): void
```

--------------------------------

### numberToReadable() method signature

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/Interaction.md

Public static method that formats a number into a readable string with suffixes like K, M, B. Precision is forced to 0 when no divisor suffix applies.

```php
public static function numberToReadable($number, $precision = 1, $divisors = null)
```

--------------------------------

### reportersCount()

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanReport.md

Get the count of reporters for the target.

```APIDOC
## reportersCount()

### Description
Get the count of reporters for the target.

### Method
reportersCount

### Returns
- `int` - Number of reporters

### Example
```php
echo $comment->reportersCount();
```
```

--------------------------------

### unreport() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanReport.md

Remove a report from a target.

```php
$user->unreport($comment);
```

--------------------------------

### unfriend() usage

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/Friendable.md

Example of removing a friendship.

```php
$user2->unfriend($user1);
```

--------------------------------

### reportersCountReadable()

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanReport.md

Get a readable formatted count of reporters.

```APIDOC
## reportersCountReadable()

### Description
Get a readable formatted count of reporters.

### Method
reportersCountReadable

### Parameters
- `$precision` (int) - Optional - Precision for formatting (default: 1)
- `$divisors` (array|null) - Optional - Custom divisors for formatting

### Returns
- `string` - Readable count string

### Example
```php
echo $comment->reportersCountReadable(0);
```
```

--------------------------------

### Calling decrementAcquaintanceCounter()

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/HasAcquaintanceCounters.md

Example usage to decrement the likes counter.

```php
$post->decrementAcquaintanceCounter(Interaction::RELATION_LIKE);
```

--------------------------------

### Calling incrementAcquaintanceCounter()

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/HasAcquaintanceCounters.md

Example usage to increment the likes counter.

```php
$post->incrementAcquaintanceCounter(Interaction::RELATION_LIKE);
```

--------------------------------

### Like

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/docs/6.interactions.md

Methods to like, unlike, toggle like, and retrieve likes/likers.

```APIDOC
## Like

### Description
Methods to like, unlike, toggle like, and retrieve likes/likers.

### Methods
- `$user->like($targets)` - Like the given targets.
- `$user->unlike($targets)` - Unlike the given targets.
- `$user->toggleLike($targets)` - Toggle like status for the given targets.
- `$user->likes()` - Get the likes of the user.
- `$object->likers()` - Get the likers of the object.

### Parameters
All methods accept IDs, model instances, or collections/arrays. Most methods accept `($targets, $class = __CLASS__)`.

### Query Helpers
```php
$user->likes()->paginate(10);
$user->likes()->orderByDesc('id')->get();
```
```

--------------------------------

### hasSubscribed() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanSubscribe.md

Check if a user has subscribed to a channel.

```php
if ($user->hasSubscribed($channel)) { /* is a subscriber */ }
```

--------------------------------

### Query helpers for followers

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/docs/6.interactions.md

Use query helpers to paginate or order follower results.

```php
$user->followers()->paginate(10);
$user->followers()->orderByDesc('id')->get();
```

--------------------------------

### Run SanityTest smoke test

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/docs/10.testing.md

Quick smoke test to verify the package's test suite is working. Run from the project root.

```bash
vendor/bin/phpunit --filter SanityTest
```

--------------------------------

### bootCanRate()

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanRate.md

Eloquent boot hook that initializes the static rating type from the configuration default.

```APIDOC
## bootCanRate()

### Description
Eloquent boot hook; sets `self::$rateType = config('acquaintances.rating.defaults.type')`.

### Method
`public static function bootCanRate(): void`

### Parameters
None.

### Returns
`void`
```

--------------------------------

### reporters()

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanReport.md

Get the morph-to-many relationship of users who reported the target.

```APIDOC
## reporters()

### Description
Get the morph-to-many relationship of users who reported the target.

### Method
reporters

### Returns
- `MorphToMany` - Relationship instance

### Example
```php
$reporters = $comment->reporters()->get();
```
```

--------------------------------

### formatTargets() method signature

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/Interaction.md

Public static method that normalizes targets into a stdClass with classname, ids, and targets. Unwraps Enumerable instances and wraps scalars into arrays.

```php
public static function formatTargets($targets, $classname, array $update = [])
```

--------------------------------

### isReportedBy() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanReport.md

Check if the current user reported the comment.

```php
if ($comment->isReportedBy(auth()->id())) { /* hidden for this user */ }
```

--------------------------------

### View interaction methods

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/docs/6.interactions.md

Methods to view, unview, toggle view, and retrieve viewers.

```php
$user->view($targets); $user->unview($targets); $user->toggleView($targets);
$object->viewers();
```

--------------------------------

### hasReported() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanReport.md

Check if the user has already reported the target.

```php
if ($user->hasReported($comment)) { /* already reported */ }
```

--------------------------------

### handle() method

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/AcquaintancesCleanupJob.md

Runs cleanupInteractions(), cleanupFriendships(), and cleanupVerifications() inside a single DB::transaction, then flushes the request cache. Destructive and one-way.

```php
public function handle(): void
```

--------------------------------

### unrate() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanRate.md

Removes a rating of type 'quality' from a restaurant.

```php
$user->unrate($restaurant, 'quality');
```

--------------------------------

### Follow

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/docs/6.interactions.md

Methods to follow, unfollow, toggle follow, and retrieve followings/followers.

```APIDOC
## Follow

### Description
Methods to follow, unfollow, toggle follow, and retrieve followings/followers.

### Methods
- `$user->follow($targets)` - Follow the given targets.
- `$user->unfollow($targets)` - Unfollow the given targets.
- `$user->toggleFollow($targets)` - Toggle follow status for the given targets.
- `$user->followings()` - Get the followings of the user.
- `$object->followers()` - Get the followers of the object.

### Parameters
All methods accept IDs, model instances, or collections/arrays. Most methods accept `($targets, $class = __CLASS__)`.

### Query Helpers
```php
$user->followers()->paginate(10);
$user->followers()->orderByDesc('id')->get();
```
```

--------------------------------

### findVerifications() method signature

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/Verifiable.md

Returns a Builder over the Verification model, always ordered by status priority (pending, accepted, denied, blocked) and optionally filtered by status, group slug, and type.

```php
public function findVerifications($status = null, string $groupSlug = '', string $type = 'all')
```

--------------------------------

### isSubscribedBy() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanSubscribe.md

Check if a channel is subscribed by a given user ID.

```php
if ($channel->isSubscribedBy(auth()->id())) { /* ... */ }
```

--------------------------------

### View

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/docs/6.interactions.md

Methods to view, unview, toggle view, and retrieve viewers.

```APIDOC
## View

### Description
Methods to view, unview, toggle view, and retrieve viewers.

### Methods
- `$user->view($targets)` - View the given targets.
- `$user->unview($targets)` - Unview the given targets.
- `$user->toggleView($targets)` - Toggle view status for the given targets.
- `$object->viewers()` - Get the viewers of the object.

### Parameters
All methods accept IDs, model instances, or collections/arrays. Most methods accept `($targets, $class = __CLASS__)`.

### Query Helpers
```php
$user->viewers()->paginate(10);
$user->viewers()->orderByDesc('id')->get();
```
```

--------------------------------

### hasFavorited() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanFavorite.md

Check if the user has favorited a product before favoriting it.

```php
if (! $user->hasFavorited($product)) {
    $user->favorite($product);
}
```

--------------------------------

### reports()

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanReport.md

Get the morph-to-many relationship of reported targets, filtered to 'report' relation.

```APIDOC
## reports()

### Description
Get the morph-to-many relationship of reported targets, filtered to 'report' relation.

### Method
reports

### Parameters
- `$class` (string) - Optional - Target model class (default: `__CLASS__`)

### Returns
- `MorphToMany` - Relationship instance

### Example
```php
$reported = $user->reports(Comment::class)->get();
```
```

--------------------------------

### Add traits to models

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/README.md

Import and use the required traits on your User model to enable friendships, verifications, follow, like, and rate functionality.

```php
use Multicaret\\Acquaintances\\Traits\\Friendable;
use Multicaret\\Acquaintances\\Traits\\Verifiable;
use Multicaret\\Acquaintances\\Traits\\CanFollow;
use Multicaret\\Acquaintances\\Traits\\CanBeFollowed;
use Multicaret\\Acquaintances\\Traits\\CanLike;
use Multicaret\\Acquaintances\\Traits\\CanBeLiked;
use Multicaret\\Acquaintances\\Traits\\CanRate;
use Multicaret\\Acquaintances\\Traits\\CanBeRated;

class User extends Model {
    use Friendable, Verifiable;
    use CanFollow, CanBeFollowed;
    use CanLike, CanBeLiked;
    use CanRate, CanBeRated;
}
```

--------------------------------

### Configure friendship groups in config/acquaintances.php

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/docs/4.friendships.md

Example configuration for friendship groups under friendships_groups in config/acquaintances.php.

```php
'friendships_groups' => [
  'acquaintances' => 0,
  'close_friends' => 1,
  'family' => 2,
],
```

--------------------------------

### Like interaction methods

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/docs/6.interactions.md

Methods to like, unlike, toggle like, retrieve likes, and retrieve likers.

```php
$user->like($targets); $user->unlike($targets); $user->toggleLike($targets);
$user->likes(); $object->likers();
```

--------------------------------

### isFavoritedBy() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanFavorite.md

Check if the current authenticated user has favorited a product.

```php
if ($product->isFavoritedBy(auth()->id())) { /* ... */ }
```

--------------------------------

### formatTargets()

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/Interaction.md

Normalizes target inputs into a consistent structure with classname, ids, and targets. Handles models, scalars, and Enumerable instances.

```APIDOC
## formatTargets()

### Description
Normalizes target inputs into a consistent structure with classname, ids, and targets. Handles models, scalars, and Enumerable instances.

### Method
formatTargets

### Signature
```php
public static function formatTargets($targets, $classname, array $update = [])
```

### Parameters
- `$targets` (array|string|Model|Enumerable) - Required - Targets to normalize
- `$classname` (string) - Required - Default class name
- `$update` (array) - Optional - Pivot updates; when empty, plain ids are used (default: `[]`)

### Returns
`stdClass` with three properties:
- `classname` (string) - Class of the targets; per-model class wins when a `Model` is passed
- `ids` (array<int>) - `getKey()` of each model or `intval()` of each scalar
- `targets` (array<int, array>) - If `$update` is non-empty: `array_combine(ids, pad([], count, $update))`; otherwise the raw ids
```

--------------------------------

### numberToReadable()

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/Interaction.md

Formats a number into a human-readable string with suffixes like K, M, B. Allows custom precision and divisor map.

```APIDOC
## numberToReadable()

### Description
Formats a number into a human-readable string with suffixes like K, M, B. Allows custom precision and divisor map.

### Method
numberToReadable

### Signature
```php
public static function numberToReadable($number, $precision = 1, $divisors = null)
```

### Parameters
- `$number` (int|float) - Required - The count to format
- `$precision` (int) - Optional - Decimal places; forced to `0` when no divisor suffix applies (default: `1`)
- `$divisors` (array|null) - Optional - Custom divisor map (see source for the default `1/K/M/B/T/Qa/Qi` map) (default: `null`)

### Returns
`string` — e.g. `12.5K`, `3M`, `45`.

### Example
```php
echo Interaction::numberToReadable(12500); // "12.5K"
echo Interaction::numberToReadable(12500, 0); // "13K"
```
```

--------------------------------

### hasRated() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanRate.md

Conditionally rates a restaurant only if not already rated with type 'quality'.

```php
if (! $user->hasRated($restaurant, 'quality')) {
    $user->rate($restaurant, 4.0, 'quality');
}
```

--------------------------------

### Publish migrations with vendor:publish

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/docs/8.migrations.md

Publishes the package's migration files with fresh timestamps so they run in order. Use this command when you need to customize the migration files or when the package's auto-loading is disabled.

```bash
php artisan vendor:publish --tag=acquaintances-migrations
```

--------------------------------

### isFollowing() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanFollow.md

Check if the user follows a post. The result is cached.

```php
if ($user->isFollowing($post)) { /* ... */ }
```

--------------------------------

### unfollow() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanFollow.md

Unfollow a model. Returns the number of detached rows.

```php
$user->unfollow($post);
```

--------------------------------

### getAllVerifications() method signature

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/Verifiable.md

Retrieves verification rows with optional filtering by group, pagination, fields, and type.

```php
public function getAllVerifications(
    string $groupSlug = '',
    int $perPage = 0,
    array $fields = ['*'],
    string $type = 'all'
)
```

--------------------------------

### follow()

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanFollow.md

Makes the current model follow one or more target models. Accepts a single model, an array of IDs, or a model instance, and returns the sync result.

```APIDOC
## follow()

### Description
Makes the current model follow one or more target models. Accepts a single model, an array of IDs, or a model instance, and returns the sync result.

### Method
follow

### Endpoint
`follow($targets, $class = __CLASS__)`

### Parameters
- `$targets` (int|array|Model) - Required - Target id(s) or model(s)
- `$class` (string) - Optional - Target model class (default: `__CLASS__`)

### Returns
`array` - The `sync(..., false)` result (`attached`/`detached`/`updated` keys)

### Throws
`\Exception` - via `Interaction` when the relation is invalid

### Events
Dispatches `acq.followships.follow`

### Request Example
```php
$user->follow($post);                    // by model
$user->follow([1, 2, 3], Post::class);   // by ids
```
```

--------------------------------

### Model name resolution helper methods

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/Interaction.md

Public static methods that resolve full model names for various configured models. Default config values are already fully qualified class names, so they are returned unchanged.

```php
public static function getFullModelName($modelClassName)
public static function getUserModelName()
public static function getInteractionRelationModelName()
public static function getFriendshipModelName()
public static function getFriendshipGroupsModelName()
public static function getVerificationModelName()
public static function getVerificationGroupsModelName()
```

--------------------------------

### setRateType() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanRate.md

Chains setRateType('quality') with rate() to rate a restaurant with a custom type.

```php
$user->setRateType('quality')->rate($restaurant, 4.5);
```

--------------------------------

### getVerifiersOfVerifiersQueryBuilder() method signature

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/Verifiable.md

Returns a Builder for second-degree verifiers (verifiers of verifiers) minus direct verifiers.

```php
public function getVerifiersOfVerifiersQueryBuilder($groupSlug = '')
```

--------------------------------

### isFollowedBy() usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanFollow.md

Check if a post is followed by the authenticated user's ID.

```php
if ($post->isFollowedBy(auth()->id())) { /* ... */ }
```

--------------------------------

### Status::getOrder() method signature

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/Status.md

Returns the status-to-priority mapping for the four lifecycle states. The mapping assigns priorities 1 through 4 to PENDING, ACCEPTED, DENIED, and BLOCKED respectively.

```php
public static function getOrder(): array
```

--------------------------------

### isRelationExists() usage with class and id

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/Interaction.md

Example checking if user 42 likes the post, with conditional comment on result.

```php
$exists = Interaction::isRelationExists($post, 'likers', 42, \App\Models\User::class);
if (!$exists) {
    // no like from user 42 on this post
}
```

--------------------------------

### Verifiable::findVerifications() ordering clause

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/Status.md

Builds an orderByRaw clause using getOrderedStatuses() to sort verification lists by status priority.

```php
// from src/Traits/Verifiable.php
->orderByRaw("FIELD(status, '".implode("','", Status::getOrderedStatuses())."')")
```

--------------------------------

### getMigrationFilesForFeature() method signature

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/AcquaintancesServiceProvider.md

Protected method that returns migration files for a given feature.

```php
protected function getMigrationFilesForFeature(string $feature): array
```

--------------------------------

### getFriendsCount() signature and usage example

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/Friendable.md

Returns the count of accepted friendships, optionally filtered by group and direction.

```php
public function getFriendsCount($groupSlug = '', $type = 'all')
```

```php
$count = $user1->getFriendsCount('close_friends');
```

--------------------------------

### Filtering and sorting with Status constants

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/Status.md

Shows how to filter friendships and verifications by status constants and sort a collection by status priority. Includes using getPendingFriendships(), findFriendships(Status::DENIED), and getAllVerifications()->sortBy() with getOrderPriority().

```php
use Multicaret\Acquaintances\Status;

// pending requests waiting for the current user
$pending = $user->getPendingFriendships();

// custom query using the constant as filter
$denied = $user->findFriendships(Status::DENIED);

// sort a collection by status priority (pending first, blocked last)
$byPriority = $user->getAllVerifications()->sortBy(
    fn ($v) => Status::getOrderPriority($v->status)
);
```

--------------------------------

### Count Helpers

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/CanView.md

Provides methods to get the count of viewers, formatted counts, and readable counts.

```APIDOC
## Count Helpers

### Description
Provides methods to get the count of viewers, formatted counts, and readable counts.

### Methods

#### viewersCount()
```php
public function viewersCount(): int
```
Returns the count of viewers.

#### getViewersCountAttribute()
```php
public function getViewersCountAttribute(): int
```
Accessor for the `viewers_count` attribute.

#### viewersCountFormatted($precision = 1, $divisors = null): string
```php
public function viewersCountFormatted($precision = 1, $divisors = null): string
```
Returns a formatted count using `Interaction::numberToReadable()`.

#### viewersCountReadable($precision = 1, $divisors = null): string
```php
public function viewersCountReadable($precision = 1, $divisors = null): string
```
Alias of `viewersCountFormatted()`.

#### getViewersCountReadableAttribute(): int
```php
public function getViewersCountReadableAttribute(): int
```
Note: Returns the raw count (int), not the formatted string.

### Example
```php
echo $article->viewers_count;          // int
echo $article->viewersCountReadable(); // "5.5K"
```
```

--------------------------------

### getVerificationRequests() method signature

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/Verifiable.md

Retrieves incoming pending verification requests.

```php
public function getVerificationRequests()
```

--------------------------------

### Combined friendship status check

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/_autodocs/api-reference/Friendable.md

Example usage combining isFriendWith() and hasSentFriendRequestTo() to verify both conditions in a single if statement.

```php
if ($user1->isFriendWith($user2) && $user1->hasSentFriendRequestTo($user2)) {
    // ...
}
```

--------------------------------

### Follow interaction methods

Source: https://github.com/multicaret/laravel-acquaintances/blob/master/docs/6.interactions.md

Methods to follow, unfollow, toggle follow, retrieve followings, and retrieve followers.

```php
$user->follow($targets); $user->unfollow($targets); $user->toggleFollow($targets);
$user->followings(); $object->followers();
```
Tokens:
Raw