Skip to content

Commit c4eb3ae

Browse files
docs: 📝 update docs
1 parent 09650ea commit c4eb3ae

File tree

1 file changed

+15
-6
lines changed

1 file changed

+15
-6
lines changed

README.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,17 +37,26 @@ return [
3737
"users_table_id_column_name" => "id",
3838

3939
/*
40-
* Specify the column that stores the ID of the user who initially created the entry
40+
* If you set the column name to "created_by",
41+
* it will generate two columns:
42+
* - created_by_id
43+
* - created_by_type
4144
*/
4245
"created_by_column" => "created_by",
4346

4447
/*
45-
* Specify the column that holds the ID of the user who last updated the entry
48+
* If you set the column name to "updated_by",
49+
* it will generate two columns:
50+
* - updated_by_id
51+
* - updated_by_type
4652
*/
4753
"updated_by_column" => "updated_by",
4854

4955
/*
50-
* Specify the column that contains the ID of the user who removed the entry
56+
* If you set the column name to "deleted_by",
57+
* it will generate two columns:
58+
* - deleted_by_id
59+
* - deleted_by_type
5160
*/
5261
"deleted_by_column" => "deleted_by",
5362

@@ -107,9 +116,9 @@ class Example extends Model {
107116
There will be methods available to retrieve the user object which performs the action for creating, updating or deleting
108117

109118
```php
110-
$model->creator; // the user who created the model
111-
$model->editor; // the user who last updated the model
112-
$model->destroyer; // the user who deleted the model
119+
$model->createdBy; // the user who created the model
120+
$model->updatedBy; // the user who last updated the model
121+
$model->deletedBy; // the user who deleted the model
113122
```
114123

115124
## Testing

0 commit comments

Comments
 (0)