Page MenuHomePhorge
Diviner libphutil Tech Docs PhutilBugtraqParser

final class PhutilBugtraqParser
libphutil Technical Documentation (Parsers)

Replaces ticket or issue IDs in a block of text with links. This mechanism is based on (and compatible with) the Bugtraq system in TortiseSVN. See

http://tortoisesvn.net/docs/release/TortoiseSVN_en/tsvn-dug-bugtracker.html

For example, to link ticket IDs formatted like this:

Issues: 123, 345

...you can use:

$message = id(new PhutilBugtraqParser())
  ->setBugtraqPattern('http://bugs.com/%BUGID%')
  ->setBugtraqCaptureExpression('/[Ii]ssues?:?(\s*,?\s*#\d+)+/')
  ->setBugtraqSelectExpression('/(\d+)/')
  ->processCorpus($message);

This will produce:

Issues: http://bugs.com/123, http://bugs.com/345

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$keyName of the constant.
int|null$byte_limitMaximum number of bytes permitted in the value.
Return
stringValue of the constant.

public function setBugtraqPattern($pattern)

This method is not documented.
Parameters
$pattern
Return
wild

public function setBugtraqCaptureExpression($regex)

This method is not documented.
Parameters
$regex
Return
wild

public function setBugtraqSelectExpression($regex)

This method is not documented.
Parameters
$regex
Return
wild

public function processCorpus($corpus)

This method is not documented.
Parameters
$corpus
Return
wild
Defined
src/parser/PhutilBugtraqParser.php:26
Extends
Phobject
Content licensed under Creative Commons Attribution-ShareAlike 4.0 (CC-BY-SA) unless otherwise noted; code licensed under Apache 2.0 or other open source licenses. · CC BY-SA 4.0 · Apache 2.0