DiscussConversation::getPostsWithLogs() - Code Metrics - Inspection of "Discuss Forum" - XetaIO/Xetaravel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#34)

by Fèvre

created 2017-06-14 23:29 UTC

DiscussConversation::getPostsWithLogs() D

↳ Parent: DiscussConversation

Complexity

Conditions	9
Paths	15

Size

Total Lines	39
Code Lines	20

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	39
rs	4.909
c	0
b	0
f	0
cc	9
eloc	20
nc	15
nop	2

<?php
namespace Xetaravel\Models;

use Eloquence\Behaviours\CountCache\Countable;
use Eloquence\Behaviours\Sluggable;
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\App;
use Illuminate\Support\Facades\Auth;
use Illuminate\Support\Facades\Route;
use Xetaio\Mentions\Models\Traits\HasMentionsTrait;
use Xetaravel\Models\Gates\FloodGate;
use Xetaravel\Models\Presenters\DiscussConversationPresenter;
use Xetaravel\Models\Scopes\DisplayScope;
use Xetaravel\Models\User;

class DiscussConversation extends Model
{
    use Countable,
        Sluggable,
        FloodGate,
        DiscussConversationPresenter,
        HasMentionsTrait;

    /**
     * The attributes that are mass assignable.
     *
     * @var array
     */
    protected $fillable = [
        'user_id',
        'category_id',
        'title',
        'slug',
        'post_count',
        'participants_count',
        'is_locked',
        'is_pinned',
        'is_solved',
        'is_edited',
        'edit_count'
    ];

    /**
     * The accessors to append to the model's array form.
     *
     * @var array
     */
    protected $appends = [
        'conversation_url',
        'last_page'
    ];

    /**
     * The attributes that should be mutated to dates.
     *
     * @var array
     */
    protected $dates = [
        'edited_at'
    ];

    /**
     * The "booting" method of the model.
     *
     * @return void
     */
    protected static function boot()
    {
        parent::boot();

        // Generated the slug before updating.
        static::updating(function ($model) {
            $model->generateSlug();
        });

        // Set the user id to the new conversation before saving it.
        static::creating(function ($model) {
            $model->user_id = Auth::id();
        });
    }

    /**
     * Return the field to slug.
     *
     * @return string
     */
    public function slugStrategy(): string
    {
        return 'title';
    }

    /**
     * Return the count cache configuration.
     *
     * @return array
     */
    public function countCaches(): array
    {
        return [
            'discuss_conversation_count' => [User::class, 'user_id', 'id'],
            'conversation_count' => [DiscussCategory::class, 'category_id', 'id']
        ];
    }

    /**
     * Get the category that owns the conversation.
     *
     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
     */
    public function category()
    {
        return $this->belongsTo(DiscussCategory::class);
    }

    /**
     * Get the user that owns the conversation.
     *
     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
     */
    public function user()
    {
        return $this->belongsTo(User::class);
    }

    /**
     * Get the posts for the conversation.
     *
     * @return \Illuminate\Database\Eloquent\Relations\HasMany
     */
    public function posts()
    {
        return $this->hasMany(DiscussPost::class, 'conversation_id', 'id');
    }

    /**
     * Get the posts for the conversation.
     *
     * @return \Illuminate\Database\Eloquent\Relations\HasMany
     */
    public function users()
    {
        return $this->hasMany(DiscussUser::class, 'conversation_id', 'id');
    }

    /**
     * Get the first post of the conversation.
     *
     * @return \Illuminate\Database\Eloquent\Relations\HasOne
     */
    public function firstPost()
    {
        return $this->hasOne(DiscussPost::class, 'id', 'first_post_id');
    }

    /**
     * Get the solved post of the conversation.
     *
     * @return \Illuminate\Database\Eloquent\Relations\HasOne
     */
    public function solvedPost()
    {
        return $this->hasOne(DiscussPost::class, 'id', 'solved_post_id');
    }

    /**
     * Get the last post of the conversation.
     *
     * @return \Illuminate\Database\Eloquent\Relations\HasOne
     */
    public function lastPost()
    {
        return $this->hasOne(DiscussPost::class, 'id', 'last_post_id');
    }

    /**
     * Get the user that edited the conversation.
     *
     * @return \Illuminate\Database\Eloquent\Relations\HasOne
     */
    public function editedUser()
    {
        return $this->hasOne(User::class, 'id', 'edited_user_id');
    }

    /**
     * Get the discuss logs for the conversation.
     *
     * @return \Illuminate\Database\Eloquent\Relations\MorphMany
     */
    public function discussLogs()
    {
        return $this->morphMany(DiscussLog::class, 'loggable');
    }

    /**
     * Get the logs and posts related to the current conversation
     * for the given the pagination posts and return the data
     * ordered by `created_at` as a Collection.
     *
     * @param \Illuminate\Support\Collection $posts
     * @param int $page
     *
     * @return \Illuminate\Support\Collection
     */
    public function getPostsWithLogs(Collection $posts, int $page): Collection
    {
        $logs = DiscussLog::where([
            'loggable_type' => get_class($this),
            'loggable_id' => $this->getKey(),
        ]);

        $previousPost = $this->getPreviousPost($posts->first()->created_at);

        // When there're several pages and the current page is not the first and not the last.
        if ($this->lastPage > $page && $page !== 1) {
            $logs = $logs->where('created_at', '<=', $posts->last()->created_at)
                ->where('created_at', '>=', $previousPost->created_at);

        // When there're only one page.
        } elseif ($this->lastPage == 1) {
            $logs = $logs->where('created_at', '>=', $this->created_at);

        // When there're several pages and the current page is the first page.
        } elseif ($page == 1) {
            $logs = $logs->where('created_at', '<=', $posts->last()->created_at);

        // When there're several page and the current page is the last page
        } elseif ($page == $this->lastPage) {
            $logs = $logs->where('created_at', '>', $previousPost->created_at);
        }
        $postsWithLogs = $posts->merge($logs->get())->sortBy('created_at');

        // If the conversation has a solved post, prepend it
        // then prepend the first post to the collection
        if ($this->lastPage == 1 || $page == 1) {
            if (!is_null($this->solved_post_id)) {
                $postsWithLogs->prepend(DiscussPost::findOrFail($this->solved_post_id));
            }
            $postsWithLogs->prepend(DiscussPost::findOrFail($this->first_post_id));
        }

        return $postsWithLogs;
    }

    /**
     * Get the previous post related to the current conversation with
     * the given date.
     *
     * @param string $createdAt
     *
     * @return \Xetaravel\Models\DiscussPost|null
     */
    protected function getPreviousPost(string $createdAt)
    {
        return DiscussPost::where('id', '!=', $this->solved_post_id)
                ->where('conversation_id', $this->getKey())
                ->where('created_at', '<', $createdAt)
                ->orderBy('created_at', 'desc')
                ->first();
    }
}


1			<?php
2			namespace Xetaravel\Models;
3
4			use Eloquence\Behaviours\CountCache\Countable;
5			use Eloquence\Behaviours\Sluggable;
6			use Illuminate\Support\Collection;
7			use Illuminate\Support\Facades\App;
8			use Illuminate\Support\Facades\Auth;
9			use Illuminate\Support\Facades\Route;
10			use Xetaio\Mentions\Models\Traits\HasMentionsTrait;
11			use Xetaravel\Models\Gates\FloodGate;
12			use Xetaravel\Models\Presenters\DiscussConversationPresenter;
13			use Xetaravel\Models\Scopes\DisplayScope;
14			use Xetaravel\Models\User;
15
16			class DiscussConversation extends Model
17			{
18			use Countable,
19			Sluggable,
20			FloodGate,
21			DiscussConversationPresenter,
22			HasMentionsTrait;
23
24			/**
25			* The attributes that are mass assignable.
26			*
27			* @var array
28			*/
29			protected $fillable = [
30			'user_id',
31			'category_id',
32			'title',
33			'slug',
34			'post_count',
35			'participants_count',
36			'is_locked',
37			'is_pinned',
38			'is_solved',
39			'is_edited',
40			'edit_count'
41			];
42
43			/**
44			* The accessors to append to the model's array form.
45			*
46			* @var array
47			*/
48			protected $appends = [
49			'conversation_url',
50			'last_page'
51			];
52
53			/**
54			* The attributes that should be mutated to dates.
55			*
56			* @var array
57			*/
58			protected $dates = [
59			'edited_at'
60			];
61
62			/**
63			* The "booting" method of the model.
64			*
65			* @return void
66			*/
67			protected static function boot()
68			{
69			parent::boot();
70
71			// Generated the slug before updating.
72			static::updating(function ($model) {
73			$model->generateSlug();
74			});
75
76			// Set the user id to the new conversation before saving it.
77			static::creating(function ($model) {
78			$model->user_id = Auth::id();
79			});
80			}
81
82			/**
83			* Return the field to slug.
84			*
85			* @return string
86			*/
87			public function slugStrategy(): string
88			{
89			return 'title';
90			}
91
92			/**
93			* Return the count cache configuration.
94			*
95			* @return array
96			*/
97			public function countCaches(): array
98			{
99			return [
100			'discuss_conversation_count' => [User::class, 'user_id', 'id'],
101			'conversation_count' => [DiscussCategory::class, 'category_id', 'id']
102			];
103			}
104
105			/**
106			* Get the category that owns the conversation.
107			*
108			* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
109			*/
110			public function category()
111			{
112			return $this->belongsTo(DiscussCategory::class);
113			}
114
115			/**
116			* Get the user that owns the conversation.
117			*
118			* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
119			*/
120			public function user()
121			{
122			return $this->belongsTo(User::class);
123			}
124
125			/**
126			* Get the posts for the conversation.
127			*
128			* @return \Illuminate\Database\Eloquent\Relations\HasMany
129			*/
130			public function posts()
131			{
132			return $this->hasMany(DiscussPost::class, 'conversation_id', 'id');
133			}
134
135			/**
136			* Get the posts for the conversation.
137			*
138			* @return \Illuminate\Database\Eloquent\Relations\HasMany
139			*/
140			public function users()
141			{
142			return $this->hasMany(DiscussUser::class, 'conversation_id', 'id');
143			}
144
145			/**
146			* Get the first post of the conversation.
147			*
148			* @return \Illuminate\Database\Eloquent\Relations\HasOne
149			*/
150			public function firstPost()
151			{
152			return $this->hasOne(DiscussPost::class, 'id', 'first_post_id');
153			}
154
155			/**
156			* Get the solved post of the conversation.
157			*
158			* @return \Illuminate\Database\Eloquent\Relations\HasOne
159			*/
160			public function solvedPost()
161			{
162			return $this->hasOne(DiscussPost::class, 'id', 'solved_post_id');
163			}
164
165			/**
166			* Get the last post of the conversation.
167			*
168			* @return \Illuminate\Database\Eloquent\Relations\HasOne
169			*/
170			public function lastPost()
171			{
172			return $this->hasOne(DiscussPost::class, 'id', 'last_post_id');
173			}
174
175			/**
176			* Get the user that edited the conversation.
177			*
178			* @return \Illuminate\Database\Eloquent\Relations\HasOne
179			*/
180			public function editedUser()
181			{
182			return $this->hasOne(User::class, 'id', 'edited_user_id');
183			}
184
185			/**
186			* Get the discuss logs for the conversation.
187			*
188			* @return \Illuminate\Database\Eloquent\Relations\MorphMany
189			*/
190			public function discussLogs()
191			{
192			return $this->morphMany(DiscussLog::class, 'loggable');
193			}
194
195			/**
196			* Get the logs and posts related to the current conversation
197			* for the given the pagination posts and return the data
198			* ordered by `created_at` as a Collection.
199			*
200			* @param \Illuminate\Support\Collection $posts
201			* @param int $page
202			*
203			* @return \Illuminate\Support\Collection
204			*/
205			public function getPostsWithLogs(Collection $posts, int $page): Collection
206			{
207			$logs = DiscussLog::where([
208			'loggable_type' => get_class($this),
209			'loggable_id' => $this->getKey(),
210			]);
211
212			$previousPost = $this->getPreviousPost($posts->first()->created_at);
213
214			// When there're several pages and the current page is not the first and not the last.
215			if ($this->lastPage > $page && $page !== 1) {
216			$logs = $logs->where('created_at', '<=', $posts->last()->created_at)
217			->where('created_at', '>=', $previousPost->created_at);
218
219			// When there're only one page.
220			} elseif ($this->lastPage == 1) {
221			$logs = $logs->where('created_at', '>=', $this->created_at);
222
223			// When there're several pages and the current page is the first page.
224			} elseif ($page == 1) {
225			$logs = $logs->where('created_at', '<=', $posts->last()->created_at);
226
227			// When there're several page and the current page is the last page
228			} elseif ($page == $this->lastPage) {
229			$logs = $logs->where('created_at', '>', $previousPost->created_at);
230			}
231			$postsWithLogs = $posts->merge($logs->get())->sortBy('created_at');
232
233			// If the conversation has a solved post, prepend it
234			// then prepend the first post to the collection
235			if ($this->lastPage == 1 \|\| $page == 1) {
236			if (!is_null($this->solved_post_id)) {
237			$postsWithLogs->prepend(DiscussPost::findOrFail($this->solved_post_id));
238			}
239			$postsWithLogs->prepend(DiscussPost::findOrFail($this->first_post_id));
240			}
241
242			return $postsWithLogs;
243			}
244
245			/**
246			* Get the previous post related to the current conversation with
247			* the given date.
248			*
249			* @param string $createdAt
250			*
251			* @return \Xetaravel\Models\DiscussPost\|null
252			*/
253			protected function getPreviousPost(string $createdAt)
254			{
255			return DiscussPost::where('id', '!=', $this->solved_post_id)
256			->where('conversation_id', $this->getKey())
257			->where('created_at', '<', $createdAt)
258			->orderBy('created_at', 'desc')
259			->first();
260			}
261			}
262

XetaIO / Xetaravel

Pull Request — master (#34)

DiscussConversation::getPostsWithLogs() D

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like