Diviner Tech Docs DifferentialCommitMessageParser

final class DifferentialCommitMessageParser
Phorge Technical Documentation (Differential)

Parses commit messages (containing relatively freeform text with textual field labels) into a dictionary of fields.

$parser = id(new DifferentialCommitMessageParser())
  ->setLabelMap($label_map)
  ->setTitleKey($key_title)
  ->setSummaryKey($key_summary);

$fields = $parser->parseCorpus($corpus);
$errors = $parser->getErrors();

This is used by Differential to parse messages entered from the command line.

Tasks

Configuring the Parser

public function setViewer($viewer)
public function getViewer()
public function setCommitMessageFields($fields)
public function getCommitMessageFields()
public function setRaiseMissingFieldErrors($raise)
public function getRaiseMissingFieldErrors()
public function setLabelMap($label_map)
public function setTitleKey($title_key)
public function setSummaryKey($summary_key)

Parsing Messages

public function parseCorpus($corpus)
public function parseFields($corpus)
public function getErrors()
public function getTransactions()

Support Methods

public static function normalizeFieldLabel($label)

Internals

private function buildLabelRegexp($label_map)

Other Methods

public function __get($name)
public function __set($name, $value)
public function current()
public function key()
public function next()
public function rewind()
public function valid()
private function throwOnAttemptedIteration()
public function getPhobjectClassConstant($key, $byte_limit) — Read the value of a class constant.
public static function newStandardParser($viewer)
private function getLabelMap()

Methods

public function __get($name)
Inherited

This method is not documented.

Parameters

$name

Return

wild

public function __set($name, $value)
Inherited

This method is not documented.

Parameters

	$name
	$value

Return

wild

public function current()
Inherited

This method is not documented.

Return

wild

public function key()
Inherited

This method is not documented.

Return

wild

public function next()
Inherited

This method is not documented.

Return

wild

public function rewind()
Inherited

This method is not documented.

Return

wild

public function valid()
Inherited

This method is not documented.

Return

wild

private function throwOnAttemptedIteration()
Inherited

This method is not documented.

Return

wild

public function getPhobjectClassConstant($key, $byte_limit)
Inherited

Phobject

Read the value of a class constant.

This is the same as just typing self::CONSTANTNAME, but throws a more useful message if the constant is not defined and allows the constant to be limited to a maximum length.

Parameters

string	$key	Name of the constant.
int\|null	$byte_limit	Maximum number of bytes permitted in the value.

Return

string

Value of the constant.

public static function newStandardParser($viewer)

This method is not documented.

Parameters

PhabricatorUser

$viewer

Return

wild

public function setViewer($viewer)

This method is not documented.

Parameters

PhabricatorUser

$viewer

Return

wild

public function getViewer()

This method is not documented.

Return

wild

public function setCommitMessageFields($fields)

This method is not documented.

Parameters

array

$fields

Return

wild

public function getCommitMessageFields()

This method is not documented.

Return

wild

public function setRaiseMissingFieldErrors($raise)

This method is not documented.

Parameters

$raise

Return

wild

public function getRaiseMissingFieldErrors()

This method is not documented.

Return

wild

public function setLabelMap($label_map)

This method is not documented.

Parameters

array

$label_map

Return

wild

public function setTitleKey($title_key)

This method is not documented.

Parameters

$title_key

Return

wild

public function setSummaryKey($summary_key)

This method is not documented.

Parameters

$summary_key

Return

wild

public function parseCorpus($corpus)

This method is not documented.

Parameters

$corpus

Return

wild

public function parseFields($corpus)

This method is not documented.

Parameters

$corpus

Return

wild

public function getErrors()

This method is not documented.

Return

wild

public function getTransactions()

This method is not documented.

Return

wild

public static function normalizeFieldLabel($label)

This method is not documented.

Parameters

$label

Return

wild

private function getLabelMap()

This method is not documented.

Return

wild

private function buildLabelRegexp($label_map)

This method is not documented.

Parameters

array

$label_map

Return

wild

Defined: src/applications/differential/parser/DifferentialCommitMessageParser.php:22
Extends: Phobject

final class DifferentialCommitMessageParserPhorge Technical Documentation (Differential)

Tasks

Configuring the Parser

Parsing Messages

Support Methods

Internals

Other Methods

Methods

public function __get($name)Inherited

public function __set($name, $value)Inherited

public function current()Inherited

public function key()Inherited

public function next()Inherited

public function rewind()Inherited

public function valid()Inherited

private function throwOnAttemptedIteration()Inherited

public function getPhobjectClassConstant($key, $byte_limit)Inherited

public static function newStandardParser($viewer)

public function setViewer($viewer)

public function getViewer()

public function setCommitMessageFields($fields)

public function getCommitMessageFields()

public function setRaiseMissingFieldErrors($raise)

public function getRaiseMissingFieldErrors()

public function setLabelMap($label_map)

public function setTitleKey($title_key)

public function setSummaryKey($summary_key)

public function parseCorpus($corpus)

public function parseFields($corpus)

public function getErrors()

public function getTransactions()

public static function normalizeFieldLabel($label)

private function getLabelMap()

private function buildLabelRegexp($label_map)

final class DifferentialCommitMessageParser
Phorge Technical Documentation (Differential)

public function __get($name)
Inherited

public function __set($name, $value)
Inherited

public function current()
Inherited

public function key()
Inherited

public function next()
Inherited

public function rewind()
Inherited

public function valid()
Inherited

private function throwOnAttemptedIteration()
Inherited

public function getPhobjectClassConstant($key, $byte_limit)
Inherited