1. Intro
2. Prerequisities
3. Yii demo app + GitLab
4. User management + DB creation + login via DB
5. i18n translations + Session
6. Access rights

Please give me a few days to add whole text

Intro ¶

Skip this paragraph if you are in hurry :-) ... 8 years ago I started these two tutorials for Yii 1:

• https://www.yiiframework.com/wiki/250/yii-for-beginners
• https://www.yiiframework.com/wiki/462/yii-for-beginners-2

... and today I am beginning with Yii 2 so I will also gather my snippets and publish them here so we all can quickly setup the yii-basic-demo just by copying and pasting.

My opinion is that technologies should not require programmers to study them deeply in order to run basic functionalities. Ordinary things should be copied and pasted so that one is happy that it works which will motivate him/her to study how it works under the hood in order to became a pro.

I have 4 years of experiences with Yii 1, but I havent used it for almost 5 years so many things in Yii 2 are new for me again. Plus I was suprised that the Yii 2 demo application does not contain some basic functionalities (like login via DB, translations etc) which must be implemented in the most of web projects so I will focus on them. Plus I will talk about GitLab.

If you find any problems in my snippets, let me know, please.

Prerequisities ¶

Skip this paragraph if you know how to run your Yii demo project...

I work with Win10 + XAMPP Server so I will expect this configuration. Do not forget to start the server and enable Apache + MySQL in the dialog. Then test that following 2 URLs work for you

• http://localhost/
• http://localhost/phpmyadmin/

You should also download the Yii basic demo application and place it into the htdocs folder. In my case it is here:

• C:\xampp\htdocs

And your index.php should be here:

• C:\xampp\htdocs\basic\web\index.php

If you set thing correcly up, following URL will open your demo application. Now it will probably throw an exception:

• http://localhost/basic/web/

The Exception is removed by enterinng any text into attribute 'cookieValidationKey' in file:

• C:\xampp\htdocs\basic\config\web.php

Dont forget to connect Yii to the DB. It is done in file:

• C:\xampp\htdocs\basic\config\db.php

... but it should work out-of-the-box if you use DB name "yii2basic" which is also used in examples below ...

Yii demo app + GitLab ¶

Once I know more about GitLab I will add some info ... for example automatical copying from GitLab to your target web space.

Once you download and run the basic app, I recommend to push it into GitLab. You will probably need a SSH certificate which can be generated like this using PuTTYgen. When I work with Git I use TortoiseGIT which integrates all git functionalities into the context menu in Windows File Explorer.

First go to GitLab web and create a new project. Then you might need to fight a bit, because the login-process seems to be quite complicated.

Once things work, just create an empty folder, right click it and select Git Clone. Enter your git path, best is this format:

• git@gitlab.com:{username}/{projectName}.git
• or you can use also this URL:
• https://gitlab.com/{username}/{projectName}.git
• or you can use HTTP:
• http://gitlab.com/{username}/{projectName}.git

When cloned, copy the content of the "basic" folder into the new empty git-folder and push everything except for folder "vendor" It contains 75MB and 7000 files. You dont want to have it in GIT.

Then you can start to modify you project, for example based on this "tutorial".

User management + DB creation + login via DB ¶

To create DB with users, use following command. I recommend charset utf8_unicode_ci (or utf8mb4_unicode_ci) as it allows you to use more international characters.

CREATE DATABASE IF NOT EXISTS `yii2basic` DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci;

CREATE TABLE IF NOT EXISTS `user` (
  `id` INT NOT NULL AUTO_INCREMENT,
  `username` VARCHAR(45) NOT NULL,
  `password` VARCHAR(60) NOT NULL,
  `email`    VARCHAR(60) NOT NULL,
  `authKey`  VARCHAR(60),
  PRIMARY KEY (`id`))
ENGINE = InnoDB;

INSERT INTO `user` (`id`, `username`, `password`, `email`, `authKey`) VALUES (NULL, 'user01', '0497fe4d674fe37194a6fcb08913e596ef6a307f', 'user01@gmail.com', NULL);

If you must use MyISAM instead of InnoDB, just change the word InnoDB into MYISAM.

Then use GII to generate model. The GII URL will probably be

• http://localhost/basic/web/index.php?r=gii.
• When creating the model, check this checkbox: Enable I18N ... we will need i18n later
• Enter table name "user" and model name "User"

• Do not create CRUD now, first use the snippet below

• Note that there already is a model named User in the demo app. You will not need it if you want to use login-via-DB so feel free to check the overwrite-checkbox in GII. The newly created User model will now be usable only for table operations, not for login. But we will enhance it, see te snippet below.
• The new model will only have 3 methods: tableName(), rules(), attributeLabels()
• In order to use the DB for login, we need to implement IdentityInterface which requires 5 new methods. But as I do not need all those methods, in some of them I have commented out their body in the example below.
• Plus we add 2 methods because of the default LoginForm

The final model should look like this:

<?php

namespace app\models;

use Yii;

class User extends \yii\db\ActiveRecord implements \yii\web\IdentityInterface {

    // When user detail is being edited we will only modify attribute password_new
    // Why? We dont want to load password-hash from DB and display it to the user
    // We only want him to see empty field and if it is filled in, password is changed on background
    public $password_new;
    public $password_new_repeat;

    // Use this scenario in UserController->actionCreate() right after: $model = new User() like this:
    // $model->scenario = User::SCENARIO_CREATE;
    // This will force the user to enter the password when new user is created
    // When user is edited, new password is not needed
    const SCENARIO_CREATE = "user-create";

    // ----- Default 3 model-methods by GII:

    public static function tableName() {
        return 'user';
    }

    public function rules() {
        return [
            [['username', 'email'], 'required'],
            [['password_new_repeat', 'password_new'], 'required', "on" => self::SCENARIO_CREATE],
            [['username', 'email'], 'string', 'max' => 45],
            ['email', 'email'],
            [['password', 'authKey'], 'string', 'max' => 60],
            [['password', 'password_new_repeat', 'password_new'], 'safe'],
            ['password_new_repeat', 'compare', 'operator' => '==', 'compareAttribute' => 'password_new'],
            ['password_new_repeat', 'setPasswordWhenChanged'],
        ];
    }

    public function attributeLabels() {
        return [
            'id' => Yii::t('app', 'ID'),
            'username' => Yii::t('app', 'Username'),
            'password' => Yii::t('app', 'Password'),
            'password_new' => Yii::t('app', 'New password'),
            'password_new_repeat' => Yii::t('app', 'Repeat new password'),
            'authKey' => Yii::t('app', 'Auth Key'),
            'email' => Yii::t('app', 'Email'),
        ];
    }

    // ----- Password validator

    public function setPasswordWhenChanged($attribute_name, $params) {

        if (trim($this->password_new_repeat) === "") {
            return true;
        }

        if ($this->password_new_repeat === $this->password_new) {
            $this->password = sha1($this->password_new_repeat);
        }

        return true;
    }

    // ----- IdentityInterface methods:

    public static function findIdentity($id) {
        return static::findOne($id);
    }

    public static function findIdentityByAccessToken($token, $type = null) {
        return static::findOne(['access_token' => $token]);
    }

    public function getId() {
        return $this->id;
    }

    public function getAuthKey() {
        return $this->authKey;
    }

    public function validateAuthKey($authKey) {
        return $this->authKey === $authKey;
    }

    // ----- Because of default LoginForm:

    public static function findByUsername($username) {
        return static::findOne(['username' => $username]);
    }

    public function validatePassword($password) {
        return $this->password === sha1($password);
    }

}

Now you can also create CRUD = Create Read Update Delete = views and controller. On the GII page enter following values:

• Model Class = app\models\User
• Search Model Class = app\models\UserSearch
• Controller Class = app\controllers\UserController
• View Path can be empty or you can set: views\user
• Again enable i18n

And then you can edit users on this URL: http://localhost/basic/web/index.php?r=user ... but it is not all. You shouldhave to modify the view-files so that correct inputs are displayed!

Open folder views\user and do following:

• _form.php - rename input password to password_new then duplicate it and rename to password_new_repeat. Remove authKey.
• _search.php - remove password and authKey.
• index.php - remove password and authKey.
• view.php - remove password and authKey.

Plus do not forget to use the new scenario in UserController->actionCreate() like this:

public function actionCreate()
{
  $model = new User();
  $model->scenario = User::SCENARIO_CREATE; // the new scenario!
  // ...

i18n translations + Session ¶

... text ...

Access rights ¶

... text ...