PHP Class genEmailUpdates, ojs

Inheritance: extends CommandLineTool

Show file Open project: pkp/ojs Class Usage Examples

Public Properties

Property	Type	Description
$newTag
$oldTag		string Name of the old git tag to use

Public Methods

Method	Description
__construct ( $argv = [] )	Constructor.
execute ( )	Execute the command
fetchFileVersion ( $repository, $filename, $tag ) : mixed	Fetch a particular version of a file from github.
parseEmails ( $contents ) : array	Parse into structures the XML contents of an email data file.
usage ( )	Print command usage information.

Method Details

__construct() public method

Constructor.

public __construct ( $argv = [] )
$argv		array command-line arguments If specified, the first argument should be the file to parse

execute() public method

Execute the command

public execute ( )

fetchFileVersion() public method

Fetch a particular version of a file from github.

public fetchFileVersion ( $repository, $filename, $tag ) : mixed
$repository		string ojs, pkp-lib, etc.
$filename		string
$tag		string
return	mixed	string file contents on success, false on failure.

parseEmails() public method

Parse into structures the XML contents of an email data file.

public parseEmails ( $contents ) : array
$contents		string
return	array

usage() public method

Print command usage information.

public usage ( )

Property Details

$newTag public property

public $newTag

$oldTag public property

string Name of the old git tag to use

public $oldTag