Jidaikobo\Kontiki\Models\Traits\PublishedTrait

Complexity

Total Complexity

2

Size/Duplication

Total Lines	38
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	applyPublisedConditions()	0	6	1
A	applyNotPublisedConditions()	0	5	1

<?php

namespace Jidaikobo\Kontiki\Models\Traits;

use Carbon\Carbon;
use Illuminate\Database\Query\Builder;

trait PublishedTrait
{
    protected string $publishedField = 'published_at';

    /**
     * Apply conditions to retrieve published posts.
     *
     * Conditions:
     * - Includes posts where `published_at` is `NULL` (considered as already published).
     * - Includes posts where `published_at` is in the past or equal to the current time.
     *
     * @param Builder $query The query builder instance.
     * @return Builder The modified query with applied conditions.
     */
    public function applyPublisedConditions(Builder $query): Builder
    {
        $currentTime = Carbon::now('UTC')->format('Y-m-d H:i:s');
        return $query->where(function ($q) use ($currentTime) {
            $q->whereNull($this->publishedField) // Consider NULL as published
              ->orWhere($this->publishedField, '<=', $currentTime);
        });
    }

    /**
     * Apply conditions to retrieve scheduled (future) posts.
     *
     * Conditions:
     * - Excludes posts where `published_at` is `NULL` (not scheduled).
     * - Includes posts where `published_at` is in the future.
     *
     * @param Builder $query The query builder instance.
     * @return Builder The modified query with applied conditions.
     */
    public function applyNotPublisedConditions(Builder $query): Builder
    {
        $currentTime = Carbon::now('UTC')->format('Y-m-d H:i:s');
        return $query->whereNotNull($this->publishedField) // Exclude NULL (not scheduled)
                     ->where($this->publishedField, '>', $currentTime);
    }
}