[Sommaire] [Imprimer]

   1  <?xml version="1.0" encoding="iso-8859-1"?>
   2  <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3    <html xmlns="http://www.w3.org/1999/xhtml">
   4          <head>
   5              <!-- template designed by Marco Von Ballmoos -->
   6              <title>Docs For Class TAuthorizationRule</title>
   7              <link rel="stylesheet" href="../media/stylesheet.css" />
   8              <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
   9          </head>
  10          <body>
  11              <div class="page-body">            
  12  <h2 class="class-name">Class TAuthorizationRule</h2>
  13  
  14  <a name="sec-description"></a>
  15  <div class="info-box">
  16      <div class="info-box-title">Description</div>
  17      <div class="nav-bar">
  18                      <span class="disabled">Description</span> |
  19                                                              <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  20                          
  21                      </div>
  22      <div class="info-box-body">
  23                  <!-- ========== Info from phpDoc block ========= -->
  24  <p class="short-description">TAuthorizationRule class</p>
  25  <p class="description"><p>TAuthorizationRule represents a single authorization rule.  A rule is specified by an action (required), a list of users (optional),  a list of roles (optional), and a verb (optional).  Action can be either 'allow' or 'deny'.  Guest (anonymous, unauthenticated) users are represented by question mark '?'.  All users (including guest users) are represented by asterisk '*'.  Users/roles are case-insensitive.  Different users/roles are separated by comma ','.  Verb can be either 'get' or 'post'. If it is absent, it means both.</p></p>
  26      <ul class="tags">
  27                  <li><span class="field">since:</span> 3.0</li>
  28                  <li><span class="field">version:</span> $Id: TAuthorizationRule.php 1423 2006-09-16 19:16:14Z xue $</li>
  29                  <li><span class="field">author:</span> Qiang Xue &lt;<a href="mailto:qiang.xue@gmail.com">qiang.xue@gmail.com</a>&gt;</li>
  30              </ul>
  31          <p class="notes">
  32              Located in <a class="field" href="_Security_TAuthorizationRule_php.html">/Security/TAuthorizationRule.php</a> (line <span class="field">30</span>)
  33          </p>
  34          
  35                  
  36          <pre><a href="../System/TComponent.html">TComponent</a>
  37     |
  38     --TAuthorizationRule</pre>
  39      
  40              </div>
  41  </div>
  42  
  43  
  44  
  45  
  46      <a name="sec-method-summary"></a>
  47      <div class="info-box">
  48          <div class="info-box-title">Method Summary</span></div>
  49          <div class="nav-bar">
  50              <a href="#sec-description">Description</a> |
  51                                                  <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  52          </div>
  53          <div class="info-box-body">            
  54              <div class="method-summary">
  55                                  
  56                  <div class="method-definition">
  57                                              <span class="method-result">TAuthorizationRule</span>
  58                                          <a href="#__construct" title="details" class="method-name">__construct</a>
  59                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$action</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$users</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$roles</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$verb</span> = <span class="var-default">''</span>])
  60                                      </div>
  61                                  
  62                  <div class="method-definition">
  63                                              <span class="method-result">string</span>
  64                                          <a href="#getAction" title="details" class="method-name">getAction</a>
  65                                          ()
  66                                      </div>
  67                                  
  68                  <div class="method-definition">
  69                                              <span class="method-result">boolean</span>
  70                                          <a href="#getEveryoneApplied" title="details" class="method-name">getEveryoneApplied</a>
  71                                          ()
  72                                      </div>
  73                                  
  74                  <div class="method-definition">
  75                                              <span class="method-result">boolean</span>
  76                                          <a href="#getGuestApplied" title="details" class="method-name">getGuestApplied</a>
  77                                          ()
  78                                      </div>
  79                                  
  80                  <div class="method-definition">
  81                                              <span class="method-result">array</span>
  82                                          <a href="#getRoles" title="details" class="method-name">getRoles</a>
  83                                          ()
  84                                      </div>
  85                                  
  86                  <div class="method-definition">
  87                                              <span class="method-result">array</span>
  88                                          <a href="#getUsers" title="details" class="method-name">getUsers</a>
  89                                          ()
  90                                      </div>
  91                                  
  92                  <div class="method-definition">
  93                                              <span class="method-result">string</span>
  94                                          <a href="#getVerb" title="details" class="method-name">getVerb</a>
  95                                          ()
  96                                      </div>
  97                                  
  98                  <div class="method-definition">
  99                                              <span class="method-result">integer</span>
 100                                          <a href="#isUserAllowed" title="details" class="method-name">isUserAllowed</a>
 101                                              (<span class="var-type">IUser</span>&nbsp;<span class="var-name">$user</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$verb</span>)
 102                                      </div>
 103                              </div>
 104          </div>
 105      </div>        
 106  
 107      
 108      <a name="sec-methods"></a>
 109      <div class="info-box">
 110          <div class="info-box-title">Methods</div>
 111          <div class="nav-bar">
 112              <a href="#sec-description">Description</a> |
 113                                                                  <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
 114                          
 115          </div>
 116          <div class="info-box-body">
 117              <A NAME='method_detail'></A>
 118  <a name="method__construct" id="__construct"><!-- --></a>
 119  <div class="evenrow">
 120      
 121      <div class="method-header">
 122          <span class="method-title">Constructor __construct</span> (line <span class="line-number">64</span>)
 123      </div> 
 124      
 125      <!-- ========== Info from phpDoc block ========= -->
 126  <p class="short-description">Constructor.</p>
 127      <ul class="tags">
 128                  <li><span class="field">access:</span> public</li>
 129              </ul>
 130      
 131      <div class="method-signature">
 132          <span class="method-result">TAuthorizationRule</span>
 133          <span class="method-name">
 134              __construct
 135          </span>
 136                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$action</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$users</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$roles</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$verb</span> = <span class="var-default">''</span>])
 137              </div>
 138      
 139              <ul class="parameters">
 140                      <li>
 141                  <span class="var-type">string</span>
 142                  <span class="var-name">$action</span><span class="var-description">: action, either 'deny' or 'allow'</span>            </li>
 143                      <li>
 144                  <span class="var-type">string</span>
 145                  <span class="var-name">$users</span><span class="var-description">: a comma separated user list</span>            </li>
 146                      <li>
 147                  <span class="var-type">string</span>
 148                  <span class="var-name">$roles</span><span class="var-description">: a comma separated role list</span>            </li>
 149                      <li>
 150                  <span class="var-type">string</span>
 151                  <span class="var-name">$verb</span><span class="var-description">: verb, can be empty, 'get', or 'post'</span>            </li>
 152                  </ul>
 153          
 154          
 155      </div>
 156  <a name="methodgetAction" id="getAction"><!-- --></a>
 157  <div class="oddrow">
 158      
 159      <div class="method-header">
 160          <span class="method-title">getAction</span> (line <span class="line-number">105</span>)
 161      </div> 
 162      
 163      <!-- ========== Info from phpDoc block ========= -->
 164      <ul class="tags">
 165                  <li><span class="field">return:</span> action, either 'allow' or 'deny'</li>
 166                  <li><span class="field">access:</span> public</li>
 167              </ul>
 168      
 169      <div class="method-signature">
 170          <span class="method-result">string</span>
 171          <span class="method-name">
 172              getAction
 173          </span>
 174                  ()
 175              </div>
 176      
 177          
 178          
 179      </div>
 180  <a name="methodgetEveryoneApplied" id="getEveryoneApplied"><!-- --></a>
 181  <div class="evenrow">
 182      
 183      <div class="method-header">
 184          <span class="method-title">getEveryoneApplied</span> (line <span class="line-number">145</span>)
 185      </div> 
 186      
 187      <!-- ========== Info from phpDoc block ========= -->
 188      <ul class="tags">
 189                  <li><span class="field">return:</span> if this rule applies to everyone</li>
 190                  <li><span class="field">access:</span> public</li>
 191              </ul>
 192      
 193      <div class="method-signature">
 194          <span class="method-result">boolean</span>
 195          <span class="method-name">
 196              getEveryoneApplied
 197          </span>
 198                  ()
 199              </div>
 200      
 201          
 202          
 203      </div>
 204  <a name="methodgetGuestApplied" id="getGuestApplied"><!-- --></a>
 205  <div class="oddrow">
 206      
 207      <div class="method-header">
 208          <span class="method-title">getGuestApplied</span> (line <span class="line-number">137</span>)
 209      </div> 
 210      
 211      <!-- ========== Info from phpDoc block ========= -->
 212      <ul class="tags">
 213                  <li><span class="field">return:</span> if this rule applies to everyone</li>
 214                  <li><span class="field">access:</span> public</li>
 215              </ul>
 216      
 217      <div class="method-signature">
 218          <span class="method-result">boolean</span>
 219          <span class="method-name">
 220              getGuestApplied
 221          </span>
 222                  ()
 223              </div>
 224      
 225          
 226          
 227      </div>
 228  <a name="methodgetRoles" id="getRoles"><!-- --></a>
 229  <div class="evenrow">
 230      
 231      <div class="method-header">
 232          <span class="method-title">getRoles</span> (line <span class="line-number">121</span>)
 233      </div> 
 234      
 235      <!-- ========== Info from phpDoc block ========= -->
 236      <ul class="tags">
 237                  <li><span class="field">return:</span> list of roles</li>
 238                  <li><span class="field">access:</span> public</li>
 239              </ul>
 240      
 241      <div class="method-signature">
 242          <span class="method-result">array</span>
 243          <span class="method-name">
 244              getRoles
 245          </span>
 246                  ()
 247              </div>
 248      
 249          
 250          
 251      </div>
 252  <a name="methodgetUsers" id="getUsers"><!-- --></a>
 253  <div class="oddrow">
 254      
 255      <div class="method-header">
 256          <span class="method-title">getUsers</span> (line <span class="line-number">113</span>)
 257      </div> 
 258      
 259      <!-- ========== Info from phpDoc block ========= -->
 260      <ul class="tags">
 261                  <li><span class="field">return:</span> list of user IDs</li>
 262                  <li><span class="field">access:</span> public</li>
 263              </ul>
 264      
 265      <div class="method-signature">
 266          <span class="method-result">array</span>
 267          <span class="method-name">
 268              getUsers
 269          </span>
 270                  ()
 271              </div>
 272      
 273          
 274          
 275      </div>
 276  <a name="methodgetVerb" id="getVerb"><!-- --></a>
 277  <div class="evenrow">
 278      
 279      <div class="method-header">
 280          <span class="method-title">getVerb</span> (line <span class="line-number">129</span>)
 281      </div> 
 282      
 283      <!-- ========== Info from phpDoc block ========= -->
 284      <ul class="tags">
 285                  <li><span class="field">return:</span> verb, may be empty, 'get', or 'post'.</li>
 286                  <li><span class="field">access:</span> public</li>
 287              </ul>
 288      
 289      <div class="method-signature">
 290          <span class="method-result">string</span>
 291          <span class="method-name">
 292              getVerb
 293          </span>
 294                  ()
 295              </div>
 296      
 297          
 298          
 299      </div>
 300  <a name="methodisUserAllowed" id="isUserAllowed"><!-- --></a>
 301  <div class="oddrow">
 302      
 303      <div class="method-header">
 304          <span class="method-title">isUserAllowed</span> (line <span class="line-number">153</span>)
 305      </div> 
 306      
 307      <!-- ========== Info from phpDoc block ========= -->
 308      <ul class="tags">
 309                  <li><span class="field">return:</span> 1 if the user is allowed, -1 if the user is denied, 0 if the rule does not apply to the user</li>
 310                  <li><span class="field">access:</span> public</li>
 311              </ul>
 312      
 313      <div class="method-signature">
 314          <span class="method-result">integer</span>
 315          <span class="method-name">
 316              isUserAllowed
 317          </span>
 318                      (<span class="var-type">IUser</span>&nbsp;<span class="var-name">$user</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$verb</span>)
 319              </div>
 320      
 321          
 322          
 323      </div>
 324                              <h4>Inherited Methods</h4>
 325                  <a name='inherited_methods'><!-- --></a>    
 326                                      <!-- =========== Summary =========== -->
 327                      <p>Inherited From <span class="classname"><a href="../System/TComponent.html">TComponent</a></span></p>
 328                      <blockquote>
 329                                                      <span class="method-name"><a href="../System/TComponent.html#methodaddParsedObject">TComponent::addParsedObject()</a></span><br>
 330                                                      <span class="method-name"><a href="../System/TComponent.html#methodattachEventHandler">TComponent::attachEventHandler()</a></span><br>
 331                                                      <span class="method-name"><a href="../System/TComponent.html#methodcanGetProperty">TComponent::canGetProperty()</a></span><br>
 332                                                      <span class="method-name"><a href="../System/TComponent.html#methodcanSetProperty">TComponent::canSetProperty()</a></span><br>
 333                                                      <span class="method-name"><a href="../System/TComponent.html#methodcreatedOnTemplate">TComponent::createdOnTemplate()</a></span><br>
 334                                                      <span class="method-name"><a href="../System/TComponent.html#methoddetachEventHandler">TComponent::detachEventHandler()</a></span><br>
 335                                                      <span class="method-name"><a href="../System/TComponent.html#methodevaluateExpression">TComponent::evaluateExpression()</a></span><br>
 336                                                      <span class="method-name"><a href="../System/TComponent.html#methodevaluateStatements">TComponent::evaluateStatements()</a></span><br>
 337                                                      <span class="method-name"><a href="../System/TComponent.html#methodgetEventHandlers">TComponent::getEventHandlers()</a></span><br>
 338                                                      <span class="method-name"><a href="../System/TComponent.html#methodgetSubProperty">TComponent::getSubProperty()</a></span><br>
 339                                                      <span class="method-name"><a href="../System/TComponent.html#methodhasEvent">TComponent::hasEvent()</a></span><br>
 340                                                      <span class="method-name"><a href="../System/TComponent.html#methodhasEventHandler">TComponent::hasEventHandler()</a></span><br>
 341                                                      <span class="method-name"><a href="../System/TComponent.html#methodhasProperty">TComponent::hasProperty()</a></span><br>
 342                                                      <span class="method-name"><a href="../System/TComponent.html#methodraiseEvent">TComponent::raiseEvent()</a></span><br>
 343                                                      <span class="method-name"><a href="../System/TComponent.html#methodsetSubProperty">TComponent::setSubProperty()</a></span><br>
 344                                                      <span class="method-name"><a href="../System/TComponent.html#method__get">TComponent::__get()</a></span><br>
 345                                                      <span class="method-name"><a href="../System/TComponent.html#method__set">TComponent::__set()</a></span><br>
 346                                              </blockquote>
 347                                          
 348          </div>
 349      </div>
 350  
 351  
 352      <p class="notes" id="credit">
 353          Documentation generated on Mon, 04 Dec 2006 11:25:54 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC4</a>
 354      </p>
 355      </div></body>
 356  </html>