PHP Class Phergie_Plugin_Acl, phergie

Configuration settings: acl.whitelist - mapping of user hostmask patterns (optionally by host) to plugins and methods where those plugins and methods will only be accessible to those users (i.e. and inaccessible to other users) acl.blacklist - mapping of user hostmasks (optionally by host) to plugins and methods where where those plugins and methods will be inaccessible to those users but accessible to other users acl.ops - TRUE to automatically give access to whitelisted plugins and methods to users with ops for events they initiate in channels where they have ops The whitelist and blacklist settings are formatted like so:


'acl.whitelist' => array(
    'hostname1' => array(
        'pattern1' => array(
            'plugins' => array(
                'ShortPluginName'
            ),
            'methods' => array(
                'methodName'
            )
        ),
    )
),

The hostname array dimension is optional; if not used, rules will be applied across all connections. The pattern is a user hostmask pattern where asterisks (*) are used for wildcards. Plugins and methods do not need to be set to empty arrays if they are not used; simply exclude them.

See link: http://pear.phergie.org/package/Phergie_Plugin_Acl

Author: Phergie Development Team ([email protected])

Inheritance: extends Phergie_Plugin_Abstract

Show file Open project: phergie/phergie

Public Methods

Method	Description
onLoad ( ) : void	Checks for permission settings and removes the plugin if none are set.
postDispatch ( ) : void	Clears filters on the plugin handler iterator.
preEvent ( ) : void	Checks permission settings and short-circuits event processing for blacklisted users.

Protected Methods

Method	Description
applyRules ( Phergie_Plugin_Iterator $iterator, array $rules ) : void	Applies a set of rules to a plugin handler iterator.

Method Details

applyRules() protected method

Applies a set of rules to a plugin handler iterator.

protected applyRules ( Phergie_Plugin_Iterator $iterator, array $rules ) : void
$iterator	Phergie_Plugin_Iterator	Iterator to receive rules
$rules	array	Associate array containing either a 'plugins' key pointing to an array containing plugin short names to filter, a 'methods' key pointing to an array containing method names to filter, or both
return	void

onLoad() public method

Checks for permission settings and removes the plugin if none are set.

public onLoad ( ) : void
return	void

postDispatch() public method

Clears filters on the plugin handler iterator.

public postDispatch ( ) : void
return	void

preEvent() public method

Checks permission settings and short-circuits event processing for blacklisted users.

public preEvent ( ) : void
return	void