samdark / yii2-cookbook

Yii 2.0 Community Cookbook

Yii 2.0 Community Cookbook

This repository hosts an OpenSource book full of tips and tricks about Yii 2.0 PHP framework.

Here's the table of contents.

Note: it's not the same book as Yii2 Application Development Cookbook - Third Edition published by PACKT.

The book is created by Yii community and edited by Alexander Makarov (@samdark), a core team member of the framework.

Feel free to pull request your own writings. I'll review it, provide feedback and merge the best possible way.

yii2-cookbook's Issues

Disabling debug toolbar runtime

if (class_exists('\yii\debug\Module')) {
    $this->off(\yii\web\View::EVENT_END_BODY, [\yii\debug\Module::getInstance(), 'renderToolbar']);
}

Creating your own application template

yiisoft/yii2#2939

Translation in Modules

I think it will be good to have few recipes on translating Modules.
Module can share messages via app catalog but for third-party modules, separate message is essential

Using IDs in translations instead of full strings

Force translation in messages source:

'components' => [
        'i18n' => [
            'translations' => [
                'app*' => [
                    'class' => 'yii\i18n\PhpMessageSource',
                    'basePath' => '@app/messages',
                    'sourceLanguage' => 'en_US',
                    'forceTranslation' => true, // <---- HERE!
                ],
            ],
        ],

How to create configurable widget

yiisoft/yii2#9833

Using locale in URL for Yii2 to make multi-lingual sites, best practices

• Multi-lingual sites based on routes (How to add locale short aliases like usually used en, ru, instead of long locale tags like en-US, ru-RU etc.)
• Multi-lingual sites based on subdomains
• Best practices
• Tips & tricks

Elasticsearch

Would be an interesting chapter
What it is?
What you need?
How to?
Why? (for what)

Form validation not working with bootstrap model

Hi,

I have used model for the popup form but i am facing one problem using this form validation working so far. Could any one can helps me to figured out this issue.

Here is my code

public function actionCreate(){
$model = new AttributeGroup();

    if ($model->load(Yii::$app->request->post()) && $model->save()) {
        return $this->redirect(['']);
    } else {
        return $this->renderAjax('create', ['model' => $model,]);

    }

}

Url::to(['attributesetgroup/create']), 'id' => 'modalButton', 'class' => 'btn btn-success']) ?>

        <?php echo Html::button('Delete Selected Group', ['value' => Url::to(['attributesetgroup/test']), 'id' => 'modalButton', 'class' => 'btn btn-warning']) ?>
        <?php
            Modal::begin([
                'id' => 'modal',
                'header'=>'Attribute Group'
            ]);

            echo "<div id='modalContent'></div>";

            Modal::end();
        ?>

$('#modalButton').click(function (){
$('#modal').modal('show')
.find('#modalContent')
.load($(this).attr('value'));
});

// serialize form, render response and close modal
function submitForm($form) {
$.post(
$form.attr("action"), // serialize Yii2 form
$form.serialize()
)
.done(function(result) {
$form.parent().html(result.message);
$('#modal').modal('hide');
})
.fail(function() {
console.log("server error");
$form.replaceWith('Fail').fadeOut()
});
return false;
}

If i will check the response in firefox console than i can see there is error message display on the response but its seem not working on form.

Please help me to figured out this issue.

Thanks in advance.

Regards,
Jignesh

Implementing AR entity map

http://www.yiiframework.com/forum/index.php/topic/59373-ar-avoid-multiple-instances-for-single-db-record/

Adjust single table inheritance recipe to be able to work with ->where

yiisoft/yii2#6011

1. Override AR's find() to return custom Query class.
2. In custom Query class override prepare to modify conditions.

Why not make a cookbook official?

Or it will only be in Russian?

RBAC & Data Permissions

This discussion should be put in this book!
http://www.yiiframework.com/forum/index.php/topic/62730-rbac-data-permissions/

Modal editing form with ajax validation

Also it would be good to have a solution for modal editing form inside another form (not modal).

How to implement REST authentication

https://aaronparecki.com/articles/2012/07/29/1/oauth2-simplified

Continuos integration in Yii 2 (suggestion)

Extract from yiisoft/yii2#1543

bootstrap modal confirm

Would be great to have example for this PR on how you can change default confirm modal dialog . Also with this example

Structure: backend and frontend via modules (Suggestion)

It was great Idea, but I have one issue while applying it.
Now with what we have, I can open blogFrontend or blogBackend regardless of the current running application. So it would be great if you can mention some way to automate this routing between backend and frontend. I would like to know what do you think? how can I restrict this? (See the following links).

http://example.com/frontend/blog/   == will take you to ==> blog-frontend
http://example.com/backend/blog/  == will take you to ==> blog-backend

Note: I'm not talking about pretty urls, I'm talking about current running application.

Using dummy cache in advanced app local config

yiisoft/yii2@2f90e4d

Testing & debuggin section

How about having a dedicated chapter for testing & debugging:

• unit testing
• integration testing
• selenium
• IDE
• XDebug
• debug toolbar
• gii
• error logging
• codeception ?
• ...

How to create a truly extensible module

• Comments module.
• Interface for user.

Asset processing with Grunt page missing grunt-contrib-copy line

Thank you for the "Asset processing with Grunt" page. It helped me tremendously.

Wanted you to know that the section which describes the node modules to install is missing this line:

npm install grunt-contrib-copy --save-dev

Spelling mistake in structure-asset-processing-with-grunt.md

In Line 189 it should be Clientside

AR Default scope

yiisoft/yii2#3565

Cookie Problem on I18n selecting application language

This documents are perfect but having some problems.
In I18n selecting application language page

$languageCookie = new Cookie([
    'name' => 'language',
    'value' => $language,
    'expire' => 60 * 60 * 24 * 30, // 30 days
]);
Yii::$app->request->cookies->add($languageCookie);

I think its should be

$languageCookie = new Cookie([
    'name' => 'language',
    'value' => $language,
    'expire' => time() + (60 * 60 * 24 * 30), // 30 days
]);
Yii::$app->response->cookies->add($languageCookie);

thanks.

Creating asset bundles with conditional comments for IE

yiisoft/yii2#4053

Adding multiple versions of jQuery for IEs

yiisoft/yii2#2906

About IDE autocompletion for Yii::createObject

/**
* add question follow
*/
public function dealWithAddFollowQuestion()
{
        $model = Yii::createObject(FollowQuestionEntity::className());
        $model->addFollow($this->owner->id, $this->owner->create_by);
}

$model is created by Yii::createObject
And how to let $model auto hints?

REST: upload a file

yiisoft/yii2#6127

How to use DI Container (suggestion)

I will be nice if the book will have a section that show how to use yii\di\Container and how it can help to decouple the business logic from the framework.

Custom error page

yiisoft/yii2#4065

Adjust Yii v.1 cookbook recipes code to Yii v.2

Is it a good idea to adjust Yii v.1 cookbook recipes code to Yii v.2 code? And publish them in this book?
http://yiicookbook.org/

Use readYAML instead of readJSON with Grunt (suggestion)

Regarding the chapter "Asset processing with Grunt". Instead of creating an all.json file, there is a benefit to creating a YAML file instead. The benefit is that comments are allowed in a YAML file, but not in JSON.

In your Gruntfile.js you can do this:

'web/js/all.js': grunt.file.readYAML('assets/js/all.yml')

instead of this:

'web/js/all.js': grunt.file.readJSON('assets/js/all.json')

The all.yml YAML file should look like this:

- vendor/bower/jquery/dist/jquery.js
- vendor/bower/bootstrap/dist/js/bootstrap.js
- vendor/yiisoft/yii2/assets/yii.js
- vendor/yiisoft/yii2/assets/yii.validation.js
- vendor/yiisoft/yii2/assets/yii.activeForm.js

So now you can do something like this, which can be really handy:

- vendor/bower/jquery/dist/jquery.js
#- not using bootstrap now, but may want to use it in the future
#- vendor/bower/bootstrap/dist/js/bootstrap.js
- vendor/yiisoft/yii2/assets/yii.js
- vendor/yiisoft/yii2/assets/yii.validation.js
- vendor/yiisoft/yii2/assets/yii.activeForm.js

Cookies tutorial: enableAutoLogin missing

https://github.com/samdark/yii2-cookbook/blob/master/book/cookies.md#cross-subdomain-authentication-and-identity-cookies

This section has a part where identityCookie is set. But the documentation mentions that this will be useless. http://www.yiiframework.com/doc-2.0/yii-web-user.html#$identityCookie-detail the configuration of the identity cookie. This property is used only when [[enableAutoLogin]] is true.

Using single vendor dir for multiple projects

http://www.yiiframework.com/forum/index.php/topic/59500-single-vendor-for-multiple-project/

Making URLs even more pretty using slugs

http://www.yiiframework.com/forum/index.php/topic/62952-how-create-custom-url-in-yii2/

How to use bower with Yii 2.0

See yiisoft/yii2#3209

Documentation for custom response.

I'm interested in creating a custom XML response but the document* is not complete so I'm unsure how this can be done. If someone can point me into the right direction, I'll be happy to document this myself once I know.

• https://github.com/samdark/yii2-cookbook/blob/master/book/response-formats.md#custom-response

Yii 2.0 + websockets

yiisoft/yii2#7676

yii2 cookbook(chinese version)

Hello. I'm trying to make a chinese version of yii 2 cookbook. May I just fork the file and start translating? (Sorry its my first time, quite nervous about translating things on github)

Any suggestion are welcome. Thank you.

The table of contents link is broken

The table of contents is broken in the main readme file:
https://github.com/samdark/yii2-cookbook/blob/master/README.md

Your own template for migration

https://toster.ru/q/212362

Describe bootstrapping process and how it can be used

yiisoft/yii2#3296

• Provide URL rules from a module.

How to deal with setting app language

See yiisoft/yii2#6568

Offline app documentation

Goal: Continue working while there is (temporarily) no internet connection

Use localstorage, firebase, ...
http://www.html5rocks.com/en/tutorials/offline/whats-offline/

Sync offline data with server database after (re)connnection with internet

Join 2 tables from different databases

yiisoft/yii2#5470

How to run Yii on shared hosting

OAuth2 Server

Well I think Yii2 have clients to Utilize Services. But I have found Yii2 and OAuth2 server Interesting. I found [https://github.com/Filsh/yii2-oauth2-server] and its interesting. Wanted to know if its valid for this cookbook.

How to deal with intl file names

yiisoft/yii2#4322

How to debug RBAC

• If there's a mistake in hierarchy.
• If there's a mistake in Rule.

Using multiple gridviews + pagination

In case of multiple paginated GridViews on the same page one should specify Pagination::$pageParam else pages of both grids will be changed.