zanevskyas/yii2-helpers

Kakadu helpers for Yii2

v1.0.0 2022-10-05 09:51 UTC

Requires

• php: >=7.1
• frostealth/yii2-aws-s3: ^2.1
• kakadu-dev/yii2-base-helpers: ^1.0
• matthew-p/yii2-services: ^3.0
• yiisoft/yii2-queue: ^2.0.0
• yiisoft/yii2-redis: ^2.0.0

MIT

• Ярмолюк Михаил

• helpers
• extension
• yii2
• kakadu

README

Yii2 Helpers

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist zanevskyas/yii2-helpers "@dev"

or add

"zanevskyas/yii2-helpers": "@dev"

to the require section of your composer.json file.

RBAC

Add below code to console main configuration:

'controllerMap' => [
    ...
    'rbac'    => [
        'class'      => Kakadu\Yii2Helpers\Rbac::class,
        'rbacConfig' => RbacConfig::class,
    ],
    ...
]

Create RbacConfigClass in common/rbac, sample:

abstract class RbacConfig
{
    /**
     * @var string|Enum
     */
    public static $roleClass = CustomerRole::class;

    /**
     * @var array
     */
    public static $roleRelationships = [
        CustomerRole::CUSTOMER,
        CustomerRole::AUTHOR      => [
            CustomerRole::CUSTOMER,
        ],
        ...
    ];

    /**
     * @var array|PermissionCustomer
     */
    public static $permissions = [
        // Customers
        PermissionCustomer::class,
        PermissionSettings::class,

        // Countries
        ...
        // Cities
        ...
    ];
}

Create permissions and rules...

Permission example:

abstract class PermissionSettings
{
    public const CREATE     = 'CUSTOMER_SETTINGS_CREATE';
    public const UPDATE     = 'CUSTOMER_SETTINGS_UPDATE';
    public const UPDATE_OWN = 'CUSTOMER_SETTINGS_UPDATE_OWN';
    public const VIEW       = 'CUSTOMER_SETTINGS_VIEW';
    public const VIEW_OWN   = 'CUSTOMER_SETTINGS_VIEW_OWN';

    /**
     * @var array
     */
    public static $ruleRelationships = [
        self::UPDATE_OWN => RuleOwnerCustomerSettings::class,
        self::VIEW_OWN   => RuleOwnerCustomerSettings::class,
    ];

    /**
     * @var array
     */
    public static $permissionRelationships = [
        self::UPDATE_OWN => [
            self::UPDATE,
        ],
        self::VIEW_OWN   => [
            self::VIEW,
        ],
    ];

    /**
     * @var array
     */
    public static $roleRelationships = [
        CustomerRole::CUSTOMER => [
            self::UPDATE_OWN,
            self::VIEW_OWN,
        ],
        CustomerRole::ADMIN    => [
            self::CREATE,
            self::UPDATE,
            self::VIEW,
        ],
    ];
}

Run console command to generate rbac cache:

php yii rbac/init

That's all. Check it.