UNIT3D-Community-Edition/app/Models/Forum.php

<?php
/**
 * NOTICE OF LICENSE.
 *
 * UNIT3D is open-sourced software licensed under the GNU Affero General Public License v3.0
 * The details is bundled with this project in the file LICENSE.txt.
 *
 * @project    UNIT3D
 *
 * @license    https://www.gnu.org/licenses/agpl-3.0.en.html/ GNU Affero General Public License v3.0
 * @author     HDVinnie
 */

namespace App\Models;

use App\Notifications\NewTopic;
use App\Traits\Auditable;
use Illuminate\Database\Eloquent\Model;

/**
 * App\Models\Forum.
 *
 * @property int $id
 * @property int|null $position
 * @property int|null $num_topic
 * @property int|null $num_post
 * @property int|null $last_topic_id
 * @property string|null $last_topic_name
 * @property string|null $last_topic_slug
 * @property int|null $last_post_user_id
 * @property string|null $last_post_user_username
 * @property string|null $name
 * @property string|null $slug
 * @property string|null $description
 * @property int|null $parent_id
 * @property \Illuminate\Support\Carbon|null $created_at
 * @property \Illuminate\Support\Carbon|null $updated_at
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\Forum[] $forums
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\Permission[] $permissions
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\Topic[] $sub_topics
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\Topic[] $subscription_topics
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\Subscription[] $subscriptions
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\Topic[] $topics
 *
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Forum newModelQuery()
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Forum newQuery()
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Forum query()
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Forum whereCreatedAt($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Forum whereDescription($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Forum whereId($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Forum whereLastPostUserId($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Forum whereLastPostUserUsername($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Forum whereLastTopicId($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Forum whereLastTopicName($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Forum whereLastTopicSlug($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Forum whereName($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Forum whereNumPost($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Forum whereNumTopic($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Forum whereParentId($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Forum wherePosition($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Forum whereSlug($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Forum whereUpdatedAt($value)
 * @mixin \Eloquent
 *
 * @property-read int|null $forums_count
 * @property-read int|null $permissions_count
 * @property-read int|null $sub_topics_count
 * @property-read int|null $subscription_topics_count
 * @property-read int|null $subscriptions_count
 * @property-read int|null $topics_count
 */
class Forum extends Model
{
    use Auditable;

    /**
     * Has Many Topic.
     *
     * @return \Illuminate\Database\Eloquent\Relations\HasMany
     */
    public function topics()
    {
        return $this->hasMany(Topic::class);
    }

    /**
     * Has Many Sub Topics.
     *
     * @return \Illuminate\Database\Eloquent\Relations\HasMany
     */
    public function sub_topics()
    {
        $children = $this->forums->pluck('id')->toArray();
        if (is_array($children)) {
            return $this->hasMany(Topic::class)->orWhereIn('topics.forum_id', $children);
        }

        return $this->hasMany(Topic::class);
    }

    /**
     * Has Many Sub Forums.
     *
     * @return \Illuminate\Database\Eloquent\Relations\HasMany
     */
    public function forums()
    {
        return $this->hasMany(self::class, 'parent_id', 'id');
    }

    /**
     * Has Many Subscribed Topics.
     *
     * @return \Illuminate\Database\Eloquent\Relations\HasMany
     */
    public function subscription_topics()
    {
        if (auth()->user()) {
            $id = $this->id;
            $subscriptions = auth()->user()->subscriptions->where('topic_id', '>', '0')->pluck('topic_id')->toArray();

            return $this->hasMany(Topic::class)->where(function ($query) use ($id, $subscriptions) {
                $query->whereIn('topics.id', [$id])->orWhereIn('topics.id', $subscriptions);
            });
        }

        return $this->hasMany(Topic::class, 'id', 'topic_id');
    }

    /**
     * Has Many Subscriptions.
     *
     * @return \Illuminate\Database\Eloquent\Relations\HasMany
     */
    public function subscriptions()
    {
        return $this->hasMany(Subscription::class, 'forum_id', 'id');
    }

    /**
     * Has Many Permissions.
     *
     * @return \Illuminate\Database\Eloquent\Relations\HasMany
     */
    public function permissions()
    {
        return $this->hasMany(Permission::class);
    }

    /**
     * Notify Subscribers Of A Forum When New Topic Is Made.
     *
     * @param $poster
     * @param $topic
     *
     * @return string
     */
    public function notifySubscribers($poster, $topic)
    {
        $subscribers = User::selectRaw('distinct(users.id),max(users.username) as username,max(users.group_id) as group_id')->with('group')->where('users.id', '!=', $topic->first_post_user_id)
            ->join('subscriptions', 'subscriptions.user_id', '=', 'users.id')
            ->leftJoin('user_notifications', 'user_notifications.user_id', '=', 'users.id')
            ->where('subscriptions.forum_id', '=', $topic->forum_id)
            ->whereRaw('(user_notifications.show_subscription_forum = 1 OR user_notifications.show_subscription_forum is null)')
            ->groupBy('users.id')->get();

        foreach ($subscribers as $subscriber) {
            if ($subscriber->acceptsNotification($poster, $subscriber, 'subscription', 'show_subscription_forum')) {
                $subscriber->notify(new NewTopic('forum', $poster, $topic));
            }
        }
    }

    /**
     * Returns A Table With The Forums In The Category.
     *
     * @return string
     */
    public function getForumsInCategory()
    {
        return self::where('parent_id', '=', $this->id)->get();
    }

    /**
     * Returns A Table With The Forums In The Category.
     *
     * @param $forumId
     *
     * @return string
     */
    public function getForumsInCategoryById($forumId)
    {
        return self::where('parent_id', '=', $forumId)->get();
    }

    /**
     * Returns The Category Nn Which The Forum Is Located.
     *
     * @return string
     */
    public function getCategory()
    {
        return self::find($this->parent_id);
    }

    /**
     * Count The Number Of Posts In The Forum.
     *
     * @param $forumId
     *
     * @return string
     */
    public function getPostCount($forumId)
    {
        $forum = self::find($forumId);
        $topics = $forum->topics;
        $count = 0;
        foreach ($topics as $t) {
            $count += $t->posts()->count();
        }

        return $count;
    }

    /**
     * Count The Number Of Topics In The Forum.
     *
     * @param $forumId
     *
     * @return string
     */
    public function getTopicCount($forumId)
    {
        $forum = self::find($forumId);

        return Topic::where('forum_id', '=', $forum->id)->count();
    }

    /**
     * Returns The Permission Field.
     *
     * @return string
     */
    public function getPermission()
    {
        if (auth()->check()) {
            $group = auth()->user()->group;
        } else {
            $group = Group::find(2);
        }

        return $group->permissions->where('forum_id', $this->id)->first();
    }
}