RightsModule.php

Go to the documentation of this file.

<?php
class RightsModule extends CWebModule
{
    public $superuserName = 'Admin';
    public $authenticatedName = 'Authenticated';
    public $userClass = 'User';
    public $userIdColumn = 'id';
    public $userNameColumn = 'username';
    public $enableBizRule = true;
    public $enableBizRuleData = false;
    public $displayDescription = true;
    public $flashSuccessKey = 'RightsSuccess';
    public $flashErrorKey = 'RightsError';
    public $install = false;
    public $baseUrl = '/rights';
    public $layout = 'rights.views.layouts.main';
    public $appLayout = 'application.views.layouts.main';
    public $cssFile;
    public $debug = false;

    private $_assetsUrl;

    public function init()
    {
        // Set required classes for import.
        $this->setImport(array(
            'rights.components.*',
            'rights.components.behaviors.*',
            'rights.components.dataproviders.*',
            'rights.controllers.*',
            'rights.models.*',
        ));

        // Set the required components.
        $this->setComponents(array(
            'authorizer' => array(
                'class' => 'RAuthorizer',
                'superuserName' => $this->superuserName,
            ),
            'generator' => array(
                'class' => 'RGenerator',
            ),
        ));

        // Normally the default controller is Assignment.
        $this->defaultController = 'assignment';

        // Set the installer if necessary.
        if ($this->install === true) {
            $this->setComponents(array(
                'installer' => array(
                    'class' => 'RInstaller',
                    'superuserName' => $this->superuserName,
                    'authenticatedName' => $this->authenticatedName,
                    'guestName' => Yii::app()->user->guestName,
                    'defaultRoles' => Yii::app()->authManager->defaultRoles,
                ),
            ));

            // When installing we need to set the default controller to Install.
            $this->defaultController = 'install';
        }
    }

    public function registerScripts()
    {
        // Get the url to the module assets
        $assetsUrl = $this->getAssetsUrl();

        // Register the necessary scripts
        $cs = Yii::app()->getClientScript();
        $cs->registerCoreScript('jquery');
        $cs->registerCoreScript('jquery.ui');
        $cs->registerScriptFile($assetsUrl.'/js/rights.js');
        $cs->registerCssFile($assetsUrl.'/css/core.css');

        // Make sure we want to register a style sheet.
        if ($this->cssFile !== false) {
            // Default style sheet is used unless one is provided.
            if ($this->cssFile === null) {
                $this->cssFile = $assetsUrl.'/css/default.css';
            } else {
                $this->cssFile = Yii::app()->request->baseUrl.$this->cssFile;
            }

            // Register the style sheet
            $cs->registerCssFile($this->cssFile);
        }
    }

    public function getAssetsUrl()
    {
        if ($this->_assetsUrl === null) {
            $assetsPath = Yii::getPathOfAlias('rights.assets');

            // We need to republish the assets if debug mode is enabled.
            if ($this->debug === true) {
                $this->_assetsUrl = Yii::app()->getAssetManager()->publish($assetsPath, false, -1, true);
            } else {
                $this->_assetsUrl = Yii::app()->getAssetManager()->publish($assetsPath);
            }
        }

        return $this->_assetsUrl;
    }

    public function getAuthorizer()
    {
        return $this->getComponent('authorizer');
    }

    public function getInstaller()
    {
        return $this->getComponent('installer');
    }

    public function getGenerator()
    {
        return $this->getComponent('generator');
    }

    public function getVersion()
    {
        return '1.3.0';
    }
}