Diviner Tech Docs AphrontFormControl

abstract class AphrontFormControl
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 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.
final public function render()
public function producePhutilSafeHTML()
public function setHidden($hidden)
public function setID($id)
public function getID()
public function setControlID($control_id)
public function getControlID()
public function setControlStyle($control_style)
public function getControlStyle()
public function setLabel($label)
public function getLabel()
public function setCaption($caption) — Set the Caption The Caption shows a tip usually nearby the related input field.
public function getCaption() — Get the Caption The Caption shows a tip usually nearby the related input field.
public function setError($error)
public function getError()
public function setName($name)
public function getName()
public function setValue($value)
public function getValue()
public function isValid()
public function isRequired()
public function isEmpty()
public function getSerializedValue()
public function readSerializedValue($value)
public function readValueFromRequest($request)
public function readValueFromDictionary($dictionary)
public function setDisabled($disabled)
public function getDisabled()
abstract protected function renderInput()
abstract protected function getCustomControlClass()
protected function shouldRender()
public function addClass($class)

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

AphrontView

Set the user viewing this element.

Parameters

PhabricatorUser

$viewer

Viewing user.

Return

this

public function getViewer()
Inherited

AphrontView

Get the user viewing this element.

Throws an exception if no viewer has been set.

Return

PhabricatorUser

Viewing user.

public function hasViewer()
Inherited

AphrontView

Test if a viewer has been set on this element.

Return

bool	True if a viewer is available.

public function setUser($user)
Inherited

AphrontView

Deprecated, use setViewer().

Parameters

PhabricatorUser

$user

Return

wild

protected function getUser()
Inherited

AphrontView

Deprecated, use getViewer().

Return

wild

protected function canAppendChild()
Inherited

AphrontView

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)
Inherited

AphrontView

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()
Inherited

AphrontView

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()
Inherited

AphrontView

Test if an element has no children.

Return

bool	True if this element has children.

private function reduceChildren($children)
Inherited

AphrontView

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()
Inherited

This method is not documented.

Return

wild

public function requireResource($symbol)
Inherited

This method is not documented.

Parameters

$symbol

Return

wild

public function initBehavior($name, $config)
Inherited

This method is not documented.

Parameters

	$name
	$config

Return

wild

public function willRender()
Inherited

AphrontView

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

final public function render()

This method is not documented.

Return

wild

public function producePhutilSafeHTML()
Inherited

This method is not documented.

Return

wild

public function setHidden($hidden)

This method is not documented.

Parameters

$hidden

Return

wild

public function setID($id)

This method is not documented.

Parameters

$id

Return

wild

public function getID()

This method is not documented.

Return

wild

public function setControlID($control_id)

This method is not documented.

Parameters

$control_id

Return

wild

public function getControlID()

This method is not documented.

Return

wild

public function setControlStyle($control_style)

This method is not documented.

Parameters

$control_style

Return

wild

public function getControlStyle()

This method is not documented.

Return

wild

public function setLabel($label)

This method is not documented.

Parameters

$label

Return

wild

public function getLabel()

This method is not documented.

Return

wild

public function setCaption($caption)

Set the Caption The Caption shows a tip usually nearby the related input field.

Parameters

string|PhutilSafeHTML|null

$caption

Return

self

public function getCaption()

Get the Caption The Caption shows a tip usually nearby the related input field.

Return

string|PhutilSafeHTML|null

public function setError($error)

This method is not documented.

Parameters

$error

Return

wild

public function getError()

This method is not documented.

Return

wild

public function setName($name)

This method is not documented.

Parameters

$name

Return

wild

public function getName()

This method is not documented.

Return

wild

public function setValue($value)

This method is not documented.

Parameters

$value

Return

wild

public function getValue()

This method is not documented.

Return

wild

public function isValid()

This method is not documented.

Return

wild

public function isRequired()

This method is not documented.

Return

wild

public function isEmpty()

This method is not documented.

Return

wild

public function getSerializedValue()

This method is not documented.

Return

wild

public function readSerializedValue($value)

This method is not documented.

Parameters

$value

Return

wild

public function readValueFromRequest($request)

This method is not documented.

Parameters

AphrontRequest

$request

Return

wild

public function readValueFromDictionary($dictionary)

This method is not documented.

Parameters

array

$dictionary

Return

wild

public function setDisabled($disabled)

This method is not documented.

Parameters

$disabled

Return

wild

public function getDisabled()

This method is not documented.

Return

wild

abstract protected function renderInput()

This method is not documented.

Return

wild

abstract protected function getCustomControlClass()

This method is not documented.

Return

wild

protected function shouldRender()

This method is not documented.

Return

wild

public function addClass($class)

This method is not documented.

Parameters

$class

Return

wild

Defined: src/view/form/control/AphrontFormControl.php:3
Extends: AphrontView
Implements: PhutilSafeHTMLProducerInterface ◀ AphrontView

abstract class AphrontFormControlPhorge Technical Documentation ()

Tasks

Managing Children

Other Methods

config

1

Methods

public function setViewer($viewer)Inherited

public function getViewer()Inherited

public function hasViewer()Inherited

public function setUser($user)Inherited

protected function getUser()Inherited

protected function canAppendChild()Inherited

final public function appendChild($child)Inherited

final protected function renderChildren()Inherited

final public function hasChildren()Inherited

private function reduceChildren($children)Inherited

public function getDefaultResourceSource()Inherited

public function requireResource($symbol)Inherited

public function initBehavior($name, $config)Inherited

public function willRender()Inherited

final public function render()

public function producePhutilSafeHTML()Inherited

public function setHidden($hidden)

public function setID($id)

public function getID()

public function setControlID($control_id)

public function getControlID()

public function setControlStyle($control_style)

public function getControlStyle()

public function setLabel($label)

public function getLabel()

public function setCaption($caption)

public function getCaption()

public function setError($error)

public function getError()

public function setName($name)

public function getName()

public function setValue($value)

public function getValue()

public function isValid()

public function isRequired()

public function isEmpty()

public function getSerializedValue()

public function readSerializedValue($value)

public function readValueFromRequest($request)

public function readValueFromDictionary($dictionary)

public function setDisabled($disabled)

public function getDisabled()

abstract protected function renderInput()

abstract protected function getCustomControlClass()

protected function shouldRender()

public function addClass($class)

abstract class AphrontFormControl
Phorge Technical Documentation ()

public function setViewer($viewer)
Inherited

public function getViewer()
Inherited

public function hasViewer()
Inherited

public function setUser($user)
Inherited

protected function getUser()
Inherited

protected function canAppendChild()
Inherited

final public function appendChild($child)
Inherited

final protected function renderChildren()
Inherited

final public function hasChildren()
Inherited

private function reduceChildren($children)
Inherited

public function getDefaultResourceSource()
Inherited

public function requireResource($symbol)
Inherited

public function initBehavior($name, $config)
Inherited

public function willRender()
Inherited

public function producePhutilSafeHTML()
Inherited