Based on yiisoft/yii2-app-advanced, create a new repository yii2-app-advanced on github, and create a new interface application (implement RESTful-style web service services. API), implement model hierarchy: data layer, logic layer, clarify common directory, application, module inheritance, reference relationship (2)

by 永夜 · 2018/04/04

浏览量： 8

1. Definition and specification:
Define:
(1) Data layer: Models is used to define automatic verification and automatic completion and data access interfaces related to data;
(2) Logical layer: Logics is used to define the business logic related to data;

Specification:
(1) The model class file in the /common/models directory is only allowed to be generated by the GII tool, which is a common model data layer;
(2) The model class file in the /common/logics directory is business logic-related, which is inherited to the /common/models data layer, which is the common model logic layer;
(3) The model class file needs to be referenced in the /common directory, only the model class file in /common/logics, for example:

public $modelClass =common\logics\user;

(4)/api/models, /backend/models, /frontend/models directory, the model class files are business logic related (only related to each application), inherit to /common/logics public logic layer;
(5) The model file needs to be referenced in the interface, front-end and back-end application directories, and only the corresponding model files in the respective directory are referenced, for example:

use API\models\user;

(6) The model class file in the /API/modules/v1/models directory is business logic related (only related to the module), and inherits to the /api/models application logic layer;
(7) The model class file needs to be referenced in the module directory, and only the corresponding model class file under the respective modules, for example:

public $modelClass =API\modules\v1\models\user;

2. Create a new logics directory in the common directory, which is used for the logical layer of the mysql model, as shown in Figure 1

Figure 1

3. Copy \common\models\loginform.php, \common\models\user.php to \common\logics, as shown in Figure 2

$复制 \common\models\LoginForm.php、\common\models\User.php 至 \common\logics$

Figure 2

4. The mysql model file in the common/models directory is only generated by the gII tool, delete \common\models\loginform.php, as shown in Figure 3

$在common/models目录中的MySQL模型文件仅为Gii工具所生成，删除 \common\models\LoginForm.php$

Figure 3

5. Configure the route, use a beautiful URL, edit \frontend\config\main.php

urlmanager=&gt;[
enablePrettyURL=&gt; true,
showscriptname=&gt; false,
rules=&gt; [
]#ATFP_CLOSE_Translate_span#,
],

6. International support, create a new directory \common\messages\en-us\model, \common\messages\zh-cn\model, which are respectively used in American English and Chinese for the data layer of the model; \common\messages\{language}\app.php, \common\messages\{language}\error.p hp, \common\messages\{language}\success.php, which are used to apply global messages, application error messages, and application success messages, as shown in Figure 4

$国际化的支持，新建目录 \common\messages\en-US\model、\common\messages\zh-CN\model，分别用于模型的数据层的美国英语、中文简体；新建 \common\messages\{language}\app.php、\common\messages\{language}\error.php、\common\messages\{language}\success.php，分别用于应用全局消息、应用错误消息、应用成功消息$

Figure 4

app.php

&lt;?php
return[
]#atfp_close_translate_span#;

error.php

&lt;?php
return[
20000 =>Error,
]#atfp_close_translate_span#;

success.php

&lt;?php
return[
10000 =&gt;succeed,
]#atfp_close_translate_span#;

7. Configure the application language, the source language is American English, and the target language is Simplified Chinese. When the source language and the target language are the same, whether the message translation is forced, the default is false, set to true, edit \common\config\main.php

sourceLanguage=&gt;en-us,
Language=&gt;en,
components=&gt;[
I18N=&gt; [
translations=&gt; [
;=&gt; [
class=&gt;yii\i18n\phpMessageSource,
ForceTranslation=&gt; true,
basepath=&gt;@common/messages,
FileMap=&gt; [
app=&gt;app.php,
Error=&gt;error.php,
succeed=&gt;success.php,
]#ATFP_CLOSE_Translate_span#,
],
],
],
cache=&gt;[
class=&gt;Yii\Caching\FileCache,
]#ATFP_CLOSE_Translate_span#,
],

8. Open the URL: http://www.github-shuijingwan-yii2-app-advanced.localhost/gii/model , option, the namespace is common\models, at this time, it is necessary to support internationalization, overwrite \common\models\user.php, as shown in Figure 5

$打开网址：http://www.github-shuijingwan-yii2-app-advanced.localhost/gii/model ，选项，命名空间为common\models，此时需支持国际化，覆盖\common\models\User.php$

Figure 5

&lt;?php

namespace common\models;

use yii;

/**
* this is the model class for table "{{%user}}".
;
* @property int $id
* @property string $username
* @property string $auth_key
* @property string $password_hash
* @property string $password_reset_token
* @property string $email
* @property int $status
* @property int $created_at
* @property int $updated_at
*/
class user extends \yii\db\ActiveRecord
{
/**
* @InheritDoc
*/
public static function tableName()
{
return{{%user}};
}

/**
* @InheritDoc
*/
public function rules()
{
return[
[[[username,auth_key,password_hash,email,created_at,updated_at]#ATFP_CLOSE_Translate_span#,required],
[['status', 'created_at', 'updated_at'],Integer],
[['username', 'password_hash', 'password_reset_token', 'email'],string,max=&gt; 255],
[['auth_key'],string,max=&gt; 32],
[['username'],unique],
[['email'],unique],
[['password_reset_token'],unique],
];
}

/**
* @InheritDoc
*/
public function attributeLabels()
{
return[
ID=&gt; yii::t(model/user,ID,
username=&gt; yii::t(model/user,username,
auth_key=&gt; yii::t(model/user,auth key,
password_hash=&gt; yii::t(model/user,Password hash,
password_reset_token=&gt; yii::t(model/user,Password reset token,
email=&gt; yii::t(model/user,email,
status=&gt; yii::t(model/user,status,
created_at=&gt; yii::t(model/user,created at,
updated_at=&gt; yii::t(model/user,updated at,
]#atfp_close_translate_span#;
}
}

9. The mysql model file in the common/logics directory is business logic related, inherited to \common\models Data layer, open the URL: http://www.github-shuijingwan-yii2-app-advanced.localhost/gii/model , options, as shown in Figure 6

$在common/logics目录中的MySQL模型文件为业务逻辑相关，继承至 \common\models 数据层，打开网址：http://www.github-shuijingwan-yii2-app-advanced.localhost/gii/model ，选项$

Figure 6

10. Based on diff, edit \common\logics\user.php, as shown in Figure 7

11. The mysql model file in the common/logics directory is business logic related, inherited to the data layer of \common\models\user

&lt;?php

namespace common\logics;

use yii;
Use Yii\Base\NotSupportedException;
use yii\behaviors\timestampbehavior;
use yii\web\identityinterface;

/**
* this is the model class for table "{{%user}}".
;
* @property int $id
* @property string $username
* @property string $auth_key
* @property string $password_hash
* @property string $password_reset_token
* @property string $email
* @property int $status
* @property int $created_at
* @property int $updated_at
* @property string $password write-only password
*/
class user extends \common\models\user implementations identityinterface
{
const status_deleted = 0;
const status_active = 10;

/**
* @InheritDoc
*/
public function behaviors()
{
return[
TimestampBehavior::ClassName(),
]#atfp_close_translate_span#;
}

/**
* @InheritDoc
*/
public function rules()
{
return[
[[[username,auth_key,password_hash,email]#ATFP_CLOSE_Translate_span#,required],
[['status', 'created_at', 'updated_at'],Integer],
[['username', 'password_hash', 'password_reset_token', 'email'],string,max=&gt; 255],
[['auth_key'],string,max=&gt; 32],
[['username'],unique],
[['email'],unique],
[['password_reset_token'],unique],
['status', 'default', 'value' =&gt; self::STATUS_ACTIVE],
['status', 'in', 'range' =&gt; [self::STATUS_ACTIVE, self::STATUS_DELETED]],
];
}

/**
* @InheritDoc
*/
public static function findIdentity($id)
{
return static::findone(['id' =&gt; $id, 'status' =&gt; self::STATUS_ACTIVE]);
}

/**
* @InheritDoc
*/
public static function findIdentityByAccessToken($token, $type = null)
{
Throw New NotsUpportedException("FindIdentityByAccessToken" is not implemented.);
}

/**
* finds user by username
;
* @param string $username
* @return static|null
*/
public static function findByUsername($username)
{
return static::findone(['username' =&gt; $username, 'status' =&gt; self::STATUS_ACTIVE]);
}

/**
* Finds user by password reset token
;
* @param string $token password reset token
* @return static|null
*/
Public static function FindByPasswordResetToken($token)
{
if (!static::isPasswordResetTokenValid($token)) {
return null;
}

return static::findone([
password_reset_token=&gt; $token,
status=&gt; self::status_active,
]#atfp_close_translate_span#);
}

/**
* Finds out if password reset token is valid
;
* @param string $token password reset token
* @return bool
*/
Public static function isPasswordResetTokenValid($token)
{
if (empty($token)) {
return false;
}

$timestamp = (int) substr($token, strrpos($token,_) + 1);
$expire = yii::$app-&gt;params['user.passwordResetTokenExpire'];
return $timestamp + $expire &gt;= time();
}

/**
* @InheritDoc
*/
public function getId()
{
return $this-&gt;GetPrimaryKey();
}

/**
* @InheritDoc
*/
public function getAuthKey()
{
return $this-&gt;auth_key;
}

/**
* @InheritDoc
*/
public function validateAuthKey($AuthKey)
{
return $this-&gt;GetAuthKey() === $AuthKey;
}

/**
* validates passwords
;
* @param string $password password to validate
* @return bool if password provided is valid for current user
*/
public function validatePassword($password)
{
return yii::$app-&gt;security-&gt;validatePassword($password, $this-&gt;password_hash);
}

/**
* Generates password hash from password and sets it to the model
;
* @param string $password
*/
public function setPassword($password)
{
$this-&gt;password_hash = yii::$app-&gt;security-&gt;GeneratePasswordHash($password);
}

/**
* generate "remember me" authentication key
*/
public function GenerateAuthKey()
{
$this-&gt;auth_key = yii::$app-&gt;security-&gt;GenerateRandomString();
}

/**
* Generates new password reset token
*/
public function GeneratePasswordResetToken()
{
$this-&gt;password_reset_token = yii::$app-&gt;Security-&gt;GeneratorAndomString() ._. time();
}

/**
* Removes password reset token
*/
public function removePasswordResetToken()
{
$this-&gt;password_reset_token = null;
}
}

12. Create a new \common\messages\en-us\model\user.php, support the message translation when the target language is English and the United States

&lt;?php
/**
* Created by phpstorm.
* user: wangqiang
* Date: 2018/04/04
* TIME: 10:34
*/

return[
ID=&gt;ID,
username=&gt;username,
auth key=&gt;auth key,
Password hash=&gt;Password hash,
Password reset token=&gt;Password reset token,
email=&gt;email,
status=&gt;status,
created at=&gt;created at,
updated at=&gt;updated at,
]#atfp_close_translate_span#;

13. Create a new \common\messages\zh-cn\model\user.php, which supports message translation when the target language is simplified Chinese

&lt;?php
/**
* Created by phpstorm.
* user: wangqiang
* Date: 2018/04/04
* TIME: 10:39
*/

return[
ID=&gt;ID,
username=&gt;Username,
auth key=&gt;authentication key,
Password hash=&gt;Password hashing,
Password reset token=&gt;Password reset token,
email=&gt;Mailbox,
status=&gt;Status,
created at=&gt;creation time,
updated at=&gt;Update time,
]#atfp_close_translate_span#;

14. Create a new \api\models\user.php, the mysql model file in the api/models directory is business logic related (only related to the API), inherit to \common\logics\user logic layer

&lt;?php
/**
* Created by phpstorm.
* user: wangqiang
* Date: 2018/04/04
* TIME: 10:44
*/

namespace api\models;

class user extends\common\logics\user
{

}

15. Copy \API\models\user.php to \frontend\models\user.php, \backend\models\user.php, and adjust to their respective namespaces
\frontend\models\user.php

&lt;?php
/**
* Created by phpstorm.
* user: wangqiang
* Date: 2018/04/04
* TIME: 10:44
*/

namespace frontend\models;

class user extends\common\logics\user
{

}

\backend\models\user.php

&lt;?php
/**
* Created by phpstorm.
* user: wangqiang
* Date: 2018/04/04
* TIME: 10:44
*/

namespace backend\models;

class user extends\common\logics\user
{

}

16. Search for use common\models\user in the API application, and replace it with: use api\models\user;, the same processing in the foreground and background applications, as shown in Figure 8

$在 api 应用中搜索 use common\models\User;，替换为：use api\models\User;，在前台、后台应用中同样类似处理$

17. Search for common\models\user in the API application, replace it with: api\models\user, the same processing in the foreground and background applications, as shown in Figure 9

$在 api 应用中搜索 common\models\User，替换为：api\models\User，在前台、后台应用中同样类似处理$

Figure 9

18. Edit \common\logics\loginform.php to adjust the namespace

&lt;?php
namespace common\logics;

use yii;
use yii\base\model;

/**
* login form
*/
Class Loginform extends model
{
public $username;
public $password;
public $rememberme = true;

private $_user;

/**
* {@inheritdoc}
*/
public function rules()
{
return[
// username and password are both required
[[[username,Password]#ATFP_CLOSE_Translate_span#,required],
// rememberme must be a boolean value
['rememberMe', 'boolean'],
// password is validated by validatePassword()
['password', 'validatePassword'],
];
}

/**
* Validates the password.
* This method serves as the inline validation for password.
;
* @param string $attribute the attribute currently being validated
* @param array $params the additional name-value pairs given in the rule
*/
public function validatePassword($attribute, $params)
{
if (!$this-&gt;hasErrors()) {
$user = $this-&gt;getUser();
if (!$user || !$user-&gt;validatePassword($this-&gt;password)) {
$this-&gt;addError($attribute,Incorrect username or password.);
}
}
}

/**
* Logs in a user using the provided username and password.
;
* @return bool whether the user is logged in successfully
*/
public function login()
{
if ($this-&gt;validate()) {
return yii::$app-&gt;user-&gt;login($this-&gt;getUser(), $this-&gt;rememberme ? 3600 * 24 * 30 : 0);
}

return false;
}

/**
* finds user by[[username]]
;
* @return user|null
*/
protected function getUser()
{
if ($this-&gt;_user === null) {
$this-&gt;_user = user::findByUsername($this-&gt;username);
}

return $this-&gt;_user;
}
}

19. Create a new \api\models\loginform.php, the mysql model file in the api/models directory is business logic related (only related to the API), inherited to \common\logics\loginform logic layer

&lt;?php
/**
* Created by phpstorm.
* user: wangqiang
* Date: 2018/04/04
* TIME: 11:10
*/

namespace api\models;

class loginform extends \common\logics\loginform
{

}

20. Copy \api\models\loginform.php to \frontend\models\loginform.php, \backend\models\loginform.php, adjust to their respective namespaces
\frontend\models\loginform.php

&lt;?php
/**
* Created by phpstorm.
* user: wangqiang
* Date: 2018/04/04
* TIME: 11:10
*/

namespace frontend\models;

class loginform extends \common\logics\loginform
{

}

\backend\models\loginform.php

&lt;?php
/**
* Created by phpstorm.
* user: wangqiang
* Date: 2018/04/04
* TIME: 11:10
*/

namespace backend\models;

class loginform extends \common\logics\loginform
{

}

21. Search for use common\models\loginform in the API application;, replace with: use api\models\loginform;, the same processing in the foreground and background applications, as shown in Figure 10

$在 api 应用中搜索 use common\models\LoginForm;，替换为：use api\models\LoginForm;，在前台、后台应用中同样类似处理$

Figure 10

22. Search common\models\loginform in the API application, replace it with: api\models\loginform, the same processing in the foreground and background applications, as shown in Figure 11

$在 api 应用中搜索 common\models\LoginForm，替换为：api\models\LoginForm，在前台、后台应用中同样类似处理$

Figure 11

23. Search for common\models\user in the common directory, replace with: common\logics\user, with the exception of \common\logics\user.php, as shown in Figure 12

$在 common 目录中搜索 common\models\User，替换为：common\logics\User，除了 \common\logics\User.php 例外$

Figure 12

24. Search common\models\loginform in the common directory, replace it with: common\logics\loginform, as shown in Figure 13

$在 common 目录中搜索 common\models\LoginForm，替换为：common\logics\LoginForm$

Figure 13

25. Test the registration function, open the website: http://www.github-shuijingwan-yii2-app-advanced.localhost/site/signup, in line with expectations, as shown in Figure 14

Figure 14

26. Check the database, as shown in Figure 15

Figure 15

You may also like...

Leave a Reply Cancel reply

You may also like...

The process class relies on proc_open, which is not available on your php installation.

Compile, install and run PHP 7.0.23, Swoole 1.9.19 in Windwos 10 64, VirtualBox, CentOS 7 64 GNOME

In Yii 2, when processing a RESTful API request, the new response format is supported: text/html, and only the HTML format is supported

Leave a Reply Cancel reply