Diviner Tech Docs PHUICrumbsView

final class PHUICrumbsView
Phorge Technical Documentation (PHUI)

This class is not documented.

Tasks

Managing Children

protected function canAppendChild()
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 addTextCrumb($text, $href, $strikethrough) — Convenience method for adding a simple crumb with just text, or text and a link.
public function addCrumb($crumb)
public function addAction($action)
public function setBorder($border)
public function getActions()

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

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.

PHUICrumbsView

This method is not documented.

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

mixed

$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

mixed

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

$children

Renderable children.

Return

list<mixed>

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 addTextCrumb($text, $href, $strikethrough)

Convenience method for adding a simple crumb with just text, or text and a link.

Parameters

string	$text	Text of the crumb.
string	$href	(optional) href for the crumb.
bool	$strikethrough	(optional) Strikethrough (=inactive/disabled) for the crumb.

Return

$this

public function addCrumb($crumb)

This method is not documented.

Parameters

\PHUICrumbView

$crumb

Return

wild

public function addAction($action)

This method is not documented.

Parameters

\PHUIListItemView

$action

Return

wild

public function setBorder($border)

This method is not documented.

Parameters

$border

Return

wild

public function getActions()

This method is not documented.

Return

wild

Defined: src/view/phui/PHUICrumbsView.php:3
Extends: AphrontView
Implements: PhutilSafeHTMLProducerInterface ◀ AphrontView

final class PHUICrumbsViewPhorge Technical Documentation (PHUI)

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

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 addTextCrumb($text, $href, $strikethrough)

public function addCrumb($crumb)

public function addAction($action)

public function setBorder($border)

public function getActions()

final class PHUICrumbsView
Phorge Technical Documentation (PHUI)

public function setViewer($viewer)
Inherited

public function getViewer()
Inherited

public function hasViewer()
Inherited

public function setUser($user)
Inherited

protected function getUser()
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