\FAACommandLineInterface

Summary

Methods

Properties

Constants

Execute()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

CronStats()
doCleanSearchAndCache()
doUpdate()
registerGroup()
resetUserPassword()
registerUser()

No private properties found

N/A

Methods

Execute()

Execute(string  $command,array  $arguments = array())

Execute a command

All currently available commands are documented in the install.sh This includes a documentation about the arguments as well.

Parameters

string	$command	The command to execute
array	$arguments	The additional arguments for this call

CronStats()

CronStats(array  $ignore,boolean  $one_line): \FAA\Obj\Result

Get list of cron execution progress

Parameters

array	$ignore	List to ignore
boolean	$one_line	Return in one line

Returns

\FAA\Obj\Result

doCleanSearchAndCache()

doCleanSearchAndCache(  $full = false)

Parameters

$full

doUpdate()

doUpdate()

registerGroup()

registerGroup(string  $alias,string  $name,integer  $level = 10): integer

Create group Creates a new user group and stores it in the encrypted storage

Parameters

string	$alias	The group alias, only \w is allowed here
string	$name	The speaking group name
integer	$level	The groups access level. 0 is the lowest 127 the highest

Returns

integer —

A function response code

resetUserPassword()

resetUserPassword(  $alias,  $password): integer

Create new user password

Parameters

	$alias
	$password

Returns

integer

registerUser()

registerUser(string  $alias,string  $email_address,string  $password,string  $surname,string  $first_name,string  $group): integer

Register user

Register a new user with alias, email, a default group and names The user will be created with default timezone and default date format.

Parameters

string	$alias	The alias
string	$email_address	The users email address
string	$password	New password
string	$surname	The users last name
string	$first_name	The first name
string	$group	The initial group of this users

Returns

integer —

0 When no error occurred otherwise a negative value