6 | 
7 | 
8 | 
9 |
5 |
102 |
103 |
104 | Thanks to Nexxtmove for sponsoring the development of this project.
105 | Your logo or name here? [Sponsor this project](https://github.com/sponsors/jpkleemans).
106 |
107 | ## License
108 |
109 | Code released under the [MIT License](https://github.com/jpkleemans/attribute-events/blob/master/LICENSE).
110 |
--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "jpkleemans/attribute-events",
3 | "description": "🔥 Fire events on attribute changes of your Eloquent model",
4 | "homepage": "https://attribute.events/",
5 | "keywords": [
6 | "laravel",
7 | "eloquent",
8 | "events",
9 | "attributes",
10 | "domain events",
11 | "model events",
12 | "ddd"
13 | ],
14 | "license": "MIT",
15 | "authors": [
16 | {
17 | "name": "Jan-Paul Kleemans",
18 | "email": "jpkleemans@gmail.com"
19 | }
20 | ],
21 | "autoload": {
22 | "psr-4": {
23 | "Kleemans\\": "src/"
24 | }
25 | },
26 | "autoload-dev": {
27 | "psr-4": {
28 | "Kleemans\\Tests\\": "tests/"
29 | }
30 | },
31 | "require": {
32 | "php": "^7.3|^8.0"
33 | },
34 | "require-dev": {
35 | "phpunit/phpunit": "^11.5",
36 | "illuminate/events": "^11.44",
37 | "illuminate/database": "^11.44",
38 | "friendsofphp/php-cs-fixer": "^3.75"
39 | },
40 | "scripts": {
41 | "tests": "phpunit ./tests",
42 | "lint": "php-cs-fixer fix"
43 | }
44 | }
45 |
--------------------------------------------------------------------------------
/src/AttributeEvents.php:
--------------------------------------------------------------------------------
1 | fireAttributeEvents();
17 | });
18 |
19 | static::retrieved(function ($model) {
20 | $model->syncOriginalAccessors();
21 | });
22 |
23 | static::saved(function ($model) {
24 | $model->syncOriginalAccessors();
25 | });
26 | }
27 |
28 | private function fireAttributeEvents(): void
29 | {
30 | foreach ($this->getAttributeEvents() as $change => $event) {
31 | [$attribute, $expected] = explode(':', $change);
32 |
33 | try {
34 | $value = $this->getAttribute($attribute);
35 | } catch (MissingAttributeException) {
36 | continue;
37 | }
38 |
39 | // Accessor
40 | if ($this->hasAccessor($attribute)) {
41 | if (!$this->isDirtyAccessor($attribute)) {
42 | continue; // Not changed
43 | }
44 | }
45 |
46 | // JSON attribute
47 | elseif (Str::contains($attribute, '->')) {
48 | [$attribute, $path] = explode('->', $attribute, 2);
49 | $path = str_replace('->', '.', $path);
50 |
51 | if (!$this->isDirtyNested($attribute, $path)) {
52 | continue; // Not changed
53 | }
54 |
55 | try {
56 | $value = Arr::get($this->getAttribute($attribute), $path);
57 | } catch (MissingAttributeException) {
58 | continue;
59 | }
60 | }
61 |
62 | // Regular attribute
63 | elseif (!$this->isDirty($attribute)) {
64 | continue; // Not changed
65 | }
66 |
67 | if ($this->shouldFireAttributeEvent($value, $expected)) {
68 | $this->fireModelEvent($change, false);
69 | }
70 | }
71 | }
72 |
73 | private function shouldFireAttributeEvent($value, $expected)
74 | {
75 | if ($expected === '*') {
76 | return true;
77 | }
78 |
79 | if ($value instanceof \UnitEnum) {
80 | return $value->name === $expected;
81 | }
82 |
83 | if ($expected === 'true') {
84 | return $value === true;
85 | }
86 |
87 | if ($expected === 'false') {
88 | return $value === false;
89 | }
90 |
91 | // Float
92 | if (is_numeric($expected) && Str::contains($expected, '.')) {
93 | return $value === (float) $expected;
94 | }
95 |
96 | // Int
97 | if (is_numeric($expected)) {
98 | return $value === (int) $expected;
99 | }
100 |
101 | return (string) $value === $expected;
102 | }
103 |
104 | private function syncOriginalAccessors(): void
105 | {
106 | foreach ($this->getAttributeEvents() as $change => $event) {
107 | [$attribute] = explode(':', $change);
108 |
109 | if (!$this->hasAccessor($attribute)) {
110 | continue; // Attribute does not have accessor
111 | }
112 |
113 | try {
114 | $value = $this->getAttribute($attribute);
115 | } catch (MissingAttributeException) {
116 | continue;
117 | }
118 |
119 | if ($value === null) {
120 | continue; // Attribute does not exist
121 | }
122 |
123 | $this->originalAccessors[$attribute] = $value;
124 | }
125 | }
126 |
127 | public function isDirtyAccessor(string $attribute): bool
128 | {
129 | if (!isset($this->originalAccessors[$attribute])) {
130 | return false; // Attribute does not have a original value saved
131 | }
132 |
133 | $originalValue = $this->originalAccessors[$attribute];
134 |
135 | try {
136 | $currentValue = $this->getAttribute($attribute);
137 | } catch (MissingAttributeException) {
138 | return false;
139 | }
140 |
141 | return $originalValue !== $currentValue;
142 | }
143 |
144 | public function isDirtyNested(string $attribute, string $path): bool
145 | {
146 | $originalValue = Arr::get($this->getOriginal($attribute), $path);
147 |
148 | try {
149 | $currentValue = Arr::get($this->getAttribute($attribute), $path);
150 | } catch (MissingAttributeException) {
151 | return false;
152 | }
153 |
154 | if ($currentValue === null) {
155 | return false;
156 | }
157 |
158 | return $originalValue !== $currentValue;
159 | }
160 |
161 | /**
162 | * @return array