Skip to content

Commit 274bc9e

Browse files
authoredNov 5, 2021
Merge pull request #98 from nelson6e65/patch-1
docs(readme): improve code examples for easy copy
2 parents 2ca2782 + 961729d commit 274bc9e

File tree

1 file changed

+48
-11
lines changed

1 file changed

+48
-11
lines changed
 

‎readme.md

+48-11
Original file line numberDiff line numberDiff line change
@@ -17,28 +17,38 @@ composer require calebporzio/parental
1717
## Simple Usage
1818

1919
```php
20+
namespace App\Models;
21+
22+
use Illuminate\Database\Eloquent\Model;
23+
use Parental\HasChildren;
24+
2025
// The "parent"
2126
class User extends Model
2227
{
23-
use \Parental\HasChildren;
24-
28+
use HasChildren;
2529
//
2630
}
2731
```
2832

2933
```php
34+
namespace App\Models;
35+
36+
use Parental\HasParent;
37+
3038
// The "child"
3139
class Admin extends User
3240
{
33-
use \Parental\HasParent;
41+
use HasParent;
3442

3543
public function impersonate($user) {
36-
...
44+
//...
3745
}
3846
}
3947
```
4048

4149
```php
50+
use App\Models\Admin;
51+
4252
// Returns "Admin" model, but reference "users" table:
4353
$admin = Admin::first();
4454

@@ -59,33 +69,50 @@ Schema::table('users', function ($table) {
5969
```
6070

6171
```php
72+
namespace App\Models;
73+
74+
use Illuminate\Database\Eloquent\Model;
75+
use Parental\HasChildren;
76+
6277
// The "parent"
6378
class User extends Model
6479
{
65-
use \Parental\HasChildren;
80+
use HasChildren;
6681

6782
protected $fillable = ['type'];
6883
}
6984
```
7085

7186
```php
87+
namespace App\Models;
88+
89+
use Parental\HasParent;
90+
7291
// A "child"
7392
class Admin extends User
7493
{
75-
use \Parental\HasParent;
94+
use HasParent;
7695
}
7796
```
7897

7998
```php
99+
namespace App\Models;
100+
101+
use Parental\HasParent;
102+
80103
// Another "child"
81104
class Guest extends User
82105
{
83-
use \Parental\HasParent;
106+
use HasParent;
84107
}
85108
```
86109

87110

88111
```php
112+
use App\Models\Admin;
113+
use App\Models\Guest;
114+
use App\Models\User;
115+
89116
// Adds row to "users" table with "type" column set to: "App/Admin"
90117
Admin::create(...);
91118

@@ -103,15 +130,20 @@ Before, if we ran: `User::first()` we would only get back `User` models. By addi
103130
If you don't want to store raw class names in the type column, you can override them using the `$childTypes` property.
104131

105132
```php
133+
namespace App\Models;
134+
135+
use Illuminate\Database\Eloquent\Model;
136+
use Parental\HasChildren;
137+
106138
class User extends Model
107139
{
108-
use \Parental\HasChildren;
140+
use HasChildren;
109141

110142
protected $fillable = ['type'];
111143

112144
protected $childTypes = [
113-
'admin' => App\Admin::class,
114-
'guest' => App\Guest::class,
145+
'admin' => Admin::class,
146+
'guest' => Guest::class,
115147
];
116148
}
117149
```
@@ -124,9 +156,14 @@ This feature is useful if you are working with an existing type column, or if yo
124156
You can override the default type column by setting the `$childColumn` property on the parent model.
125157

126158
```php
159+
namespace App\Models;
160+
161+
use Illuminate\Database\Eloquent\Model;
162+
use Parental\HasChildren;
163+
127164
class User extends Model
128165
{
129-
use \Parental\HasChildren;
166+
use HasChildren;
130167

131168
protected $fillable = ['parental_type'];
132169

0 commit comments

Comments
 (0)
Please sign in to comment.