Bmatovu\Publishable\Publishable

Complexity

Total Complexity

17

Size/Duplication

Total Lines	167
Duplicated Lines	23.35 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

61.9%

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	bootPublishable()	0	4	1
A	initializePublishable()	0	4	1
A	publish()	23	23	3
A	unpublish()	16	16	3
A	draft()	0	4	1
A	publishing()	0	4	1
A	published()	0	4	1
A	unpublishing()	0	4	1
A	unpublished()	0	4	1
A	isPublished()	0	4	1
A	getPublishedAtColumn()	0	4	2
A	getQualifiedPublishedAtColumn()	0	4	1

<?php

namespace Bmatovu\Publishable;

/**
 * @method static static|\Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Query\Builder withDrafts()
 * @method static static|\Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Query\Builder onlyDrafts()
 * @method static static|\Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Query\Builder onlyPublished()
 */
trait Publishable
{
    /**
     * Boot the has-drafts trait for a model.
     *
     * @return void
     */
    public static function bootPublishable()
    {
        static::addGlobalScope(new PublishedScope);
    }

    /**
     * Initialize this trait for an instance.
     *
     * @return void
     */
    public function initializePublishable()
    {
        $this->dates[] = $this->getPublishedAtColumn();

The property dates does not exist. Did you maybe forget to declare it?

    }

    /**
     * Save instance of this model as published.
     *
     * @param array $options
     *
     * @return bool
     */
    public function publish(array $options = [])

This method seems to be duplicated in your project.

    {
        // https://laravel-news.com/laravel-model-events-getting-started
        // https://gist.github.com/scrubmx/7fc20663ce2b3ac103a2879915b572be
        // https://www.google.com/search?q=laravel+register+fire+model+event&oq=laravel+register+fire+model+event

        // If the "publishing" event returns false we bail out immediately and return false,
        // indicating that the save failed. This provides a chance for any
        // listeners to cancel save operations if validations fail or whatever.
        if ($this->fireModelEvent('publishing') === false) {

It seems like fireModelEvent() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            return false;
        }

        $this->{$this->getPublishedAtColumn()} = $this->freshTimestamp();

It seems like freshTimestamp() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $saved = parent::save($options);

It seems like you call parent on a different method (save() instead of publish()). Are you sure this is correct? If so, you might want to change this to $this->save().

        if ($saved) {
            $this->fireModelEvent('published', false);

It seems like fireModelEvent() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        }

        return $saved;
    }

    /**
     * Toogle model instance state to non-published.
     *
     * @param array $options
     *
     * @return bool
     */
    public function unpublish(array $options = [])

This method seems to be duplicated in your project.

    {
        if ($this->fireModelEvent('unpublishing') === false) {

It seems like fireModelEvent() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            return false;
        }

        $this->{$this->getPublishedAtColumn()} = null;

        $saved = parent::save($options);

It seems like you call parent on a different method (save() instead of unpublish()). Are you sure this is correct? If so, you might want to change this to $this->save().

        if ($saved) {
            $this->fireModelEvent('unpublished', false);

It seems like fireModelEvent() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        }

        return $saved;
    }

    /**
     * Save instance of this model as a draft.
     *
     * @param array $options
     *
     * @return bool
     */
    public function draft(array $options = [])
    {
        return $this->unpublish($options);
    }

    /**
     * Register a "publishing" model event callback with the dispatcher.
     *
     * @param \Closure|string $callback
     *
     * @return void
     */
    public static function publishing($callback)
    {
        static::registerModelEvent('publishing', $callback);
    }

    /**
     * Register a "published" model event callback with the dispatcher.
     *
     * @param \Closure|string $callback
     *
     * @return void
     */
    public static function published($callback)
    {
        static::registerModelEvent('published', $callback);
    }

    /**
     * Register a "unpublishing" model event callback with the dispatcher.
     *
     * @param \Closure|string $callback
     *
     * @return void
     */
    public static function unpublishing($callback)
    {
        static::registerModelEvent('unpublishing', $callback);
    }

    /**
     * Register a "unpublished" model event callback with the dispatcher.
     *
     * @param \Closure|string $callback
     *
     * @return void
     */
    public static function unpublished($callback)
    {
        static::registerModelEvent('unpublished', $callback);
    }

    /**
     * Determine if the model instance is published.
     *
     * @return bool
     */
    public function isPublished()
    {
        return ! is_null($this->{$this->getPublishedAtColumn()});
    }

    /**
     * Get the name of the "published at" column.
     *
     * @return string
     */
    public function getPublishedAtColumn()
    {
        return defined('static::PUBLISHED_AT') ? static::PUBLISHED_AT : 'published_at';
    }

    /**
     * Get the fully qualified "published at" column.
     *
     * @return string
     */
    public function getQualifiedPublishedAtColumn()
    {
        return $this->qualifyColumn($this->getPublishedAtColumn());

It seems like qualifyColumn() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }
}