[extension] akiraz2/yii2-blog

Yii2 Super Blog ¶

1. Features:
2. Installation
3. Usage
4. Support
5. Contributing
6. Licensing

Yii2 Super Blog is simple, configured yii2 Module with frontend and backend, cloned from unmaintained repo funson86/yii2-blog, fully reorganized and improved.

Features: ¶

• Blog Post with image banner, seo tags
• Blog Category (nested) with image banner, seo tags
• Blog Tags
• Blog Comment (can be disabled), with standard yii2 captcha (can be ReCaptcha2)
• email in comments are masked (a*i*a*@bk.ru)
• all models has Status (Inactive, Active, Archive)
• Inactive comments are truncated (and strip tags)
• also added semantic OpenGraph (via yii2 component dragonjet/yii2-opengraph), Schema.org
• backendControllers can be protected by your CustomAccessControl (roles or rbac)
• frontend and backend are translated (i18n)
• url rules with slug (for seo)

NOTE: Module is in initial development. Anything may change at any time.

Installation ¶

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist akiraz2/yii2-blog "dev-master"

or add

"akiraz2/yii2-blog": "dev-master"

to the require section of your composer.json file.

Migration ¶

Migration run

yii migrate --migrationPath=@akiraz2/blog/migrations

Config url rewrite in /common/config/main.php ¶

    'timeZone' => 'Europe/Moscow', //time zone affect the formatter datetime format
    'components' => [
        'urlManager' => [
            'enablePrettyUrl' => true,
            'showScriptName' => false,
            'rules' => [               
            ],
        ],
        'formatter' => [ //for the showing of date datetime
            'dateFormat' => 'yyyy-MM-dd',
            'datetimeFormat' => 'yyyy-MM-dd HH:mm:ss',
            'decimalSeparator' => '.',
            'thousandSeparator' => ' ',
            'currencyCode' => 'EUR',
        ],
    ],

Config common modules in common/config/main.php ¶

    'modules' => [
        'blog' => [
            'class' => akiraz2\blog\Module::class,
            'urlManager' => 'urlManagerFrontend',
            'imgFilePath' => '@frontend/web/img/blog/',
            'imgFileUrl' => '/img/blog/',
            'adminAccessControl' => 'common\components\AdminAccessControl',        
        ],
     ],    

Config backend modules in backend/config/main.php ¶

    'modules' => [
        'blog' => [
            'class' => 'akiraz2\blog\Module',
            'controllerNamespace' => 'akiraz2\blog\controllers\backend'
        ],
    ],

Config frontend modules in frontend/config/main.php ¶

    //'defaultRoute' => 'blog', //set blog as default route
    'modules' => [
        'blog' => [
            'class' => 'akiraz2\blog\Module',
            'controllerNamespace' => 'akiraz2\blog\controllers\frontend',
            'blogPostPageCount' => 6,
            'blogCommentPageCount' => 10, //20 by default
            'enableComments' => true, //true by default
            'schemaOrg' => [ // empty array [] by default! 
                'publisher' => [
                    'logo' => '/img/logo.png',
                    'logoWidth' => 191,
                    'logoHeight' => 74,
                    'name' => 'My Company',
                    'phone' => '+1 800 488 80 85',
                    'address' => 'City, street, house'
                ]
            ]
        ],
    ],

Access Url ¶

1. backend : http://backend.you-domain.com/blog
   • Category : http://backend.you-domain.com/blog/blog-category
   • Post : http://backend.you-domain.com/blog/blog-post
   • Comment : http://backend.you-domain.com/blog/blog-comment
   • Tag : http://backend.you-domain.com/blog/blog-tag
2. frontend : http://you-domain.com/blog

Usage ¶

Overriding views ¶

When you start using Yii2-blog you will probably find that you need to override the default views provided by the module. Although view names are not configurable, Yii2 provides a way to override views using themes. To get started you should configure your view application component as follows:

...
'components' => [
    'view' => [
        'theme' => [
            'pathMap' => [
                '@akiraz2/yii2-blog/views/frontend/default' => '@app/views/blog'
            ],
        ],
    ],
],
...

In the above pathMap means that every view in @akiraz2/yii2-blog/views/frontend/default will be first searched under @app/views/blog and if a view exists in the theme directory it will be used instead of the original view.

NOTE: Just copy all necessary views from @akiraz2/yii2-blog/views/frontend/default to @app/views/blog and change!

How to change captcha in Comments ¶

Not yet...

User model ¶

Module Yii2-Blog use common\models\User, so if you use custom user component or Module like dektrium/yii2-user, you should create model under path common\models\User with overriding your user-model.

For example, `php
namespace common\models;

use dektrium\user\models\User as BaseUser;

class User extends BaseUser {

} `

CustomAdminAccessControl for backend ¶

For example, using dektrium/yii2-user

`php

'modules' => [
     'blog' => [
         'class' => akiraz2\blog\Module::class,
         ...
         'adminAccessControl' => 'common\components\AdminAccessControl',  
         ...      
     ],
 ], 

`

Create file common\components\AdminAccessControl.php

`php

namespace common\components;

use yii\filters\AccessControl;

class AdminAccessControl extends AccessControl
{

    public function init()
    {
        $this->rules[] =[
            'allow' => true,
            'roles' => ['@'],
            'matchCallback' => function () {
                return \Yii::$app->user->identity->getIsAdmin();
            }
        ];
        parent::init();
    }
}

`

Opengraph ¶

Please, add component dragonjet/yii2-opengraph to your project. php composer.phar require --prefer-dist dragonjet/yii2-opengraph "dev-master"

Configuration common/config/main.php or frontend/config/main.php

`php

'components' => [
    'opengraph' => [
        'class' => 'dragonjet\opengraph\OpenGraph',
    ],
    //....
],

`

Support ¶

If you have any questions or problems with Yii2-Blog you can ask them directly by using following email address: akiraz@bk.ru.

Contributing ¶

If you'd like to contribute, please fork the repository and use a feature branch. Pull requests are warmly welcome. +PSR-2 style coding. I can apply patch, PR in 2-3 days! If not, please write me akiraz@bk.ru

Licensing ¶

Yii2-Blog is released under the MIT License. See the bundled LICENSE.md for details.