Page MenuHomePhorge
Diviner Tech Docs AphrontDialogView

final class AphrontDialogView
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

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

public function setViewer($viewer)
Inherited

AphrontView

Set the user viewing this element.

Parameters
PhabricatorUser$viewerViewing user.
Return
this

public function getViewer()
Inherited

AphrontView

Get the user viewing this element.

Throws an exception if no viewer has been set.

Return
PhabricatorUserViewing user.

public function hasViewer()
Inherited

AphrontView

Test if a viewer has been set on this element.

Return
boolTrue 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
boolTrue 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$childSomething 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
wildRenderable children.

final public function hasChildren()
Inherited

AphrontView

Test if an element has no children.

Return
boolTrue 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>$childrenRenderable 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

public function render()

This method is not documented.
Return
wild

public function producePhutilSafeHTML()
Inherited

This method is not documented.
Return
wild

public function setMethod($method)

This method is not documented.
Parameters
$method
Return
wild

public function setIsStandalone($is_standalone)

This method is not documented.
Parameters
$is_standalone
Return
wild

public function setErrors($errors)

This method is not documented.
Parameters
array$errors
Return
wild

public function getIsStandalone()

This method is not documented.
Return
wild

public function setSubmitURI($uri)

This method is not documented.
Parameters
$uri
Return
wild

public function setTitle($title)

This method is not documented.
Parameters
$title
Return
wild

public function getTitle()

This method is not documented.
Return
wild

public function setShortTitle($short_title)

This method is not documented.
Parameters
$short_title
Return
wild

public function getShortTitle()

This method is not documented.
Return
wild

public function setResizeY($resize_y)

This method is not documented.
Parameters
$resize_y
Return
wild

public function getResizeY()

This method is not documented.
Return
wild

public function setResizeX($resize_x)

This method is not documented.
Parameters
$resize_x
Return
wild

public function getResizeX()

This method is not documented.
Return
wild

public function addSubmitButton($text)

This method is not documented.
Parameters
$text
Return
wild

public function addCancelButton($uri, $text)

This method is not documented.
Parameters
$uri
$text
Return
wild

public function addFooter($footer)

This method is not documented.
Parameters
$footer
Return
wild

public function addHiddenInput($key, $value)

This method is not documented.
Parameters
$key
$value
Return
wild

public function setClass($class)

This method is not documented.
Parameters
$class
Return
wild

public function setFlush($flush)

This method is not documented.
Parameters
$flush
Return
wild

public function setRenderDialogAsDiv()

This method is not documented.
Return
wild

public function setFormID($id)

This method is not documented.
Parameters
$id
Return
wild

public function setWidth($width)

This method is not documented.
Parameters
$width
Return
wild

public function setObjectList($list)

This method is not documented.
Parameters
PHUIObjectItemListView$list
Return
wild

public function appendRemarkup($remarkup)

This method is not documented.
Parameters
$remarkup
Return
wild

public function appendParagraph($paragraph)

This method is not documented.
Parameters
$paragraph
Return
wild

public function appendCommand($command)

This method is not documented.
Parameters
$command
Return
wild

private function appendParagraphTag($content, $classes)

This method is not documented.
Parameters
$content
$classes
Return
wild

public function appendList($items)

This method is not documented.
Parameters
array$items
Return
wild

public function appendForm($form)

This method is not documented.
Parameters
AphrontFormView$form
Return
wild

public function setDisableWorkflowOnSubmit($disable_workflow_on_submit)

This method is not documented.
Parameters
$disable_workflow_on_submit
Return
wild

public function getDisableWorkflowOnSubmit()

This method is not documented.
Return
wild

public function setDisableWorkflowOnCancel($disable_workflow_on_cancel)

This method is not documented.
Parameters
$disable_workflow_on_cancel
Return
wild

public function getDisableWorkflowOnCancel()

This method is not documented.
Return
wild

public function setValidationException($ex)

This method is not documented.
Parameters
PhabricatorApplicationTransactionValidationException$ex
Return
wild

public function produceAphrontResponse()

This method is not documented.
Return
wild