vistart\Models\models\BaseBlameableModel

Complexity

Total Complexity

4

Size/Duplication

Total Lines	29
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

81.82%

Importance

Changes	8
Bugs	1	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	init()	0	11	3
A	findByIdentity()	0	4	1

<?php

/**
 *  _   __ __ _____ _____ ___  ____  _____
 * | | / // // ___//_  _//   ||  __||_   _|
 * | |/ // /(__  )  / / / /| || |     | |
 * |___//_//____/  /_/ /_/ |_||_|     |_|
 * @link http://vistart.name/
 * @copyright Copyright (c) 2016 vistart
 * @license http://vistart.name/license/
 */

namespace vistart\Models\models;

use vistart\Models\traits\BlameableTrait;

/**
 * BaseBlameableEntityModel automatically fills the specified attributes with
 * the current user's GUID.
 * For example:<br/>
 * ~~~php
 * * @property string $comment
 * class Comment extends BaseBlameableEntityModel
 * {
 *     public static function tableName()
 *     {
 *         return <table_name>;
 *     }
 *     public function rules()
 *     {
 *         $rules = [
 *             [['comment'], 'required'],
 *             [['comment'], 'string', 'max' => 140],
 *         ];
 *         return array_merge(parent::rules(), $rules);
 *     }
 *     public function behaviors()
 *     {
 *         $behaviors = <Your Behaviors>;
 *         return array_merge(parent::behaviors(), $behaviors);
 *     }
 *     public function attributeLabels()
 *     {
 *         return [
 *             ...
 *         ];
 *     }
 * }
 * ~~~
 * Well, when you're signed-in, you can save a new `Example` instance:
 * ~~~php
 * $example = new Example();
 * $example->comment = 'New Comment.';
 * $example->save();
 * ~~~
 * or update an existing one:
 * ~~~php
 * $example = Example::find()
 *                   ->where([$this->createdByAttribute => $user_uuid])
 *                   ->one();
 * if ($example)
 * {
 *     $example->comment = 'Updated Comment.';
 *     $example->save();
 * }
 * ~~~
 * @property array createdByAttributeRules the whole validation rules of
 * creator attribute only, except of combination rules.
 * @property array updatedByAttributeRules the whole validation rules of
 * creator attribute only, except of combination rules.
 * @since 1.1
 * @version 2.0
 * @author vistart <i@vistart.name>
 */
abstract class BaseBlameableModel extends BaseEntityModel
{
    use BlameableTrait;

    /**
     * Initialize the blameable model.
     */
    public function init()
    {
        if (!is_string($this->queryClass)) {
            $this->queryClass = \vistart\Models\queries\BaseBlameableQuery::className();
        }
        if ($this->skipInit) {
            return;
        }
        $this->initBlameableEvents();
        parent::init();
    }

    /**
     * Get the query class.
     * @param \vistart\Models\models\BaseUserModel $identity
     * @return \vistart\Models\queries\BaseBlameableQuery
     */
    public static function findByIdentity($identity = null)
    {
        return static::find()->byIdentity($identity);
    }
}