Skip to content

Commit 678095a

Browse files
Merge pull request #3 from t-kanstantsin/patch-remove-uneccessary-from-doc
Patch remove uneccessary from doc
2 parents 5db3fb5 + 492af63 commit 678095a

File tree

1 file changed

+7
-27
lines changed

1 file changed

+7
-27
lines changed

README.md

Lines changed: 7 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Create directory structure for model "User" (only example, not required):
3131
common/
3232
models/
3333
Users/
34-
Enum/
34+
Enums/
3535
UserStatus.php
3636
User.php
3737
UserQuery.php
@@ -41,30 +41,18 @@ UserStatus class example:
4141
```php
4242
<?php
4343

44-
namespace common\models\Users\Enum;
44+
namespace common\models\Users\Enums;
4545

4646
use Yii;
4747
use Kakadu\Yii2Enum\Enum;
4848

49-
/**
50-
* Class UserStatus
51-
* @package common\models\Users\Enum
52-
* @author
53-
* @version 1.0
54-
*/
5549
class UserStatus extends Enum
5650
{
5751
const DELETED = 0;
5852
const ACTIVE = 1;
5953

60-
/**
61-
* @inheritdoc
62-
*/
6354
protected static $attribute = 'status';
6455

65-
/**
66-
* @inheritdoc
67-
*/
6856
public static function all(): array
6957
{
7058
return [
@@ -78,26 +66,19 @@ class UserStatus extends Enum
7866
And use:
7967

8068
```php
81-
...
69+
namespace common\models\Users;
8270

83-
use common\models\Users\Enum\UserStatus;
84-
...
71+
use common\models\Users\Enums\UserStatus;
8572

86-
class User extends ActiveRecord implements IdentityInterface
73+
class User extends ActiveRecord
8774
{
88-
...
89-
90-
/**
91-
* {@inheritdoc}
92-
*/
93-
public function rules()
75+
public function rules(): array
9476
{
9577
return [
9678
['status', 'default', 'value' => UserStatus::ACTIVE],
9779
['status', 'in', 'range' => UserStatus::keys()],
9880
];
9981
}
100-
10182
...
10283
}
10384
```
@@ -107,7 +88,7 @@ More examples:
10788
$model = new User(['status' => UserStatus::ACTIVE]);
10889

10990
if (UserStatus::has($model, UserStatus::ACTIVE)) {
110-
//
91+
// do something
11192
}
11293

11394
// DetailView widget (or GridView)
@@ -118,7 +99,6 @@ DetailView::widget([
11899
'name',
119100
[
120101
'attribute' => 'status',
121-
'format' => 'raw',
122102
'filter' => UserStatus::all(),
123103
'value' => UserStatus::get($model->status),
124104
],

0 commit comments

Comments
 (0)