API16

JRules/allow: Difference between revisions

From Joomla! Documentation

m clean up
m preparing for archive only
 
Line 4: Line 4:




{{subst:Description:JRules/allow}}
 


===Syntax===
===Syntax===
Line 48: Line 48:




{{subst:SeeAlso:JRules/allow}}
 


===Examples===
===Examples===
<CodeExamplesForm />
=== Code Examples ===
<dpl>
<dpl>
  noresultsheader=\n
  noresultsheader=\n
  category=allow
  category=allow
  category=JRules
  category=JRules
  category=CodeExample
  namespace=CodeExample
  category=MethodExample
  category=MethodExample
  include=*
  include=*
  format= ,,,
  format= ,,,
</dpl>
</dpl>

Latest revision as of 02:02, 25 March 2017

Description

Checks that an action can be performed by an identity.



Syntax

allow($action, $identity)
Parameter Name Default Value Description
$action The name of the action.
$identity An integer representing the identity, or an array of identities

Returns

mixed

Defined in

libraries/joomla/access/rules.php

Importing

jimport( 'joomla.access.rules' );

Source Body

public function allow($action, $identity)
{
// TODO: Remove debug when finished testing.
//echo "<br>Action: $action, ".print_r($identity, 1);
        // Check we have information about this action.
        if (isset($this->_data[$action])) {
//print_r($this->_data[$action]);
                return $this->_data[$action]->allow($identity);
        }
        return null;
}



Examples

Code Examples