To be compatible with the auth package, containers must impliment this interface.
Any potential AuthContainer must impliment the methods of this interface (they don't have to impliment the interface explicitly though!).
| package | dstruct_auth |
|---|
authenticate(string $username, string $password) : boolean
The operation of the authenticate method is entirely up to the implimenting class. This allows the container to integrate and authenticate with whatever system you choose. The class must return a boolean with true as a successfull authentication.
| see | \Perm::authenticate() |
|---|
string
string
booleangetDisplayName(boolean $raw) : string
If $raw is false then the return should be encoded to be output as html.
boolean
stringgetGroups() : object
objectgetID() : string
stringhasGroups() : boolean
booleanloadByID(string $id) : object
string
objectusernameExists(string $username) : boolean
This kind of call would usually be made on the Object Collection class,, but the auth package gets no knowledge of these collections so must make the call to the implimenting class which will usually pass the call on to the collection.
string
boolean