Add empty line in documentation CAccessControlFilter for easier read #1839

Closed
gusdecool opened this Issue Dec 10, 2012 · 1 comment

Comments

Projects
None yet
3 participants
@gusdecool

In documentation at this link http://www.yiiframework.com/doc/api/1.1/CAccessControlFilter
Please add empty line for easier reading.

array(

  'allow',  // or 'deny'

  // optional, list of action IDs (case insensitive) that this rule applies to
  // if not specified, rule applies to all actions
  'actions'=>array('edit', 'delete'),

  // optional, list of controller IDs (case insensitive) that this rule applies to
  'controllers'=>array('post', 'admin/user'),

  // optional, list of usernames (case insensitive) that this rule applies to
  // Use * to represent all users, ? guest users, and @ authenticated users
  'users'=>array('thomas', 'kevin'),

  // optional, list of roles (case sensitive!) that this rule applies to.
  'roles'=>array('admin', 'editor'),

  // since version 1.1.11 you can pass parameters for RBAC bizRules
  'roles'=>array('updateTopic'=>array('topic'=>$topic))

  // optional, list of IP address/patterns that this rule applies to
  // e.g. 127.0.0.1, 127.0.0.*
  'ips'=>array('127.0.0.1'),

  // optional, list of request types (case insensitive) that this rule applies to
  'verbs'=>array('GET', 'POST'),

  // optional, a PHP expression whose value indicates whether this rule applies
  'expression'=>'!$user->isGuest && $user->level==2',

  // optional, the customized error message to be displayed
  // This option is available since version 1.1.1.
  'message'=>'Access Denied.',

  // optional, the denied method callback name, that will be called once the
 // access is denied, instead of showing the customized error message. It can also be
  // a valid PHP callback, including class method name (array(ClassName/Object, MethodName)),
 // or anonymous function (PHP 5.3.0+). The function/method signature should be as follows:
 // function foo($user, $rule) { ... }
 // where $user is the current application user object and $rule is this access rule.
  // This option is available since version 1.1.11.
  'deniedCallback'=>'redirectToDeniedMethod',
)
@maximal

This comment has been minimized.

Show comment Hide comment
@maximal

maximal Dec 10, 2012

Contributor

+1

Contributor

maximal commented Dec 10, 2012

+1

@mdomba mdomba closed this in 60094db Dec 11, 2012

mdomba added a commit that referenced this issue Dec 11, 2012

Merge pull request #1841 from rawtaz/1839-phpdoc-CAccessControlFilter
Fix #1839: Add more whitespace to phpdoc for CAccessControlFilter.
[ci skip]

@ghost ghost assigned mdomba Dec 11, 2012

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment