Audit\Models\Change

Complexity

Total Complexity

54

Size/Duplication

Total Lines	534
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	5

Importance

Changes

0

28 Methods

Rating	Name	Duplication	Size	Complexity
A	admin()	0	4	1
A	loggable()	0	4	1
A	changedModel()	0	4	1
A	scopeOrdered()	0	4	1
A	shouldLogChange()	0	4	1
A	log()	0	25	4
A	shouldWriteChange()	0	9	2
A	getChanged()	0	8	3
A	createLog()	0	17	1
A	getModelTitle()	0	5	2
A	getAdminId()	0	7	3
A	logPublishingChange()	0	13	5
A	getActions()	0	9	1
A	getAdmins()	0	4	1
A	getAdminTitleHtmlAttribute()	0	12	1
A	getAdminLinkAttribute()	0	12	2
A	getActionLabelAttribute()	0	17	2
A	getModelNameHtmlAttribute()	0	22	3
A	getLinkedTitleAttribute()	0	10	2
A	getDateAttribute()	0	14	2
A	getHumanDateAttribute()	0	13	3
A	makeAdminActions()	0	10	1
A	getFilterActionAttribute()	0	11	1
A	filterUrl()	0	4	1
A	getChangesActionAttribute()	0	22	2
A	getPreviewActionAttribute()	0	17	4
A	getPreviewUrlAttribute()	0	10	1
A	attributesForModal()	0	18	2

<?php

namespace Audit\Models;

use DB;
use Facilitador;
use Config;
use PedreiroURL;
use Illuminate\Support\Str;
use Pedreiro\Template\Input\Search;
use Muleta\Library\Utils\Text;
use Illuminate\Database\Eloquent\Model;
use Audit\Models\Base;
use App\Models\User;

/**
 * Reperesents a single model change event.  Typically a single CRUD action on
 * a model.
 */
class Change extends Base
{
    /**
     * The query param key used when previewing
     *
     * @var string
     */
    const QUERY_KEY = 'view-change';

    /**
     * The attributes that should be cast to native types.
     *
     * @var array
     */
    protected $casts = [
        'changed' => 'array',
    ];

    protected $fillable = [
        'admin',
        'key',
        'changeable_id',
        'changed',
        'deleted',
        
        'action',
        'model',
        'model_title',
        'date',
        'title',
        'meta',
    ];

    /**
     * Get the admin associated with the change
     *
     * @return Illuminate\Database\Eloquent\Relations\Relation
     */
    public function admin()
    {
        return $this->belongsTo(\Illuminate\Support\Facades\Config::get('sitec.core.models.user', \App\Models\User::class));
    }

    /**
     * The polymorphic relation back to the parent model
     *
     * @var mixed
     */
    public function loggable()
    {
        return $this->morphTo('loggable', 'model', 'key');
    }

    /**
     * Get the related model, including trashed instances
     *
     * @return Model
     */
    public function changedModel()
    {
        return $this->loggable()->withTrashed();
    }

    /**
     * Default ordering by descending time, designed to be overridden
     *
     * @param  Illuminate\Database\Query\Builder $query
     * @return Illuminate\Database\Query\Builder
     */
    public function scopeOrdered($query)
    {
        return $query->orderBy('changes.id', 'desc')->with('admin');
    }

    /**
     * Don't log changes
     *
     * @param  string $action
     * @return boolean
     */
    public function shouldLogChange($action)

The parameter $action is not used and could be removed.

    {
        return false;
    }

    /**
     * A convenience method for saving a change instance
     *
     * @param  Model  $model  The model being touched
     * @param  string $action Generally a CRUD verb: "created", "updated", "deleted"
     * @param  User   $admin  The admin acting on the record
     * @return static|void
     */
    public static function log(Model $model, $action, User $admin = null)
    {
        // Create a new change instance
        if (static::shouldWriteChange($model, $action)) {

Since shouldWriteChange() is declared private, calling it with static will lead to errors in possible sub-classes. You can either use self, or increase the visibility of shouldWriteChange() to at least protected.

            $changed = static::getChanged($model, $action);

Since getChanged() is declared private, calling it with static will lead to errors in possible sub-classes. You can either use self, or increase the visibility of getChanged() to at least protected.

            $change = static::createLog($model, $action, $admin, $changed);
        }

        // Log published / unpblished changes
        static::logPublishingChange($model, $action, $admin);

        // If the action was a deletion, mark all of the records for this model as
        // deleted
        if ($action == 'deleted') {
            DB::table('changes')
                ->where('model', get_class($model))
                ->where('key', $model->getKey())
                ->update(['deleted' => 1]);
        }

        // Return the changed instance
        if (isset($change)) {
            return $change;
        }
    }

    /**
     * Don't log changes when the only thing that changed was the published
     * state or updated timestamp.  We check if there are any attributes
     * besides these that changed.
     *
     * @param  Model  $model  The model being touched
     * @param  string $action
     * @return boolean
     */
    static private function shouldWriteChange(Model $model, $action)
    {
        if (in_array($action, ['created', 'deleted'])) { return true;
        }
        $changed_attributes = array_keys($model->getDirty());
        $ignored = ['updated_at', 'public'];
        $loggable = array_diff($changed_attributes, $ignored);
        return count($loggable) > 0;
    }

    /**
     * Get the changes attributes
     *
     * @param  Model  $model  The model being touched
     * @param  string $action
     * @return array|null
     */
    static private function getChanged(Model $model, $action)
    {
        $changed = $model->getDirty();
        if ($action == 'deleted' || empty($changed)) {
            $changed = null;
        }
        return $changed;
    }

    /**
     * Create a change entry
     *
     * @param Model  $model  Th
     * @param string $action
     * @param User   $admin
     */
    static protected function createLog(
        Model $model,
        $action,
        User $admin = null,
        $changed = null
    ) {
        return static::create(

The method create() does not exist on Audit\Models\Change. Did you maybe mean createLog()?

            [
            'model' => get_class($model),
            'key' => $model->getKey(),
            'action' => $action,
            'title' => static::getModelTitle($model),
            'changed' => $changed,
            'changeable_id' => static::getAdminId($admin),
            ]
        );
    }

    /**
     * Get the title of the model
     *
     * @param  Model $model
     * @return string
     */
    static protected function getModelTitle(Model $model)
    {
        return method_exists($model, 'getAdminTitleAttribute') ?
            $model->getAdminTitleAttribute() : null;
    }

    /**
     * Get the admin id
     *
     * @param  User $admin
     * @return integer
     */
    static protected function getAdminId(User $admin = null)
    {
        if (!$admin) {
            $admin = app('facilitador.user');
        }
        return $admin ? $admin->getKey() : null;
    }

    /**
     * Log changes to publishing state.  The initial publish should be logged
     * but not an initil unpublished state.
     *
     * @param  Model  $model
     * @param  string $action
     * @param  User   $admin
     * @return void
     */
    static public function logPublishingChange(
        Model $model,
        $action,
        User $admin = null
    ) {
        if ($model->isDirty('public')) {
            if ($model->public) {
                static::createLog($model, 'published', $admin);
            } else if (!$model->public && $action != 'created') {
                static::createLog($model, 'unpublished', $admin);
            }
        }
    }

    /**
     * Return a list of all the actions currently being used as a hash for use
     * in a select menu
     *
     * @return array
     */
    public static function getActions()
    {
        return static::groupBy('action')->pluck('action', 'action')
            ->mapWithKeys(
                function ($item) {
                    return [$item => __("facilitador::changes.actions.$item")];
                }
            );
    }

    /**
     * Return a list of all the admins as a hash for use in a select menu
     *
     * @return array
     */
    public static function getAdmins()
    {
        return User::all(['id', 'email'])->pluck('email', 'id');
    }

    /**
     * Format the the activity like a sentence
     *
     * @return string HTML
     */
    public function getAdminTitleHtmlAttribute()
    {
        return __(
            'facilitador::changes.admin_title', [
            'admin' => $this->getAdminLinkAttribute(),
            'action' => $this->getActionLabelAttribute(),
            'model' => $this->getModelNameHtmlAttribute(),
            'model_title' => $this->getLinkedTitleAttribute(),
            'date' => $this->getDateAttribute()
            ]
        );
    }

    /**
     * Get the admin name and link
     *
     * @return string HTML
     */
    public function getAdminLinkAttribute()
    {
        if ($this->changeable_id) {

The property changeable_id does not exist on object<Audit\Models\Change>. Since you implemented __get, maybe consider adding a @property annotation.

            return sprintf(
                '<a href="%s">%s</a>',
                $this->filterUrl(['changeable_id' => $this->changeable_id]),

The property changeable_id does not exist on object<Audit\Models\Change>. Since you implemented __get, maybe consider adding a @property annotation.

                $this->admin->getAdminTitleHtmlAttribute()

The property admin does not exist on object<Audit\Models\Change>. Since you implemented __get, maybe consider adding a @property annotation.

            );
        } else {
            return 'Someone';
        }
    }

    /**
     * Format the activity as a colored label
     *
     * @return string HTML
     */
    public function getActionLabelAttribute()
    {
        $map = [
            'created' => 'success',
            'updated' => 'warning',
            'deleted' => 'danger',
            'published' => 'info',
            'unpublished' => 'default',
        ];

        return sprintf(
            '<a href="%s" class="label label-%s">%s</a>',
            $this->filterUrl(['action' => $this->action]),

The property action does not exist on object<Audit\Models\Change>. Since you implemented __get, maybe consider adding a @property annotation.

            isset($map[$this->action]) ? $map[$this->action] : 'info',

The property action does not exist on object<Audit\Models\Change>. Since you implemented __get, maybe consider adding a @property annotation.

            __("facilitador::changes.actions.$this->action")

The property action does not exist on object<Audit\Models\Change>. Since you implemented __get, maybe consider adding a @property annotation.

        );
    }

    /**
     * Format the model name by translating it through the controllers's defined
     * title
     *
     * @return string HTML
     */
    public function getModelNameHtmlAttribute()
    {
        $class = Facilitador::controllerForModel($this->model);

The property model does not exist on object<Audit\Models\Change>. Since you implemented __get, maybe consider adding a @property annotation.

        // There is not a controller for the model
        if (!$class || !class_exists($class)) {
            return sprintf(
                '<b><a href="%s">%s</a></b>',
                $this->filterUrl(['model' => $this->model]),

The property model does not exist on object<Audit\Models\Change>. Since you implemented __get, maybe consider adding a @property annotation.

                preg_replace('#(?<!\ )[A-Z]#', ' $0', $this->model)

The property model does not exist on object<Audit\Models\Change>. Since you implemented __get, maybe consider adding a @property annotation.

            );
        }

        // There is a corresponding controller class
        $controller = new $class;
        return sprintf(
            '<b class="js-tooltip" title="%s"><a href="%s">%s</a></b>',
            htmlentities($controller->description()),
            $this->filterUrl(['model' => $this->model]),

The property model does not exist on object<Audit\Models\Change>. Since you implemented __get, maybe consider adding a @property annotation.

            Str::singular($controller->title())
        );
    }

    /**
     * Get the title of the model. Perhaps in the future there will be more smarts
     * here, like generating a link to the edit view
     *
     * @return string HTML
     */
    public function getLinkedTitleAttribute()
    {
        if (!$this->title) { return;

The property title does not exist on object<Audit\Models\Change>. Since you implemented __get, maybe consider adding a @property annotation.

        }
        return sprintf(
            '<a href="%s">"%s"</a>',
            $this->filterUrl(['model' => $this->model, 'key' => $this->key]),

The property model does not exist on object<Audit\Models\Change>. Since you implemented __get, maybe consider adding a @property annotation.

The property key does not exist on object<Audit\Models\Change>. Since you implemented __get, maybe consider adding a @property annotation.

            $this->title

The property title does not exist on object<Audit\Models\Change>. Since you implemented __get, maybe consider adding a @property annotation.

        );
    }

    /**
     * Get the date of the change
     *
     * @return string HTML
     */
    public function getDateAttribute()
    {
        \Carbon\Carbon::setLocale(Facilitador::locale());
        if (is_null($this->created_at)) {

The property created_at does not exist on object<Audit\Models\Change>. Since you implemented __get, maybe consider adding a @property annotation.

            return '-';
        }

        return sprintf(
            '<a href="%s" class="js-tooltip" title="%s">%s</a>',
            $this->filterUrl(['created_at' => $this->created_at->format('m/d/Y')]),

The property created_at does not exist on object<Audit\Models\Change>. Since you implemented __get, maybe consider adding a @property annotation.

            $this->getHumanDateAttribute(),
            $this->created_at->diffForHumans()

The property created_at does not exist on object<Audit\Models\Change>. Since you implemented __get, maybe consider adding a @property annotation.

        );
    }

    /**
     * Get the human readable date
     *
     * @return string
     */
    public function getHumanDateAttribute()
    {
        $format = __('pedreiro::changes.human_date');
        if (is_null($format)) {
            $format = 'd \d\e F \d\e Y \à\s h\hi';
        }
        
        if (is_null($this->created_at)) {

The property created_at does not exist on object<Audit\Models\Change>. Since you implemented __get, maybe consider adding a @property annotation.

            return '-';
        }

        return $this->created_at->format($format);

The property created_at does not exist on object<Audit\Models\Change>. Since you implemented __get, maybe consider adding a @property annotation.

    }

    /**
     * Customize the action links
     *
     * @param  array $data The data passed to a listing view
     * @return array
     */
    public function makeAdminActions($data)

The parameter $data is not used and could be removed.

    {
        return array_filter(
            [
            $this->filter_action,

The property filter_action does not exist on object<Audit\Models\Change>. Since you implemented __get, maybe consider adding a @property annotation.

            $this->changes_action,

The property changes_action does not seem to exist. Did you mean changes?

            $this->preview_action,

The property preview_action does not exist on object<Audit\Models\Change>. Since you implemented __get, maybe consider adding a @property annotation.

            ]
        );
    }

    /**
     * Make the preview filter icon
     *
     * @return string
     */
    public function getFilterActionAttribute()
    {
        return sprintf(
            '<a href="%s"
            class="glyphicon glyphicon-filter js-tooltip"
            title="' . __('pedreiro::changes.standard_list.filter') . '"
            data-placement="left"></a>',
            $this->filterUrl(['model' => $this->model, 'key' => $this->key]),

The property model does not exist on object<Audit\Models\Change>. Since you implemented __get, maybe consider adding a @property annotation.

The property key does not exist on object<Audit\Models\Change>. Since you implemented __get, maybe consider adding a @property annotation.

            strip_tags($this->getModelNameHtmlAttribute())
        );
    }

    /**
     * Make a link to filter the result set
     *
     * @return string
     */
    public function filterUrl($query)
    {
        return PedreiroURL::action('changes').'?'.Search::query($query);
    }

    /**
     * Make the changes icon
     *
     * @return string
     */
    public function getChangesActionAttribute()
    {
        // If there are changes, add the modal button
        if ($this->changed) {

The property changed does not exist on object<Audit\Models\Change>. Since you implemented __get, maybe consider adding a @property annotation.

            return sprintf(
                '<a href="%s"
                class="glyphicon glyphicon-export js-tooltip changes-modal-link"
                title="%s" data-placement="left"></a>',
                PedreiroURL::action('changes@edit', $this->id),

The property id does not exist on object<Audit\Models\Change>. Since you implemented __get, maybe consider adding a @property annotation.

                __('pedreiro::changes.standard_list.view')
            );
        }

        // Else, show a disabled button
        else {
            return sprintf(
                '<span
            class="glyphicon glyphicon-export js-tooltip"
            title="%s" data-placement="left"></span>', __('pedreiro::changes.standard_list.no_changed')
            );
        }
    }

    /**
     * Make link to preview a version as long as the model has a URI and the
     * action wasn't a delete action.
     *
     * @return string
     */
    public function getPreviewActionAttribute()
    {
        if ($this->changedModel

The property changedModel does not exist on object<Audit\Models\Change>. Since you implemented __get, maybe consider adding a @property annotation.

            && $this->changedModel->uri

The property changedModel does not exist on object<Audit\Models\Change>. Since you implemented __get, maybe consider adding a @property annotation.

            && $this->action != 'deleted'

The property action does not exist on object<Audit\Models\Change>. Since you implemented __get, maybe consider adding a @property annotation.

        ) {
            return sprintf(
                '<a href="%s" target="_blank"
                class="glyphicon glyphicon-bookmark js-tooltip"
                title="%s" data-placement="left"></a>',
                $this->preview_url,

The property preview_url does not exist on object<Audit\Models\Change>. Since you implemented __get, maybe consider adding a @property annotation.

                __('pedreiro::changes.standard_list.preview')
            );
        } else {
            return '<span class="glyphicon glyphicon-bookmark disabled"></span>';
        }
    }

    /**
     * Make the preview URL for a the model
     *
     * @return string
     */
    public function getPreviewUrlAttribute()
    {
        return vsprintf(
            '%s?%s=%s', [
            $this->changedModel->uri,

The property changedModel does not exist on object<Audit\Models\Change>. Since you implemented __get, maybe consider adding a @property annotation.

            static::QUERY_KEY,
            $this->id,

The property id does not exist on object<Audit\Models\Change>. Since you implemented __get, maybe consider adding a @property annotation.

            ]
        );
    }

    /**
     * Get just the attributes that should be displayed in the admin modal.
     *
     * @return array
     */
    public function attributesForModal()
    {
        // Remove some specific attributes.  Leaving empties in there so the updating
        // of values to NULL is displayed.
        $attributes = array_except(
            $this->changed, [

The property changed does not exist on object<Audit\Models\Change>. Since you implemented __get, maybe consider adding a @property annotation.

            'id', 'updated_at', 'created_at', 'password', 'remember_token',
            ]
        );

        // Make more readable titles
        $out = [];
        foreach ($attributes as $key => $val) {
            $out[Text::titleFromKey($key)] = $val;
        }

        return $out;
    }
}