Diviner Tech Docs PhabricatorActionView

final class PhabricatorActionView
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.
public function render()
public function producePhutilSafeHTML()
public function setSelected($selected)
public function getSelected()
public function setMetadata($metadata)
public function getMetadata()
public function setDownload($download)
public function getDownload()
public function setHref($href)
public function setColor($color)
public function addSigil($sigil)
public function getHref()
public function setIcon($icon)
public function setName($name)
public function getName()
public function setLabel($label)
public function setDisabled($disabled)
public function getDisabled()
public function setWorkflow($workflow)
public function setRenderAsForm($form)
public function setOpenInNewWindow($open_in_new_window)
public function getOpenInNewWindow()
public function setID($id)
public function getID()
public function setOrder($order)
public function getOrder()
public function setType($type)
public function getType()
public function setSubmenu($submenu)
public function getItems($depth)
public function setHidden($hidden)
public function getHidden()
public function setDepth($depth)
public function getDepth()

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

wild

public function producePhutilSafeHTML()
Inherited

This method is not documented.

Return

wild

public function setSelected($selected)

This method is not documented.

Parameters

$selected

Return

wild

public function getSelected()

This method is not documented.

Return

wild

public function setMetadata($metadata)

This method is not documented.

Parameters

$metadata

Return

wild

public function getMetadata()

This method is not documented.

Return

wild

public function setDownload($download)

This method is not documented.

Parameters

$download

Return

wild

public function getDownload()

This method is not documented.

Return

wild

public function setHref($href)

This method is not documented.

Parameters

$href

Return

wild

public function setColor($color)

This method is not documented.

Parameters

$color

Return

wild

public function addSigil($sigil)

This method is not documented.

Parameters

$sigil

Return

wild

public function getHref()

This method is not documented.

Return

wild

public function setIcon($icon)

This method is not documented.

Parameters

$icon

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 setLabel($label)

This method is not documented.

Parameters

$label

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

public function setWorkflow($workflow)

This method is not documented.

Parameters

$workflow

Return

wild

public function setRenderAsForm($form)

This method is not documented.

Parameters

$form

Return

wild

public function setOpenInNewWindow($open_in_new_window)

This method is not documented.

Parameters

$open_in_new_window

Return

wild

public function getOpenInNewWindow()

This method is not documented.

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 setOrder($order)

This method is not documented.

Parameters

$order

Return

wild

public function getOrder()

This method is not documented.

Return

wild

public function setType($type)

This method is not documented.

Parameters

$type

Return

wild

public function getType()

This method is not documented.

Return

wild

public function setSubmenu($submenu)

This method is not documented.

Parameters

array

$submenu

Return

wild

public function getItems($depth)

This method is not documented.

Parameters

$depth

Return

wild

public function setHidden($hidden)

This method is not documented.

Parameters

$hidden

Return

wild

public function getHidden()

This method is not documented.

Return

wild

public function setDepth($depth)

This method is not documented.

Parameters

$depth

Return

wild

public function getDepth()

This method is not documented.

Return

wild

Defined: src/view/layout/PhabricatorActionView.php:3
Extends: PhobjectAphrontView
Implements: PhutilSafeHTMLProducerInterface ◀ AphrontView

final class PhabricatorActionViewPhorge 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)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 setSelected($selected)

public function getSelected()

public function setMetadata($metadata)

public function getMetadata()

public function setDownload($download)

public function getDownload()

public function setHref($href)

public function setColor($color)

public function addSigil($sigil)

public function getHref()

public function setIcon($icon)

public function setName($name)

public function getName()

public function setLabel($label)

public function setDisabled($disabled)

public function getDisabled()

public function setWorkflow($workflow)

public function setRenderAsForm($form)

public function setOpenInNewWindow($open_in_new_window)

public function getOpenInNewWindow()

public function setID($id)

public function getID()

public function setOrder($order)

public function getOrder()

public function setType($type)

public function getType()

public function setSubmenu($submenu)

public function getItems($depth)

public function setHidden($hidden)

public function getHidden()

public function setDepth($depth)

public function getDepth()

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

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