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

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.
public function render()
public function producePhutilSafeHTML()
public function setMethod($method)
public function setIsStandalone($is_standalone)
public function setErrors($errors)
public function getIsStandalone()
public function setSubmitURI($uri) — Set the URI associated to the Submit Button
public function setTitle($title)
public function getTitle()
public function setShortTitle($short_title)
public function getShortTitle()
public function setResizeY($resize_y)
public function getResizeY()
public function setResizeX($resize_x)
public function getResizeX()
public function addSubmitButton($text) — Add a Submit Button and specify its text
public function addCancelButton($uri, $text)
public function addFooter($footer)
public function addHiddenInput($key, $value)
public function setClass($class)
public function setFlush($flush)
public function setRenderDialogAsDiv()
public function setFormID($id)
public function setWidth($width)
public function setObjectList($list)
public function appendRemarkup($remarkup)
public function appendParagraph($paragraph)
public function appendCommand($command)
private function appendParagraphTag($content, $classes)
public function appendList($items)
public function appendForm($form)
public function setDisableWorkflowOnSubmit($disable_workflow_on_submit) — Enable or Disable a Workflow on Submit
public function getDisableWorkflowOnSubmit()
public function setDisableWorkflowOnCancel($disable_workflow_on_cancel)
public function getDisableWorkflowOnCancel()
public function setValidationException($ex)
public function produceAphrontResponse()

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

public function render()

This method is not documented.

Return

This method is not documented.

Parameters

array

$errors

Return

wild

public function getIsStandalone()

This method is not documented.

Return

wild

public function setSubmitURI($uri)

Set the URI associated to the Submit Button

If you want a normal link and not any form submission, see also: setDisableWorkflowOnSubmit(false).

Parameters

string

Return

self

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

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)

Enable or Disable a Workflow on Submit

For example, if your Submit Button should be a normal link, without activating any Workflow, you can set false.

Parameters

bool

$disable_workflow_on_submit

Return

self

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

Defined: src/view/AphrontDialogView.php:3
Extends: AphrontView
Implements: AphrontResponseProducerInterface
PhutilSafeHTMLProducerInterface ◀ AphrontView

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

public function render()

public function producePhutilSafeHTML()Inherited

public function setMethod($method)

public function setIsStandalone($is_standalone)

public function setErrors($errors)

public function getIsStandalone()

public function setSubmitURI($uri)

public function setTitle($title)

public function getTitle()

public function setShortTitle($short_title)

public function getShortTitle()

public function setResizeY($resize_y)

public function getResizeY()

public function setResizeX($resize_x)

public function getResizeX()

public function addSubmitButton($text)

public function addCancelButton($uri, $text)

public function addFooter($footer)

public function addHiddenInput($key, $value)

public function setClass($class)

public function setFlush($flush)

public function setRenderDialogAsDiv()

public function setFormID($id)

public function setWidth($width)

public function setObjectList($list)

public function appendRemarkup($remarkup)

public function appendParagraph($paragraph)

public function appendCommand($command)

private function appendParagraphTag($content, $classes)

public function appendList($items)

public function appendForm($form)

public function setDisableWorkflowOnSubmit($disable_workflow_on_submit)

public function getDisableWorkflowOnSubmit()

public function setDisableWorkflowOnCancel($disable_workflow_on_cancel)

public function getDisableWorkflowOnCancel()

public function setValidationException($ex)

public function produceAphrontResponse()

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