ProAI\Versioning\Versionable

Complexity

Total Complexity

14

Size/Duplication

Total Lines	116
Duplicated Lines	0 %

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	getVersionTable()	0	3	1
A	newEloquentBuilder()	0	3	1
A	getQualifiedVersionColumn()	0	3	1
A	getQualifiedLatestVersionColumn()	0	3	1
A	getVersionKeyName()	0	3	1
A	getVersionedAttributeNames()	0	3	2
A	getVersionColumn()	0	3	2
A	getQualifiedVersionKeyName()	0	3	1
A	getLatestVersionColumn()	0	3	2
A	bootVersionable()	0	3	1
A	newFromBuilder()	0	6	1

<?php

namespace ProAI\Versioning;

trait Versionable
{
    /**
     * Boot the versionable trait for a model.
     *
     * @return void
     */
    public static function bootVersionable()
    {
        static::addGlobalScope(new VersioningScope);
    }

    /**
     * Create a new model instance that is existing.
     *
     * @param  array  $attributes
     * @param  string|null  $connection
     * @return static
     */
    public function newFromBuilder($attributes = array(), $connection = null)
    {
        // hide ref_id from model, because ref_id == id
        $attributes = array_except((array) $attributes, $this->getVersionKeyName());

        return parent::newFromBuilder($attributes, $connection);
    }

    /**
     * Create a new Eloquent query builder for the model.
     *
     * @param  \Illuminate\Database\Query\Builder $query
     * @return \ProAI\Versioning\Builder|static
     */
    public function newEloquentBuilder($query)
    {
        return new Builder($query);
    }

    /**
     * Get the names of the attributes that are versioned.
     *
     * @return array
     */
    public function getVersionedAttributeNames()
    {
        return (! empty($this->versioned)) ? $this->versioned : [];
    }

    /**
     * Get the version key name.
     *
     * @return string
     */
    public function getVersionKeyName()
    {
        return 'ref_' . $this->getKeyName();

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

    }

    /**
     * Get the version table associated with the model.
     *
     * @return string
     */
    public function getVersionTable()
    {
        return $this->getTable() . '_version';

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

    }

    /**
     * Get the table qualified version key name.
     *
     * @return string
     */
    public function getQualifiedVersionKeyName()
    {
        return $this->getVersionTable().'.'.$this->getVersionKeyName();
    }

    /**
     * Get the name of the "latest version" column.
     *
     * @return string
     */
    public function getLatestVersionColumn()
    {
        return defined('static::LATEST_VERSION') ? static::LATEST_VERSION : 'latest_version';

The constant ProAI\Versioning\Versionable::LATEST_VERSION was not found. Maybe you did not declare it correctly or list all dependencies?

    }

    /**
     * Get the fully qualified "latest version" column.
     *
     * @return string
     */
    public function getQualifiedLatestVersionColumn()
    {
        return $this->getTable().'.'.$this->getLatestVersionColumn();
    }

    /**
     * Get the name of the "version" column.
     *
     * @return string
     */
    public function getVersionColumn()
    {
        return defined('static::VERSION') ? static::VERSION : 'version';

The constant ProAI\Versioning\Versionable::VERSION was not found. Maybe you did not declare it correctly or list all dependencies?

    }

    /**
     * Get the fully qualified "version" column.
     *
     * @return string
     */
    public function getQualifiedVersionColumn()
    {
        return $this->getVersionTable().'.'.$this->getVersionColumn();
    }

}