Open Journal Systems  3.3.0
MergeUsersTool Class Reference
Inheritance diagram for MergeUsersTool:
CommandLineTool

Public Member Functions

 __construct ($argv=array())
 
 execute ()
 
 usage ()
 

Data Fields

 $mergeSpecifiers
 
 $targetSpecifier
 
- Data Fields inherited from CommandLineTool
 $argv
 
 $scriptName
 

Protected Member Functions

 _getUserBySpecifier ($specifier)
 

Detailed Description

Definition at line 18 of file MergeUsersTool.inc.php.

Constructor & Destructor Documentation

◆ __construct()

MergeUsersTool::__construct (   $argv = array())

Constructor.

Parameters
$argvarray command-line arguments

Reimplemented from CommandLineTool.

Definition at line 36 of file MergeUsersTool.inc.php.

References CommandLineTool\$argv, and usage().

Member Function Documentation

◆ _getUserBySpecifier()

MergeUsersTool::_getUserBySpecifier (   $specifier)
protected

Get a username by specifier, i.e. username or id=xyz.

Parameters
$specifierstring The specifier
Returns
User|null

Definition at line 116 of file MergeUsersTool.inc.php.

References DAORegistry\getDAO().

Referenced by execute().

◆ execute()

MergeUsersTool::execute ( )

Execute the merge users command.

Definition at line 74 of file MergeUsersTool.inc.php.

References _getUserBySpecifier().

◆ usage()

MergeUsersTool::usage ( )

Print command usage information.

Reimplemented from CommandLineTool.

Definition at line 51 of file MergeUsersTool.inc.php.

Referenced by __construct().

Field Documentation

◆ $mergeSpecifiers

$mergeSpecifier MergeUsersTool::$mergeSpecifiers

array

Definition at line 30 of file MergeUsersTool.inc.php.

◆ $targetSpecifier

$targetSpecifier MergeUsersTool::$targetSpecifier

string

Definition at line 24 of file MergeUsersTool.inc.php.


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