pclib  2.3.2
Lightweight PHP framework
Public Member Functions | Data Fields | Protected Member Functions | Protected Attributes
AuthConsole Class Reference

Execute auth console commands, see execute() method. More...

Inheritance diagram for AuthConsole:
AuthBase BaseObject

Public Member Functions

 executeFile ($fileName)
 Execute ATERM batch file. More...
 
 execute ($line)
 Execute ATERM commands. More...
 
- Public Member Functions inherited from AuthBase
 __construct ()
 Constructor - load config parameters.
 
 passwordHash ($password)
 Return password hash. More...
 
 passwordHashVerify ($password, $hash)
 Verify password hash. More...
 
 setError ($message)
 Add error message into ->errors variable. More...
 
- Public Member Functions inherited from BaseObject
 loadDefaults ($className=null)
 Load default parameters of class $className into object instance.
 
 setProperties (array $defaults)
 Set public properties of object from the array. More...
 
 addEvent ($name, $callback)
 Add event handler to $object->$name property. More...
 
 toArray ()
 Convert object to array. More...
 

Data Fields

 $db
 var Db
 
 $messages = array()
 Array of AuthConsole messages.
 
- Data Fields inherited from AuthBase
 $translator
 var Translator
 
 $errors = array()
 Array of error messages (if any)
 
 $secret
 Secret string used for enpowerment of md5 hash.
 
 $passwordAlgo
 Password algorhitm - can be 'md5' or 'bcrypt'.
 
 $passwordCost = 10
 Bcrypt cost. More...
 
 $throwsExceptions = false
 Throws exceptions instead of just collecting errors in ->errors.
 
 $onError
 Occurs on auth error. More...
 
- Data Fields inherited from BaseObject
 $onNewInstance
 Occurs when new instance of the class is created. More...
 
 $onMissingMethod
 Occurs when called method does not exist. More...
 
 $serviceLocator
 var function() Return service object when requested with service(). More...
 

Protected Member Functions

 userFilter (array $terms)
 Build filter for querying users. More...
 
 query (array $terms)
 Perform '?entity' commands. More...
 
 executeCmd ($cmd)
 Execute one ATERM command. More...
 
 message ($message, $params)
 Set message to $this->messages. More...
 
- Protected Member Functions inherited from AuthBase
 log ($category, $messageId, $message=null, $itemId=null)
 log security issue using App->logger. More...
 
- Protected Member Functions inherited from BaseObject
 fireEvent ($name, array $args=array())
 Run all event handlers in $object->$name property. More...
 
 service ($service, $default=null)
 Try acquire $service and load it into property $this->$service. More...
 

Protected Attributes

 $mng
 var AuthManager
 
- Protected Attributes inherited from AuthBase
 $app
 var App
 

Additional Inherited Members

- Static Public Member Functions inherited from BaseObject
static defaults ()
 Set or retireve default parameters of the object. More...
 

Detailed Description

Execute auth console commands, see execute() method.

Member Function Documentation

execute (   $line)

Execute ATERM commands.

Generated messages are stored in $this->messages.

Parameters
string$lineATERM commands
Returns
bool $ok See ATERM commands for description of aterm language.
executeCmd (   $cmd)
protected

Execute one ATERM command.

executeFile (   $fileName)

Execute ATERM batch file.

Generated messages are stored in $this->messages.

Parameters
string$fileNameFilename of batch file
Returns
bool $ok See ATERM commands for description of aterm language.
message (   $message,
  $params 
)
protected

Set message to $this->messages.

query ( array  $terms)
protected

Perform '?entity' commands.

Store result in $this->messages. Used in function execute().

userFilter ( array  $terms)
protected

Build filter for querying users.

Return filter array. Used in query().


The documentation for this class was generated from the following file: