MessageTrait::touchReceived() - Code Metrics - Inspection of "2.0.0.20160212-nightly-patch1" - vistart/yii2-models - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c7ad4e...58a298 )

by vistart

created 2016-02-12 02:41 UTC

MessageTrait::touchReceived() A

↳ Parent: MessageTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
cc	1
eloc	2
nc	1
nop	0
crap	1

<?php

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

namespace vistart\Models\traits;

/**
 * This trait should be used in models extended from models used BlameableTrait.
 * Notice: The models used BlameableTrait are also models used EntityTrait.
 *
 * @author vistart <[email protected]>
 */
trait MessageTrait
{

    public $otherGuidAttribute = 'other_guid';
    public $attachmentAttribute = 'attachment';
    public $expiration = 604800; // 7 days
    public $receivedAtAttribute = 'received_at';
    public $readAtAttribute = 'read_at';
    public static $eventMessageReceived = 'messageReceived';
    public static $eventMessageRead = 'messageRead';
    public $permitChangeContent = false;
    public $permitChangeReceivedAt = false;

    public function hasBeenReceived()
    {
        return is_string($this->receivedAtAttribute) ? !$this->isInitDatetime($this->receivedAtAttribute) : false;
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    public function hasBeenRead()
    {
        return is_string($this->readAtAttribute) ? !$this->isInitDatetime($this->readAtAttribute) : false;
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    public function touchReceived()
    {
        return $this->setReceivedAt(static::currentDatetime());
    }

    public function touchRead()
    {
        return $this->setReadAt(static::currentDatetime());
    }

    public function getReceivedAt()
    {
        if (is_string($this->receivedAtAttribute)) {
            $raAttribute = $this->receivedAtAttribute;
            return $this->$raAttribute;
        }
        return null;
    }

    public function setReceivedAt($receivedAt)
    {
        if (is_string($this->receivedAtAttribute)) {
            $raAttribute = $this->receivedAtAttribute;
            return $this->$raAttribute = $receivedAt;
        }
        return null;
    }

    public function getReadAt()
    {
        if (is_string($this->readAtAttribute)) {
            $raAttribute = $this->readAtAttribute;
            return $this->$raAttribute;
        }
        return null;
    }

    public function setReadAt($readAt)
    {
        if (is_string($this->readAtAttribute)) {
            $raAttribute = $this->readAtAttribute;
            return $this->$raAttribute = $readAt;
        }
        return null;
    }

    /**
     * @param \yii\base\ModelEvent $event
     */
    public function onInitReceivedAtAttribute($event)
    {
        $sender = $event->sender;
        /* @var $sender static */
        $sender->setReceivedAt(static::getInitDatetime($event));
    }

    /**
     * @param \yii\base\ModelEvent $event
     */
    public function onInitReadAtAttribute($event)
    {
        $sender = $event->sender;
        /* @var $sender static */
        $sender->setReadAt(static::getInitDatetime($event));
    }

    /**
     * We consider you have received the message if you read it.
     * @param \yii\base\ModelEvent $event
     */
    public function onReadAtChanged($event)
    {
        $sender = $event->sender;
        if (!is_string($sender->readAtAttribute)) {
            return;
        }
        $raAttribute = $sender->readAtAttribute;
        $reaAttribute = $sender->receivedAtAttribute;
        if ($sender->$raAttribute != $sender->initDatetime() && $sender->$reaAttribute == $sender->initDatetime()) {
            $sender->$reaAttribute = $sender->currentDatetime();
        }
        $oldRa = $sender->getOldAttribute($raAttribute);
        if ($oldRa != $sender->initDatetime() && $sender->$raAttribute != $oldRa) {
            $sender->$raAttribute = $oldRa;
        }
    }

    /**
     * You are not allowed to change receive time if you have received it.
     * @param \yii\base\ModelEvent $event
     */
    public function onReceivedAtChanged($event)
    {
        $sender = $event->sender;
        if ($sender->permitChangeReceivedAt) {
            return;
        }
        $raAttribute = $sender->receivedAtAttribute;
        $oldRa = $sender->getOldAttribute($raAttribute);
        if ($oldRa != $sender->initDatetime() && $sender->$raAttribute != $oldRa) {
            $sender->$raAttribute = $oldRa;
        }
    }

    /**
     * You are not allowed to change the content if it is not new message.
     * @param \yii\base\ModelEvent $event
     */
    public function onContentChanged($event)
    {
        $sender = $event->sender;
        if ($sender->permitChangeContent) {
            return;
        }
        $cAttribute = $sender->contentAttribute;
        $oldContent = $sender->getOldAttribute($cAttribute);
        if ($oldContent != $sender->$cAttribute) {
            $sender->$cAttribute = $oldContent;
        }
    }

    public function initMessageEvents()
    {
        $this->on(static::EVENT_BEFORE_INSERT, [$this, 'onInitReceivedAtAttribute']);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        $this->on(static::EVENT_BEFORE_INSERT, [$this, 'onInitReadAtAttribute']);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        $this->on(static::EVENT_BEFORE_UPDATE, [$this, 'onReadAtChanged']);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        $this->on(static::EVENT_BEFORE_UPDATE, [$this, 'onReceivedAtChanged']);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        $this->on(static::EVENT_BEFORE_UPDATE, [$this, 'onContentChanged']);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    public function getMessageRules()
    {
        $rules = [
            [$this->otherGuidAttribute, 'required'],
            [$this->otherGuidAttribute, 'string', 'max' => 36],
        ];
        if (is_string($this->attachmentAttribute)) {
            $rules[] = [$this->attachmentAttribute, 'safe'];
        }
        if (is_string($this->receivedAtAttribute)) {
            $rules[] = [$this->receivedAtAttribute, 'safe'];
        }
        if (is_string($this->readAtAttribute)) {
            $rules[] = [$this->readAtAttribute, 'safe'];
        }
        return $rules;
    }

    public function rules()
    {
        return array_merge(parent::rules(), $this->getMessageRules());
    }

    public function enabledFields()
    {
        $fields = parent::enabledFields();
        $fields[] = $this->otherGuidAttribute;
        if (is_string($this->attachmentAttribute)) {
            $fields[] = $this->attachmentAttribute;
        }
        if (is_string($this->receivedAtAttribute)) {
            $fields[] = $this->receivedAtAttribute;
        }
        if (is_string($this->readAtAttribute)) {
            $fields[] = $this->readAtAttribute;
        }
        return $fields;
    }
}


1		<?php
2
3		/**
4		* _ __ __ _____ _____ ___ ____ _____
5		* \| \| / // // ___//_ _// \|\| __\|\|_ _\|
6		* \| \|/ // /(__ ) / / / /\| \|\| \| \| \|
7		* \|___//_//____/ /_/ /_/ \|_\|\|_\| \|_\|
8		* @link https://vistart.name/
9		* @copyright Copyright (c) 2016 vistart
10		* @license https://vistart.name/license/
11		*/
12
13		namespace vistart\Models\traits;
14
15		/**
16		* This trait should be used in models extended from models used BlameableTrait.
17		* Notice: The models used BlameableTrait are also models used EntityTrait.
18		*
19		* @author vistart <[email protected]>
20		*/
21		trait MessageTrait
22		{
23
24		public $otherGuidAttribute = 'other_guid';
25		public $attachmentAttribute = 'attachment';
26		public $expiration = 604800; // 7 days
27		public $receivedAtAttribute = 'received_at';
28		public $readAtAttribute = 'read_at';
29		public static $eventMessageReceived = 'messageReceived';
30		public static $eventMessageRead = 'messageRead';
31		public $permitChangeContent = false;
32		public $permitChangeReceivedAt = false;
33
34	2	public function hasBeenReceived()
35		{
36	2	return is_string($this->receivedAtAttribute) ? !$this->isInitDatetime($this->receivedAtAttribute) : false;
		0 ignored issues – show Bug introduced 2016-02-10 13:41 UTC by Report Bug Copy Issue Report It seems like `isInitDatetime()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
37		}
38
39	2	public function hasBeenRead()
40		{
41	2	return is_string($this->readAtAttribute) ? !$this->isInitDatetime($this->readAtAttribute) : false;
		0 ignored issues – show Bug introduced 2016-02-12 02:46 UTC by Report Bug Copy Issue Report It seems like `isInitDatetime()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
42		}
43
44	1	public function touchReceived()
45		{
46	1	return $this->setReceivedAt(static::currentDatetime());
47		}
48
49	1	public function touchRead()
50		{
51	1	return $this->setReadAt(static::currentDatetime());
52		}
53
54		public function getReceivedAt()
55		{
56		if (is_string($this->receivedAtAttribute)) {
57		$raAttribute = $this->receivedAtAttribute;
58		return $this->$raAttribute;
59		}
60		return null;
61		}
62
63	3	public function setReceivedAt($receivedAt)
64		{
65	3	if (is_string($this->receivedAtAttribute)) {
66	3	$raAttribute = $this->receivedAtAttribute;
67	3	return $this->$raAttribute = $receivedAt;
68		}
69		return null;
70		}
71
72		public function getReadAt()
73		{
74		if (is_string($this->readAtAttribute)) {
75		$raAttribute = $this->readAtAttribute;
76		return $this->$raAttribute;
77		}
78		return null;
79		}
80
81	3	public function setReadAt($readAt)
82		{
83	3	if (is_string($this->readAtAttribute)) {
84	3	$raAttribute = $this->readAtAttribute;
85	3	return $this->$raAttribute = $readAt;
86		}
87		return null;
88		}
89
90		/**
91		* @param \yii\base\ModelEvent $event
92		*/
93	3	public function onInitReceivedAtAttribute($event)
94		{
95	3	$sender = $event->sender;
96		/* @var $sender static */
97	3	$sender->setReceivedAt(static::getInitDatetime($event));
98	3	}
99
100		/**
101		* @param \yii\base\ModelEvent $event
102		*/
103	3	public function onInitReadAtAttribute($event)
104		{
105	3	$sender = $event->sender;
106		/* @var $sender static */
107	3	$sender->setReadAt(static::getInitDatetime($event));
108	3	}
109
110		/**
111		* We consider you have received the message if you read it.
112		* @param \yii\base\ModelEvent $event
113		*/
114	2	public function onReadAtChanged($event)
115		{
116	2	$sender = $event->sender;
117	2	if (!is_string($sender->readAtAttribute)) {
118		return;
119		}
120	2	$raAttribute = $sender->readAtAttribute;
121	2	$reaAttribute = $sender->receivedAtAttribute;
122	2	if ($sender->$raAttribute != $sender->initDatetime() && $sender->$reaAttribute == $sender->initDatetime()) {
123	1	$sender->$reaAttribute = $sender->currentDatetime();
124	1	}
125	2	$oldRa = $sender->getOldAttribute($raAttribute);
126	2	if ($oldRa != $sender->initDatetime() && $sender->$raAttribute != $oldRa) {
127		$sender->$raAttribute = $oldRa;
128		}
129	2	}
130
131		/**
132		* You are not allowed to change receive time if you have received it.
133		* @param \yii\base\ModelEvent $event
134		*/
135	2	public function onReceivedAtChanged($event)
136		{
137	2	$sender = $event->sender;
138	2	if ($sender->permitChangeReceivedAt) {
139		return;
140		}
141	2	$raAttribute = $sender->receivedAtAttribute;
142	2	$oldRa = $sender->getOldAttribute($raAttribute);
143	2	if ($oldRa != $sender->initDatetime() && $sender->$raAttribute != $oldRa) {
144		$sender->$raAttribute = $oldRa;
145		}
146	2	}
147
148		/**
149		* You are not allowed to change the content if it is not new message.
150		* @param \yii\base\ModelEvent $event
151		*/
152	2	public function onContentChanged($event)
153		{
154	2	$sender = $event->sender;
155	2	if ($sender->permitChangeContent) {
156		return;
157		}
158	2	$cAttribute = $sender->contentAttribute;
159	2	$oldContent = $sender->getOldAttribute($cAttribute);
160	2	if ($oldContent != $sender->$cAttribute) {
161	1	$sender->$cAttribute = $oldContent;
162	1	}
163	2	}
164
165	3	public function initMessageEvents()
166		{
167	3	$this->on(static::EVENT_BEFORE_INSERT, [$this, 'onInitReceivedAtAttribute']);
		0 ignored issues – show Bug introduced 2016-02-11 02:52 UTC by Report Bug Copy Issue Report It seems like `on()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
168	3	$this->on(static::EVENT_BEFORE_INSERT, [$this, 'onInitReadAtAttribute']);
		0 ignored issues – show Bug introduced 2016-02-11 02:52 UTC by Report Bug Copy Issue Report It seems like `on()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
169	3	$this->on(static::EVENT_BEFORE_UPDATE, [$this, 'onReadAtChanged']);
		0 ignored issues – show Bug introduced 2016-02-12 02:46 UTC by Report Bug Copy Issue Report It seems like `on()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
170	3	$this->on(static::EVENT_BEFORE_UPDATE, [$this, 'onReceivedAtChanged']);
		0 ignored issues – show Bug introduced 2016-02-12 02:46 UTC by Report Bug Copy Issue Report It seems like `on()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
171	3	$this->on(static::EVENT_BEFORE_UPDATE, [$this, 'onContentChanged']);
		0 ignored issues – show Bug introduced 2016-02-12 02:46 UTC by Report Bug Copy Issue Report It seems like `on()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
172	3	}
173
174	3	public function getMessageRules()
175		{
176		$rules = [
177	3	[$this->otherGuidAttribute, 'required'],
178	3	[$this->otherGuidAttribute, 'string', 'max' => 36],
179	3	];
180	3	if (is_string($this->attachmentAttribute)) {
181	3	$rules[] = [$this->attachmentAttribute, 'safe'];
182	3	}
183	3	if (is_string($this->receivedAtAttribute)) {
184	3	$rules[] = [$this->receivedAtAttribute, 'safe'];
185	3	}
186	3	if (is_string($this->readAtAttribute)) {
187	3	$rules[] = [$this->readAtAttribute, 'safe'];
188	3	}
189	3	return $rules;
190		}
191
192	3	public function rules()
193		{
194	3	return array_merge(parent::rules(), $this->getMessageRules());
195		}
196
197	3	public function enabledFields()
198		{
199	3	$fields = parent::enabledFields();
200	3	$fields[] = $this->otherGuidAttribute;
201	3	if (is_string($this->attachmentAttribute)) {
202	3	$fields[] = $this->attachmentAttribute;
203	3	}
204	3	if (is_string($this->receivedAtAttribute)) {
205	3	$fields[] = $this->receivedAtAttribute;
206	3	}
207	3	if (is_string($this->readAtAttribute)) {
208	3	$fields[] = $this->readAtAttribute;
209	3	}
210	3	return $fields;
211		}
212		}
213

vistart / yii2-models

Push — master ( c7ad4e...58a298 )

MessageTrait::touchReceived() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like