Yii Powered

YiiPowered is a showcase of websites and projects built with Yii framework.

YiiPowered is not really an application template. But it is a non-trivial application, which is available with code at GitHub.

About YiiPowered

1. Build the docker image: docker build -t yiipowered ..
2. Run docker stack: docker-compose up.
3. Add yiipowered.test to your hosts file (on Windows: Open file C:\Windows\System32\Drivers\etc\hosts with Notepad running as admin).
4. There are .php-orig sample configs in config directory. Copy all these files to .php without -orig and adjust to your needs.
5. Run docker exec -it yiipowered bash.
6. Inside this bash termimnal, run: composer install && php yii migrate to setup the database tables.
7. Open http://yiipowered.test in your browser.
8. Register as a new user.
9. In the docker bash terminal (see above), run yii user/assign USERNAME admin to assign admin role to user USERNAME.

• Simple user administration
• Self-registration
• User has two stati

The Project model has these behaviors:

• timestamp
• blameable
• sluggable
• taggable

There are queues for

There is a nice example of an attribute evalidation using new and old attribute values:

models/User.php

    public function rules()
    {
        return [
            // ...
            ['status', 'validateStatus']
        ];
    }
 
    public function validateStatus()
    {
        if ($this->isAttributeChanged('status', false)) {
            if ($this->status == self::STATUS_DELETED && $this->getOldAttribute('status') != self::STATUS_DRAFT) {
                $this->addError('status', Yii::t('project', 'You can only delete a project from a draft.'));
            }
 
            if ($this->getOldAttribute('status') == self::STATUS_DELETED) {
                $this->addError('status', Yii::t('project', 'You can not restore a deleted project.'));
            }
        }
    }

• Show a little bookmark icon at the top left corner of the project image
• Handle bookmark/un-bookmark action via API calls

• Introduction page with example links
• API is a module within the application

config/web.php

    'modules' => [
        'api1' => [
            'class' => \app\modules\api1\Module::class,
        ],
    ],

• There are extended AR Models in the REST API module, mostly to implement Linkable or fields()
• Example of n:m relation:

modules/api1/models/Project.php

    /**
     * @return \yii\db\ActiveQuery
     */
    public function getUsers()
    {
        return $this->hasMany(User::className(), ['id' => 'user_id'])->viaTable('{{%project_user}}', ['project_id' => 'id']);
    }

• Each model has an own controller
• The controllers extend a custom API controller which has the method getCurrentUser
• index action creates and validates a search model, then just returns a DataProvider:

modules/api1/controllers/ProjectController.php

class ProjectController extends Controller
{
    public function actionIndex()
    {
        $projectSearch = new ProjectSearch();
        $projectSearch->load(\Yii::$app->request->get());
        if (!$projectSearch->validate()) {
            throw new BadRequestHttpException('Invalid parameters: ' . json_encode($projectSearch->getErrors()));
        }
        return $projectSearch->getDataProvider();
    }
}

The RSS feed is a regular controller action.

• Get Project records:

controllers/ProjectController.php

        $projects = Project::find()
            ->with('images', 'users')
            ->limit(50)
            ->all();

• Instantiate the Feed object
• Set feed metadata
• Add projects as feed Item
• Render the feed

controllers/ProjectController.php

        $feed = new Feed();
        $feed->title = 'YiiPowered';
        $feed->setWebMaster('sam@rmcreative.ru', 'Alexander Makarov');
        // ...
        foreach ($projects as $project) {
            $url = Url::to(['project/view', 'id' => $project->id, 'slug' => $project->slug], true);
            $item = new Item();
            $item->title = $project->title;
            // ...
            $item->setAuthor('noreply@yiipowered.com', implode(', ', $authors));
            $feed->addItem($item);
        }
        $feed->render();

The api docs page is a rendered Markdown page.

modules/api1/controllers/DocController.php

use yii\helpers\Markdown;
// ...
class DocsController extends Controller
{
    public function actionIndex()
    {
        $docs = file_get_contents(\Yii::getAlias('@app/modules/api1/docs.md'));  
        return $this->render('index', [
            'content' => Markdown::process($docs, 'gfm'),
        ]);
    }
}

• add the label as placeholder attribute
• add method →label(false):

views/project/_form.php

<?= $form->field($model, 'title')
    ->textInput([/* ... */ 'placeholder' => $model->getAttributeLabel('title')])
    ->label(false) ?>

models/User.php

class User extends ActiveRecord implements IdentityInterface
{
    const STATUS_DELETED = 0;
    const STATUS_ACTIVE = 10;
 
    // ...
 
    public function rules()
    {
        return [
            ['status', 'default', 'value' => self::STATUS_ACTIVE],
            ['status', 'in', 'range' => [self::STATUS_ACTIVE, self::STATUS_DELETED]],
            ['status', 'filter', 'filter' => 'intval'],
            // ...
        ];
    } 
 
    // Get the label for the current status
    public function getStatusLabel()
    {
        $statuses = self::getStatuses();
        return ArrayHelper::getValue($statuses, $this->status);
    }
 
    // Get an array of status labels, indexed by status constants
    public static function getStatuses()
    {
        return [
            self::STATUS_DELETED => Yii::t('user', 'Delete'),
            self::STATUS_ACTIVE  => Yii::t('user', 'Active'),
        ];
    }
}