Diviner Tech Docs HarbormasterBuildRequest

final class HarbormasterBuildRequest
Phorge Technical Documentation (Harbormaster)

Structure used to ask Harbormaster to start a build.

Requests to start builds sometimes originate several layers away from where they are processed. For example, Herald rules which start builds pass the requests through the adapter and then through the editor before they reach Harbormaster.

This class is just a thin wrapper around these requests so we can make them more complex later without needing to rewrite any APIs.

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 function setBuildPlanPHID($build_plan_phid)

This method is not documented.

Parameters

$build_plan_phid

Return

wild

public function getBuildPlanPHID()

This method is not documented.

Return

wild

public function setBuildParameters($build_parameters)

This method is not documented.

Parameters

array

$build_parameters

Return

wild

public function getBuildParameters()

This method is not documented.

Return

wild

public function setInitiatorPHID($phid)

This method is not documented.

Parameters

$phid

Return

wild

public function getInitiatorPHID()

This method is not documented.

Return

wild

Defined: src/applications/harbormaster/engine/HarbormasterBuildRequest.php:14
Extends: Phobject

final class HarbormasterBuildRequestPhorge Technical Documentation (Harbormaster)

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 function setBuildPlanPHID($build_plan_phid)

public function getBuildPlanPHID()

public function setBuildParameters($build_parameters)

public function getBuildParameters()

public function setInitiatorPHID($phid)

public function getInitiatorPHID()

final class HarbormasterBuildRequest
Phorge Technical Documentation (Harbormaster)

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