Rights.php

Go to the documentation of this file.

<?php
class Rights
{
    const PERM_NONE = 0;
    const PERM_DIRECT = 1;
    const PERM_INHERITED = 2;

    private static $_m;
    private static $_a;

    public static function assign($itemName, $userId, $bizRule = null, $data = null)
    {
        $authorizer = self::getAuthorizer();

        return $authorizer->authManager->assign($itemName, $userId, $bizRule, $data);
    }

    public static function revoke($itemName, $userId)
    {
        $authorizer = self::getAuthorizer();

        return $authorizer->authManager->revoke($itemName, $userId);
    }

    public static function getAssignedRoles($userId = null, $sort = true)
    {
        $user = Yii::app()->getUser();
        if ($userId === null && $user->isGuest === false) {
            $userId = $user->id;
        }

        $authorizer = self::getAuthorizer();

        return $authorizer->getAuthItems(CAuthItem::TYPE_ROLE, $userId, null, $sort);
    }

    public static function getBaseUrl()
    {
        $module = self::module();

        return Yii::app()->createUrl($module->baseUrl);
    }

    public static function getAuthItemOptions()
    {
        return array(
            CAuthItem::TYPE_OPERATION => Rights::t('core', 'Operation'),
            CAuthItem::TYPE_TASK => Rights::t('core', 'Task'),
            CAuthItem::TYPE_ROLE => Rights::t('core', 'Role'),
        );
    }

    public static function getAuthItemTypeName($type)
    {
        $options = self::getAuthItemOptions();
        if (isset($options[ $type ]) === true) {
            return $options[ $type ];
        } else {
            throw new CException(Rights::t('core', 'Invalid authorization item type.'));
        }
    }

    public static function getAuthItemTypeNamePlural($type)
    {
        switch ((int) $type) {
            case CAuthItem::TYPE_OPERATION: return Rights::t('core', 'Operations');
            case CAuthItem::TYPE_TASK: return Rights::t('core', 'Tasks');
            case CAuthItem::TYPE_ROLE: return Rights::t('core', 'Roles');
            default: throw new CException(Rights::t('core', 'Invalid authorization item type.'));
        }
    }

    public static function getAuthItemRoute($type)
    {
        switch ((int) $type) {
            case CAuthItem::TYPE_OPERATION: return array('authItem/operations');
            case CAuthItem::TYPE_TASK: return array('authItem/tasks');
            case CAuthItem::TYPE_ROLE: return array('authItem/roles');
            default: throw new CException(Rights::t('core', 'Invalid authorization item type.'));
        }
    }

    public static function getValidChildTypes($type)
    {
        switch ((int) $type) {
            // Roles can consist of any type of authorization items
            case CAuthItem::TYPE_ROLE: return;
            // Tasks can consist of other tasks and operations
            case CAuthItem::TYPE_TASK: return array(CAuthItem::TYPE_TASK, CAuthItem::TYPE_OPERATION);
            // Operations can consist of other operations
            case CAuthItem::TYPE_OPERATION: return array(CAuthItem::TYPE_OPERATION);
            // Invalid type
            default: throw new CException(Rights::t('core', 'Invalid authorization item type.'));
        }
    }

    public static function getAuthItemSelectOptions($type = null, $exclude = array())
    {
        $authorizer = self::getAuthorizer();
        $items = $authorizer->getAuthItems($type, null, null, true, $exclude);

        return self::generateAuthItemSelectOptions($items, $type);
    }

    public static function getParentAuthItemSelectOptions(CAuthItem $parent, $type = null, $exclude = array())
    {
        $authorizer = self::getAuthorizer();
        $items = $authorizer->getAuthItems($type, null, $parent, true, $exclude);

        return self::generateAuthItemSelectOptions($items, $type);
    }

    protected static function generateAuthItemSelectOptions($items, $type)
    {
        $selectOptions = array();

        // We have multiple types, nest the items under their types
           if ($type !== (int) $type) {
               foreach ($items as $itemName => $item) {
                   $selectOptions[ self::getAuthItemTypeNamePlural($item->type) ][ $itemName ] = $item->getNameText();
               }
           }
        // We have only one type
        else {
            foreach ($items as $itemName => $item) {
                $selectOptions[ $itemName ] = $item->getNameText();
            }
        }

        return $selectOptions;
    }

    public static function getDataCsrf()
    {
        return ($csrf = self::getCsrfParam()) !== null ? ', '.$csrf : '';
    }

    public static function getCsrfParam()
    {
        if (Yii::app()->request->enableCsrfValidation === true) {
            $csrfTokenName = Yii::app()->request->csrfTokenName;
            $csrfToken = Yii::app()->request->csrfToken;

            return "'$csrfTokenName':'$csrfToken'";
        } else {
            return;
        }
    }

    public static function powered()
    {
        $module = self::module();

        return 'Secured with <a href="http://www.yiiframework.com/extension/rights" rel="external">Rights</a> version '.$module->getVersion().'.';
    }

    public static function module()
    {
        if (isset(self::$_m) === false) {
            self::$_m = self::findModule();
        }

        return self::$_m;
    }

    private static function findModule(CModule $module = null)
    {
        if ($module === null) {
            $module = Yii::app();
        }

        if (($m = $module->getModule('rights')) !== null) {
            return $m;
        }

        foreach ($module->getModules() as $id => $c) {
            if (($m = self::findModule($module->getModule($id))) !== null) {
                return $m;
            }
        }

        return;
    }

    public static function getAuthorizer()
    {
        if (isset(self::$_a) === false) {
            self::$_a = self::module()->getAuthorizer();
        }

        return self::$_a;
    }

    public static function t($category, $message, $params = array(), $source = null, $language = null)
    {
        return Yii::t('RightsModule.'.$category, $message, $params, $source, $language);
    }
}