Completed
Push — master ( 8e6cd2...c06e7b )
by Vadim
68:16 queued 33:20
created

TrashBehavior::trashAttribute()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 5
Code Lines 3

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
c 1
b 0
f 0
dl 0
loc 5
rs 9.4285
cc 1
eloc 3
nc 1
nop 0
1
<?php
2
/**
3
 * Created by PhpStorm.
4
 * User: vadim
5
 * Date: 30.04.15
6
 * Time: 22:07
7
 */
8
9
namespace sibds\behaviors;
10
11
use yii\behaviors\AttributeBehavior;
12
use yii\db\ActiveRecord;
13
use yii\db\BaseActiveRecord;
14
use yii\helpers\ArrayHelper;
15
16
/**
17
 * Class TrashBehavior
18
 * @package sibds\behaviors
19
 * @author Vadim Mazur <[email protected]>
20
 * @since 0.1
21
 */
22
class TrashBehavior extends AttributeBehavior
23
{
24
    /**
25
     * @var string The name of the table where data stored.
26
     * Defaults to "removed".
27
     */
28
    public $trashAttribute = 'removed';
29
    /**
30
     * @var mixed The value to set for removed model.
31
     * Default is 1.
32
     */
33
    public $removedFlag=1;
34
    /**
35
     * @var mixed The value to set for restored model.
36
     * Default is 0.
37
     */
38
    public $restoredFlag=0;
39
40
    /**
41
     * @var callable the value that will be assigned to the attributes. This should be a valid
42
     * PHP callable whose return value will be assigned to the current attribute(s).
43
     */
44
     public $value;
45
46
    /**
47
     * @inheritdoc
48
     */
49
    public function init()
50
    {
51
        parent::init();
52
53
        if (empty($this->attributes)) {
54
            $this->attributes = [
55
                BaseActiveRecord::EVENT_BEFORE_DELETE => $this->trashAttribute,
56
            ];
57
        }
58
    }
59
60
    public function events(){
61
        return ArrayHelper::merge([
62
            ActiveRecord::EVENT_BEFORE_INSERT => 'checkNewRecord',
63
        ], parent::events());
64
    }
65
66
    public function checkNewRecord($events){
0 ignored issues
show
Unused Code introduced by
The parameter $events is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
67
        /* @var $owner BaseActiveRecord */
68
        $owner = $this->owner;
69
70
        if($owner->hasAttribute($this->trashAttribute))
71
            if(empty($owner->{$this->trashAttribute})||is_null($owner->{$this->trashAttribute}))
72
                $owner->{$this->trashAttribute} = $this->restoredFlag;
73
    }
74
75
    protected function getValue($event)
76
    {
77
        /* @var $owner BaseActiveRecord */
78
        $owner = $this->owner;
79
80
        if ($this->value === null) {
81
            if($owner->{$this->trashAttribute}==$this->restoredFlag)
82
            {
83
                $event->isValid = false;
84
                $owner->{$this->trashAttribute}=$this->removedFlag;
85
                $owner->save(false);
86
87
                return $this->removedFlag;
88
            }else{
89
                return true;
90
            }
91
            return false;
0 ignored issues
show
Unused Code introduced by
return false; does not seem to be reachable.

This check looks for unreachable code. It uses sophisticated control flow analysis techniques to find statements which will never be executed.

Unreachable code is most often the result of return, die or exit statements that have been added for debug purposes.

function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}

In the above example, the last return false will never be executed, because a return statement has already been met in every possible execution path.

Loading history...
92
        } else {
93
            return call_user_func($this->value, $event);
94
        }
95
    }
96
97
    public function restore()
98
    {
99
        /* @var $owner BaseActiveRecord */
100
        $owner = $this->owner;
101
102
        $owner->{$this->trashAttribute}=$this->restoredFlag;
103
104
        $owner->save(false);
105
    }
106
107
    public function getIsRemoved(){
108
        return $this->owner->{$this->trashAttribute}==$this->removedFlag;
109
    }
110
111
    public function trashAttribute(){
112
        $owner = $this->owner->className();
113
114
        return $owner::tableName().'.'.$this->trashAttribute;
115
    }
116
117
    public function fullTrashAttribute($removed=false){
118
        return [$this->trashAttribute()=>($removed?$this->removedFlag:$this->restoredFlag)];
119
    }
120
}
121