Diviner Tech Docs AphrontRemarkupHTTPParameterType

final class AphrontRemarkupHTTPParameterType
Phorge Technical Documentation (Aphront)

This class is not documented.

Tasks

Reading Values from a Request

final public function setViewer($viewer) — Set the current viewer.
final public function getViewer() — Get the current viewer.
final public function getExists($request, $key) — Test if a value is present in a request.
final public function getValue($request, $key) — Read a value from a request.
final public function getDefaultValue() — Get the default value for this parameter type.

Information About the Type

final public function getTypeName() — Get a short name for this type, like `string` or `list<phid>`.
final public function getFormatDescriptions() — Get a list of human-readable descriptions of acceptable formats for this type.
final public function getExamples() — Get a list of human-readable examples of how to format this type as an HTTP GET parameter.

Parsing Utilities

final protected function getExistsWithType($type, $request, $key) — Call another type's existence check.
final protected function getValueWithType($type, $request, $key) — Call another type's value parser.
final public static function getAllTypes() — Get a list of all available parameter types.

Implementation

protected function getParameterExists($request, $key) — Test if a parameter exists in a request.
protected function getParameterValue($request, $key)
protected function getParameterTypeName()
protected function getParameterFormatDescriptions()
protected function getParameterExamples()
protected function getParameterDefault()

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.
private function newRemarkupValue()

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.

final public function setViewer($viewer)
Inherited

AphrontHTTPParameterType

Set the current viewer.

Some parameter types perform complex parsing involving lookups. For example, a type might lookup usernames or project names. These types need to use the current viewer to execute queries.

Parameters

PhabricatorUser

$viewer

Current viewer.

Return

this

final public function getViewer()
Inherited

AphrontHTTPParameterType

Get the current viewer.

Return

PhabricatorUser

Current viewer.

final public function getExists($request, $key)
Inherited

AphrontHTTPParameterType

Test if a value is present in a request.

Parameters

AphrontRequest	$request	The incoming request.
string	$key	The key to examine.

Return

bool	True if a readable value is present in the request.

final public function getValue($request, $key)
Inherited

AphrontHTTPParameterType

Read a value from a request.

If the value is not present, a default value is returned (usually null). Use getExists() to test if a value is present.

Parameters

AphrontRequest	$request	The incoming request.
string	$key	The key to examine.

Return

wild	Value, or default if value is not present.

final public function getDefaultValue()
Inherited

AphrontHTTPParameterType

Get the default value for this parameter type.

Return

wild	Default value for this type.

final public function getTypeName()
Inherited

AphrontHTTPParameterType

Get a short name for this type, like string or list<phid>.

Return

string

Short type name.

final public function getFormatDescriptions()
Inherited

AphrontHTTPParameterType

Get a list of human-readable descriptions of acceptable formats for this type.

For example, a type might return strings like these:

Any positive integer. A comma-separated list of PHIDs.

This is used to explain to users how to specify a type when generating documentation.

Return

list<string>

Human-readable list of acceptable formats.

final public function getExamples()
Inherited

AphrontHTTPParameterType

Get a list of human-readable examples of how to format this type as an HTTP GET parameter.

For example, a type might return strings like these:

v=123 v[]=1&v[]=2

This is used to show users how to specify parameters of this type in generated documentation.

Return

list<string>

Human-readable list of format examples.

final protected function getExistsWithType($type, $request, $key)
Inherited

AphrontHTTPParameterType

Call another type's existence check.

This method allows a type to reuse the existence behavior of a different type. For example, a "list of users" type may have the same basic existence check that a simpler "list of strings" type has, and can just call the simpler type to reuse its behavior.

Parameters

AphrontHTTPParameterType	$type	The other type.
AphrontRequest	$request	Incoming request.
string	$key	Key to examine.

Return

bool	True if the parameter exists.

final protected function getValueWithType($type, $request, $key)
Inherited

AphrontHTTPParameterType

Call another type's value parser.

This method allows a type to reuse the parsing behavior of a different type. For example, a "list of users" type may start by running the same basic parsing that a simpler "list of strings" type does.

Parameters

AphrontHTTPParameterType	$type	The other type.
AphrontRequest	$request	Incoming request.
string	$key	Key to examine.

Return

wild	Parsed value.

final public static function getAllTypes()
Inherited

AphrontHTTPParameterType

Get a list of all available parameter types.

Return

list<AphrontHTTPParameterType>

List of all available types.

protected function getParameterExists($request, $key)
Inherited

AphrontHTTPParameterType

Test if a parameter exists in a request.

See getExists(). By default, this method tests if the key is present in the request.

To call another type's behavior in order to perform this check, use getExistsWithType().

Parameters

AphrontRequest	$request	The incoming request.
string	$key	The key to examine.

Return

bool	True if a readable value is present in the request.

protected function getParameterValue($request, $key)

AphrontHTTPParameterType

Parse a value from a request.

See getValue(). This method will only be called if this type has already asserted that the value exists with getParameterExists().

To call another type's behavior in order to parse a value, use getValueWithType().

AphrontRemarkupHTTPParameterType

This method is not documented.

Parameters

AphrontRequest	$request	The incoming request.
string	$key	The key to examine.

Return

wild	Parsed value.

protected function getParameterTypeName()

AphrontHTTPParameterType

Return a simple type name string, like "string" or "list<phid>".

See getTypeName().

AphrontRemarkupHTTPParameterType

This method is not documented.

Return

string

Short type name.

protected function getParameterFormatDescriptions()

AphrontHTTPParameterType

Return a human-readable list of format descriptions.

See getFormatDescriptions().

AphrontRemarkupHTTPParameterType

This method is not documented.

Return

list<string>

Human-readable list of acceptable formats.

protected function getParameterExamples()

AphrontHTTPParameterType

Return a human-readable list of examples.

See getExamples().

AphrontRemarkupHTTPParameterType

This method is not documented.

Return

list<string>

Human-readable list of format examples.

protected function getParameterDefault()

AphrontHTTPParameterType

Return the default value for this parameter type.

See getDefaultValue(). If unspecified, the default is null.

AphrontRemarkupHTTPParameterType

This method is not documented.

Return

wild	Default value.

private function newRemarkupValue()

This method is not documented.

Return

wild

Defined: src/aphront/httpparametertype/AphrontRemarkupHTTPParameterType.php:3
Extends: PhobjectAphrontHTTPParameterType

final class AphrontRemarkupHTTPParameterTypePhorge Technical Documentation (Aphront)

Tasks

Reading Values from a Request

Information About the Type

Parsing Utilities

Implementation

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

final public function setViewer($viewer)Inherited

final public function getViewer()Inherited

final public function getExists($request, $key)Inherited

final public function getValue($request, $key)Inherited

final public function getDefaultValue()Inherited

final public function getTypeName()Inherited

final public function getFormatDescriptions()Inherited

final public function getExamples()Inherited

final protected function getExistsWithType($type, $request, $key)Inherited

final protected function getValueWithType($type, $request, $key)Inherited

final public static function getAllTypes()Inherited

protected function getParameterExists($request, $key)Inherited

protected function getParameterValue($request, $key)

protected function getParameterTypeName()

protected function getParameterFormatDescriptions()

protected function getParameterExamples()

protected function getParameterDefault()

private function newRemarkupValue()

final class AphrontRemarkupHTTPParameterType
Phorge Technical Documentation (Aphront)

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

final public function setViewer($viewer)
Inherited

final public function getViewer()
Inherited

final public function getExists($request, $key)
Inherited

final public function getValue($request, $key)
Inherited

final public function getDefaultValue()
Inherited

final public function getTypeName()
Inherited

final public function getFormatDescriptions()
Inherited

final public function getExamples()
Inherited

final protected function getExistsWithType($type, $request, $key)
Inherited

final protected function getValueWithType($type, $request, $key)
Inherited

final public static function getAllTypes()
Inherited

protected function getParameterExists($request, $key)
Inherited