Diviner Tech Docs AphrontView

abstract class AphrontView
Phorge Technical Documentation ()

This class is not documented.

Tasks

Managing Children

protected function canAppendChild() — Test if this View accepts children.
final public function hasChildren() — Test if an element has no children.
private function reduceChildren($children) — Reduce effectively-empty lists of children to be actually empty. This recursively removes `null`, `''`, and `array()` from the list of children so that @{method:hasChildren} can more effectively align with expectations.

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 function setViewer($viewer) — Set the user viewing this element.
public function getViewer() — Get the user viewing this element.
public function hasViewer() — Test if a viewer has been set on this element.
final public function appendChild($child) — Append a child to the list of children.
public function getDefaultResourceSource()
public function requireResource($symbol)
public function initBehavior($name, $config)
public function willRender() — Inconsistent, unreliable pre-rendering hook.
abstract public function render()
public function producePhutilSafeHTML()

config

public function setUser($user) — Deprecated, use @{method:setViewer}.
protected function getUser() — Deprecated, use @{method:getViewer}.

1

final protected function renderChildren() — Produce children for rendering.

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 setViewer($viewer)

Set the user viewing this element.

Parameters

PhabricatorUser

$viewer

Viewing user.

Return

this

public function getViewer()

Get the user viewing this element.

Throws an exception if no viewer has been set.

Return

PhabricatorUser

Viewing user.

public function hasViewer()

Test if a viewer has been set on this element.

Return

bool	True if a viewer is available.

public function setUser($user)

Deprecated, use setViewer().

Parameters

PhabricatorUser

$user

Return

wild

protected function getUser()

Deprecated, use getViewer().

Return

wild

protected function canAppendChild()

Test if this View accepts children.

By default, views accept children, but subclases may override this method to prevent children from being appended. Doing so will cause appendChild() to throw exceptions instead of appending children.

Return

bool	True if the View should accept children.

final public function appendChild($child)

Append a child to the list of children.

This method will only work if the view supports children, which is determined by canAppendChild().

Parameters

wild

$child

Something renderable.

Return

this

final protected function renderChildren()

Produce children for rendering.

Historically, this method reduced children to a string representation, but it no longer does.

Return

wild	Renderable children.

final public function hasChildren()

Test if an element has no children.

Return

bool	True if this element has children.

private function reduceChildren($children)

Reduce effectively-empty lists of children to be actually empty. This recursively removes null, '', and array() from the list of children so that hasChildren() can more effectively align with expectations.

NOTE: Because View children are not rendered, a View which renders down to nothing will not be reduced by this method.

Parameters

list<wild>

$children

Renderable children.

Return

list<wild>

Reduced list of children.

public function getDefaultResourceSource()

This method is not documented.

Return

wild

public function requireResource($symbol)

This method is not documented.

Parameters

$symbol

Return

wild

public function initBehavior($name, $config)

This method is not documented.

Parameters

	$name
	$config

Return

wild

public function willRender()

Inconsistent, unreliable pre-rendering hook.

This hook may fire before views render. It is not fired reliably, and may fire multiple times.

If it does fire, views might use it to register data for later loads, but almost no datasources support this now; this is currently only useful for tokenizers. This mechanism might eventually see wider support or might be removed.

Return

wild

abstract public function render()

This method is not documented.

Return

wild

public function producePhutilSafeHTML()

This method is not documented.

Return

wild

Defined: src/view/AphrontView.php:6
Extends: Phobject
Implements: PhutilSafeHTMLProducerInterface

abstract class AphrontViewPhorge Technical Documentation ()

Tasks

Managing Children

Other Methods

config

1

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 setViewer($viewer)

public function getViewer()

public function hasViewer()

public function setUser($user)

protected function getUser()

protected function canAppendChild()

final public function appendChild($child)

final protected function renderChildren()

final public function hasChildren()

private function reduceChildren($children)

public function getDefaultResourceSource()

public function requireResource($symbol)

public function initBehavior($name, $config)

public function willRender()

abstract public function render()

public function producePhutilSafeHTML()

abstract class AphrontView
Phorge Technical Documentation ()

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