Overview
Prev Solar_Role_Adapter_File Next

Overview

Adapter to fetch roles from a Unix-style groups file.

The file format is "group:user1,user2,user3\n".

sysadmin:pmjones
writer:pmjones,boshag,agtsmith
editor:pmjones,agtsmith

Package

This class is part of the Solar_Role package.

Inheritance:

Configuration Keys

  • cache: A Solar_Cache dependency injection. Default is to create a Solar_Cache_Adapter_Session object internal to this instance to retain the role list.

  • file: Where the roles file is located.

Constants

None.

Public Properties

The Solar_Role_Adapter_File class has no public properties; try the list of all properties.

Public Methods

These are all the public methods in the Solar_Role_Adapter_File class.

You can also view the list of all public, protected, and private methods.

__call()

Provides magic "isRoleName()" to map to "is('role_name')".

__construct()

Constructor.

__destruct()

Default destructor; does nothing other than provide a safe fallback for calls to parent::__destruct().

add()

Appends a single role to the existing list of roles.

addList()

Appends a list of roles to the existing list of roles.

dump()

Convenience method for getting a dump the whole object, or one of its properties, or an external variable.

fetch()

Fetches the roles for a username.

getList()

Gets the list of all loaded roles for the user.

is()

Check to see if a user is in a role.

isAll()

Check to see if a user is in all of the listed roles.

isAny()

Check to see if a user is in any of the listed roles.

load()

Load the list of roles for the given user from the adapter.

locale()

Looks up class-specific locale strings based on a key.

reset()

Resets the role list to nothing.

setList()

Sets the list, overriding what is there already.

Prev Up Next
Solar_Role_Adapter_File Home Configuration

Local