Overview

Packages

  • application
    • commands
    • components
      • actions
      • filters
      • leftWidget
      • permissions
      • sortableWidget
      • util
      • webupdater
      • x2flow
        • actions
        • triggers
      • X2GridView
      • X2Settings
    • controllers
    • models
      • embedded
    • modules
      • accounts
        • controllers
        • models
      • actions
        • controllers
        • models
      • calendar
        • controllers
        • models
      • charts
        • models
      • contacts
        • controllers
        • models
      • docs
        • components
        • controllers
        • models
      • groups
        • controllers
        • models
      • marketing
        • components
        • controllers
        • models
      • media
        • controllers
        • models
      • mobile
        • components
      • opportunities
        • controllers
        • models
      • products
        • controllers
        • models
      • quotes
        • controllers
        • models
      • services
        • controllers
        • models
      • template
        • models
      • users
        • controllers
        • models
      • workflow
        • controllers
        • models
      • x2Leads
        • controllers
        • models
  • Net
  • None
  • PHP
  • system
    • base
    • caching
      • dependencies
    • collections
    • console
    • db
      • ar
      • schema
        • cubrid
        • mssql
        • mysql
        • oci
        • pgsql
        • sqlite
    • i18n
      • gettext
    • logging
    • test
    • utils
    • validators
    • web
      • actions
      • auth
      • filters
      • form
      • helpers
      • renderers
      • services
      • widgets
        • captcha
        • pagers
  • Text
    • Highlighter
  • zii
    • behaviors
    • widgets
      • grid
      • jui

Classes

  • CAccessControlFilter
  • CAccessRule
  • CAuthAssignment
  • CAuthItem
  • CAuthManager
  • CBaseUserIdentity
  • CDbAuthManager
  • CPhpAuthManager
  • CUserIdentity
  • CWebUser
  • X2WebUser
  • Overview
  • Package
  • Class
  • Tree

Class CAuthAssignment

CAuthAssignment represents an assignment of a role to a user. It includes additional assignment information such as bizRule and data. Do not create a CAuthAssignment instance using the 'new' operator. Instead, call IAuthManager::assign().

CComponent
Extended by CAuthAssignment
Package: system\web\auth
Copyright: 2008-2013 Yii Software LLC
License: http://www.yiiframework.com/license/
Author: Qiang Xue <qiang.xue@gmail.com>
Since: 1.0
Located at x2engine/framework/web/auth/CAuthAssignment.php
Methods summary
public
# __construct( IAuthManager $auth, string $itemName, mixed $userId, string $bizRule = null, mixed $data = null )

Constructor.

Constructor.

Parameters

$auth
IAuthManager
$auth the authorization manager
$itemName
string
$itemName authorization item name
$userId
mixed
$userId user ID (see IWebUser::getId())
$bizRule
string
$bizRule the business rule associated with this assignment
$data
mixed
$data additional data for this assignment
public mixed
# getUserId( )

Returns

mixed
user ID (see IWebUser::getId())
public string
# getItemName( )

Returns

string
the authorization item name
public string
# getBizRule( )

Returns

string
the business rule associated with this assignment
public
# setBizRule( string $value )

Parameters

$value
string
$value the business rule associated with this assignment
public mixed
# getData( )

Returns

mixed
additional data for this assignment
public
# setData( mixed $value )

Parameters

$value
mixed
$value additional data for this assignment
Methods inherited from CComponent
__call(), __get(), __isset(), __set(), __unset(), asa(), attachBehavior(), attachBehaviors(), attachEventHandler(), canGetProperty(), canSetProperty(), detachBehavior(), detachBehaviors(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), getEventHandlers(), hasEvent(), hasEventHandler(), hasProperty(), raiseEvent()
Magic properties summary
public mixed $userId
#

User ID (see IWebUser::getId()).

User ID (see IWebUser::getId()).

public string $itemName
#

The authorization item name.

The authorization item name.

public string $bizRule
#

The business rule associated with this assignment.

The business rule associated with this assignment.

public mixed $data
#

Additional data for this assignment.

Additional data for this assignment.

API documentation generated by ApiGen 2.8.0